From 62025851fe956d5872048be7cde1fa8d3c647e16 Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 25 Jul 2024 05:44:43 +0000 Subject: [PATCH] CI Update Build.Reason:Manual by Yanan Zhao Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=441272&view=results --- .../Alpha_numsContext.yml | 895 +++ .../AlternationContext.yml | 869 +++ .../ArgsListContext.yml | 901 +++ .../ArrayCreationExpContext.yml | 928 ++++ .../ArrayExpression.yml | 140 + .../ArrayExpressionConverter.yml | 33 + .../adaptive-expressions-ie11/AtomContext.yml | 922 ++++ .../BinaryOpExpContext.yml | 1097 ++++ .../BoolExpression.yml | 142 + .../BoolExpressionConverter.yml | 29 + .../CaptureContext.yml | 894 +++ .../Cc_atomContext.yml | 867 +++ .../Cc_literalContext.yml | 940 ++++ .../Character_classContext.yml | 876 +++ .../adaptive-expressions-ie11/Clause.yml | 538 ++ .../adaptive-expressions-ie11/CommonRegex.yml | 28 + .../CommonRegexLexer.yml | 2140 ++++++++ .../CommonRegexListener.yml | 714 +++ .../CommonRegexParser.yml | 3122 +++++++++++ .../CommonRegexVisitor.yml | 412 ++ .../ComparisonEvaluator.yml | 130 + .../adaptive-expressions-ie11/Constant.yml | 474 ++ .../DigitContext.yml | 927 ++++ .../DigitsContext.yml | 843 +++ .../ElementContext.yml | 839 +++ .../EnumExpression.yml | 138 + .../EnumExpressionConverter.yml | 47 + .../EvaluateExpressionDelegate.yml | 18 + .../EvaluatorLookup.yml | 10 + .../adaptive-expressions-ie11/ExprContext.yml | 843 +++ .../adaptive-expressions-ie11/Expression.yml | 407 ++ .../ExpressionAntlrLexer.yml | 1347 +++++ .../ExpressionAntlrParser.yml | 1944 +++++++ .../ExpressionAntlrParserListener.yml | 720 +++ .../ExpressionAntlrParserVisitor.yml | 415 ++ .../ExpressionContext.yml | 806 +++ .../ExpressionConverter.yml | 27 + .../ExpressionEvaluator.yml | 101 + .../ExpressionFunctions.yml | 36 + .../ExpressionParser.yml | 55 + .../ExpressionParserInterface.yml | 25 + .../ExpressionProperty.yml | 120 + .../ExpressionType.yml | 1930 +++++++ .../adaptive-expressions-ie11/Extensions.yml | 60 + .../adaptive-expressions-ie11/FileContext.yml | 845 +++ .../FuncInvokeExpContext.yml | 950 ++++ .../FunctionTable.yml | 273 + .../FunctionUtils.yml | 819 +++ .../IdAtomContext.yml | 906 ++++ .../IndexAccessExpContext.yml | 939 ++++ .../IntExpression.yml | 141 + .../IntExpressionConverter.yml | 29 + .../JsonCreationExpContext.yml | 930 ++++ .../adaptive-expressions-ie11/KeyContext.yml | 845 +++ .../KeyValuePairContext.yml | 856 +++ .../KeyValuePairListContext.yml | 875 +++ .../LambdaContext.yml | 856 +++ .../LetterContext.yml | 1389 +++++ .../LiteralContext.yml | 841 +++ .../MemberAccessExpContext.yml | 928 ++++ .../MemoryInterface.yml | 60 + .../MultivariateNumericEvaluator.yml | 121 + .../adaptive-expressions-ie11/NameContext.yml | 828 +++ .../adaptive-expressions-ie11/Node.yml | 172 + .../Non_captureContext.yml | 872 +++ .../Non_close_parenContext.yml | 828 +++ .../Non_close_parensContext.yml | 843 +++ .../NumberContext.yml | 828 +++ .../NumberExpression.yml | 144 + .../NumberExpressionConverter.yml | 29 + .../NumberTransformEvaluator.yml | 113 + .../NumericAtomContext.yml | 906 ++++ .../NumericEvaluator.yml | 110 + .../ObjectExpression.yml | 144 + .../ObjectExpressionConverter.yml | 34 + .../Octal_charContext.yml | 898 +++ .../Octal_digitContext.yml | 905 +++ .../adaptive-expressions-ie11/Optimizer.yml | 25 + .../OptionContext.yml | 876 +++ .../Option_flagContext.yml | 850 +++ .../adaptive-expressions-ie11/Options.yml | 49 + .../ParenthesisExpContext.yml | 928 ++++ .../ParseContext.yml | 839 +++ .../ParseErrorListener.yml | 55 + .../PredicateComparer.yml | 43 + .../PredicateComparers.yml | 10 + .../PrimaryExpContext.yml | 906 ++++ .../PrimaryExpressionContext.yml | 806 +++ .../adaptive-expressions-ie11/Quantifier.yml | 79 + .../QuantifierContext.yml | 920 ++++ .../QuantifierType.yml | 19 + .../Quantifier_typeContext.yml | 839 +++ .../RegexErrorListener.yml | 61 + .../RelationshipType.yml | 29 + .../adaptive-expressions-ie11/ReturnType.yml | 34 + .../Shared_atomContext.yml | 916 ++++ .../Shared_literalContext.yml | 1103 ++++ .../SimpleObjectMemory.yml | 113 + .../StackedMemory.yml | 1367 +++++ .../StringAtomContext.yml | 906 ++++ .../StringExpression.yml | 149 + .../StringExpressionConverter.yml | 29 + .../StringInterpolationAtomContext.yml | 909 ++++ .../StringInterpolationContext.yml | 929 ++++ .../StringTransformEvaluator.yml | 118 + .../TextContentContext.yml | 849 +++ .../TimeTransformEvaluator.yml | 115 + .../TimeZoneConverter.yml | 65 + .../adaptive-expressions-ie11/Trigger.yml | 137 + .../adaptive-expressions-ie11/TriggerTree.yml | 160 + .../TripleOpExpContext.yml | 943 ++++ .../UnaryOpExpContext.yml | 939 ++++ .../adaptive-expressions-ie11/Util.yml | 28 + .../ValidateExpressionDelegate.yml | 12 + .../ValueExpression.yml | 149 + .../ValueExpressionConverter.yml | 29 + .../ValueWithError.yml | 10 + .../VerifyExpression.yml | 16 + .../adaptive-expressions-ie11/index.yml | 148 + .../adaptive-expressions/Abs.yml | 116 - .../adaptive-expressions/Accessor.yml | 116 - .../adaptive-expressions/Add.yml | 118 - .../adaptive-expressions/AddDays.yml | 116 - .../adaptive-expressions/AddHours.yml | 116 - .../adaptive-expressions/AddMinutes.yml | 116 - .../adaptive-expressions/AddOrdinal.yml | 116 - .../adaptive-expressions/AddProperty.yml | 120 - .../adaptive-expressions/AddSeconds.yml | 116 - .../adaptive-expressions/AddToTime.yml | 116 - .../adaptive-expressions/All.yml | 116 - .../Alpha_numsContext.yml | 219 +- .../AlternationContext.yml | 215 +- .../adaptive-expressions/And.yml | 118 - .../adaptive-expressions/Any.yml | 116 - .../adaptive-expressions/ArgsListContext.yml | 219 +- .../ArrayCreationExpContext.yml | 367 +- .../adaptive-expressions/ArrayExpression.yml | 33 +- .../ArrayExpressionConverter.yml | 4 +- .../adaptive-expressions/AtomContext.yml | 252 +- .../adaptive-expressions/Average.yml | 116 - .../adaptive-expressions/Base64.yml | 116 - .../adaptive-expressions/Base64ToBinary.yml | 116 - .../adaptive-expressions/Base64ToString.yml | 118 - .../adaptive-expressions/Binary.yml | 116 - .../BinaryOpExpContext.yml | 444 +- .../adaptive-expressions/Bool.yml | 116 - .../adaptive-expressions/BoolExpression.yml | 27 +- .../BoolExpressionConverter.yml | 4 +- .../adaptive-expressions/CaptureContext.yml | 230 +- .../adaptive-expressions/Cc_atomContext.yml | 221 +- .../Cc_literalContext.yml | 262 +- .../adaptive-expressions/Ceiling.yml | 118 - .../Character_classContext.yml | 218 +- .../adaptive-expressions/Clause.yml | 177 +- .../adaptive-expressions/Coalesce.yml | 118 - .../adaptive-expressions/CommonRegex.yml | 2 - .../adaptive-expressions/CommonRegexLexer.yml | 510 +- .../CommonRegexListener.yml | 59 - .../CommonRegexParser.yml | 676 +-- .../CommonRegexVisitor.yml | 42 +- .../ComparisonEvaluator.yml | 85 +- .../adaptive-expressions/Concat.yml | 116 - .../adaptive-expressions/Constant.yml | 152 +- .../adaptive-expressions/Contains.yml | 120 - .../adaptive-expressions/ConvertFromUTC.yml | 133 - .../adaptive-expressions/ConvertToUTC.yml | 118 - .../adaptive-expressions/Count.yml | 116 - .../adaptive-expressions/CountWord.yml | 116 - .../adaptive-expressions/CreateArray.yml | 116 - .../adaptive-expressions/DataUri.yml | 116 - .../adaptive-expressions/DataUriToBinary.yml | 116 - .../adaptive-expressions/DataUriToString.yml | 116 - .../adaptive-expressions/DateFunc.yml | 116 - .../adaptive-expressions/DateReadBack.yml | 116 - .../adaptive-expressions/DateTimeDiff.yml | 116 - .../adaptive-expressions/DayOfMonth.yml | 116 - .../adaptive-expressions/DayOfWeek.yml | 116 - .../adaptive-expressions/DayOfYear.yml | 116 - .../adaptive-expressions/DigitContext.yml | 257 +- .../adaptive-expressions/DigitsContext.yml | 211 +- .../adaptive-expressions/Divide.yml | 116 - .../adaptive-expressions/EOL.yml | 116 - .../adaptive-expressions/Element.yml | 118 - .../adaptive-expressions/ElementContext.yml | 213 +- .../adaptive-expressions/Empty.yml | 126 - .../adaptive-expressions/EndsWith.yml | 120 - .../adaptive-expressions/EnumExpression.yml | 27 +- .../EnumExpressionConverter.yml | 10 +- .../adaptive-expressions/Equal.yml | 118 - .../EvaluateExpressionDelegate.yml | 1 - .../adaptive-expressions/EvaluatorLookup.yml | 1 - .../adaptive-expressions/Exists.yml | 116 - .../adaptive-expressions/ExprContext.yml | 211 +- .../adaptive-expressions/Expression.yml | 91 +- .../ExpressionAntlrLexer.yml | 300 +- .../ExpressionAntlrParser.yml | 400 +- .../ExpressionAntlrParserListener.yml | 53 - .../ExpressionAntlrParserVisitor.yml | 39 +- .../ExpressionContext.yml | 206 +- .../ExpressionConverter.yml | 4 +- .../ExpressionEvaluator.yml | 72 +- .../ExpressionFunctions.yml | 6 +- .../adaptive-expressions/ExpressionParser.yml | 14 +- .../ExpressionParserInterface.yml | 2 - .../ExpressionProperty.yml | 27 +- .../adaptive-expressions/ExpressionType.yml | 481 +- .../adaptive-expressions/Extensions.yml | 5 +- .../adaptive-expressions/FileContext.yml | 209 +- .../adaptive-expressions/First.yml | 116 - .../adaptive-expressions/Flatten.yml | 118 - .../adaptive-expressions/Float.yml | 118 - .../adaptive-expressions/Floor.yml | 116 - .../adaptive-expressions/Foreach.yml | 116 - .../adaptive-expressions/FormatDateTime.yml | 120 - .../adaptive-expressions/FormatEpoch.yml | 118 - .../adaptive-expressions/FormatNumber.yml | 116 - .../adaptive-expressions/FormatTicks.yml | 116 - .../FuncInvokeExpContext.yml | 373 +- .../adaptive-expressions/FunctionTable.yml | 77 +- .../adaptive-expressions/FunctionUtils.yml | 205 +- .../adaptive-expressions/GetFutureTime.yml | 116 - .../GetNextViableDate.yml | 118 - .../GetNextViableTime.yml | 118 - .../adaptive-expressions/GetPastTime.yml | 116 - .../GetPreviousViableDate.yml | 119 - .../GetPreviousViableTime.yml | 119 - .../adaptive-expressions/GetProperty.yml | 116 - .../adaptive-expressions/GetTimeOfDay.yml | 116 - .../adaptive-expressions/GreaterThan.yml | 118 - .../GreaterThanOrEqual.yml | 120 - .../adaptive-expressions/IdAtomContext.yml | 361 +- .../adaptive-expressions/If.yml | 118 - .../adaptive-expressions/Ignore.yml | 120 - .../IndexAccessExpContext.yml | 364 +- .../adaptive-expressions/IndexOf.yml | 120 - .../adaptive-expressions/IndicesAndValues.yml | 122 - .../adaptive-expressions/Int.yml | 116 - .../adaptive-expressions/IntExpression.yml | 26 +- .../IntExpressionConverter.yml | 4 +- .../InternalFunctionUtils.yml | 394 -- .../adaptive-expressions/Intersection.yml | 125 - .../adaptive-expressions/IsArray.yml | 116 - .../adaptive-expressions/IsBoolean.yml | 116 - .../adaptive-expressions/IsDate.yml | 118 - .../adaptive-expressions/IsDateRange.yml | 118 - .../adaptive-expressions/IsDateTime.yml | 118 - .../adaptive-expressions/IsDefinite.yml | 118 - .../adaptive-expressions/IsDuration.yml | 118 - .../adaptive-expressions/IsFloat.yml | 120 - .../adaptive-expressions/IsInteger.yml | 119 - .../adaptive-expressions/IsMatch.yml | 116 - .../adaptive-expressions/IsObject.yml | 122 - .../adaptive-expressions/IsPresent.yml | 118 - .../adaptive-expressions/IsString.yml | 116 - .../adaptive-expressions/IsTime.yml | 120 - .../adaptive-expressions/IsTimeRange.yml | 118 - .../adaptive-expressions/JPath.yml | 118 - .../adaptive-expressions/Join.yml | 116 - .../adaptive-expressions/Json.yml | 118 - .../JsonCreationExpContext.yml | 369 +- .../adaptive-expressions/JsonStringify.yml | 116 - .../adaptive-expressions/KeyContext.yml | 217 +- .../KeyValuePairContext.yml | 210 +- .../KeyValuePairListContext.yml | 215 +- .../adaptive-expressions/LambdaContext.yml | 210 +- .../adaptive-expressions/Last.yml | 116 - .../adaptive-expressions/LastIndexOf.yml | 120 - .../adaptive-expressions/Length.yml | 116 - .../adaptive-expressions/LessThan.yml | 120 - .../adaptive-expressions/LessThanOrEqual.yml | 120 - .../adaptive-expressions/LetterContext.yml | 467 +- .../adaptive-expressions/LiteralContext.yml | 217 +- .../adaptive-expressions/Max.yml | 116 - .../MemberAccessExpContext.yml | 363 +- .../adaptive-expressions/MemoryInterface.yml | 6 +- .../adaptive-expressions/Merge.yml | 118 - .../adaptive-expressions/Min.yml | 116 - .../adaptive-expressions/Mod.yml | 116 - .../adaptive-expressions/Month.yml | 116 - .../adaptive-expressions/Multiply.yml | 116 - .../MultivariateNumericEvaluator.yml | 81 +- .../adaptive-expressions/NameContext.yml | 208 +- .../adaptive-expressions/NewGuid.yml | 116 - .../adaptive-expressions/Node.yml | 43 +- .../Non_captureContext.yml | 212 +- .../Non_close_parenContext.yml | 208 +- .../Non_close_parensContext.yml | 211 +- .../adaptive-expressions/Not.yml | 118 - .../adaptive-expressions/NotEqual.yml | 116 - .../adaptive-expressions/NumberContext.yml | 208 +- .../adaptive-expressions/NumberExpression.yml | 26 +- .../NumberExpressionConverter.yml | 4 +- .../NumberTransformEvaluator.yml | 81 +- .../NumericAtomContext.yml | 361 +- .../adaptive-expressions/NumericEvaluator.yml | 81 +- .../adaptive-expressions/ObjectExpression.yml | 26 +- .../ObjectExpressionConverter.yml | 4 +- .../Octal_charContext.yml | 236 +- .../Octal_digitContext.yml | 247 +- .../adaptive-expressions/Optimizer.yml | 2 - .../adaptive-expressions/OptionContext.yml | 214 +- .../Option_flagContext.yml | 222 +- .../adaptive-expressions/Optional.yml | 118 - .../adaptive-expressions/Options.yml | 7 +- .../adaptive-expressions/Or.yml | 120 - .../ParenthesisExpContext.yml | 363 +- .../adaptive-expressions/ParseContext.yml | 209 +- .../ParseErrorListener.yml | 18 +- .../adaptive-expressions/Power.yml | 116 - .../PredicateComparer.yml | 5 +- .../PredicateComparers.yml | 4 +- .../PrimaryExpContext.yml | 361 +- .../PrimaryExpressionContext.yml | 206 +- .../adaptive-expressions/Quantifier.yml | 21 +- .../QuantifierContext.yml | 242 +- .../adaptive-expressions/QuantifierType.yml | 1 - .../Quantifier_typeContext.yml | 217 +- .../adaptive-expressions/Rand.yml | 118 - .../adaptive-expressions/Range.yml | 118 - .../RegexErrorListener.yml | 19 +- .../adaptive-expressions/RelationshipType.yml | 1 - .../adaptive-expressions/RemoveProperty.yml | 116 - .../adaptive-expressions/Replace.yml | 118 - .../ReplaceIgnoreCase.yml | 118 - .../adaptive-expressions/ReturnType.yml | 3 +- .../adaptive-expressions/Reverse.yml | 114 - .../adaptive-expressions/Round.yml | 116 - .../adaptive-expressions/Select.yml | 116 - .../adaptive-expressions/SentenceCase.yml | 116 - .../adaptive-expressions/SetPathToValue.yml | 116 - .../adaptive-expressions/SetProperty.yml | 116 - .../Shared_atomContext.yml | 252 +- .../Shared_literalContext.yml | 337 +- .../SimpleObjectMemory.yml | 15 +- .../adaptive-expressions/Skip.yml | 116 - .../adaptive-expressions/SortBy.yml | 118 - .../adaptive-expressions/SortByDescending.yml | 118 - .../adaptive-expressions/Split.yml | 118 - .../adaptive-expressions/Sqrt.yml | 116 - .../adaptive-expressions/StackedMemory.yml | 870 ++- .../adaptive-expressions/StartOfDay.yml | 116 - .../adaptive-expressions/StartOfHour.yml | 116 - .../adaptive-expressions/StartOfMonth.yml | 116 - .../adaptive-expressions/StartsWith.yml | 120 - .../adaptive-expressions/String.yml | 116 - .../StringAtomContext.yml | 361 +- .../adaptive-expressions/StringExpression.yml | 15 +- .../StringExpressionConverter.yml | 4 +- .../StringInterpolationAtomContext.yml | 361 +- .../StringInterpolationContext.yml | 223 +- .../adaptive-expressions/StringOrValue.yml | 119 - .../StringTransformEvaluator.yml | 82 +- .../adaptive-expressions/SubArray.yml | 118 - .../adaptive-expressions/Substring.yml | 118 - .../adaptive-expressions/Subtract.yml | 116 - .../adaptive-expressions/SubtractFromTime.yml | 116 - .../adaptive-expressions/Sum.yml | 116 - .../adaptive-expressions/Take.yml | 118 - .../TextContentContext.yml | 211 +- .../adaptive-expressions/Ticks.yml | 118 - .../adaptive-expressions/TicksToDays.yml | 116 - .../adaptive-expressions/TicksToHours.yml | 116 - .../adaptive-expressions/TicksToMinutes.yml | 116 - .../TimeTransformEvaluator.yml | 81 +- .../TimeZoneConverter.yml | 4 - .../adaptive-expressions/TimexResolve.yml | 118 - .../adaptive-expressions/TitleCase.yml | 116 - .../adaptive-expressions/ToLower.yml | 120 - .../adaptive-expressions/ToUpper.yml | 120 - .../adaptive-expressions/Trigger.yml | 35 +- .../adaptive-expressions/TriggerTree.yml | 34 +- .../adaptive-expressions/Trim.yml | 118 - .../TripleOpExpContext.yml | 366 +- .../UnaryOpExpContext.yml | 376 +- .../adaptive-expressions/Union.yml | 123 - .../adaptive-expressions/Unique.yml | 116 - .../adaptive-expressions/UriComponent.yml | 116 - .../UriComponentToString.yml | 119 - .../adaptive-expressions/UriHost.yml | 116 - .../adaptive-expressions/UriPath.yml | 116 - .../adaptive-expressions/UriPathAndQuery.yml | 116 - .../adaptive-expressions/UriPort.yml | 116 - .../adaptive-expressions/UriQuery.yml | 116 - .../adaptive-expressions/UriScheme.yml | 116 - .../adaptive-expressions/UtcNow.yml | 116 - .../adaptive-expressions/Util.yml | 4 +- .../ValidateExpressionDelegate.yml | 1 - .../adaptive-expressions/ValueExpression.yml | 27 +- .../ValueExpressionConverter.yml | 10 +- .../adaptive-expressions/ValueWithError.yml | 3 +- .../adaptive-expressions/VerifyExpression.yml | 1 - .../adaptive-expressions/Where.yml | 118 - .../adaptive-expressions/XML.yml | 116 - .../adaptive-expressions/XPath.yml | 116 - .../adaptive-expressions/Year.yml | 116 - .../adaptive-expressions/index.yml | 327 +- .../botbuilder-ai-orchestrator/Label.yml | 37 - .../LabelResolver.yml | 30 - .../botbuilder-ai-orchestrator/LabelType.yml | 1 - .../OrchestratorBotComponent.yml | 12 +- .../OrchestratorRecognizer.yml | 58 +- .../OrchestratorRecognizerConfiguration.yml | 113 - .../botbuilder-ai-orchestrator/Result.yml | 50 - .../botbuilder-ai-orchestrator/index.yml | 9 +- .../botbuilder-ai/ActiveLearningUtils.yml | 12 +- .../docs-ref-autogen/botbuilder-ai/Anchor.yml | 1 - .../botbuilder-ai/AnswerSpanResponse.yml | 5 - .../botbuilder-ai/BindToActivity.yml | 48 - .../botbuilder-ai/CustomQuestionAnswering.yml | 55 +- .../botbuilder-ai/DateTimeSpec.yml | 5 +- .../botbuilder-ai/DynamicList.yml | 31 +- .../botbuilder-ai/ExternalEntity.yml | 5 - .../botbuilder-ai/FeedbackRecord.yml | 4 - .../botbuilder-ai/FeedbackRecords.yml | 4 +- .../botbuilder-ai/Filters.yml | 8 +- .../botbuilder-ai/GenerateAnswerUtils.yml | 140 - .../botbuilder-ai/GeographyV2.yml | 3 - .../botbuilder-ai/GeographyV2Type.yml | 1 - .../botbuilder-ai/HttpRequestUtils.yml | 41 - .../botbuilder-ai/InstanceData.yml | 5 - .../botbuilder-ai/IntentData.yml | 2 - .../botbuilder-ai/JoinOperator.yml | 5 +- .../botbuilder-ai/KnowledgeBaseAnswer.yml | 13 +- .../botbuilder-ai/KnowledgeBaseAnswerSpan.yml | 5 - .../botbuilder-ai/KnowledgeBaseAnswers.yml | 4 +- .../botbuilder-ai/LanguageServiceUtils.yml | 142 - .../botbuilder-ai/ListElement.yml | 5 +- .../LuisAdaptivePredictionOptions.yml | 123 - ...AdaptivePredictionOptionsConfiguration.yml | 129 - ...LuisAdaptivePredictionOptionsConverter.yml | 37 - .../botbuilder-ai/LuisAdaptiveRecognizer.yml | 53 +- .../LuisAdaptiveRecognizerConfiguration.yml | 39 +- .../botbuilder-ai/LuisApplication.yml | 4 - .../botbuilder-ai/LuisBotComponent.yml | 17 +- .../LuisComponentRegistration.yml | 23 +- .../botbuilder-ai/LuisPredictionOptions.yml | 92 +- .../botbuilder-ai/LuisRecognizer.yml | 120 +- .../botbuilder-ai/LuisRecognizerInternal.yml | 71 - .../botbuilder-ai/LuisRecognizerOptions.yml | 4 - .../botbuilder-ai/LuisRecognizerOptionsV2.yml | 12 - .../botbuilder-ai/LuisRecognizerOptionsV3.yml | 23 +- .../LuisRecognizerTelemetryClient.yml | 14 +- .../botbuilder-ai/LuisRecognizerV2.yml | 110 - .../botbuilder-ai/LuisRecognizerV3.yml | 109 - .../botbuilder-ai/LuisTelemetryConstants.yml | 13 - .../botbuilder-ai/MetadataFilter.yml | 7 +- .../botbuilder-ai/NumberWithUnits.yml | 3 - .../botbuilder-ai/OrdinalV2.yml | 3 - .../botbuilder-ai/QnACardBuilder.yml | 80 +- .../botbuilder-ai/QnAMaker.yml | 67 +- .../botbuilder-ai/QnAMakerBotComponent.yml | 12 +- .../botbuilder-ai/QnAMakerClient.yml | 24 +- .../QnAMakerComponentRegistration.yml | 23 +- .../botbuilder-ai/QnAMakerDialog.yml | 240 +- .../QnAMakerDialogConfiguration.yml | 265 - .../botbuilder-ai/QnAMakerDialogOptions.yml | 3 - .../QnAMakerDialogResponseOptions.yml | 6 - .../botbuilder-ai/QnAMakerEndpoint.yml | 7 +- .../botbuilder-ai/QnAMakerMetadata.yml | 3 - .../botbuilder-ai/QnAMakerOptions.yml | 30 +- .../botbuilder-ai/QnAMakerPrompt.yml | 5 - .../botbuilder-ai/QnAMakerRecognizer.yml | 61 +- .../QnAMakerRecognizerConfiguration.yml | 62 +- .../botbuilder-ai/QnAMakerResult.yml | 11 +- .../botbuilder-ai/QnAMakerResults.yml | 7 +- .../botbuilder-ai/QnAMakerTelemetryClient.yml | 18 +- .../botbuilder-ai/QnAMakerTraceInfo.yml | 18 +- .../botbuilder-ai/QnARequestContext.yml | 3 - .../botbuilder-ai/QnAResponseContext.yml | 4 +- .../QnASuggestionsActivityFactory.yml | 4 +- .../botbuilder-ai/QnATelemetryConstants.yml | 156 - .../botbuilder-ai/RankerTypes.yml | 1 - .../botbuilder-ai/ServiceType.yml | 1 - .../botbuilder-ai/TrainUtils.yml | 57 - .../docs-ref-autogen/botbuilder-ai/index.yml | 136 +- .../docs-ref-autogen/botbuilder-ai/window.yml | 11 - .../ApplicationInsightsTelemetryClient.yml | 36 +- .../TelemetryInitializerMiddleware.yml | 15 +- .../botbuilder-azure-blobs/BlobsStorage.yml | 34 +- .../BlobsStorageOptions.yml | 4 +- .../BlobsTranscriptStore.yml | 19 +- .../BlobsTranscriptStoreOptions.yml | 5 +- .../botbuilder-azure-blobs/IgnoreError.yml | 11 - .../botbuilder-azure-blobs/index.yml | 72 - .../AzureQueueStorage.yml | 10 +- .../AzureBlobTranscriptStore.yml | 21 +- .../botbuilder-azure/BlobStorage.yml | 16 +- .../botbuilder-azure/BlobStorageSettings.yml | 5 - .../botbuilder-azure/CosmosDbKeyEscape.yml | 3 +- .../CosmosDbPartitionedStorage.yml | 23 +- .../CosmosDbPartitionedStorageOptions.yml | 29 +- .../botbuilder-azure/DoOnce.yml | 30 - .../botbuilder-azure/Host.yml | 3 - .../botbuilder-azure/index.yml | 3 +- .../botbuilder-core/AceCardSize.yml | 10 + .../botbuilder-core/AceData.yml | 114 + .../botbuilder-core/AceRequest.yml | 34 + .../botbuilder-core/Action.yml | 12 + .../botbuilder-core/ActionTypes.yml | 63 + .../botbuilder-core/Activity.yml | 594 ++ .../botbuilder-core/ActivityEventNames.yml | 19 + .../botbuilder-core/ActivityEx.yml | 621 +++ .../botbuilder-core/ActivityFactory.yml | 4 +- .../botbuilder-core/ActivityHandler.yml | 171 +- .../botbuilder-core/ActivityHandlerBase.yml | 5 +- .../botbuilder-core/ActivityImageType.yml | 12 + .../botbuilder-core/ActivityImportance.yml | 23 + .../botbuilder-core/ActivityTimestamps.yml | 751 +++ .../botbuilder-core/ActivityTypes.yml | 90 + .../AdaptiveCardAuthentication.yml | 60 + .../AdaptiveCardInvokeAction.yml | 60 + .../AdaptiveCardInvokeResponse.yml | 50 + .../AdaptiveCardInvokeValue.yml | 59 + .../botbuilder-core/AnimationCard.yml | 166 + .../botbuilder-core/AppBasedLinkQuery.yml | 34 + .../ApplicationIdentityType.yml | 19 + .../botbuilder-core/Attachment.yml | 70 + .../botbuilder-core/AttachmentData.yml | 58 + .../botbuilder-core/AttachmentInfo.yml | 46 + .../botbuilder-core/AttachmentLayout.yml | 12 + .../botbuilder-core/AttachmentLayoutTypes.yml | 19 + .../botbuilder-core/AttachmentView.yml | 34 + .../botbuilder-core/AudioCard.yml | 166 + .../AutoSaveStateMiddleware.yml | 24 +- .../botbuilder-core/BaseCardComponent.yml | 36 + .../BaseCardViewParameters.yml | 22 + .../BaseHandleActionResponse.yml | 36 + .../botbuilder-core/BasicCard.yml | 82 + .../BatchFailedEntriesResponse.yml | 34 + .../botbuilder-core/BatchFailedEntry.yml | 34 + .../botbuilder-core/BatchOperationRequest.yml | 58 + .../BatchOperationResponse.yml | 22 + .../BatchOperationStateResponse.yml | 58 + .../botbuilder-core/BotAdapter.yml | 95 +- .../botbuilder-core/BotComponent.yml | 14 +- .../botbuilder-core/BotConfigAuth.yml | 34 + .../botbuilder-core/BotConfigAuthType.yml | 12 + .../botbuilder-core/BotFrameworkClient.yml | 28 + .../botbuilder-core/BotFrameworkSkill.yml | 4 - .../botbuilder-core/BotHandler.yml | 1 - .../BotMessagePreviewActionType.yml | 12 + .../botbuilder-core/BotMessagePreviewType.yml | 12 + .../BotPageViewTelemetryClient.yml | 2 - .../botbuilder-core/BotState.yml | 20 +- .../BotStatePropertyAccessor.yml | 36 +- .../botbuilder-core/BotStateSet.yml | 31 +- .../botbuilder-core/BotTelemetryClient.yml | 6 - .../botbuilder-core/BrowserLocalStorage.yml | 13 +- .../botbuilder-core/BrowserSessionStorage.yml | 13 +- .../botbuilder-core/CacheInfo.yml | 34 + .../botbuilder-core/CachedBotState.yml | 7 +- .../botbuilder-core/CallerIdConstants.yml | 48 + .../botbuilder-core/CardAction.yml | 115 + .../botbuilder-core/CardBarComponent.yml | 63 + .../botbuilder-core/CardButtonBase.yml | 36 + .../botbuilder-core/CardButtonComponent.yml | 80 + .../botbuilder-core/CardComponentName.yml | 16 + .../botbuilder-core/CardFactory.yml | 197 +- .../botbuilder-core/CardImage.yml | 46 + .../CardSearchBoxComponent.yml | 77 + .../CardSearchFooterComponent.yml | 105 + .../botbuilder-core/CardTextComponent.yml | 53 + .../CardTextInputComponent.yml | 117 + .../CardViewActionsFooterParameters.yml | 13 + .../CardViewFooterParameters.yml | 14 + .../CardViewHandleActionResponse.yml | 35 + .../botbuilder-core/CardViewParameters.yml | 14 + .../botbuilder-core/CardViewResponse.yml | 58 + .../botbuilder-core/ChannelAccount.yml | 74 + .../botbuilder-core/ChannelInfo.yml | 46 + .../botbuilder-core/Channels.yml | 106 + .../botbuilder-core/CloudAdapterBase.yml | 228 +- .../botbuilder-core/CommandContext.yml | 12 + .../botbuilder-core/CommandResultValue.yml | 58 + .../botbuilder-core/CommandValue.yml | 42 + .../botbuilder-core/ComponentRegistration.yml | 12 +- .../botbuilder-core/ConfigResponse.yml | 48 + .../botbuilder-core/ConfigResponseConfig.yml | 10 + ...onfigurationBotFrameworkAuthentication.yml | 65 +- ...ationBotFrameworkAuthenticationOptions.yml | 5 +- ...gurationServiceClientCredentialFactory.yml | 45 +- ...nServiceClientCredentialFactoryOptions.yml | 5 +- .../botbuilder-core/ConfirmationDialog.yml | 36 + .../ConsoleTranscriptLogger.yml | 9 +- .../ContactRelationUpdateActionTypes.yml | 19 + .../botbuilder-core/ContentType.yml | 12 + .../botbuilder-core/ConversationAccount.yml | 116 + .../ConversationIdentityType.yml | 12 + .../botbuilder-core/ConversationList.yml | 22 + .../botbuilder-core/ConversationMembers.yml | 34 + .../ConversationParameters.yml | 98 + .../botbuilder-core/ConversationReference.yml | 101 + .../ConversationResourceResponse.yml | 48 + .../botbuilder-core/ConversationState.yml | 29 +- .../botbuilder-core/ConversationsResult.yml | 34 + .../botbuilder-core/CoreAppCredentials.yml | 6 +- .../botbuilder-core/CoreWebResource.yml | 63 - .../botbuilder-core/DeleteActivityHandler.yml | 1 - .../botbuilder-core/DeliveryModes.yml | 29 + .../botbuilder-core/DropDownOptionType.yml | 24 + .../EndOfConversationCodes.yml | 39 + .../botbuilder-core/Entity.yml | 22 + .../botbuilder-core/ErrorModel.yml | 46 + .../botbuilder-core/ErrorResponse.yml | 22 + .../botbuilder-core/ExecuteCardAction.yml | 46 + .../botbuilder-core/ExecuteCardParameters.yml | 9 + .../botbuilder-core/ExpectedReplies.yml | 22 + .../ExtendedUserTokenProvider.yml | 74 +- .../ExternalLinkActionParameters.yml | 34 + .../ExternalLinkCardAction.yml | 34 + .../docs-ref-autogen/botbuilder-core/Fact.yml | 41 + .../botbuilder-core/FieldType.yml | 54 + .../botbuilder-core/FileConsentCard.yml | 58 + .../FileConsentCardResponse.yml | 46 + .../botbuilder-core/FileDownloadInfo.yml | 58 + .../FileDownloadInfoAttachment.yml | 10 + .../botbuilder-core/FileInfoCard.yml | 46 + .../botbuilder-core/FileUploadInfo.yml | 70 + .../botbuilder-core/FocusParameters.yml | 49 + .../botbuilder-core/GeoCoordinates.yml | 76 + .../GetLocationActionParameters.yml | 26 + .../botbuilder-core/GetLocationCardAction.yml | 34 + .../GetPropertyPaneConfigurationResponse.yml | 61 + .../botbuilder-core/HandleActionResponse.yml | 13 + .../botbuilder-core/HeroCard.yml | 82 + .../botbuilder-core/IActivity.yml | 163 + .../botbuilder-core/ICardSearchBoxButton.yml | 41 + .../ICardTextInputIconButton.yml | 54 + .../ICardTextInputTitleButton.yml | 54 + .../botbuilder-core/ICommandActivity.yml | 223 + .../ICommandResultActivity.yml | 223 + .../IContactRelationUpdateActivity.yml | 215 + .../IConversationUpdateActivity.yml | 247 + .../IEndOfConversationActivity.yml | 230 + .../botbuilder-core/IEventActivity.yml | 235 + .../botbuilder-core/IHandoffActivity.yml | 10 + .../IInstallationUpdateActivity.yml | 215 + .../botbuilder-core/IInvokeActivity.yml | 235 + .../botbuilder-core/IMessageActivity.yml | 389 ++ .../IMessageDeleteActivity.yml | 10 + .../IMessageReactionActivity.yml | 223 + .../IMessageUpdateActivity.yml | 429 ++ .../botbuilder-core/IStatusCodeError.yml | 34 + .../botbuilder-core/ISuggestionActivity.yml | 444 ++ .../botbuilder-core/ITraceActivity.yml | 259 + .../botbuilder-core/ITypingActivity.yml | 10 + .../botbuilder-core/IUserTokenProvider.yml | 44 +- .../botbuilder-core/Importance.yml | 12 + .../botbuilder-core/InnerHttpError.yml | 34 + .../botbuilder-core/InputHints.yml | 23 + .../InstallationUpdateActionTypes.yml | 19 + .../botbuilder-core/IntentScore.yml | 2 - .../botbuilder-core/InvokeException.yml | 81 +- .../botbuilder-core/InvokeResponse.yml | 39 + .../botbuilder-core/Location.yml | 58 + .../botbuilder-core/MediaCard.yml | 166 + .../botbuilder-core/MediaEventValue.yml | 24 + .../botbuilder-core/MediaType.yml | 24 + .../botbuilder-core/MediaUrl.yml | 36 + .../botbuilder-core/Meeting.yml | 34 + .../botbuilder-core/MeetingDetails.yml | 99 + .../MeetingEndEventDetails.yml | 84 + .../botbuilder-core/MeetingEventDetails.yml | 63 + .../botbuilder-core/MeetingInfo.yml | 46 + .../botbuilder-core/MeetingNotification.yml | 10 + .../MeetingNotificationBase.yml | 34 + .../MeetingNotificationChannelData.yml | 22 + ...eetingNotificationRecipientFailureInfo.yml | 48 + .../MeetingNotificationResponse.yml | 26 + .../MeetingParticipantsEventDetails.yml | 22 + .../botbuilder-core/MeetingStageSurface.yml | 46 + .../MeetingStartEventDetails.yml | 84 + .../botbuilder-core/MeetingSurface.yml | 10 + .../botbuilder-core/MeetingTabIconSurface.yml | 34 + .../botbuilder-core/MemoryStorage.yml | 21 +- .../botbuilder-core/MemoryTranscriptStore.yml | 17 +- .../botbuilder-core/Mention.yml | 46 + .../botbuilder-core/MessageActionsPayload.yml | 214 + .../MessageActionsPayloadApp.yml | 46 + .../MessageActionsPayloadAttachment.yml | 82 + .../MessageActionsPayloadBody.yml | 46 + .../MessageActionsPayloadConversation.yml | 46 + .../MessageActionsPayloadFrom.yml | 46 + .../MessageActionsPayloadMention.yml | 46 + .../MessageActionsPayloadReaction.yml | 46 + .../MessageActionsPayloadUser.yml | 46 + .../botbuilder-core/MessageFactory.yml | 70 +- .../botbuilder-core/MessageReaction.yml | 22 + .../botbuilder-core/MessageReactionTypes.yml | 19 + .../botbuilder-core/MessageType.yml | 12 + .../MessagingExtensionAction.yml | 117 + .../MessagingExtensionActionResponse.yml | 48 + .../MessagingExtensionAttachment.yml | 99 + .../MessagingExtensionParameter.yml | 34 + .../MessagingExtensionQuery.yml | 58 + .../MessagingExtensionQueryOptions.yml | 34 + .../MessagingExtensionResponse.yml | 34 + .../MessagingExtensionResult.yml | 82 + .../MessagingExtensionResultType.yml | 20 + .../MessagingExtensionSuggestedAction.yml | 22 + .../MicrosoftPayMethodData.yml | 47 + .../botbuilder-core/Middleware.yml | 6 +- .../botbuilder-core/MiddlewareHandler.yml | 4 +- .../botbuilder-core/MiddlewareSet.yml | 42 +- .../NoOpHandleActionResponse.yml | 35 + .../botbuilder-core/NotificationInfo.yml | 46 + .../botbuilder-core/NullTelemetryClient.yml | 21 +- .../botbuilder-core/O365ConnectorCard.yml | 82 + .../O365ConnectorCardActionBase.yml | 46 + .../O365ConnectorCardActionCard.yml | 81 + .../O365ConnectorCardActionQuery.yml | 34 + .../O365ConnectorCardActionType.yml | 16 + .../O365ConnectorCardDateInput.yml | 99 + .../botbuilder-core/O365ConnectorCardFact.yml | 34 + .../O365ConnectorCardHttpPOST.yml | 69 + .../O365ConnectorCardImage.yml | 34 + .../O365ConnectorCardInputBase.yml | 70 + .../O365ConnectorCardInputBaseType.yml | 15 + .../O365ConnectorCardInputType.yml | 13 + .../O365ConnectorCardMultichoiceInput.yml | 125 + ...365ConnectorCardMultichoiceInputChoice.yml | 34 + .../O365ConnectorCardOpenUri.yml | 69 + .../O365ConnectorCardOpenUriTarget.yml | 34 + .../O365ConnectorCardSection.yml | 142 + .../O365ConnectorCardTextInput.yml | 111 + .../O365ConnectorCardViewAction.yml | 69 + .../botbuilder-core/OAuthCard.yml | 70 + .../botbuilder-core/OnBehalfOf.yml | 58 + .../botbuilder-core/OnCardSelectionAction.yml | 17 + .../docs-ref-autogen/botbuilder-core/Os.yml | 12 + .../botbuilder-core/PagedMembersResult.yml | 34 + .../botbuilder-core/PagedResult.yml | 5 +- .../botbuilder-core/PaymentAddress.yml | 164 + .../botbuilder-core/PaymentCurrencyAmount.yml | 47 + .../botbuilder-core/PaymentDetails.yml | 75 + .../PaymentDetailsModifier.yml | 74 + .../botbuilder-core/PaymentItem.yml | 47 + .../botbuilder-core/PaymentMethodData.yml | 47 + .../botbuilder-core/PaymentOptions.yml | 92 + .../botbuilder-core/PaymentRequest.yml | 71 + .../PaymentRequestComplete.yml | 47 + .../PaymentRequestCompleteResult.yml | 23 + .../botbuilder-core/PaymentRequestUpdate.yml | 59 + .../PaymentRequestUpdateResult.yml | 23 + .../botbuilder-core/PaymentResponse.yml | 117 + .../botbuilder-core/PaymentShippingOption.yml | 59 + .../botbuilder-core/Place.yml | 74 + .../botbuilder-core/PopupWindowPosition.yml | 34 + .../PrivateConversationState.yml | 29 +- .../botbuilder-core/PropertyManager.yml | 5 +- .../PropertyPaneCheckboxProperties.yml | 47 + .../PropertyPaneChoiceGroupIconProperties.yml | 23 + .../PropertyPaneChoiceGroupImageSize.yml | 34 + .../PropertyPaneChoiceGroupOption.yml | 108 + .../PropertyPaneChoiceGroupProperties.yml | 35 + .../PropertyPaneDropDownOption.yml | 58 + .../PropertyPaneDropDownProperties.yml | 113 + .../PropertyPaneFieldProperties.yml | 9 + .../botbuilder-core/PropertyPaneGroup.yml | 59 + .../PropertyPaneGroupField.yml | 58 + .../PropertyPaneGroupOrConditionalGroup.yml | 9 + .../PropertyPaneLabelProperties.yml | 35 + .../PropertyPaneLinkPopupWindowProperties.yml | 59 + .../PropertyPaneLinkProperties.yml | 85 + .../botbuilder-core/PropertyPanePage.yml | 46 + .../PropertyPanePageHeader.yml | 22 + .../PropertyPaneSliderProperties.yml | 109 + .../PropertyPaneTextFieldProperties.yml | 175 + .../PropertyPaneToggleProperties.yml | 125 + .../botbuilder-core/QueueStorage.yml | 9 +- .../botbuilder-core/QuickViewCardAction.yml | 34 + .../botbuilder-core/QuickViewData.yml | 9 + .../QuickViewHandleActionResponse.yml | 35 + .../botbuilder-core/QuickViewParameters.yml | 22 + .../botbuilder-core/QuickViewResponse.yml | 86 + .../botbuilder-core/ReactionType.yml | 12 + .../botbuilder-core/ReceiptCard.yml | 106 + .../botbuilder-core/ReceiptItem.yml | 98 + .../botbuilder-core/RecognizerResult.yml | 9 +- .../RegisterClassMiddleware.yml | 14 +- .../botbuilder-core/ResourceResponse.yml | 22 + .../botbuilder-core/RoleTypes.yml | 23 + .../SearchCardViewParameters.yml | 75 + .../botbuilder-core/SearchInvokeOptions.yml | 38 + .../botbuilder-core/SearchInvokeResponse.yml | 60 + .../botbuilder-core/SearchInvokeValue.yml | 73 + .../SelectMediaActionParameters.yml | 60 + .../botbuilder-core/SelectMediaCardAction.yml | 34 + .../botbuilder-core/SemanticAction.yml | 46 + .../SemanticActionStateTypes.yml | 23 + .../botbuilder-core/SendActivitiesHandler.yml | 1 - .../SetPropertyPaneConfigurationResponse.yml | 12 + .../botbuilder-core/Severity.yml | 1 - .../ShowLocationActionParameters.yml | 26 + .../ShowLocationCardAction.yml | 34 + .../botbuilder-core/ShowTypingMiddleware.yml | 22 +- .../SignInCardViewParameters.yml | 75 + .../botbuilder-core/SignInUrlResponse.yml | 46 + .../botbuilder-core/SigninCard.yml | 34 + .../SigninStateVerificationQuery.yml | 22 + .../SkillConversationIdFactory.yml | 15 +- .../SkillConversationIdFactoryBase.yml | 17 +- .../SkillConversationIdFactoryOptions.yml | 7 +- .../SkillConversationReference.yml | 5 +- .../SkypeMentionNormalizeMiddleware.yml | 20 +- .../botbuilder-core/SpeechConstants.yml | 25 + .../botbuilder-core/StatePropertyAccessor.yml | 19 +- .../botbuilder-core/StatusCodes.yml | 76 + .../botbuilder-core/Storage.yml | 21 +- .../botbuilder-core/StorageKeyFactory.yml | 4 +- .../botbuilder-core/StoreItem.yml | 2 - .../botbuilder-core/StoreItems.yml | 1 - .../botbuilder-core/StringUtils.yml | 8 +- .../botbuilder-core/Style.yml | 12 + .../botbuilder-core/SubmitCardAction.yml | 46 + .../botbuilder-core/SubmitCardParameters.yml | 9 + .../botbuilder-core/SuggestedActions.yml | 38 + .../botbuilder-core/TabContext.yml | 22 + .../botbuilder-core/TabEntityContext.yml | 22 + .../botbuilder-core/TabRequest.yml | 46 + .../botbuilder-core/TabResponse.yml | 22 + .../botbuilder-core/TabResponseCard.yml | 22 + .../botbuilder-core/TabResponseCards.yml | 22 + .../botbuilder-core/TabResponsePayload.yml | 46 + .../botbuilder-core/TabSubmit.yml | 46 + .../botbuilder-core/TabSubmitData.yml | 22 + .../botbuilder-core/TabSuggestedActions.yml | 22 + .../TargetedMeetingNotification.yml | 53 + .../TargetedMeetingNotificationValue.yml | 34 + .../TaskModuleCardResponse.yml | 39 + .../TaskModuleContinueResponse.yml | 39 + .../TaskModuleMessageResponse.yml | 39 + .../botbuilder-core/TaskModuleRequest.yml | 46 + .../TaskModuleRequestContext.yml | 22 + .../botbuilder-core/TaskModuleResponse.yml | 36 + .../TaskModuleResponseBase.yml | 22 + .../botbuilder-core/TaskModuleTaskInfo.yml | 94 + .../botbuilder-core/TeamDetails.yml | 84 + .../botbuilder-core/TeamInfo.yml | 46 + .../botbuilder-core/TeamsAttachment.yml | 84 + .../botbuilder-core/TeamsChannelAccount.yml | 163 + .../botbuilder-core/TeamsChannelData.yml | 106 + .../TeamsChannelDataSettings.yml | 22 + .../botbuilder-core/TeamsMeetingInfo.yml | 22 + .../botbuilder-core/TeamsMeetingMember.yml | 34 + .../TeamsMeetingParticipant.yml | 46 + .../botbuilder-core/TeamsMember.yml | 10 + .../TeamsPagedMembersResult.yml | 34 + .../botbuilder-core/TelemetryConstants.yml | 208 - .../botbuilder-core/TelemetryDependency.yml | 8 - .../botbuilder-core/TelemetryEvent.yml | 12 +- .../botbuilder-core/TelemetryException.yml | 14 +- .../TelemetryLoggerMiddleware.yml | 18 +- .../botbuilder-core/TelemetryPageView.yml | 12 +- .../botbuilder-core/TelemetryTrace.yml | 8 +- .../botbuilder-core/TenantInfo.yml | 22 + .../botbuilder-core/TestActivityInspector.yml | 4 +- .../botbuilder-core/TestAdapter.yml | 189 +- .../botbuilder-core/TestFlow.yml | 33 +- .../TextCardViewParameters.yml | 87 + .../botbuilder-core/TextFormatTypes.yml | 23 + .../botbuilder-core/TextHighlight.yml | 36 + .../TextInputCardViewParameters.yml | 87 + .../botbuilder-core/Thing.yml | 34 + .../botbuilder-core/ThumbnailCard.yml | 82 + .../botbuilder-core/ThumbnailUrl.yml | 34 + .../TokenExchangeInvokeRequest.yml | 46 + .../TokenExchangeInvokeResponse.yml | 58 + .../botbuilder-core/TokenExchangeRequest.yml | 34 + .../botbuilder-core/TokenExchangeResource.yml | 46 + .../botbuilder-core/TokenExchangeState.yml | 15 + .../botbuilder-core/TokenPollingSettings.yml | 3 - .../botbuilder-core/TokenPostResource.yml | 22 + .../botbuilder-core/TokenRequest.yml | 34 + .../botbuilder-core/TokenResponse.yml | 72 + .../botbuilder-core/TokenStatus.yml | 15 + .../botbuilder-core/Transcript.yml | 22 + .../botbuilder-core/TranscriptInfo.yml | 4 - .../botbuilder-core/TranscriptLogger.yml | 7 +- .../TranscriptLoggerMiddleware.yml | 11 +- .../botbuilder-core/TranscriptStore.yml | 29 +- .../botbuilder-core/TurnContext.yml | 193 +- .../TurnContextStateCollection.yml | 224 +- .../docs-ref-autogen/botbuilder-core/Type.yml | 12 + .../botbuilder-core/Type1.yml | 11 + .../botbuilder-core/Type2.yml | 11 + .../botbuilder-core/Type3.yml | 11 + .../botbuilder-core/UpdateActivityHandler.yml | 1 - .../botbuilder-core/UserIdentityType.yml | 18 + .../botbuilder-core/UserMeetingDetails.yml | 34 + .../botbuilder-core/UserState.yml | 29 +- .../botbuilder-core/VideoCard.yml | 166 + .../botbuilder-core/ViewResponseType.yml | 10 + .../botbuilder-core/index.yml | 816 ++- .../Configuration.yml | 20 +- .../DependencyFactory.yml | 11 +- .../Factory.yml | 10 +- .../ServiceCollection.yml | 72 +- .../index.yml | 4 +- .../Options.yml | 3 +- .../index.yml | 31 +- .../Options.yml | 3 +- .../index.yml | 44 +- .../Options.yml | 3 +- .../index.yml | 41 +- .../Configuration.yml | 186 - .../ConfigurationResourceExporer.yml | 302 -- .../CoreBotAdapter.yml | 420 -- .../index.yml | 29 +- .../GetMeetingParticipant.yml | 463 ++ .../GetMeetingParticipantConfiguration.yml | 104 + .../GetMember.yml | 432 ++ .../GetMemberConfiguration.yml | 74 + .../GetPagedMembers.yml | 439 ++ .../GetPagedMembersConfiguration.yml | 88 + .../GetPagedTeamMembers.yml} | 350 +- .../GetPagedTeamMembersConfiguration.yml | 103 + .../GetTeamChannels.yml | 424 ++ .../GetTeamChannelsConfiguration.yml | 75 + .../GetTeamDetails.yml | 421 ++ .../GetTeamDetailsConfiguration.yml | 75 + .../GetTeamMember.yml | 446 ++ .../GetTeamMemberConfiguration.yml | 87 + .../OnTeamsAppBasedLinkQuery.yml | 269 + .../OnTeamsCardAction.yml | 264 + .../OnTeamsChannelCreated.yml | 269 + .../OnTeamsChannelDeleted.yml | 269 + .../OnTeamsChannelRenamed.yml | 269 + .../OnTeamsChannelRestored.yml | 271 + .../OnTeamsFileConsent.yml | 264 + .../OnTeamsMEBotMessagePreviewEdit.yml | 281 + .../OnTeamsMEBotMessagePreviewSend.yml | 281 + .../OnTeamsMECardButtonClicked.yml | 275 + .../OnTeamsMEConfigQuerySettingUrl.yml | 279 + .../OnTeamsMEConfigurationSetting.yml | 279 + .../OnTeamsMEFetchTask.yml | 264 + .../OnTeamsMEQuery.yml | 264 + .../OnTeamsMESelectItem.yml | 264 + .../OnTeamsMESubmitAction.yml | 267 + .../OnTeamsO365ConnectorCardAction.yml | 279 + .../OnTeamsTabFetch.yml | 264 + .../OnTeamsTabSubmit.yml | 264 + .../OnTeamsTaskModuleFetch.yml | 269 + .../OnTeamsTaskModuleSubmit.yml | 269 + .../OnTeamsTeamArchived.yml | 266 + .../OnTeamsTeamDeleted.yml | 266 + .../OnTeamsTeamHardDeleted.yml | 271 + .../OnTeamsTeamRenamed.yml | 266 + .../OnTeamsTeamRestored.yml | 266 + .../OnTeamsTeamUnarchived.yml | 269 + .../SendAppBasedLinkQueryResponse.yml | 467 ++ ...AppBasedLinkQueryResponseConfiguration.yml | 79 + .../SendMEActionResponse.yml | 517 ++ .../SendMEActionResponseConfiguration.yml | 77 + .../SendMEAttachmentsResponse.yml | 471 ++ ...SendMEAttachmentsResponseConfiguration.yml | 94 + .../SendMEAuthResponse.yml | 476 ++ .../SendMEBotMessagePreviewResponse.yml | 533 ++ ...BotMessagePreviewResponseConfiguration.yml | 66 + .../SendMEConfigQuerySettingUrlResponse.yml | 479 ++ ...igQuerySettingUrlResponseConfiguration.yml | 67 + .../SendMEMessageResponse.yml | 453 ++ .../SendMEMessageResponseConfiguration.yml | 65 + .../SendMESelectItemResponse.yml | 455 ++ .../SendMESelectItemResponseConfiguration.yml | 65 + .../SendMessageToTeamsChannel.yml | 461 ++ ...SendMessageToTeamsChannelConfiguration.yml | 118 + .../SendTaskModuleCardResponse.yml | 521 ++ ...endTaskModuleCardResponseConfiguration.yml | 66 + .../SendTaskModuleMessageResponse.yml | 465 ++ ...TaskModuleMessageResponseConfiguration.yml | 66 + .../SendTaskModuleUrlResponse.yml | 533 ++ ...SendTaskModuleUrlResponseConfiguration.yml | 79 + .../TeamsComponentRegistration.yml | 65 + .../index.yml | 74 + .../AdaptiveTestBotComponent.yml | 12 +- .../AssertCondition.yml | 150 +- .../AssertConditionConfiguration.yml | 5 - .../AssertNoActivity.yml | 34 +- .../AssertNoActivityConfiguration.yml | 2 - .../AssertReply.yml | 41 +- .../AssertReplyActivity.yml | 39 +- .../AssertReplyActivityConfiguration.yml | 6 +- .../AssertReplyConfiguration.yml | 8 +- .../AssertReplyOneOf.yml | 43 +- .../AssertReplyOneOfConfiguration.yml | 10 +- .../AssertTelemetryContains.yml | 37 +- .../AssertTelemetryContainsConfiguration.yml | 5 +- .../AssignmentInput.yml | 11 - .../BodyMatchType.yml | 18 - .../CustomEvent.yml | 33 +- .../CustomEventConfiguration.yml | 3 - .../DialogContextInspector.yml | 11 - .../DialogInspector.yml | 140 - .../FallbackFunc.yml | 1 - .../HttpRequestMessage.yml | 1 - .../HttpRequestMock.yml | 58 - .../HttpRequestMocksConverter.yml | 44 - .../HttpRequestSequenceMock.yml | 137 - .../HttpRequestSequenceMockConfiguration.yml | 83 - .../HttpResponseMessage.yml | 37 - .../HttpResponseMock.yml | 63 - .../HttpResponseMockContent.yml | 38 - .../HttpResponseMockMessage.yml | 38 - .../Inspector.yml | 1 - .../MemoryAssertions.yml | 33 +- .../MemoryAssertionsConfiguration.yml | 5 +- .../MockHttpRequestMiddleware.yml | 19 +- .../MockLuisLoader.yml | 19 +- .../MockLuisRecognizer.yml | 36 +- .../MockSettingsMiddleware.yml | 15 +- .../ResponseContent.yml | 11 - .../ResponseContentType.yml | 18 - .../ResponseStatusCode.yml | 251 - .../SequenceResponseManager.yml | 40 - .../SetProperties.yml | 32 +- .../SetPropertiesConfiguration.yml | 6 +- .../SetTestOptionsMiddleware.yml | 35 - .../SettingMock.yml | 48 - .../SettingMocksConverter.yml | 44 - .../SettingStringAssignment.yml | 37 - .../SettingStringMock.yml | 79 - .../SettingStringMockConfiguration.yml | 27 - .../TestAction.yml | 20 +- .../TestScript.yml | 59 +- .../TestScriptConfiguration.yml | 34 +- .../TestTelemetryClient.yml | 116 - .../TestUtils.yml | 9 +- .../UserActivity.yml | 31 +- .../UserActivityConfiguration.yml | 3 - .../UserConversationUpdate.yml | 39 +- .../UserConversationUpdateConfiguration.yml | 7 +- .../UserDelay.yml | 30 +- .../UserDelayConfiguration.yml | 2 - .../UserSays.yml | 32 +- .../UserSaysConfiguration.yml | 3 - .../UserTokenBasicMock.yml | 142 - .../UserTokenBasicMockConfiguration.yml | 79 - .../UserTokenMock.yml | 62 - .../UserTokenMocksConverter.yml | 44 - .../UserTyping.yml | 22 +- .../UserTypingConfiguration.yml | 2 - .../index.yml | 53 +- .../ActionChangeList.yml | 50 - .../ActionChangeType.yml | 28 - .../ActionContext.yml | 159 +- .../ActionScope.yml | 157 +- .../ActionScopeCommands.yml | 1 - .../ActionScopeConfiguration.yml | 8 +- .../ActionScopeResult.yml | 3 - .../ActionState.yml | 55 - .../ActivityTemplate.yml | 31 +- .../ActivityTemplateConguration.yml | 2 - .../ActivityTemplateConverter.yml | 38 - .../AdaptiveBotComponent.yml | 12 +- .../AdaptiveDialog.yml | 174 +- .../AdaptiveDialogConfiguration.yml | 23 +- .../AdaptiveDialogState.yml | 24 - .../AdaptiveEvents.yml | 14 - .../AdaptiveRecognizer.yml | 34 +- .../AdaptiveRecognizerConfiguration.yml | 2 - .../AgeEntityRecognizer.yml | 59 +- .../ArrayChangeType.yml | 1 - .../ArrayProperty.yml | 1 - .../botbuilder-dialogs-adaptive/Ask.yml | 193 +- .../AskConfiguration.yml | 15 +- .../AssignmentInput.yml | 11 - .../AttachmentInput.yml | 199 +- .../AttachmentInputConfiguration.yml | 34 +- .../AttachmentOutputFormat.yml | 1 - .../BaseInvokeDialog.yml | 158 +- .../BaseInvokeDialogConfiguration.yml | 6 - .../BeginDialog.yml | 187 +- .../BeginDialogConfiguration.yml | 16 +- .../BeginSkill.yml | 171 +- .../BeginSkillConfiguration.yml | 13 - .../BoolProperty.yml | 1 - .../botbuilder-dialogs-adaptive/BreakLoop.yml | 147 +- .../BreakLoopConfiguration.yml | 4 - .../CancelAllDialogs.yml | 205 +- .../CancelAllDialogsBaseConfiguration.yml | 11 +- .../CancelDialog.yml | 204 +- .../botbuilder-dialogs-adaptive/Case.yml | 183 +- .../botbuilder-dialogs-adaptive/CaseInput.yml | 11 - .../ChannelMentionEntityRecognizer.yml | 48 +- .../ChoiceInput.yml | 202 +- .../ChoiceInputConfiguration.yml | 39 +- .../ChoiceInputOptions.yml | 4 +- .../ChoiceOptionsSet.yml | 12 +- .../ChoiceOutputFormat.yml | 1 - .../botbuilder-dialogs-adaptive/ChoiceSet.yml | 651 ++- .../CodeAction.yml | 151 +- .../CodeActionConfiguration.yml | 4 - .../CodeActionHandler.yml | 1 - .../ConditionalSelector.yml | 41 +- .../ConditionalSelectorConfiguration.yml | 4 - .../ConfirmInput.yml | 201 +- .../ConfirmInputConfiguration.yml | 38 +- .../ConfirmationEntityRecognizer.yml | 63 +- .../ContinueConversation.yml | 158 +- .../ContinueConversationConfiguration.yml | 10 +- .../ContinueConversationLater.yml | 156 +- ...ContinueConversationLaterConfiguration.yml | 10 +- .../ContinueLoop.yml | 147 +- .../ContinueLoopConfiguration.yml | 4 - .../CrossTrainedRecognizerSet.yml | 50 +- ...CrossTrainedRecognizerSetConfiguration.yml | 6 +- .../CurrencyEntityRecognizer.yml | 61 +- .../botbuilder-dialogs-adaptive/D.yml | 11 - .../DateTimeEntityRecognizer.yml | 61 +- .../DateTimeInput.yml | 200 +- .../DateTimeInputConfiguration.yml | 35 +- .../DeleteActivity.yml | 152 +- .../DeleteActivityConfiguration.yml | 5 - .../DeleteProperties.yml | 156 +- .../DeletePropertiesConfiguration.yml | 9 +- .../DeleteProperty.yml | 150 +- .../DeletePropertyConfiguration.yml | 5 - .../DialogExpression.yml | 37 +- .../DialogExpressionConverter.yml | 10 +- .../DialogListConverter.yml | 45 - .../DialogProperty.yml | 1 - .../DialogSetConverter.yml | 49 - .../DimensionEntityRecognizer.yml | 61 +- .../DynamicBeginDialog.yml | 205 +- .../DynamicBeginDialogDeserializer.yml | 56 - .../EditActions.yml | 184 +- .../EditActionsConfiguration.yml | 14 +- .../botbuilder-dialogs-adaptive/EditArray.yml | 168 +- .../EditArrayConfiguration.yml | 12 +- .../EmailEntityRecognizer.yml | 61 +- .../botbuilder-dialogs-adaptive/EmitEvent.yml | 161 +- .../EmitEventConfiguration.yml | 12 +- .../botbuilder-dialogs-adaptive/EndDialog.yml | 149 +- .../EndDialogConfiguration.yml | 9 +- .../botbuilder-dialogs-adaptive/EndTurn.yml | 142 +- .../EndTurnConfiguration.yml | 4 - .../EntityAssignment.yml | 178 - .../EntityAssignmentComparer.yml | 62 - .../EntityAssignmentConfiguration.yml | 118 - .../EntityAssignments.yml | 108 - .../EntityAssignmentsConfiguration.yml | 24 - .../EntityInfo.yml | 310 -- .../EntityRecognizer.yml | 56 +- .../EntityRecognizerSet.yml | 707 ++- .../EnumProperty.yml | 1 - .../FirstSelector.yml | 37 +- .../botbuilder-dialogs-adaptive/ForEach.yml | 193 +- .../ForEachConfiguration.yml | 20 +- .../ForEachPage.yml | 185 +- .../ForEachPageConfiguration.yml | 21 +- .../GetActivityMembers.yml | 159 +- .../GetActivityMembersConfiguration.yml | 6 - .../GetConversationMembers.yml | 159 +- .../GetConversationMembersConfiguration.yml | 5 - .../GetConversationReference.yml | 157 +- .../GetConversationReferenceConfiguration.yml | 5 - .../GotoAction.yml | 152 +- .../GotoActionConfiguration.yml | 5 - .../GuidEntityRecognizer.yml | 61 +- .../HasPendingActionsFunction.yml | 8 - .../HashtagEntityRecognizer.yml | 61 +- .../HeadersInput.yml | 11 - .../HeadersOutput.yml | 11 - .../HttpMethod.yml | 5 +- .../HttpRequest.yml | 177 +- .../HttpRequestConfiguration.yml | 19 +- .../IfCondition.yml | 173 +- .../IfConditionConfiguration.yml | 15 +- .../botbuilder-dialogs-adaptive/Input.yml | 11 - .../InputDialog.yml | 173 +- .../InputDialogConfiguration.yml | 25 +- .../InputState.yml | 1 - .../IntProperty.yml | 1 - .../IntentPattern.yml | 18 +- .../IntentPatternInput.yml | 11 - .../IpEntityRecognizer.yml | 59 +- .../IsDialogActiveFunction.yml | 17 +- .../LanguageGenerationBotComponent.yml | 12 +- .../LanguageGenerator.yml | 6 +- .../LanguageGeneratorConverter.yml | 41 - .../LanguageGeneratorExtensions.yml | 14 +- .../LanguageGeneratorManager.yml | 15 +- .../LanguagePolicy.yml | 128 +- .../LanguagePolicyConverter.yml | 10 +- .../LanguageResourceLoader.yml | 10 +- .../botbuilder-dialogs-adaptive/LogAction.yml | 151 +- .../LogActionConfiguration.yml | 9 +- .../MentionEntityRecognizer.yml | 61 +- .../MostSpecificSelector.yml | 40 +- .../MostSpecificSelectorConfiguration.yml | 2 - .../MultiLanguageGenerator.yml | 60 +- .../MultiLanguageGeneratorBase.yml | 39 +- ...ultiLanguageGeneratorBaseConfiguration.yml | 8 +- .../MultiLanguageRecognizer.yml | 63 +- .../MultiLanguageRecognizerConfiguration.yml | 13 +- .../MultiLanguageRecognizerConverter.yml | 51 - .../NumberEntityRecognizer.yml | 61 +- .../NumberInput.yml | 198 +- .../NumberInputConfiguration.yml | 35 +- .../NumberProperty.yml | 1 - .../OAuthInput.yml | 204 +- .../OAuthInputConfiguration.yml | 37 +- .../ObjectProperty.yml | 1 - .../OnActivity.yml | 89 +- .../OnActivityConfiguration.yml | 22 +- .../OnAssignEntity.yml | 95 +- .../OnAssignEntityConfiguration.yml | 24 +- .../OnBeginDialog.yml | 86 +- .../OnCancelDialog.yml | 86 +- .../OnChooseEntity.yml | 95 +- .../OnChooseEntityConfiguration.yml | 24 +- .../OnChooseIntent.yml | 95 +- .../OnChooseIntentConfiguration.yml | 30 +- .../OnChooseProperty.yml | 86 +- .../OnCommandActivity.yml | 91 +- .../OnCommandResultActivity.yml | 93 +- .../OnCondition.yml | 59 +- .../OnConditionConfiguration.yml | 10 +- .../OnContinueConversation.yml | 93 +- .../OnConversationUpdateActivity.yml | 95 +- .../OnDialogEvent.yml | 64 +- .../OnDialogEventConfiguration.yml | 11 +- .../OnEndOfActions.yml | 86 +- .../OnEndOfConversationActivity.yml | 93 +- .../botbuilder-dialogs-adaptive/OnError.yml | 95 +- .../OnEventActivity.yml | 89 +- .../OnHandoffActivity.yml | 89 +- .../OnInstallationUpdateActivity.yml | 95 +- .../botbuilder-dialogs-adaptive/OnIntent.yml | 94 +- .../OnIntentConfiguration.yml | 25 +- .../OnInvokeActivity.yml | 89 +- .../OnMessageActivity.yml | 89 +- .../OnMessageDeleteActivity.yml | 91 +- .../OnMessageReactionActivity.yml | 93 +- .../OnMessageUpdateActivity.yml | 91 +- .../OnQnAMatch.yml | 92 +- .../OnRepromptDialog.yml | 86 +- .../OnTypingActivity.yml | 89 +- .../OnUnknownIntent.yml | 86 +- .../OrdinalEntityRecognizer.yml | 61 +- .../botbuilder-dialogs-adaptive/Output.yml | 11 - .../PercentageEntityRecognizer.yml | 61 +- .../PhoneNumberEntityRecognizer.yml | 61 +- .../PropertiesInput.yml | 11 - .../PropertiesOutput.yml | 11 - .../botbuilder-dialogs-adaptive/Property.yml | 1 - .../PropertyAssignment.yml | 3 - .../PropertySchema.yml | 39 +- .../RandomSelector.yml | 37 +- .../RecognizerConverter.yml | 51 - .../RecognizerListConverter.yml | 51 - .../RecognizerSet.yml | 57 +- .../RecognizerSetConfiguration.yml | 6 +- .../RegexEntityRecognizer.yml | 77 +- .../RegexEntityRecognizerConfiguration.yml | 3 - .../RegexRecognizer.yml | 60 +- .../RegexRecognizerConfiguration.yml | 19 +- .../RepeatDialog.yml | 194 +- .../RepeatDialogConfiguration.yml | 16 +- .../ReplaceDialog.yml | 188 +- .../ReplaceDialogConfiguration.yml | 15 +- .../ResourceExtensions.yml | 4 +- .../ResourceMultiLanguageGenerator.yml | 48 +- ...rceMultiLanguageGeneratorConfiguration.yml | 9 +- .../ResponsesTypes.yml | 1 - .../botbuilder-dialogs-adaptive/Result.yml | 13 +- .../SchemaHelper.yml | 17 +- .../SendActivity.yml | 163 +- .../SendActivityConfiguration.yml | 8 +- .../SendHandoffActivity.yml | 146 +- .../SendHandoffActivityConfiguration.yml | 5 - .../SetProperties.yml | 154 +- .../SetPropertiesConfiguration.yml | 8 +- .../SetProperty.yml | 162 +- .../SetPropertyConfiguration.yml | 10 +- .../SignOutUser.yml | 155 +- .../SignOutUserConfiguration.yml | 6 - .../SkillExtensions.yml | 5 +- .../StaticActivityTemplate.yml | 34 +- .../StaticActivityTemplateConfiguration.yml | 2 - .../StringProperty.yml | 1 - .../SwitchCondition.yml | 184 +- .../SwitchConditionConfiguration.yml | 15 +- .../TelemetryLoggerConstants.yml | 17 - .../TelemetryTrackEventAction.yml | 168 +- ...TelemetryTrackEventActionConfiguration.yml | 10 +- .../TemperatureEntityRecognizer.yml | 61 +- .../TemplateEngineLanguageGenerator.yml | 43 +- ...teEngineLanguageGeneratorConfiguration.yml | 2 - .../TemplateInterfaceProperty.yml | 3 +- .../TextEntity.yml | 7 +- .../TextEntityRecognizer.yml | 166 - .../botbuilder-dialogs-adaptive/TextInput.yml | 197 +- .../TextInputConfiguration.yml | 34 +- .../TextTemplate.yml | 31 +- .../TextTemplateConfiguration.yml | 2 - .../TextTemplateConverter.yml | 33 - .../ThrowException.yml | 149 +- .../ThrowExceptionConfiguration.yml | 9 +- .../TraceActivity.yml | 164 +- .../TraceActivityConfiguration.yml | 12 +- .../TriggerSelector.yml | 31 +- .../TrueSelector.yml | 37 +- .../UnknownProperty.yml | 1 - .../UpdateActivity.yml | 161 +- .../UpdateActivityConfiguration.yml | 9 +- .../UrlEntityRecognizer.yml | 59 +- .../ValueRecognizer.yml | 142 - .../botbuilder-dialogs-adaptive/index.yml | 377 +- .../ComponentDeclarativeTypes.yml | 8 +- .../CustomDeserializer.yml | 8 +- .../DeclarativeType.yml | 8 +- .../DefaultLoader.yml | 14 +- .../FileResource.yml | 8 +- .../FolderResourceProvider.yml | 22 +- .../PathUtil.yml | 64 - .../Resource.yml | 4 - .../ResourceChangeEvent.yml | 1 - .../ResourceExplorer.yml | 58 +- .../ResourceExplorerOptions.yml | 6 +- .../ResourceProvider.yml | 23 +- .../botbuilder-dialogs-declarative/index.yml | 24 +- .../botbuilder-dialogs/ActivityPrompt.yml | 121 +- .../botbuilder-dialogs/AliasPathResolver.yml | 8 +- .../botbuilder-dialogs/AtAtPathResolver.yml | 3 - .../botbuilder-dialogs/AtPathResolver.yml | 5 +- .../botbuilder-dialogs/AttachmentPrompt.yml | 124 +- .../BeginSkillDialogOptions.yml | 2 - .../BotStateMemoryScope.yml | 21 +- .../botbuilder-dialogs/Choice.yml | 6 +- .../ChoiceDefaultsChoicePrompt.yml | 10 - .../ChoiceDefaultsConfirmPrompt.yml | 10 - .../botbuilder-dialogs/ChoiceFactory.yml | 49 +- .../ChoiceFactoryOptions.yml | 5 - .../botbuilder-dialogs/ChoicePrompt.yml | 136 +- .../botbuilder-dialogs/ClassMemoryScope.yml | 26 +- .../botbuilder-dialogs/ComponentDialog.yml | 121 +- .../ComponentMemoryScopes.yml | 4 +- .../ComponentPathResolvers.yml | 4 +- .../botbuilder-dialogs/Configurable.yml | 20 +- .../botbuilder-dialogs/ConfirmPrompt.yml | 138 +- .../ConversationMemoryScope.yml | 22 +- .../botbuilder-dialogs/Converter.yml | 4 +- .../botbuilder-dialogs/ConverterFactory.yml | 5 +- .../botbuilder-dialogs/DateTimePrompt.yml | 125 +- .../botbuilder-dialogs/DateTimeResolution.yml | 4 - .../botbuilder-dialogs/Dialog.yml | 111 +- .../DialogClassMemoryScope.yml | 35 +- .../DialogConfiguration.yml | 3 - .../botbuilder-dialogs/DialogContainer.yml | 129 +- .../botbuilder-dialogs/DialogContext.yml | 118 +- .../botbuilder-dialogs/DialogContextError.yml | 89 +- .../DialogContextMemoryScope.yml | 25 +- .../botbuilder-dialogs/DialogDependencies.yml | 6 +- .../botbuilder-dialogs/DialogEvent.yml | 4 - .../botbuilder-dialogs/DialogEvents.yml | 7 - .../botbuilder-dialogs/DialogInstance.yml | 4 - .../botbuilder-dialogs/DialogManager.yml | 51 +- .../DialogManagerConfiguration.yml | 12 +- .../DialogManagerResult.yml | 6 +- .../botbuilder-dialogs/DialogMemoryScope.yml | 23 +- .../botbuilder-dialogs/DialogPath.yml | 9 - .../botbuilder-dialogs/DialogReason.yml | 1 - .../botbuilder-dialogs/DialogSet.yml | 32 +- .../botbuilder-dialogs/DialogState.yml | 6 +- .../botbuilder-dialogs/DialogStateManager.yml | 55 +- .../DialogStateManagerConfiguration.yml | 7 +- .../botbuilder-dialogs/DialogTurnResult.yml | 6 +- .../DialogTurnStateConstants.yml | 5 - .../botbuilder-dialogs/DialogTurnStatus.yml | 6 +- .../DialogsBotComponent.yml | 12 +- .../DialogsComponentRegistration.yml | 80 - .../botbuilder-dialogs/DollarPathResolver.yml | 3 - .../botbuilder-dialogs/FindChoicesOptions.yml | 9 - .../botbuilder-dialogs/FindValuesOptions.yml | 5 - .../botbuilder-dialogs/FoundChoice.yml | 5 - .../botbuilder-dialogs/FoundValue.yml | 4 - .../botbuilder-dialogs/HashPathResolver.yml | 3 - .../botbuilder-dialogs/ListStyle.yml | 1 - .../botbuilder-dialogs/MemoryScope.yml | 27 +- .../botbuilder-dialogs/ModelResult.yml | 6 - .../botbuilder-dialogs/NumberPrompt.yml | 121 +- .../botbuilder-dialogs/OAuthPrompt.yml | 119 +- .../OAuthPromptSettings.yml | 8 - .../botbuilder-dialogs/PathResolver.yml | 2 - .../PercentPathResolver.yml | 3 - .../botbuilder-dialogs/Prompt.yml | 107 +- .../botbuilder-dialogs/PromptCultureModel.yml | 19 +- .../PromptCultureModels.yml | 14 +- .../botbuilder-dialogs/PromptOptions.yml | 22 +- .../PromptRecognizerResult.yml | 5 +- .../botbuilder-dialogs/PromptValidator.yml | 4 +- .../PromptValidatorContext.yml | 9 +- .../botbuilder-dialogs/Recognizer.yml | 30 +- .../RecognizerConfiguration.yml | 3 - .../botbuilder-dialogs/ScopePath.yml | 10 - .../SettingsMemoryScope.yml | 34 +- .../botbuilder-dialogs/SkillDialog.yml | 100 +- .../botbuilder-dialogs/SkillDialogOptions.yml | 8 - .../botbuilder-dialogs/SortedValue.yml | 3 - .../botbuilder-dialogs/TemplateInterface.yml | 6 +- .../botbuilder-dialogs/TextPrompt.yml | 120 +- .../botbuilder-dialogs/ThisMemoryScope.yml | 23 +- .../botbuilder-dialogs/ThisPath.yml | 2 - .../botbuilder-dialogs/Token.yml | 5 - .../botbuilder-dialogs/TokenizerFunction.yml | 4 +- .../botbuilder-dialogs/TurnMemoryScope.yml | 23 +- .../botbuilder-dialogs/TurnPath.yml | 13 - .../botbuilder-dialogs/UserMemoryScope.yml | 22 +- .../botbuilder-dialogs/WaterfallDialog.yml | 115 +- .../botbuilder-dialogs/WaterfallStep.yml | 4 +- .../WaterfallStepContext.yml | 126 +- .../botbuilder-dialogs/WaterfallStepInfo.yml | 16 +- .../botbuilder-dialogs/index.yml | 572 +- .../botbuilder-lg/Analyzer.yml | 46 +- .../botbuilder-lg/AnalyzerOptions.yml | 16 +- .../botbuilder-lg/AnalyzerResult.yml | 24 +- .../botbuilder-lg/BodyContext.yml | 206 +- .../CommentDefinitionContext.yml | 213 +- .../botbuilder-lg/CustomizedMemory.yml | 17 +- .../botbuilder-lg/Diagnostic.yml | 15 +- .../botbuilder-lg/DiagnosticSeverity.yml | 13 +- .../botbuilder-lg/ErrorDefinitionContext.yml | 213 +- .../botbuilder-lg/ErrorListener.yml | 23 +- .../ErrorStructureLineContext.yml | 231 +- .../ErrorStructuredNameContext.yml | 215 +- .../ErrorTemplateStringContext.yml | 211 +- .../botbuilder-lg/EvaluationOptions.yml | 29 +- .../botbuilder-lg/EvaluationTarget.yml | 13 +- .../botbuilder-lg/Evaluator.yml | 69 +- .../botbuilder-lg/Expander.yml | 69 +- .../botbuilder-lg/ExpressionContext.yml | 208 +- .../ExpressionInStructureContext.yml | 208 +- .../botbuilder-lg/Extractor.yml | 56 +- .../botbuilder-lg/FileContext.yml | 212 +- .../botbuilder-lg/FileFormat.yml | 1 - .../botbuilder-lg/IfConditionContext.yml | 235 +- .../botbuilder-lg/IfConditionRuleContext.yml | 213 +- .../botbuilder-lg/IfElseBodyContext.yml | 361 +- .../IfElseTemplateBodyContext.yml | 211 +- .../botbuilder-lg/ImportDefinitionContext.yml | 213 +- .../botbuilder-lg/ImportResolverDelegate.yml | 1 - .../KeyValueStructureLineContext.yml | 217 +- .../KeyValueStructureValueContext.yml | 219 +- .../botbuilder-lg/LGCacheScope.yml | 1 - .../botbuilder-lg/LGFileLexer.yml | 222 +- .../botbuilder-lg/LGFileParser.yml | 326 +- .../botbuilder-lg/LGFileParserListener.yml | 25 - .../botbuilder-lg/LGFileParserVisitor.yml | 29 +- .../botbuilder-lg/LGLineBreakStyle.yml | 1 - .../botbuilder-lg/LGResource.yml | 12 +- .../botbuilder-lg/LGTemplateLexer.yml | 309 +- .../botbuilder-lg/LGTemplateParser.yml | 437 +- .../LGTemplateParserListener.yml | 57 - .../botbuilder-lg/LGTemplateParserVisitor.yml | 45 +- .../botbuilder-lg/MultiLanguageLG.yml | 28 +- .../botbuilder-lg/NormalBodyContext.yml | 361 +- .../NormalTemplateBodyContext.yml | 211 +- .../NormalTemplateStringContext.yml | 230 +- .../botbuilder-lg/OptionDefinitionContext.yml | 213 +- .../botbuilder-lg/ParagraphContext.yml | 242 +- .../botbuilder-lg/Position.yml | 18 +- .../docs-ref-autogen/botbuilder-lg/Range.yml | 33 +- .../botbuilder-lg/SourceRange.yml | 80 - .../botbuilder-lg/StaticChecker.yml | 49 +- .../StructuredBodyContentLineContext.yml | 223 +- .../botbuilder-lg/StructuredBodyContext.yml | 361 +- .../StructuredBodyEndLineContext.yml | 208 +- .../StructuredBodyNameLineContext.yml | 218 +- .../StructuredTemplateBodyContext.yml | 227 +- .../botbuilder-lg/SwitchCaseBodyContext.yml | 361 +- .../botbuilder-lg/SwitchCaseRuleContext.yml | 213 +- .../botbuilder-lg/SwitchCaseStatContext.yml | 235 +- .../SwitchCaseTemplateBodyContext.yml | 211 +- .../botbuilder-lg/Template.yml | 28 +- .../botbuilder-lg/TemplateBodyContext.yml | 211 +- .../botbuilder-lg/TemplateBodyLineContext.yml | 240 +- .../botbuilder-lg/TemplateContext.yml | 209 +- .../TemplateDefinitionContext.yml | 209 +- .../botbuilder-lg/TemplateErrors.yml | 509 +- .../botbuilder-lg/TemplateException.yml | 77 +- .../botbuilder-lg/TemplateExtensions.yml | 19 +- .../botbuilder-lg/TemplateImport.yml | 32 +- .../botbuilder-lg/TemplateNameLineContext.yml | 213 +- .../botbuilder-lg/TemplateStringContext.yml | 217 +- .../botbuilder-lg/Templates.yml | 141 +- .../botbuilder-lg/TemplatesParser.yml | 30 +- .../botbuilder-lg/TemplatesTransformer.yml | 38 +- .../docs-ref-autogen/botbuilder-lg/index.yml | 61 +- .../botbuilder-stdlib/Extends.yml | 10 + .../botbuilder-stdlib/Maybe.yml | 10 + .../botbuilder-stdlib/Newable.yml | 10 + .../botbuilder-stdlib/Nil.yml | 10 + .../botbuilder-stdlib/index.yml | 145 + .../botbuilder-stdlib/stringExt.yml | 22 + .../botbuilder-testing/DialogTestClient.yml | 49 +- .../botbuilder-testing/DialogTestLogger.yml | 15 +- .../botbuilder-testing/Logger.yml | 4 +- .../botbuilder/AceCardSize.yml | 10 + .../docs-ref-autogen/botbuilder/AceData.yml | 114 + .../botbuilder/AceRequest.yml | 34 + .../docs-ref-autogen/botbuilder/Action.yml | 12 + .../botbuilder/ActionTypes.yml | 63 + .../docs-ref-autogen/botbuilder/Activity.yml | 594 ++ .../botbuilder/ActivityEventNames.yml | 19 + .../botbuilder/ActivityEx.yml | 609 +++ .../botbuilder/ActivityFactory.yml | 29 + .../ActivityHandler.yml} | 452 +- .../botbuilder/ActivityHandlerBase.yml | 84 + .../botbuilder/ActivityImageType.yml | 12 + .../botbuilder/ActivityImportance.yml | 23 + .../botbuilder/ActivityTimestamps.yml | 739 +++ .../botbuilder/ActivityTypes.yml | 90 + .../botbuilder/AdaptiveCardAuthentication.yml | 60 + .../botbuilder/AdaptiveCardInvokeAction.yml | 60 + .../botbuilder/AdaptiveCardInvokeResponse.yml | 50 + .../botbuilder/AdaptiveCardInvokeValue.yml | 59 + .../botbuilder/AnimationCard.yml | 166 + .../botbuilder/AppBasedLinkQuery.yml | 34 + .../botbuilder/ApplicationIdentityType.yml | 19 + .../botbuilder/Attachment.yml | 70 + .../botbuilder/AttachmentData.yml | 58 + .../botbuilder/AttachmentInfo.yml | 46 + .../botbuilder/AttachmentLayout.yml | 12 + .../botbuilder/AttachmentLayoutTypes.yml | 19 + .../botbuilder/AttachmentView.yml | 34 + .../docs-ref-autogen/botbuilder/AudioCard.yml | 166 + .../botbuilder/AutoSaveStateMiddleware.yml | 123 + .../botbuilder/BaseCardComponent.yml | 36 + .../botbuilder/BaseCardViewParameters.yml | 22 + .../botbuilder/BaseHandleActionResponse.yml | 36 + .../docs-ref-autogen/botbuilder/BasicCard.yml | 82 + .../botbuilder/BatchFailedEntriesResponse.yml | 34 + .../botbuilder/BatchFailedEntry.yml | 34 + .../botbuilder/BatchOperationRequest.yml | 58 + .../botbuilder/BatchOperationResponse.yml | 22 + .../BatchOperationStateResponse.yml | 58 + .../botbuilder/BotAdapter.yml | 413 ++ .../botbuilder/BotComponent.yml | 54 + .../botbuilder/BotConfigAuth.yml | 34 + .../botbuilder/BotConfigAuthType.yml | 12 + .../botbuilder/BotFrameworkAdapter.yml | 384 +- .../BotFrameworkAdapterSettings.yml | 12 - .../botbuilder/BotFrameworkClient.yml | 28 + .../botbuilder/BotFrameworkHttpAdapter.yml | 26 +- .../botbuilder/BotFrameworkHttpClient.yml | 14 +- .../botbuilder/BotFrameworkSkill.yml | 46 + .../botbuilder/BotHandler.yml | 43 + .../BotMessagePreviewActionType.yml | 12 + .../botbuilder/BotMessagePreviewType.yml | 12 + .../botbuilder/BotPageViewTelemetryClient.yml | 25 + .../docs-ref-autogen/botbuilder/BotState.yml | 211 + .../botbuilder/BotStatePropertyAccessor.yml | 122 + .../botbuilder/BotStateSet.yml | 107 + .../botbuilder/BotTelemetryClient.yml | 81 + .../botbuilder/BrowserLocalStorage.yml | 96 + .../botbuilder/BrowserSessionStorage.yml | 103 + .../docs-ref-autogen/botbuilder/CacheInfo.yml | 34 + .../botbuilder/CachedBotState.yml | 36 + .../botbuilder/CallerIdConstants.yml | 48 + .../botbuilder/CardAction.yml | 115 + .../botbuilder/CardBarComponent.yml | 63 + .../botbuilder/CardButtonBase.yml | 36 + .../botbuilder/CardButtonComponent.yml | 80 + .../botbuilder/CardComponentName.yml | 16 + .../botbuilder/CardFactory.yml | 555 ++ .../docs-ref-autogen/botbuilder/CardImage.yml | 46 + .../botbuilder/CardSearchBoxComponent.yml | 77 + .../botbuilder/CardSearchFooterComponent.yml | 105 + .../botbuilder/CardTextComponent.yml | 53 + .../botbuilder/CardTextInputComponent.yml | 117 + .../CardViewActionsFooterParameters.yml | 13 + .../botbuilder/CardViewFooterParameters.yml | 14 + .../CardViewHandleActionResponse.yml | 35 + .../botbuilder/CardViewParameters.yml | 14 + .../botbuilder/CardViewResponse.yml | 58 + .../botbuilder/ChannelAccount.yml | 74 + .../botbuilder/ChannelInfo.yml | 46 + .../botbuilder/ChannelServiceHandler.yml | 102 +- .../botbuilder/ChannelServiceHandlerBase.yml | 98 +- .../botbuilder/ChannelServiceRoutes.yml | 10 +- .../docs-ref-autogen/botbuilder/Channels.yml | 106 + .../botbuilder/CloudAdapter.yml | 353 +- .../botbuilder/CloudAdapterBase.yml | 335 ++ .../botbuilder/CloudChannelServiceHandler.yml | 421 -- .../botbuilder/CloudSkillHandler.yml | 151 +- .../botbuilder/CommandContext.yml | 12 + .../botbuilder/CommandResultValue.yml | 58 + .../botbuilder/CommandValue.yml | 42 + .../botbuilder/ComponentRegistration.yml | 37 + .../botbuilder/ConfigResponse.yml | 48 + .../botbuilder/ConfigResponseConfig.yml | 10 + ...onfigurationBotFrameworkAuthentication.yml | 219 + ...ationBotFrameworkAuthenticationOptions.yml | 15 + ...gurationServiceClientCredentialFactory.yml | 142 + ...nServiceClientCredentialFactoryOptions.yml | 15 + .../botbuilder/ConfirmationDialog.yml | 36 + .../botbuilder/ConnectorClientBuilder.yml | 28 - .../botbuilder/ConsoleTranscriptLogger.yml | 25 + .../ContactRelationUpdateActionTypes.yml | 19 + .../botbuilder/ContentType.yml | 12 + .../botbuilder/ConversationAccount.yml | 116 + .../botbuilder/ConversationIdentityType.yml | 12 + .../botbuilder/ConversationList.yml | 22 + .../botbuilder/ConversationMembers.yml | 34 + .../botbuilder/ConversationParameters.yml | 98 + .../botbuilder/ConversationReference.yml | 101 + .../ConversationResourceResponse.yml | 48 + .../botbuilder/ConversationState.yml | 240 + .../botbuilder/ConversationsResult.yml | 34 + .../botbuilder/CoreAppCredentials.yml | 29 + .../botbuilder/DeleteActivityHandler.yml | 59 + .../botbuilder/DeliveryModes.yml | 29 + .../botbuilder/DropDownOptionType.yml | 24 + .../botbuilder/EndOfConversationCodes.yml | 39 + .../docs-ref-autogen/botbuilder/Entity.yml | 22 + .../botbuilder/ErrorModel.yml | 46 + .../botbuilder/ErrorResponse.yml | 22 + .../botbuilder/EventFactory.yml | 17 +- .../botbuilder/ExecuteCardAction.yml | 46 + .../botbuilder/ExecuteCardParameters.yml | 9 + .../botbuilder/ExpectedReplies.yml | 22 + .../botbuilder/ExtendedUserTokenProvider.yml | 300 + .../ExternalLinkActionParameters.yml | 34 + .../botbuilder/ExternalLinkCardAction.yml | 34 + .../docs-ref-autogen/botbuilder/Fact.yml | 41 + .../docs-ref-autogen/botbuilder/FieldType.yml | 54 + .../botbuilder/FileConsentCard.yml | 58 + .../botbuilder/FileConsentCardResponse.yml | 46 + .../botbuilder/FileDownloadInfo.yml | 58 + .../botbuilder/FileDownloadInfoAttachment.yml | 10 + .../botbuilder/FileInfoCard.yml | 46 + .../botbuilder/FileTranscriptStore.yml | 25 +- .../botbuilder/FileUploadInfo.yml | 70 + .../botbuilder/FocusParameters.yml | 49 + .../botbuilder/GeoCoordinates.yml | 76 + .../GetLocationActionParameters.yml | 26 + .../botbuilder/GetLocationCardAction.yml | 34 + .../GetPropertyPaneConfigurationResponse.yml | 60 + .../botbuilder/HandleActionResponse.yml | 13 + .../botbuilder/HandoffEventNames.yml | 3 - .../docs-ref-autogen/botbuilder/HeroCard.yml | 82 + .../docs-ref-autogen/botbuilder/IActivity.yml | 163 + .../botbuilder/ICardSearchBoxButton.yml | 41 + .../botbuilder/ICardTextInputIconButton.yml | 54 + .../botbuilder/ICardTextInputTitleButton.yml | 54 + .../botbuilder/ICommandActivity.yml | 219 + .../botbuilder/ICommandResultActivity.yml | 219 + .../IContactRelationUpdateActivity.yml | 211 + .../IConversationUpdateActivity.yml | 243 + .../botbuilder/IEndOfConversationActivity.yml | 226 + .../botbuilder/IEventActivity.yml | 231 + .../botbuilder/IHandoffActivity.yml | 10 + .../IInstallationUpdateActivity.yml | 211 + .../botbuilder/IInvokeActivity.yml | 231 + .../botbuilder/IMessageActivity.yml | 385 ++ .../botbuilder/IMessageDeleteActivity.yml | 10 + .../botbuilder/IMessageReactionActivity.yml | 219 + .../botbuilder/IMessageUpdateActivity.yml | 423 ++ .../botbuilder/IStatusCodeError.yml | 34 + .../botbuilder/ISuggestionActivity.yml | 438 ++ .../botbuilder/ITraceActivity.yml | 255 + .../botbuilder/ITypingActivity.yml | 10 + .../botbuilder/IUserTokenProvider.yml | 135 + .../botbuilder/Importance.yml | 12 + .../botbuilder/InnerHttpError.yml | 34 + .../botbuilder/InputHints.yml | 23 + .../botbuilder/InspectionMiddleware.yml | 30 +- .../botbuilder/InspectionState.yml | 50 +- .../InstallationUpdateActionTypes.yml | 19 + .../botbuilder/IntentScore.yml | 22 + .../botbuilder/InvokeException.yml | 129 + .../botbuilder/InvokeResponse.yml | 39 + .../docs-ref-autogen/botbuilder/Location.yml | 58 + .../docs-ref-autogen/botbuilder/MediaCard.yml | 166 + .../botbuilder/MediaEventValue.yml | 24 + .../docs-ref-autogen/botbuilder/MediaType.yml | 24 + .../docs-ref-autogen/botbuilder/MediaUrl.yml | 36 + .../docs-ref-autogen/botbuilder/Meeting.yml | 34 + .../botbuilder/MeetingDetails.yml | 99 + .../botbuilder/MeetingEndEventDetails.yml | 84 + .../botbuilder/MeetingEventDetails.yml | 63 + .../botbuilder/MeetingInfo.yml | 46 + .../botbuilder/MeetingNotification.yml | 10 + .../botbuilder/MeetingNotificationBase.yml | 34 + .../MeetingNotificationChannelData.yml | 22 + ...eetingNotificationRecipientFailureInfo.yml | 48 + .../MeetingNotificationResponse.yml | 24 + .../MeetingParticipantsEventDetails.yml | 22 + .../botbuilder/MeetingStageSurface.yml | 46 + .../botbuilder/MeetingStartEventDetails.yml | 84 + .../botbuilder/MeetingSurface.yml | 10 + .../botbuilder/MeetingTabIconSurface.yml | 34 + .../botbuilder/MemoryStorage.yml | 101 + .../botbuilder/MemoryTranscriptStore.yml | 100 + .../docs-ref-autogen/botbuilder/Mention.yml | 46 + .../botbuilder/MessageActionsPayload.yml | 214 + .../botbuilder/MessageActionsPayloadApp.yml | 46 + .../MessageActionsPayloadAttachment.yml | 82 + .../botbuilder/MessageActionsPayloadBody.yml | 46 + .../MessageActionsPayloadConversation.yml | 46 + .../botbuilder/MessageActionsPayloadFrom.yml | 46 + .../MessageActionsPayloadMention.yml | 46 + .../MessageActionsPayloadReaction.yml | 46 + .../botbuilder/MessageActionsPayloadUser.yml | 46 + .../botbuilder/MessageFactory.yml | 252 + .../botbuilder/MessageReaction.yml | 22 + .../botbuilder/MessageReactionTypes.yml | 19 + .../botbuilder/MessageType.yml | 12 + .../botbuilder/MessagingExtensionAction.yml | 117 + .../MessagingExtensionActionResponse.yml | 48 + .../MessagingExtensionAttachment.yml | 97 + .../MessagingExtensionParameter.yml | 34 + .../botbuilder/MessagingExtensionQuery.yml | 58 + .../MessagingExtensionQueryOptions.yml | 34 + .../botbuilder/MessagingExtensionResponse.yml | 34 + .../botbuilder/MessagingExtensionResult.yml | 82 + .../MessagingExtensionResultType.yml | 20 + .../MessagingExtensionSuggestedAction.yml | 22 + .../botbuilder/MicrosoftPayMethodData.yml | 47 + .../botbuilder/Middleware.yml | 60 + .../botbuilder/MiddlewareHandler.yml | 22 + .../botbuilder/MiddlewareSet.yml | 117 + .../botbuilder/NoOpHandleActionResponse.yml | 35 + .../botbuilder/NotificationInfo.yml | 46 + .../botbuilder/NullTelemetryClient.yml | 107 + .../botbuilder/O365ConnectorCard.yml | 82 + .../O365ConnectorCardActionBase.yml | 46 + .../O365ConnectorCardActionCard.yml | 81 + .../O365ConnectorCardActionQuery.yml | 34 + .../O365ConnectorCardActionType.yml | 16 + .../botbuilder/O365ConnectorCardDateInput.yml | 99 + .../botbuilder/O365ConnectorCardFact.yml | 34 + .../botbuilder/O365ConnectorCardHttpPOST.yml | 69 + .../botbuilder/O365ConnectorCardImage.yml | 34 + .../botbuilder/O365ConnectorCardInputBase.yml | 70 + .../O365ConnectorCardInputBaseType.yml | 15 + .../botbuilder/O365ConnectorCardInputType.yml | 13 + .../O365ConnectorCardMultichoiceInput.yml | 123 + ...365ConnectorCardMultichoiceInputChoice.yml | 34 + .../botbuilder/O365ConnectorCardOpenUri.yml | 69 + .../O365ConnectorCardOpenUriTarget.yml | 34 + .../botbuilder/O365ConnectorCardSection.yml | 142 + .../botbuilder/O365ConnectorCardTextInput.yml | 111 + .../O365ConnectorCardViewAction.yml | 69 + .../docs-ref-autogen/botbuilder/OAuthCard.yml | 70 + .../botbuilder/OnBehalfOf.yml | 58 + .../botbuilder/OnCardSelectionAction.yml | 17 + .../docs-ref-autogen/botbuilder/Os.yml | 12 + .../botbuilder/PagedMembersResult.yml | 34 + .../botbuilder/PagedResult.yml | 34 + .../botbuilder/PaymentAddress.yml | 164 + .../botbuilder/PaymentCurrencyAmount.yml | 47 + .../botbuilder/PaymentDetails.yml | 75 + .../botbuilder/PaymentDetailsModifier.yml | 74 + .../botbuilder/PaymentItem.yml | 47 + .../botbuilder/PaymentMethodData.yml | 47 + .../botbuilder/PaymentOptions.yml | 92 + .../botbuilder/PaymentRequest.yml | 71 + .../botbuilder/PaymentRequestComplete.yml | 47 + .../PaymentRequestCompleteResult.yml | 23 + .../botbuilder/PaymentRequestUpdate.yml | 59 + .../botbuilder/PaymentRequestUpdateResult.yml | 23 + .../botbuilder/PaymentResponse.yml | 117 + .../botbuilder/PaymentShippingOption.yml | 59 + .../docs-ref-autogen/botbuilder/Place.yml | 74 + .../botbuilder/PopupWindowPosition.yml | 34 + .../botbuilder/PrivateConversationState.yml | 241 + .../botbuilder/PropertyManager.yml | 29 + .../PropertyPaneCheckboxProperties.yml | 47 + .../PropertyPaneChoiceGroupIconProperties.yml | 22 + .../PropertyPaneChoiceGroupImageSize.yml | 34 + .../PropertyPaneChoiceGroupOption.yml | 108 + .../PropertyPaneChoiceGroupProperties.yml | 35 + .../botbuilder/PropertyPaneDropDownOption.yml | 58 + .../PropertyPaneDropDownProperties.yml | 113 + .../PropertyPaneFieldProperties.yml | 9 + .../botbuilder/PropertyPaneGroup.yml | 59 + .../botbuilder/PropertyPaneGroupField.yml | 58 + .../PropertyPaneGroupOrConditionalGroup.yml | 9 + .../PropertyPaneLabelProperties.yml | 35 + .../PropertyPaneLinkPopupWindowProperties.yml | 58 + .../botbuilder/PropertyPaneLinkProperties.yml | 85 + .../botbuilder/PropertyPanePage.yml | 46 + .../botbuilder/PropertyPanePageHeader.yml | 22 + .../PropertyPaneSliderProperties.yml | 109 + .../PropertyPaneTextFieldProperties.yml | 175 + .../PropertyPaneToggleProperties.yml | 125 + .../botbuilder/QueueStorage.yml | 41 + .../botbuilder/QuickViewCardAction.yml | 34 + .../botbuilder/QuickViewData.yml | 9 + .../QuickViewHandleActionResponse.yml | 35 + .../botbuilder/QuickViewParameters.yml | 22 + .../botbuilder/QuickViewResponse.yml | 86 + .../botbuilder/ReactionType.yml | 12 + .../botbuilder/ReceiptCard.yml | 106 + .../botbuilder/ReceiptItem.yml | 98 + .../botbuilder/RecognizerResult.yml | 58 + .../botbuilder/RegisterClassMiddleware.yml | 61 + .../docs-ref-autogen/botbuilder/Request.yml | 6 +- .../botbuilder/ResourceResponse.yml | 22 + .../docs-ref-autogen/botbuilder/Response.yml | 16 +- .../docs-ref-autogen/botbuilder/RoleTypes.yml | 23 + .../botbuilder/RouteConstants.yml | 139 - .../botbuilder/RouteHandler.yml | 1 - .../botbuilder/SearchCardViewParameters.yml | 75 + .../botbuilder/SearchInvokeOptions.yml | 38 + .../botbuilder/SearchInvokeResponse.yml | 60 + .../botbuilder/SearchInvokeValue.yml | 73 + .../SelectMediaActionParameters.yml | 60 + .../botbuilder/SelectMediaCardAction.yml | 34 + .../botbuilder/SemanticAction.yml | 46 + .../botbuilder/SemanticActionStateTypes.yml | 23 + .../botbuilder/SendActivitiesHandler.yml | 68 + .../SetPropertyPaneConfigurationResponse.yml | 12 + .../botbuilder/SetSpeakMiddleware.yml | 16 +- .../docs-ref-autogen/botbuilder/Severity.yml | 34 + .../botbuilder/SharePointActivityHandler.yml | 761 +++ .../ShowLocationActionParameters.yml | 26 + .../botbuilder/ShowLocationCardAction.yml | 34 + .../botbuilder/ShowTypingMiddleware.yml | 63 + .../botbuilder/SignInCardViewParameters.yml | 75 + .../botbuilder/SignInUrlResponse.yml | 46 + .../botbuilder/SigninCard.yml | 34 + .../SigninStateVerificationQuery.yml | 22 + .../botbuilder/SkillConversationIdFactory.yml | 148 + .../SkillConversationIdFactoryBase.yml | 125 + .../SkillConversationIdFactoryOptions.yml | 61 + .../botbuilder/SkillConversationReference.yml | 34 + .../botbuilder/SkillHandler.yml | 134 +- .../botbuilder/SkillHandlerImpl.yml | 171 - .../botbuilder/SkillHttpClient.yml | 40 +- .../SkypeMentionNormalizeMiddleware.yml | 62 + .../botbuilder/SpeechConstants.yml | 25 + .../botbuilder/StatePropertyAccessor.yml | 123 + .../botbuilder/StatusCodeError.yml | 76 +- .../botbuilder/StatusCodes.yml | 76 + .../docs-ref-autogen/botbuilder/Storage.yml | 74 + .../botbuilder/StorageKeyFactory.yml | 15 + .../docs-ref-autogen/botbuilder/StoreItem.yml | 22 + .../botbuilder/StoreItems.yml | 9 + .../botbuilder/StreamingHttpClient.yml | 10 +- .../botbuilder/StringUtils.yml | 67 + .../docs-ref-autogen/botbuilder/Style.yml | 12 + .../botbuilder/SubmitCardAction.yml | 46 + .../botbuilder/SubmitCardParameters.yml | 9 + .../botbuilder/SuggestedActions.yml | 38 + .../botbuilder/TabContext.yml | 22 + .../botbuilder/TabEntityContext.yml | 22 + .../botbuilder/TabRequest.yml | 46 + .../botbuilder/TabResponse.yml | 22 + .../botbuilder/TabResponseCard.yml | 22 + .../botbuilder/TabResponseCards.yml | 22 + .../botbuilder/TabResponsePayload.yml | 46 + .../docs-ref-autogen/botbuilder/TabSubmit.yml | 46 + .../botbuilder/TabSubmitData.yml | 22 + .../botbuilder/TabSuggestedActions.yml | 22 + .../TargetedMeetingNotification.yml | 53 + .../TargetedMeetingNotificationValue.yml | 34 + .../botbuilder/TaskModuleCardResponse.yml | 39 + .../botbuilder/TaskModuleContinueResponse.yml | 39 + .../botbuilder/TaskModuleMessageResponse.yml | 39 + .../botbuilder/TaskModuleRequest.yml | 46 + .../botbuilder/TaskModuleRequestContext.yml | 22 + .../botbuilder/TaskModuleResponse.yml | 36 + .../botbuilder/TaskModuleResponseBase.yml | 22 + .../botbuilder/TaskModuleTaskInfo.yml | 94 + .../botbuilder/TeamDetails.yml | 84 + .../docs-ref-autogen/botbuilder/TeamInfo.yml | 46 + .../botbuilder/TeamsActivityHandler.yml | 516 +- .../botbuilder/TeamsAttachment.yml | 82 + .../botbuilder/TeamsChannelAccount.yml | 163 + .../botbuilder/TeamsChannelData.yml | 106 + .../botbuilder/TeamsChannelDataSettings.yml | 22 + .../docs-ref-autogen/botbuilder/TeamsInfo.yml | 305 +- .../botbuilder/TeamsMeetingInfo.yml | 22 + .../botbuilder/TeamsMeetingMember.yml | 34 + .../botbuilder/TeamsMeetingParticipant.yml | 46 + .../botbuilder/TeamsMember.yml | 10 + .../botbuilder/TeamsPagedMembersResult.yml | 34 + .../TeamsSSOTokenExchangeMiddleware.yml | 21 +- .../botbuilder/TelemetryDependency.yml | 94 + .../botbuilder/TelemetryEvent.yml | 46 + .../botbuilder/TelemetryException.yml | 70 + .../botbuilder/TelemetryLoggerMiddleware.yml | 134 + .../botbuilder/TelemetryPageView.yml | 46 + .../botbuilder/TelemetryTrace.yml | 46 + .../botbuilder/TenantInfo.yml | 22 + .../botbuilder/TestActivityInspector.yml | 25 + .../botbuilder/TestAdapter.yml | 888 +++ .../docs-ref-autogen/botbuilder/TestFlow.yml | 297 + .../botbuilder/TextCardViewParameters.yml | 87 + .../botbuilder/TextFormatTypes.yml | 23 + .../botbuilder/TextHighlight.yml | 36 + .../TextInputCardViewParameters.yml | 87 + .../docs-ref-autogen/botbuilder/Thing.yml | 34 + .../botbuilder/ThumbnailCard.yml | 82 + .../botbuilder/ThumbnailUrl.yml | 34 + .../botbuilder/TokenExchangeInvokeRequest.yml | 46 + .../TokenExchangeInvokeResponse.yml | 58 + .../botbuilder/TokenExchangeRequest.yml | 34 + .../botbuilder/TokenExchangeResource.yml | 46 + .../botbuilder/TokenExchangeState.yml | 15 + .../botbuilder/TokenPollingSettings.yml | 36 + .../botbuilder/TokenPostResource.yml | 22 + .../botbuilder/TokenRequest.yml | 34 + .../botbuilder/TokenResolver.yml | 19 +- .../botbuilder/TokenResponse.yml | 72 + .../botbuilder/TokenStatus.yml | 15 + .../botbuilder/Transcript.yml | 22 + .../botbuilder/TranscriptInfo.yml | 46 + .../botbuilder/TranscriptLogger.yml | 25 + .../botbuilder/TranscriptLoggerMiddleware.yml | 45 + .../botbuilder/TranscriptStore.yml | 101 + .../botbuilder/TurnContext.yml | 795 +++ .../botbuilder/TurnContextStateCollection.yml | 291 + .../docs-ref-autogen/botbuilder/Type.yml | 12 + .../docs-ref-autogen/botbuilder/Type1.yml | 11 + .../docs-ref-autogen/botbuilder/Type2.yml | 11 + .../docs-ref-autogen/botbuilder/Type3.yml | 11 + .../botbuilder/UpdateActivityHandler.yml | 57 + .../botbuilder/UserIdentityType.yml | 18 + .../botbuilder/UserMeetingDetails.yml | 34 + .../docs-ref-autogen/botbuilder/UserState.yml | 238 + .../docs-ref-autogen/botbuilder/VideoCard.yml | 166 + .../botbuilder/ViewResponseType.yml | 10 + .../botbuilder/WebRequest.yml | 17 +- .../botbuilder/WebResponse.yml | 25 +- .../docs-ref-autogen/botbuilder/WebServer.yml | 6 - .../docs-ref-autogen/botbuilder/index.yml | 992 +++- .../AppInsightsService.yml | 66 +- .../botframework-config/AzureService.yml | 192 - .../BlobStorageService.yml | 61 +- .../botframework-config/BotConfiguration.yml | 66 +- .../BotConfigurationBase.yml | 22 +- .../botframework-config/BotService.yml | 60 +- .../botframework-config/ConnectedService.yml | 23 +- .../botframework-config/CosmosDbService.yml | 63 +- .../botframework-config/DispatchService.yml | 39 +- .../botframework-config/EndpointService.yml | 25 +- .../botframework-config/FileService.yml | 22 +- .../botframework-config/GenericService.yml | 27 +- .../IAppInsightsService.yml | 25 +- .../botframework-config/IAzureService.yml | 12 +- .../IBlobStorageService.yml | 24 +- .../botframework-config/IBotConfiguration.yml | 10 +- .../botframework-config/IBotService.yml | 19 +- .../botframework-config/IConnectedService.yml | 8 +- .../botframework-config/ICosmosDBService.yml | 22 +- .../botframework-config/IDispatchService.yml | 23 +- .../botframework-config/IEndpointService.yml | 12 +- .../botframework-config/IFileService.yml | 9 +- .../botframework-config/IGenericService.yml | 14 +- .../botframework-config/ILuisService.yml | 14 +- .../botframework-config/IQnAService.yml | 12 +- .../botframework-config/LuisService.yml | 30 +- .../botframework-config/QnaMakerService.yml | 25 +- .../botframework-config/ServiceTypes.yml | 3 +- .../botframework-config/index.yml | 9 +- .../AadResourceUrls.yml | 4 +- .../botframework-connector/AppCredentials.yml | 45 +- .../AseChannelValidation.yml | 59 + .../botframework-connector/Attachments.yml | 164 - .../AttachmentsGetAttachmentInfoResponse.yml | 13 - .../AttachmentsGetAttachmentResponse.yml | 15 - .../AuthenticateRequestResult.yml | 9 +- .../AuthenticationConfiguration.yml | 18 +- .../AuthenticationError.yml | 88 +- .../AuthenticatorResult.yml | 38 + .../BatchBatchFailedEntriesResponse.yml | 15 + .../BatchBatchOperationStateResponse.yml | 15 + .../BotFrameworkAuthentication.yml | 18 +- .../BotFrameworkAuthenticationFactory.yml | 5 +- .../BotFrameworkClient.yml | 2 - .../BotFrameworkClientImpl.yml | 75 - .../botframework-connector/BotSignIn.yml | 167 - ...tSignInGetSignInResourceOptionalParams.yml | 75 +- .../BotSignInGetSignInResourceResponse.yml | 7 +- .../BotSignInGetSignInUrlOptionalParams.yml | 74 +- .../BotSignInGetSignInUrlResponse.yml | 5 +- .../CancelOperationResponse.yml | 12 + .../CertificateAppCredentials.yml | 100 +- ...ificateServiceClientCredentialsFactory.yml | 154 + .../ChannelValidation.yml | 11 +- .../botframework-connector/Claim.yml | 3 - .../botframework-connector/ClaimsIdentity.yml | 19 +- .../ConnectorClient.yml | 46 +- .../ConnectorClientContext.yml | 97 - .../ConnectorClientOptions.yml | 90 +- .../ConnectorFactory.yml | 4 +- .../ConnectorFactoryImpl.yml | 75 - .../ConversationConstants.yml | 6 + .../botframework-connector/Conversations.yml | 1166 ---- ...onversationsCreateConversationResponse.yml | 17 - ...onversationsGetActivityMembersResponse.yml | 16 - ...ersationsGetConversationMemberResponse.yml | 13 - ...rsationsGetConversationMembersResponse.yml | 16 - ...ConversationPagedMembersOptionalParams.yml | 74 +- ...onsGetConversationPagedMembersResponse.yml | 16 - ...rsationsGetConversationsOptionalParams.yml | 105 - .../ConversationsGetConversationsResponse.yml | 16 - .../ConversationsReplyToActivityResponse.yml | 16 - ...sationsSendConversationHistoryResponse.yml | 16 - ...onversationsSendToConversationResponse.yml | 16 - .../ConversationsUpdateActivityResponse.yml | 16 - .../ConversationsUploadAttachmentResponse.yml | 16 - .../EmulatorApiClient.yml | 8 +- .../EmulatorValidation.yml | 8 +- .../EndorsementsValidator.yml | 6 +- .../EnterpriseChannelValidation.yml | 11 +- .../botframework-connector/ErrorModel.yml | 6 +- .../botframework-connector/ErrorResponse.yml | 4 +- .../GovernmentChannelValidation.yml | 11 +- .../ICredentialProvider.yml | 17 +- .../IJwtTokenProviderFactory.yml | 4 +- .../IOpenIdMetadataKey.yml | 37 - .../botframework-connector/InnerHttpError.yml | 3 - .../JwtTokenExtractor.yml | 128 - .../JwtTokenProviderFactory.yml | 4 +- .../JwtTokenValidation.yml | 15 +- .../ManagedIdentityAppCredentials.yml | 31 +- .../ManagedIdentityAuthenticator.yml | 10 +- ...dentityServiceClientCredentialsFactory.yml | 38 +- .../MicrosoftAppCredentials.yml | 77 +- .../MicrosoftGovernmentAppCredentials.yml | 202 + .../MsalAppCredentials.yml | 237 + .../MsalServiceClientCredentialsFactory.yml | 97 + .../botframework-connector/OpenIdMetadata.yml | 49 - ...arameterizedBotFrameworkAuthentication.yml | 220 - ...PasswordServiceClientCredentialFactory.yml | 44 +- .../ReadReceiptInfo.yml | 10 +- .../ServiceClientCredentials.yml | 29 + .../ServiceClientCredentialsFactory.yml | 14 +- .../SignInUrlResponse.yml | 46 + .../SimpleCredentialProvider.yml | 23 +- .../SkillValidation.yml | 14 +- .../botframework-connector/StatusCode.yml | 1 - .../botframework-connector/Teams.yml | 455 +- .../TeamsBatchOperationResponse.yml | 15 + .../TeamsConnectorClient.yml | 52 +- .../TeamsConnectorClientContext.yml | 35 +- .../TeamsConnectorClientOptions.yml | 76 +- .../TeamsConnectorMappers.yml | 6 + ...Models.BatchBatchFailedEntriesResponse.yml | 15 + ...odels.BatchBatchOperationStateResponse.yml | 15 + ...onnectorModels.CancelOperationResponse.yml | 12 + ...ConversationPagedMembersOptionalParams.yml | 163 + ...ctorModels.TeamsBatchOperationResponse.yml | 15 + ...ctorModels.TeamsConnectorClientOptions.yml | 250 + ...orModels.TeamsFetchChannelListResponse.yml | 12 + ...sFetchMeetingParticipantOptionalParams.yml | 150 + ...s.TeamsFetchMeetingParticipantResponse.yml | 16 + ...orModels.TeamsFetchTeamDetailsResponse.yml | 12 + ...nnectorModels.TeamsMeetingInfoResponse.yml | 15 + ...odels.TeamsMeetingNotificationResponse.yml | 15 + .../TeamsConnectorModels.yml | 23 + .../TeamsFetchChannelListResponse.yml | 6 +- ...sFetchMeetingParticipantOptionalParams.yml | 73 +- .../TeamsFetchMeetingParticipantResponse.yml | 7 +- .../TeamsFetchTeamDetailsResponse.yml | 3 +- .../TeamsMeetingInfoResponse.yml | 9 +- .../TeamsMeetingNotificationResponse.yml | 15 + .../botframework-connector/TokenApiClient.yml | 50 +- .../TokenApiClientContext.yml | 97 - .../TokenApiClientOptions.yml | 76 +- .../TokenApiModels.AadResourceUrls.yml | 22 + ...tSignInGetSignInResourceOptionalParams.yml | 175 + ...els.BotSignInGetSignInResourceResponse.yml | 15 + ...ls.BotSignInGetSignInUrlOptionalParams.yml | 175 + ...piModels.BotSignInGetSignInUrlResponse.yml | 13 + .../TokenApiModels.ErrorModel.yml | 46 + .../TokenApiModels.ErrorResponse.yml | 22 + .../TokenApiModels.InnerHttpError.yml | 34 + .../TokenApiModels.TokenApiClientOptions.yml | 245 + ...iModels.UserTokenExchangeAsyncResponse.yml | 13 + ...ls.UserTokenGetAadTokensOptionalParams.yml | 149 + ...piModels.UserTokenGetAadTokensResponse.yml | 17 + ...Models.UserTokenGetTokenOptionalParams.yml | 161 + ...kenApiModels.UserTokenGetTokenResponse.yml | 12 + ....UserTokenGetTokenStatusOptionalParams.yml | 162 + ...Models.UserTokenGetTokenStatusResponse.yml | 12 + ...iModels.UserTokenSignOutOptionalParams.yml | 162 + ...okenApiModels.UserTokenSignOutResponse.yml | 13 + .../botframework-connector/TokenApiModels.yml | 27 + .../TokenCredentials.yml | 70 + .../TokenExchangeRequest.yml | 34 + .../botframework-connector/TokenStatus.yml | 15 + .../botframework-connector/UserToken.yml | 432 -- .../UserTokenClient.yml | 40 +- .../UserTokenClientImpl.yml | 209 - .../UserTokenExchangeAsyncResponse.yml | 5 +- .../UserTokenGetAadTokensOptionalParams.yml | 72 +- .../UserTokenGetAadTokensResponse.yml | 14 +- .../UserTokenGetTokenOptionalParams.yml | 71 +- .../UserTokenGetTokenResponse.yml | 3 +- .../UserTokenGetTokenStatusOptionalParams.yml | 74 +- .../UserTokenGetTokenStatusResponse.yml | 5 +- .../UserTokenSignOutOptionalParams.yml | 71 +- .../UserTokenSignOutResponse.yml | 5 +- .../botframework-connector/ValidateClaims.yml | 1 - .../botframework-connector/index.yml | 214 +- .../botframework-schema/AceCardSize.yml | 10 + .../botframework-schema/AceData.yml | 114 + .../botframework-schema/AceRequest.yml | 34 + .../botframework-schema/Action.yml | 1 - .../botframework-schema/ActionTypes.yml | 1 - .../botframework-schema/Activity.yml | 91 +- .../ActivityEventNames.yml | 1 - .../botframework-schema/ActivityEx.yml | 66 +- .../botframework-schema/ActivityImageType.yml | 1 - .../ActivityImportance.yml | 1 - .../ActivityTimestamps.yml | 96 +- .../botframework-schema/ActivityTypes.yml | 1 - .../AdaptiveCardAuthentication.yml | 4 - .../AdaptiveCardInvokeAction.yml | 7 +- .../AdaptiveCardInvokeResponse.yml | 6 +- .../AdaptiveCardInvokeValue.yml | 4 - .../botframework-schema/AnimationCard.yml | 21 +- .../botframework-schema/AppBasedLinkQuery.yml | 7 +- .../ApplicationIdentityType.yml | 1 - .../botframework-schema/Attachment.yml | 6 - .../botframework-schema/AttachmentData.yml | 5 - .../botframework-schema/AttachmentInfo.yml | 6 +- .../botframework-schema/AttachmentLayout.yml | 1 - .../AttachmentLayoutTypes.yml | 1 - .../botframework-schema/AttachmentView.yml | 3 - .../botframework-schema/AudioCard.yml | 21 +- .../botframework-schema/BaseCardComponent.yml | 36 + .../BaseCardViewParameters.yml | 22 + .../BaseHandleActionResponse.yml | 36 + .../botframework-schema/BasicCard.yml | 11 +- .../BatchFailedEntriesResponse.yml | 34 + .../botframework-schema/BatchFailedEntry.yml | 34 + .../BatchOperationRequest.yml | 58 + .../BatchOperationResponse.yml | 22 + .../BatchOperationStateResponse.yml | 58 + .../botframework-schema/BotConfigAuth.yml | 34 + .../botframework-schema/BotConfigAuthType.yml | 12 + .../BotMessagePreviewActionType.yml | 1 - .../BotMessagePreviewType.yml | 1 - .../botframework-schema/CacheInfo.yml | 7 +- .../botframework-schema/CallerIdConstants.yml | 4 - .../botframework-schema/CardAction.yml | 15 +- .../botframework-schema/CardBarComponent.yml | 63 + .../botframework-schema/CardButtonBase.yml | 36 + .../CardButtonComponent.yml | 80 + .../botframework-schema/CardComponentName.yml | 16 + .../botframework-schema/CardImage.yml | 4 - .../CardSearchBoxComponent.yml | 77 + .../CardSearchFooterComponent.yml | 105 + .../botframework-schema/CardTextComponent.yml | 53 + .../CardTextInputComponent.yml | 117 + .../CardViewActionsFooterParameters.yml | 13 + .../CardViewFooterParameters.yml | 14 + .../CardViewHandleActionResponse.yml | 35 + .../CardViewParameters.yml | 14 + .../botframework-schema/CardViewResponse.yml | 58 + .../botframework-schema/ChannelAccount.yml | 27 +- .../botframework-schema/ChannelInfo.yml | 10 +- .../botframework-schema/Channels.yml | 1 - .../botframework-schema/CommandContext.yml | 1 - .../CommandResultValue.yml | 6 +- .../botframework-schema/CommandValue.yml | 3 - .../botframework-schema/ConfigResponse.yml | 48 + .../ConfigResponseConfig.yml | 10 + .../ConfirmationDialog.yml | 36 + .../ContactRelationUpdateActionTypes.yml | 1 - .../botframework-schema/ContentType.yml | 1 - .../ConversationAccount.yml | 15 +- .../ConversationIdentityType.yml | 1 - .../botframework-schema/ConversationList.yml | 4 +- .../ConversationMembers.yml | 5 +- .../ConversationParameters.yml | 10 +- .../ConversationReference.yml | 8 - .../ConversationResourceResponse.yml | 4 - .../ConversationsResult.yml | 5 +- .../botframework-schema/DeliveryModes.yml | 1 - .../DropDownOptionType.yml | 24 + .../EndOfConversationCodes.yml | 1 - .../botframework-schema/Entity.yml | 2 - .../botframework-schema/ErrorModel.yml | 4 - .../botframework-schema/ErrorResponse.yml | 2 - .../botframework-schema/ExecuteCardAction.yml | 46 + .../ExecuteCardParameters.yml | 9 + .../botframework-schema/ExpectedReplies.yml | 4 +- .../ExternalLinkActionParameters.yml | 34 + .../ExternalLinkCardAction.yml | 34 + .../botframework-schema/Fact.yml | 3 - .../botframework-schema/FieldType.yml | 54 + .../botframework-schema/FileConsentCard.yml | 13 +- .../FileConsentCardResponse.yml | 10 +- .../botframework-schema/FileDownloadInfo.yml | 13 +- .../FileDownloadInfoAttachment.yml | 1 - .../botframework-schema/FileInfoCard.yml | 10 +- .../botframework-schema/FileUploadInfo.yml | 16 +- .../botframework-schema/FocusParameters.yml | 49 + .../botframework-schema/GeoCoordinates.yml | 6 - .../GetLocationActionParameters.yml | 26 + .../GetLocationCardAction.yml | 34 + .../GetPropertyPaneConfigurationResponse.yml | 62 + .../HandleActionResponse.yml | 13 + .../botframework-schema/HeroCard.yml | 13 +- .../botframework-schema/IActivity.yml | 22 +- .../ICardSearchBoxButton.yml | 41 + .../ICardTextInputIconButton.yml | 54 + .../ICardTextInputTitleButton.yml | 54 + .../botframework-schema/ICommandActivity.yml | 24 +- .../ICommandResultActivity.yml | 24 +- .../IContactRelationUpdateActivity.yml | 23 +- .../IConversationUpdateActivity.yml | 30 +- .../IEndOfConversationActivity.yml | 28 +- .../botframework-schema/IEventActivity.yml | 25 +- .../botframework-schema/IHandoffActivity.yml | 1 - .../IInstallationUpdateActivity.yml | 23 +- .../botframework-schema/IInvokeActivity.yml | 25 +- .../botframework-schema/IMessageActivity.yml | 57 +- .../IMessageDeleteActivity.yml | 1 - .../IMessageReactionActivity.yml | 28 +- .../IMessageUpdateActivity.yml | 61 +- .../botframework-schema/IStatusCodeError.yml | 3 - .../ISuggestionActivity.yml | 64 +- .../botframework-schema/ITraceActivity.yml | 27 +- .../botframework-schema/ITypingActivity.yml | 1 - .../botframework-schema/Importance.yml | 1 - .../botframework-schema/InnerHttpError.yml | 3 - .../botframework-schema/InputHints.yml | 1 - .../InstallationUpdateActionTypes.yml | 1 - .../botframework-schema/InvokeResponse.yml | 6 +- .../botframework-schema/Location.yml | 58 + .../botframework-schema/MediaCard.yml | 21 +- .../botframework-schema/MediaEventValue.yml | 2 - .../botframework-schema/MediaType.yml | 24 + .../botframework-schema/MediaUrl.yml | 3 - .../botframework-schema/Meeting.yml | 7 +- .../botframework-schema/MeetingDetails.yml | 36 +- .../MeetingDetailsBase.yml | 50 - .../MeetingEndEventDetails.yml | 22 +- .../MeetingEventDetails.yml | 27 +- .../botframework-schema/MeetingInfo.yml | 10 +- .../MeetingNotification.yml | 10 + .../MeetingNotificationBase.yml | 34 + .../MeetingNotificationChannelData.yml | 22 + ...eetingNotificationRecipientFailureInfo.yml | 48 + .../MeetingNotificationResponse.yml | 26 + .../MeetingParticipantsEventDetails.yml | 22 + .../MeetingStageSurface.yml | 46 + .../MeetingStartEventDetails.yml | 22 +- .../botframework-schema/MeetingSurface.yml | 10 + .../MeetingTabIconSurface.yml | 34 + .../botframework-schema/Mention.yml | 4 - .../MessageActionsPayload.yml | 62 +- .../MessageActionsPayloadApp.yml | 10 +- .../MessageActionsPayloadAttachment.yml | 19 +- .../MessageActionsPayloadBody.yml | 12 +- .../MessageActionsPayloadConversation.yml | 10 +- .../MessageActionsPayloadFrom.yml | 10 +- .../MessageActionsPayloadMention.yml | 10 +- .../MessageActionsPayloadReaction.yml | 10 +- .../MessageActionsPayloadUser.yml | 10 +- .../botframework-schema/MessageReaction.yml | 6 +- .../MessageReactionTypes.yml | 1 - .../botframework-schema/MessageType.yml | 1 - .../MessagingExtensionAction.yml | 25 +- .../MessagingExtensionActionResponse.yml | 8 +- .../MessagingExtensionAttachment.yml | 7 - .../MessagingExtensionParameter.yml | 7 +- .../MessagingExtensionQuery.yml | 13 +- .../MessagingExtensionQueryOptions.yml | 7 +- .../MessagingExtensionResponse.yml | 5 +- .../MessagingExtensionResult.yml | 19 +- .../MessagingExtensionResultType.yml | 1 - .../MessagingExtensionSuggestedAction.yml | 6 +- .../MicrosoftPayMethodData.yml | 12 +- .../NoOpHandleActionResponse.yml | 35 + .../botframework-schema/NotificationInfo.yml | 10 +- .../botframework-schema/O365ConnectorCard.yml | 23 +- .../O365ConnectorCardActionBase.yml | 10 +- .../O365ConnectorCardActionCard.yml | 24 +- .../O365ConnectorCardActionQuery.yml | 7 +- .../O365ConnectorCardActionType.yml | 1 - .../O365ConnectorCardDateInput.yml | 21 +- .../O365ConnectorCardFact.yml | 7 +- .../O365ConnectorCardHttpPOST.yml | 17 +- .../O365ConnectorCardImage.yml | 7 +- .../O365ConnectorCardInputBase.yml | 16 +- .../O365ConnectorCardInputBaseType.yml | 1 - .../O365ConnectorCardInputType.yml | 1 - .../O365ConnectorCardMultichoiceInput.yml | 27 +- ...365ConnectorCardMultichoiceInputChoice.yml | 7 +- .../O365ConnectorCardOpenUri.yml | 19 +- .../O365ConnectorCardOpenUriTarget.yml | 7 +- .../O365ConnectorCardSection.yml | 40 +- .../O365ConnectorCardTextInput.yml | 24 +- .../O365ConnectorCardViewAction.yml | 19 +- .../botframework-schema/OAuthCard.yml | 19 +- .../botframework-schema/OnBehalfOf.yml | 58 + .../OnCardSelectionAction.yml | 17 + .../botframework-schema/Os.yml | 1 - .../PagedMembersResult.yml | 5 +- .../botframework-schema/PaymentAddress.yml | 20 +- .../PaymentCurrencyAmount.yml | 4 - .../botframework-schema/PaymentDetails.yml | 12 +- .../PaymentDetailsModifier.yml | 9 +- .../botframework-schema/PaymentItem.yml | 4 - .../botframework-schema/PaymentMethodData.yml | 5 +- .../botframework-schema/PaymentOptions.yml | 6 - .../botframework-schema/PaymentRequest.yml | 10 +- .../PaymentRequestComplete.yml | 4 - .../PaymentRequestCompleteResult.yml | 2 - .../PaymentRequestUpdate.yml | 5 - .../PaymentRequestUpdateResult.yml | 2 - .../botframework-schema/PaymentResponse.yml | 7 - .../PaymentShippingOption.yml | 5 - .../botframework-schema/Place.yml | 6 - .../PopupWindowPosition.yml | 34 + .../PropertyPaneCheckboxProperties.yml | 47 + .../PropertyPaneChoiceGroupIconProperties.yml | 23 + .../PropertyPaneChoiceGroupImageSize.yml | 34 + .../PropertyPaneChoiceGroupOption.yml | 110 + .../PropertyPaneChoiceGroupProperties.yml | 35 + .../PropertyPaneDropDownOption.yml | 58 + .../PropertyPaneDropDownProperties.yml | 113 + .../PropertyPaneFieldProperties.yml | 9 + .../botframework-schema/PropertyPaneGroup.yml | 59 + .../PropertyPaneGroupField.yml | 58 + .../PropertyPaneGroupOrConditionalGroup.yml | 9 + .../PropertyPaneLabelProperties.yml | 35 + .../PropertyPaneLinkPopupWindowProperties.yml | 59 + .../PropertyPaneLinkProperties.yml | 87 + .../botframework-schema/PropertyPanePage.yml | 48 + .../PropertyPanePageHeader.yml | 22 + .../PropertyPaneSliderProperties.yml | 109 + .../PropertyPaneTextFieldProperties.yml | 175 + .../PropertyPaneToggleProperties.yml | 125 + .../QuickViewCardAction.yml | 34 + .../botframework-schema/QuickViewData.yml | 9 + .../QuickViewHandleActionResponse.yml | 35 + .../QuickViewParameters.yml | 22 + .../botframework-schema/QuickViewResponse.yml | 86 + .../botframework-schema/ReactionType.yml | 1 - .../botframework-schema/ReceiptCard.yml | 15 +- .../botframework-schema/ReceiptItem.yml | 8 - .../botframework-schema/ResourceResponse.yml | 2 - .../botframework-schema/RoleTypes.yml | 1 - .../SearchCardViewParameters.yml | 75 + .../SearchInvokeOptions.yml | 3 - .../SearchInvokeResponse.yml | 6 +- .../botframework-schema/SearchInvokeValue.yml | 5 - .../SelectMediaActionParameters.yml | 60 + .../SelectMediaCardAction.yml | 34 + .../botframework-schema/SemanticAction.yml | 12 +- .../SemanticActionStateTypes.yml | 1 - .../SetPropertyPaneConfigurationResponse.yml | 12 + .../ShowLocationActionParameters.yml | 26 + .../ShowLocationCardAction.yml | 34 + .../SignInCardViewParameters.yml | 75 + .../botframework-schema/SignInUrlResponse.yml | 15 +- .../botframework-schema/SigninCard.yml | 5 +- .../SigninStateVerificationQuery.yml | 4 +- .../botframework-schema/SpeechConstants.yml | 2 - .../botframework-schema/StatusCodes.yml | 1 - .../botframework-schema/Style.yml | 1 - .../botframework-schema/SubmitCardAction.yml | 46 + .../SubmitCardParameters.yml | 9 + .../botframework-schema/SuggestedActions.yml | 7 +- .../botframework-schema/TabContext.yml | 4 +- .../botframework-schema/TabEntityContext.yml | 4 +- .../botframework-schema/TabRequest.yml | 10 +- .../botframework-schema/TabResponse.yml | 4 +- .../botframework-schema/TabResponseCard.yml | 6 +- .../botframework-schema/TabResponseCards.yml | 6 +- .../TabResponsePayload.yml | 14 +- .../botframework-schema/TabSubmit.yml | 10 +- .../botframework-schema/TabSubmitData.yml | 4 +- .../TabSuggestedActions.yml | 6 +- .../TargetedMeetingNotification.yml | 53 + .../TargetedMeetingNotificationValue.yml | 34 + .../TaskModuleCardResponse.yml | 7 +- .../TaskModuleContinueResponse.yml | 7 +- .../TaskModuleMessageResponse.yml | 7 +- .../botframework-schema/TaskModuleRequest.yml | 10 +- .../TaskModuleRequestContext.yml | 2 - .../TaskModuleResponse.yml | 7 +- .../TaskModuleResponseBase.yml | 4 +- .../TaskModuleTaskInfo.yml | 22 +- .../botframework-schema/TeamDetails.yml | 21 +- .../botframework-schema/TeamInfo.yml | 10 +- .../botframework-schema/TeamsAttachment.yml | 10 +- .../TeamsChannelAccount.yml | 48 +- .../botframework-schema/TeamsChannelData.yml | 34 +- .../TeamsChannelDataSettings.yml | 4 +- .../botframework-schema/TeamsMeetingInfo.yml | 4 +- .../TeamsMeetingMember.yml | 34 + .../TeamsMeetingParticipant.yml | 10 +- .../botframework-schema/TeamsMember.yml | 10 + .../TeamsPagedMembersResult.yml | 5 +- .../botframework-schema/TenantInfo.yml | 4 +- .../TextCardViewParameters.yml | 87 + .../botframework-schema/TextFormatTypes.yml | 1 - .../botframework-schema/TextHighlight.yml | 3 - .../TextInputCardViewParameters.yml | 87 + .../botframework-schema/Thing.yml | 3 - .../botframework-schema/ThumbnailCard.yml | 13 +- .../botframework-schema/ThumbnailUrl.yml | 3 - .../TokenExchangeInvokeRequest.yml | 4 - .../TokenExchangeInvokeResponse.yml | 7 +- .../TokenExchangeRequest.yml | 3 - .../TokenExchangeResource.yml | 4 - .../TokenExchangeState.yml | 9 +- .../botframework-schema/TokenPostResource.yml | 22 + .../botframework-schema/TokenRequest.yml | 7 +- .../botframework-schema/TokenResponse.yml | 12 +- .../botframework-schema/TokenStatus.yml | 9 +- .../botframework-schema/Transcript.yml | 4 +- .../botframework-schema/Type.yml | 1 - .../botframework-schema/Type1.yml | 1 - .../botframework-schema/Type2.yml | 1 - .../botframework-schema/Type3.yml | 1 - .../botframework-schema/UserIdentityType.yml | 1 - .../UserMeetingDetails.yml | 34 + .../botframework-schema/VideoCard.yml | 21 +- .../botframework-schema/ViewResponseType.yml | 10 + .../botframework-schema/index.yml | 882 ++- .../botframework-streaming/AddressInfo.yml | 50 - .../botframework-streaming/BufferEncoding.yml | 21 - .../CancelDisassembler.yml | 51 - .../ConnectionListener.yml | 11 - .../botframework-streaming/ContentStream.yml | 19 +- .../HeaderSerializer.yml | 269 - .../botframework-streaming/HttpContent.yml | 13 +- .../HttpContentStream.yml | 71 - .../HttpContentStreamDisassembler.yml | 99 - .../IAssemblerParams.yml | 54 - .../IBrowserFileReader.yml | 56 - .../IBrowserWebSocket.yml | 106 - .../botframework-streaming/IEventEmitter.yml | 285 - .../botframework-streaming/IHeader.yml | 63 - .../IHttpContentHeaders.yml | 37 - .../botframework-streaming/INodeBuffer.yml | 364 +- .../INodeIncomingMessage.yml | 6 +- .../botframework-streaming/INodeServer.yml | 408 -- .../botframework-streaming/INodeSocket.yml | 397 +- .../IReceiveRequest.yml | 6 +- .../IReceiveResponse.yml | 5 +- .../IRequestPayload.yml | 50 - .../IResponsePayload.yml | 37 - .../botframework-streaming/ISendPacket.yml | 50 - .../botframework-streaming/ISocket.yml | 8 - .../IStreamDescription.yml | 50 - .../botframework-streaming/IStreamWrapper.yml | 37 - .../IStreamingTransportClient.yml | 4 - .../IStreamingTransportServer.yml | 5 - .../botframework-streaming/ITransport.yml | 37 - .../ITransportReceiver.yml | 61 - .../ITransportSender.yml | 61 - .../NamedPipeClient.yml | 9 +- .../NamedPipeServer.yml | 11 +- .../NamedPipeTransport.yml | 127 - .../botframework-streaming/NodeWebSocket.yml | 52 +- .../NodeWebSocketFactory.yml | 5 +- .../NodeWebSocketFactoryBase.yml | 4 +- .../PayloadAssembler.yml | 135 - .../PayloadAssemblerManager.yml | 93 - .../PayloadConstants.yml | 30 - .../PayloadDisassembler.yml | 77 - .../PayloadReceiver.yml | 99 - .../botframework-streaming/PayloadSender.yml | 91 - .../botframework-streaming/PayloadTypes.yml | 30 - .../ProtocolAdapter.yml | 123 - .../RequestDisassembler.yml | 100 - .../botframework-streaming/RequestHandler.yml | 2 - .../botframework-streaming/RequestManager.yml | 64 - .../ResponseDisassembler.yml | 100 - .../botframework-streaming/SendOperations.yml | 105 - .../botframework-streaming/StreamManager.yml | 130 - .../StreamingRequest.yml | 21 +- .../StreamingResponse.yml | 18 +- .../SubscribableStream.yml | 1480 +---- .../TransportDisconnectedEvent.yml | 56 - .../TransportDisconnectedEventHandler.yml | 14 - .../botframework-streaming/ValidBuffer.yml | 13 - .../WebSocketClient.yml | 16 +- .../WebSocketServer.yml | 10 +- .../WebSocketTransport.yml | 104 - .../botframework-streaming/WritableStream.yml | 447 -- .../botframework-streaming/index.yml | 92 +- .../docs-ref-autogen/toc.yml | 4830 ++++++++++++----- 2488 files changed, 176709 insertions(+), 74675 deletions(-) create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Alpha_numsContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AlternationContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArgsListContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayCreationExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AtomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BinaryOpExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CaptureContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_atomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_literalContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Character_classContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Clause.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegex.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexLexer.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexListener.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexParser.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexVisitor.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ComparisonEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Constant.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitsContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ElementContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluateExpressionDelegate.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluatorLookup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExprContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Expression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrLexer.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParser.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserListener.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserVisitor.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionFunctions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParser.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParserInterface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionProperty.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Extensions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FileContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FuncInvokeExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionTable.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionUtils.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IdAtomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IndexAccessExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/JsonCreationExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairListContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LambdaContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LetterContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LiteralContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemberAccessExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemoryInterface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MultivariateNumericEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NameContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Node.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_captureContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parenContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parensContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberTransformEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericAtomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_charContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_digitContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Optimizer.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/OptionContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Option_flagContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Options.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParenthesisExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseErrorListener.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparer.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparers.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpressionContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier_typeContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RegexErrorListener.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RelationshipType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ReturnType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_atomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_literalContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/SimpleObjectMemory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StackedMemory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringAtomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationAtomContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringTransformEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TextContentContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeTransformEvaluator.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeZoneConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Trigger.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TriggerTree.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TripleOpExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/UnaryOpExpContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Util.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValidateExpressionDelegate.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpressionConverter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueWithError.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/VerifyExpression.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/index.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Abs.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Accessor.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Add.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddDays.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddHours.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddMinutes.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddOrdinal.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddProperty.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddSeconds.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddToTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/All.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/And.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Any.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Average.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToBinary.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToString.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Binary.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Bool.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ceiling.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Coalesce.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Concat.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Contains.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertFromUTC.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertToUTC.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Count.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CountWord.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CreateArray.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUri.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToBinary.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToString.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateFunc.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateReadBack.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateTimeDiff.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfMonth.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfWeek.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfYear.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Divide.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EOL.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Element.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Empty.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EndsWith.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Equal.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Exists.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/First.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Flatten.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Float.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Floor.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Foreach.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatDateTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatEpoch.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatNumber.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatTicks.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetFutureTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableDate.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPastTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableDate.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetProperty.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetTimeOfDay.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThan.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThanOrEqual.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/If.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ignore.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexOf.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndicesAndValues.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Int.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/InternalFunctionUtils.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Intersection.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsArray.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsBoolean.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDate.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateRange.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDefinite.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDuration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsFloat.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsInteger.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsMatch.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsObject.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsPresent.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsString.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTimeRange.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JPath.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Join.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Json.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonStringify.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Last.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LastIndexOf.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Length.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThan.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThanOrEqual.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Max.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Merge.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Min.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Mod.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Month.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Multiply.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NewGuid.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Not.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NotEqual.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optional.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Or.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Power.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Rand.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Range.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RemoveProperty.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Replace.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReplaceIgnoreCase.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Reverse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Round.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Select.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SentenceCase.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetPathToValue.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetProperty.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Skip.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortBy.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortByDescending.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Split.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sqrt.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfDay.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfHour.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfMonth.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartsWith.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/String.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringOrValue.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubArray.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Substring.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Subtract.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubtractFromTime.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sum.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Take.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ticks.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToDays.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToHours.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToMinutes.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimexResolve.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TitleCase.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToLower.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToUpper.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trim.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Union.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Unique.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponent.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponentToString.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriHost.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPath.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPathAndQuery.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPort.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriQuery.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriScheme.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UtcNow.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Where.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XML.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XPath.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Year.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Label.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelResolver.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizerConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Result.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/BindToActivity.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GenerateAnswerUtils.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/HttpRequestUtils.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LanguageServiceUtils.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptions.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerInternal.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV2.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV3.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnATelemetryConstants.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/TrainUtils.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-ai/window.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/IgnoreError.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-azure/DoOnce.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceCardSize.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Action.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Activity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEventNames.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEx.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImageType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImportance.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTimestamps.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardAuthentication.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AnimationCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AppBasedLinkQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ApplicationIdentityType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Attachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayout.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayoutTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentView.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/AudioCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BasicCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntriesResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntry.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationStateResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuth.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuthType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkClient.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewActionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CacheInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CallerIdConstants.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardBarComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardComponentName.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardImage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchBoxComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchFooterComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextInputComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewActionsFooterParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewFooterParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelAccount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Channels.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandResultValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponseConfig.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfirmationDialog.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContactRelationUpdateActionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContentType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationAccount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationIdentityType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationList.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationMembers.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationReference.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationResourceResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationsResult.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreWebResource.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeliveryModes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/DropDownOptionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/EndOfConversationCodes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Entity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorModel.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExpectedReplies.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Fact.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FieldType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCardResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfoAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileInfoCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileUploadInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/FocusParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/GeoCoordinates.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetPropertyPaneConfigurationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/HandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/HeroCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardSearchBoxButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputIconButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputTitleButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandResultActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IContactRelationUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IConversationUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEndOfConversationActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEventActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IHandoffActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInstallationUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInvokeActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageDeleteActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageReactionActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/IStatusCodeError.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ISuggestionActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITraceActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITypingActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Importance.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/InnerHttpError.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/InputHints.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/InstallationUpdateActionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Location.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaEventValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaUrl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Meeting.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEndEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotification.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationChannelData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationRecipientFailureInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingParticipantsEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStageSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStartEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingTabIconSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Mention.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayload.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadApp.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadBody.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadConversation.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadFrom.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadMention.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadReaction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadUser.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReaction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReactionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionParameter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQueryOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResultType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionSuggestedAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/MicrosoftPayMethodData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/NoOpHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/NotificationInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardDateInput.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardFact.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardHttpPOST.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardImage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBaseType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInput.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInputChoice.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUri.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUriTarget.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardSection.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardTextInput.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardViewAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/OAuthCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnBehalfOf.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnCardSelectionAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Os.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedMembersResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentAddress.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentCurrencyAmount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetailsModifier.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentItem.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentMethodData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestComplete.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestCompleteResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdate.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdateResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentShippingOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Place.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PopupWindowPosition.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneCheckboxProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupIconProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupImageSize.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneFieldProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupField.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupOrConditionalGroup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLabelProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkPopupWindowProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePageHeader.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneSliderProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneTextFieldProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneToggleProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReactionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptItem.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ResourceResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/RoleTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticActionStateTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SetPropertyPaneConfigurationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInUrlResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninStateVerificationQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SpeechConstants.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatusCodes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Style.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/SuggestedActions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabEntityContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCards.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponsePayload.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmit.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmitData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSuggestedActions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotification.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotificationValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleCardResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleContinueResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleMessageResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequestContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponseBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleTaskInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelAccount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelDataSettings.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingParticipant.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsPagedMembersResult.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryConstants.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TenantInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextFormatTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextHighlight.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextInputCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Thing.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailUrl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeResource.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPostResource.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenStatus.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Transcript.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type1.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type2.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type3.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserIdentityType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserMeetingDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/VideoCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-core/ViewResponseType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/Configuration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/ConfigurationResourceExporer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBotAdapter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipant.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipantConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMemberConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembers.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembersConfiguration.yml rename botbuilder-typescript/docs-ref-autogen/{botbuilder-dialogs-adaptive/CancelAllDialogsBase.yml => botbuilder-dialogs-adaptive-teams/GetPagedTeamMembers.yml} (54%) create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembersConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannels.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannelsConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetailsConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMemberConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsAppBasedLinkQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelCreated.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelDeleted.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRenamed.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRestored.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsFileConsent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewEdit.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewSend.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMECardButtonClicked.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigQuerySettingUrl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigurationSetting.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEFetchTask.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESelectItem.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESubmitAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsO365ConnectorCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabFetch.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabSubmit.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleFetch.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleSubmit.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamArchived.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamDeleted.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamHardDeleted.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRenamed.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRestored.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamUnarchived.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAuthResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannel.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannelConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponseConfiguration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/TeamsComponentRegistration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/index.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssignmentInput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/BodyMatchType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogContextInspector.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogInspector.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMocksConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMockConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMessage.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockContent.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockMessage.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContent.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContentType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseStatusCode.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SequenceResponseManager.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetTestOptionsMiddleware.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMocksConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringAssignment.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMockConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestTelemetryClient.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMockConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMock.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMocksConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeList.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionState.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogState.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AssignmentInput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CaseInput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/D.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogListConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogSetConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialogDeserializer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignment.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentComparer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignments.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentsConfiguration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityInfo.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersInput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersOutput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Input.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPatternInput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Output.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesInput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesOutput.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerListConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntityRecognizer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConverter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ValueRecognizer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/PathUtil.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsChoicePrompt.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsConfirmPrompt.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsComponentRegistration.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SourceRange.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Extends.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Maybe.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Newable.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Nil.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/index.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/stringExt.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AceCardSize.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AceData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AceRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Action.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Activity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEventNames.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEx.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityFactory.yml rename botbuilder-typescript/docs-ref-autogen/{botbuilder-dialogs-adaptive-runtime/CoreBot.yml => botbuilder/ActivityHandler.yml} (64%) create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandlerBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImageType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImportance.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTimestamps.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardAuthentication.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AnimationCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AppBasedLinkQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ApplicationIdentityType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Attachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayout.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayoutTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentView.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AudioCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/AutoSaveStateMiddleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BaseHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BasicCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntriesResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntry.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationStateResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotAdapter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuth.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuthType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkClient.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkSkill.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewActionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotPageViewTelemetryClient.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotStatePropertyAccessor.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotStateSet.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BotTelemetryClient.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserLocalStorage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserSessionStorage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CacheInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CachedBotState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CallerIdConstants.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardBarComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardComponentName.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardFactory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardImage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchBoxComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchFooterComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextInputComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewActionsFooterParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewFooterParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelAccount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Channels.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapterBase.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CloudChannelServiceHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CommandContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CommandResultValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CommandValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ComponentRegistration.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponseConfig.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthentication.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthenticationOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactoryOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConfirmationDialog.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConnectorClientBuilder.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConsoleTranscriptLogger.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ContactRelationUpdateActionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ContentType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationAccount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationIdentityType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationList.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationMembers.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationReference.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationResourceResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationsResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/CoreAppCredentials.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/DeleteActivityHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/DeliveryModes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/DropDownOptionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/EndOfConversationCodes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Entity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorModel.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ExpectedReplies.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ExtendedUserTokenProvider.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Fact.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FieldType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCardResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfoAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FileInfoCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FileUploadInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/FocusParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/GeoCoordinates.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/GetPropertyPaneConfigurationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/HandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/HeroCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ICardSearchBoxButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputIconButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputTitleButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandResultActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IContactRelationUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IConversationUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IEndOfConversationActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IEventActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IHandoffActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IInstallationUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IInvokeActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageDeleteActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageReactionActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageUpdateActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IStatusCodeError.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ISuggestionActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ITraceActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ITypingActivity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IUserTokenProvider.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Importance.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/InnerHttpError.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/InputHints.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/InstallationUpdateActionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/IntentScore.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeException.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Location.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MediaCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MediaEventValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MediaType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MediaUrl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Meeting.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEndEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotification.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationChannelData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationRecipientFailureInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingParticipantsEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStageSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStartEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingTabIconSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryStorage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryTranscriptStore.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Mention.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayload.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadApp.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadBody.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadConversation.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadFrom.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadMention.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadReaction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadUser.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageFactory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReaction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReactionTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessageType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionParameter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQueryOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResultType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionSuggestedAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MicrosoftPayMethodData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Middleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareSet.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/NoOpHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/NotificationInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/NullTelemetryClient.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardDateInput.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardFact.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardHttpPOST.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardImage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBaseType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInput.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInputChoice.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUri.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUriTarget.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardSection.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardTextInput.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardViewAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/OAuthCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/OnBehalfOf.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/OnCardSelectionAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Os.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PagedMembersResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PagedResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentAddress.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentCurrencyAmount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetailsModifier.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentItem.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentMethodData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestComplete.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestCompleteResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdate.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdateResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentShippingOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Place.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PopupWindowPosition.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PrivateConversationState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyManager.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneCheckboxProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupIconProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupImageSize.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneFieldProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupField.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupOrConditionalGroup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLabelProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkPopupWindowProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePageHeader.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneSliderProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneTextFieldProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneToggleProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/QueueStorage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ReactionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptItem.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/RecognizerResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/RegisterClassMiddleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ResourceResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/RoleTypes.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/RouteConstants.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SearchCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticActionStateTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SendActivitiesHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SetPropertyPaneConfigurationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Severity.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SharePointActivityHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ShowTypingMiddleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SignInCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SignInUrlResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SigninCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SigninStateVerificationQuery.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationReference.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandlerImpl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SkypeMentionNormalizeMiddleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SpeechConstants.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/StatePropertyAccessor.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Storage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/StorageKeyFactory.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItem.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItems.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/StringUtils.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Style.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/SuggestedActions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabEntityContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCards.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponsePayload.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmit.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmitData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TabSuggestedActions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotification.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotificationValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleCardResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleContinueResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleMessageResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequestContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponseBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleTaskInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsAttachment.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelAccount.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelDataSettings.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingParticipant.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsPagedMembersResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryDependency.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryEvent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryException.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryLoggerMiddleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryPageView.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryTrace.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TenantInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TestActivityInspector.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TestAdapter.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TestFlow.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TextCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TextFormatTypes.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TextHighlight.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TextInputCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Thing.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailUrl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeResource.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPollingSettings.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPostResource.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TokenStatus.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Transcript.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLogger.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLoggerMiddleware.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptStore.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContextStateCollection.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Type.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Type1.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Type2.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/Type3.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/UpdateActivityHandler.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/UserIdentityType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/UserMeetingDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/UserState.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/VideoCard.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botbuilder/ViewResponseType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-config/AzureService.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/AseChannelValidation.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/Attachments.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentInfoResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticatorResult.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchFailedEntriesResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchOperationStateResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClientImpl.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignIn.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/CancelOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateServiceClientCredentialsFactory.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientContext.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactoryImpl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationConstants.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/Conversations.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsCreateConversationResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetActivityMembersResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMemberResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMembersResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsOptionalParams.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsReplyToActivityResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendConversationHistoryResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendToConversationResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUpdateActivityResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUploadAttachmentResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/IOpenIdMetadataKey.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenExtractor.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftGovernmentAppCredentials.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalAppCredentials.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalServiceClientCredentialsFactory.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/OpenIdMetadata.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ParameterizedBotFrameworkAuthentication.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentials.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/SignInUrlResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsBatchOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorMappers.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchFailedEntriesResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchOperationStateResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.CancelOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsBatchOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsConnectorClientOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchChannelListResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchTeamDetailsResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingInfoResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingNotificationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingNotificationResponse.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientContext.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.AadResourceUrls.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorModel.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.InnerHttpError.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.TokenApiClientOptions.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenExchangeAsyncResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutOptionalParams.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenCredentials.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenExchangeRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenStatus.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/UserToken.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClientImpl.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/AceCardSize.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/AceData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/AceRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntriesResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntry.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationRequest.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationStateResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuth.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuthType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardBarComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardComponentName.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchBoxComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchFooterComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextInputComponent.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewActionsFooterParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewFooterParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponseConfig.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfirmationDialog.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/DropDownOptionType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/FieldType.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/FocusParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/GetPropertyPaneConfigurationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/HandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardSearchBoxButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputIconButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputTitleButton.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/Location.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetailsBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotification.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationBase.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationChannelData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationRecipientFailureInfo.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingParticipantsEventDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStageSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingTabIconSurface.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/NoOpHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/OnBehalfOf.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/OnCardSelectionAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PopupWindowPosition.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneCheckboxProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupIconProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupImageSize.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownOption.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneFieldProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupField.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupOrConditionalGroup.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLabelProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkPopupWindowProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePage.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePageHeader.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneSliderProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneTextFieldProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneToggleProperties.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewData.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewHandleActionResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SetPropertyPaneConfigurationResponse.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationActionParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardAction.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotification.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotificationValue.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMember.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TextCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TextInputCardViewParameters.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenPostResource.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/UserMeetingDetails.yml create mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-schema/ViewResponseType.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/AddressInfo.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/BufferEncoding.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/CancelDisassembler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ConnectionListener.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/HeaderSerializer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStream.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStreamDisassembler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IAssemblerParams.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserFileReader.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserWebSocket.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IEventEmitter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHeader.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHttpContentHeaders.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeServer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IRequestPayload.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IResponsePayload.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISendPacket.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamDescription.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamWrapper.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransport.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportReceiver.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportSender.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeTransport.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssembler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssemblerManager.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadConstants.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadDisassembler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadReceiver.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadSender.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadTypes.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ProtocolAdapter.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestDisassembler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestManager.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ResponseDisassembler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/SendOperations.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamManager.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEvent.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEventHandler.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/ValidBuffer.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketTransport.yml delete mode 100644 botbuilder-typescript/docs-ref-autogen/botframework-streaming/WritableStream.yml diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Alpha_numsContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Alpha_numsContext.yml new file mode 100644 index 00000000..7bfd2c66 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Alpha_numsContext.yml @@ -0,0 +1,895 @@ +### YamlMime:TSType +name: Alpha_numsContext +uid: adaptive-expressions-ie11.Alpha_numsContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Alpha_numsContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Alpha_numsContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Alpha_numsContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Alpha_numsContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Alpha_numsContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Alpha_numsContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Alpha_numsContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Alpha_numsContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Alpha_numsContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Alpha_numsContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Alpha_numsContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Alpha_numsContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Alpha_numsContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Alpha_numsContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Alpha_numsContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Alpha_numsContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Alpha_numsContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Alpha_numsContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Alpha_numsContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Alpha_numsContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Alpha_numsContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Alpha_numsContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Alpha_numsContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Alpha_numsContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Alpha_numsContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Alpha_numsContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Alpha_numsContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Alpha_numsContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Alpha_numsContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Alpha_numsContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Alpha_numsContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Alpha_numsContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Alpha_numsContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Alpha_numsContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Alpha_numsContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Alpha_numsContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Alpha_numsContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Alpha_numsContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Alpha_numsContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Alpha_numsContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Alpha_numsContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Alpha_numsContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Alpha_numsContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Alpha_numsContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Alpha_numsContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Alpha_numsContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Alpha_numsContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Alpha_numsContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Alpha_numsContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Alpha_numsContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: digit() + uid: adaptive-expressions-ie11.Alpha_numsContext.digit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digit(): DigitContext[]' + return: + description: '' + type: [] + - name: digit(number) + uid: adaptive-expressions-ie11.Alpha_numsContext.digit_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digit(i: number): DigitContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Alpha_numsContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Alpha_numsContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: letter() + uid: adaptive-expressions-ie11.Alpha_numsContext.letter + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function letter(): LetterContext[]' + return: + description: '' + type: [] + - name: letter(number) + uid: adaptive-expressions-ie11.Alpha_numsContext.letter_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function letter(i: number): LetterContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: Underscore() + uid: adaptive-expressions-ie11.Alpha_numsContext.Underscore + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Underscore(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: Underscore(number) + uid: adaptive-expressions-ie11.Alpha_numsContext.Underscore_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Underscore(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AlternationContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AlternationContext.yml new file mode 100644 index 00000000..3b3764e7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AlternationContext.yml @@ -0,0 +1,869 @@ +### YamlMime:TSType +name: AlternationContext +uid: adaptive-expressions-ie11.AlternationContext +package: adaptive-expressions-ie11 +summary: '' +fullName: AlternationContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AlternationContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.AlternationContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new AlternationContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.AlternationContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.AlternationContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.AlternationContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.AlternationContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.AlternationContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.AlternationContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.AlternationContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.AlternationContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.AlternationContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.AlternationContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: AlternationContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.AlternationContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.AlternationContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.AlternationContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.AlternationContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.AlternationContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.AlternationContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.AlternationContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.AlternationContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.AlternationContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.AlternationContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.AlternationContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.AlternationContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.AlternationContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.AlternationContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AlternationContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.AlternationContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AlternationContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.AlternationContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.AlternationContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.AlternationContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.AlternationContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.AlternationContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.AlternationContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.AlternationContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.AlternationContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.AlternationContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.AlternationContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.AlternationContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.AlternationContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.AlternationContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.AlternationContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AlternationContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AlternationContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.AlternationContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.AlternationContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.AlternationContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.AlternationContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: expr() + uid: adaptive-expressions-ie11.AlternationContext.expr + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expr(): ExprContext[]' + return: + description: '' + type: [] + - name: expr(number) + uid: adaptive-expressions-ie11.AlternationContext.expr_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expr(i: number): ExprContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: Pipe() + uid: adaptive-expressions-ie11.AlternationContext.Pipe + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Pipe(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: Pipe(number) + uid: adaptive-expressions-ie11.AlternationContext.Pipe_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Pipe(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArgsListContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArgsListContext.yml new file mode 100644 index 00000000..5c6d955f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArgsListContext.yml @@ -0,0 +1,901 @@ +### YamlMime:TSType +name: ArgsListContext +uid: adaptive-expressions-ie11.ArgsListContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ArgsListContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ArgsListContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.ArgsListContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ArgsListContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.ArgsListContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ArgsListContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.ArgsListContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.ArgsListContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.ArgsListContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.ArgsListContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.ArgsListContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.ArgsListContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.ArgsListContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.ArgsListContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ArgsListContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.ArgsListContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.ArgsListContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.ArgsListContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.ArgsListContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ArgsListContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ArgsListContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ArgsListContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.ArgsListContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ArgsListContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ArgsListContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.ArgsListContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.ArgsListContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.ArgsListContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.ArgsListContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArgsListContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ArgsListContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArgsListContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ArgsListContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ArgsListContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.ArgsListContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.ArgsListContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ArgsListContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ArgsListContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.ArgsListContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ArgsListContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ArgsListContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ArgsListContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ArgsListContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.ArgsListContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ArgsListContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ArgsListContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArgsListContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArgsListContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ArgsListContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.ArgsListContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: COMMA() + uid: adaptive-expressions-ie11.ArgsListContext.COMMA + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function COMMA(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: COMMA(number) + uid: adaptive-expressions-ie11.ArgsListContext.COMMA_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function COMMA(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.ArgsListContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.ArgsListContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.ArgsListContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext[]' + return: + description: '' + type: [] + - name: expression(number) + uid: adaptive-expressions-ie11.ArgsListContext.expression_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(i: number): ExpressionContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: lambda() + uid: adaptive-expressions-ie11.ArgsListContext.lambda + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function lambda(): LambdaContext[]' + return: + description: '' + type: [] + - name: lambda(number) + uid: adaptive-expressions-ie11.ArgsListContext.lambda_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function lambda(i: number): LambdaContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayCreationExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayCreationExpContext.yml new file mode 100644 index 00000000..cc286cad --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayCreationExpContext.yml @@ -0,0 +1,928 @@ +### YamlMime:TSType +name: ArrayCreationExpContext +uid: adaptive-expressions-ie11.ArrayCreationExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ArrayCreationExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ArrayCreationExpContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ArrayCreationExpContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ArrayCreationExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.ArrayCreationExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.ArrayCreationExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.ArrayCreationExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.ArrayCreationExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.ArrayCreationExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.ArrayCreationExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.ArrayCreationExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.ArrayCreationExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ArrayCreationExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.ArrayCreationExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.ArrayCreationExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.ArrayCreationExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.ArrayCreationExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.ArrayCreationExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArrayCreationExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ArrayCreationExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: argsList() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.argsList + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function argsList(): undefined | ArgsListContext' + return: + description: '' + type: undefined | + - name: CLOSE_SQUARE_BRACKET() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.CLOSE_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CLOSE_SQUARE_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.ArrayCreationExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: OPEN_SQUARE_BRACKET() + uid: adaptive-expressions-ie11.ArrayCreationExpContext.OPEN_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OPEN_SQUARE_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpression.yml new file mode 100644 index 00000000..833f4889 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpression.yml @@ -0,0 +1,140 @@ +### YamlMime:TSType +name: ArrayExpression +uid: adaptive-expressions-ie11.ArrayExpression +package: adaptive-expressions-ie11 +summary: >- + Represents a property which is either a value of array of T or a string + expression to bind to a + + array of T. +fullName: ArrayExpression +remarks: >- + String values are always interpreted as an expression, whether it has '=' + prefix or not. +isDeprecated: false +type: class +constructors: + - name: ArrayExpression(string | Expression | T[]) + uid: adaptive-expressions-ie11.ArrayExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [ArrayExpression](xref:adaptive-expressions.ArrayExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new ArrayExpression(value?: string | Expression | T[])' + parameters: + - id: value + type: string | | T[] + description: Value of `T[]` or a `string` expression to bind to a `T[]`. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.ArrayExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.ArrayExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T[]' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.ArrayExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): T[]' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.ArrayExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.ArrayExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.ArrayExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: T[] }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: T[] }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +methods: + - name: setValue(string | Expression | T[]) + uid: adaptive-expressions-ie11.ArrayExpression.setValue + package: adaptive-expressions-ie11 + summary: Set an array value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | Expression | T[])' + parameters: + - id: value + type: string | | T[] + description: Value to set. +extends: <T[]> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpressionConverter.yml new file mode 100644 index 00000000..8aeeaeba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ArrayExpressionConverter.yml @@ -0,0 +1,33 @@ +### YamlMime:TSType +name: ArrayExpressionConverter +uid: adaptive-expressions-ie11.ArrayExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `array` to json [ArrayExpression](xref:adaptive-expressions.ArrayExpression) + converter. +fullName: ArrayExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(Input | ArrayExpression) + uid: adaptive-expressions-ie11.ArrayExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts an array into an + [ArrayExpression](xref:adaptive-expressions.ArrayExpression). + remarks: '' + isDeprecated: false + syntax: + content: >- + function convert(value: Input | ArrayExpression): + ArrayExpression + parameters: + - id: value + type: >- + Input<T> | <T> + description: '`array` to convert.' + return: + description: The [ArrayExpression](xref:adaptive-expressions.ArrayExpression). + type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AtomContext.yml new file mode 100644 index 00000000..97044fec --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/AtomContext.yml @@ -0,0 +1,922 @@ +### YamlMime:TSType +name: AtomContext +uid: adaptive-expressions-ie11.AtomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: AtomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AtomContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.AtomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new AtomContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.AtomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.AtomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.AtomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.AtomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.AtomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.AtomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.AtomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.AtomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.AtomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.AtomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: AtomContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.AtomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.AtomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.AtomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.AtomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.AtomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.AtomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.AtomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.AtomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.AtomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.AtomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.AtomContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.AtomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.AtomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.AtomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AtomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.AtomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AtomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.AtomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.AtomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.AtomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.AtomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.AtomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.AtomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.AtomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.AtomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.AtomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.AtomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.AtomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.AtomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.AtomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.AtomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AtomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.AtomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.AtomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.AtomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: capture() + uid: adaptive-expressions-ie11.AtomContext.capture + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function capture(): undefined | CaptureContext' + return: + description: '' + type: undefined | + - name: Caret() + uid: adaptive-expressions-ie11.AtomContext.Caret + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Caret(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: character_class() + uid: adaptive-expressions-ie11.AtomContext.character_class + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function character_class(): undefined | Character_classContext' + return: + description: '' + type: >- + undefined | + - name: Dot() + uid: adaptive-expressions-ie11.AtomContext.Dot + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Dot(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: EndOfSubject() + uid: adaptive-expressions-ie11.AtomContext.EndOfSubject + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function EndOfSubject(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.AtomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.AtomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: literal() + uid: adaptive-expressions-ie11.AtomContext.literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function literal(): undefined | LiteralContext' + return: + description: '' + type: undefined | + - name: non_capture() + uid: adaptive-expressions-ie11.AtomContext.non_capture + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function non_capture(): undefined | Non_captureContext' + return: + description: '' + type: >- + undefined | + - name: option() + uid: adaptive-expressions-ie11.AtomContext.option + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function option(): undefined | OptionContext' + return: + description: '' + type: undefined | + - name: shared_atom() + uid: adaptive-expressions-ie11.AtomContext.shared_atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function shared_atom(): undefined | Shared_atomContext' + return: + description: '' + type: >- + undefined | +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BinaryOpExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BinaryOpExpContext.yml new file mode 100644 index 00000000..96b21142 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BinaryOpExpContext.yml @@ -0,0 +1,1097 @@ +### YamlMime:TSType +name: BinaryOpExpContext +uid: adaptive-expressions-ie11.BinaryOpExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: BinaryOpExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BinaryOpExpContext(ExpressionContext) + uid: adaptive-expressions-ie11.BinaryOpExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new BinaryOpExpContext(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.BinaryOpExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions-ie11.ExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.BinaryOpExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions-ie11.ExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.BinaryOpExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions-ie11.ExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.BinaryOpExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions-ie11.ExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.BinaryOpExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions-ie11.ExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.BinaryOpExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions-ie11.ExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.BinaryOpExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions-ie11.ExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.BinaryOpExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions-ie11.ExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.BinaryOpExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: BinaryOpExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions-ie11.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.BinaryOpExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.ExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.BinaryOpExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.ExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.BinaryOpExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions-ie11.ExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.BinaryOpExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions-ie11.ExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.BinaryOpExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions-ie11.ExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.BinaryOpExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.ExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.BinaryOpExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.BinaryOpExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.BinaryOpExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.BinaryOpExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.BinaryOpExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: copyFrom(ExpressionContext) + uid: adaptive-expressions-ie11.BinaryOpExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.copyFrom](xref:adaptive-expressions-ie11.ExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.BinaryOpExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions-ie11.ExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.BinaryOpExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions-ie11.ExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.BinaryOpExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.BinaryOpExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.BinaryOpExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions-ie11.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.BinaryOpExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.BinaryOpExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.BinaryOpExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions-ie11.ExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.BinaryOpExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions-ie11.ExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.BinaryOpExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.ExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.BinaryOpExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions-ie11.ExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions-ie11.ExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.BinaryOpExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.BinaryOpExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.BinaryOpExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.BinaryOpExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.BinaryOpExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.BinaryOpExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.ExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.BinaryOpExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: ASTERISK() + uid: adaptive-expressions-ie11.BinaryOpExpContext.ASTERISK + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ASTERISK(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: DOUBLE_AND() + uid: adaptive-expressions-ie11.BinaryOpExpContext.DOUBLE_AND + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DOUBLE_AND(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: DOUBLE_EQUAL() + uid: adaptive-expressions-ie11.BinaryOpExpContext.DOUBLE_EQUAL + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DOUBLE_EQUAL(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: DOUBLE_VERTICAL_CYLINDER() + uid: adaptive-expressions-ie11.BinaryOpExpContext.DOUBLE_VERTICAL_CYLINDER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DOUBLE_VERTICAL_CYLINDER(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.BinaryOpExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.BinaryOpExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.BinaryOpExpContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext[]' + return: + description: '' + type: [] + - name: expression(number) + uid: adaptive-expressions-ie11.BinaryOpExpContext.expression_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(i: number): ExpressionContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: LESS_OR_EQUAl() + uid: adaptive-expressions-ie11.BinaryOpExpContext.LESS_OR_EQUAl + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function LESS_OR_EQUAl(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: LESS_THAN() + uid: adaptive-expressions-ie11.BinaryOpExpContext.LESS_THAN + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function LESS_THAN(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: MORE_OR_EQUAL() + uid: adaptive-expressions-ie11.BinaryOpExpContext.MORE_OR_EQUAL + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function MORE_OR_EQUAL(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: MORE_THAN() + uid: adaptive-expressions-ie11.BinaryOpExpContext.MORE_THAN + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function MORE_THAN(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: NOT_EQUAL() + uid: adaptive-expressions-ie11.BinaryOpExpContext.NOT_EQUAL + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NOT_EQUAL(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: NULL_COALESCE() + uid: adaptive-expressions-ie11.BinaryOpExpContext.NULL_COALESCE + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NULL_COALESCE(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: PERCENT() + uid: adaptive-expressions-ie11.BinaryOpExpContext.PERCENT + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function PERCENT(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: PLUS() + uid: adaptive-expressions-ie11.BinaryOpExpContext.PLUS + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function PLUS(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SINGLE_AND() + uid: adaptive-expressions-ie11.BinaryOpExpContext.SINGLE_AND + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SINGLE_AND(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SLASH() + uid: adaptive-expressions-ie11.BinaryOpExpContext.SLASH + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SLASH(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SUBSTRACT() + uid: adaptive-expressions-ie11.BinaryOpExpContext.SUBSTRACT + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SUBSTRACT(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: XOR() + uid: adaptive-expressions-ie11.BinaryOpExpContext.XOR + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function XOR(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpression.yml new file mode 100644 index 00000000..5b674ab9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpression.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: BoolExpression +uid: adaptive-expressions-ie11.BoolExpression +package: adaptive-expressions-ie11 +summary: >- + Represents a property which is either a boolean or a string expression which + resolves to a boolean. +fullName: BoolExpression +remarks: >- + String values are always interpreted as an expression, whether it has '=' + prefix or not. +isDeprecated: false +type: class +constructors: + - name: BoolExpression(string | boolean | Expression) + uid: adaptive-expressions-ie11.BoolExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [BoolExpression](xref:adaptive-expressions.BoolExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new BoolExpression(value?: string | boolean | Expression)' + parameters: + - id: value + type: >- + string | boolean | + description: A `boolean` or a `string` expression which resolves to a `boolean`. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.BoolExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.BoolExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.BoolExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): boolean' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: boolean + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.BoolExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.BoolExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.BoolExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: boolean }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: boolean }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +methods: + - name: setValue(string | boolean | Expression) + uid: adaptive-expressions-ie11.BoolExpression.setValue + package: adaptive-expressions-ie11 + summary: Set a boolean value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | boolean | Expression)' + parameters: + - id: value + type: >- + string | boolean | + description: Value to set. +extends: <boolean> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpressionConverter.yml new file mode 100644 index 00000000..cc99d2e9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/BoolExpressionConverter.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: BoolExpressionConverter +uid: adaptive-expressions-ie11.BoolExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `any` value to json [BoolExpression](xref:adaptive-expressions.BoolExpression) + converter. +fullName: BoolExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(Input | BoolExpression) + uid: adaptive-expressions-ie11.BoolExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts `any` value into a + [BoolExpression](xref:adaptive-expressions.BoolExpression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: Input | BoolExpression): BoolExpression' + parameters: + - id: value + type: Input | + description: '`any` value to convert.' + return: + description: The [BoolExpression](xref:adaptive-expressions.BoolExpression). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CaptureContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CaptureContext.yml new file mode 100644 index 00000000..09a3be22 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CaptureContext.yml @@ -0,0 +1,894 @@ +### YamlMime:TSType +name: CaptureContext +uid: adaptive-expressions-ie11.CaptureContext +package: adaptive-expressions-ie11 +summary: '' +fullName: CaptureContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: CaptureContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.CaptureContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new CaptureContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.CaptureContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.CaptureContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.CaptureContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.CaptureContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.CaptureContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.CaptureContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.CaptureContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.CaptureContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.CaptureContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.CaptureContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: CaptureContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.CaptureContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.CaptureContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.CaptureContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.CaptureContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.CaptureContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.CaptureContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.CaptureContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.CaptureContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.CaptureContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.CaptureContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.CaptureContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.CaptureContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.CaptureContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.CaptureContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.CaptureContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.CaptureContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.CaptureContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.CaptureContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.CaptureContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.CaptureContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.CaptureContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.CaptureContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.CaptureContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.CaptureContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.CaptureContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.CaptureContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.CaptureContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.CaptureContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.CaptureContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.CaptureContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.CaptureContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.CaptureContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.CaptureContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.CaptureContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.CaptureContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: alternation() + uid: adaptive-expressions-ie11.CaptureContext.alternation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function alternation(): AlternationContext' + return: + description: '' + type: + - name: CloseParen() + uid: adaptive-expressions-ie11.CaptureContext.CloseParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.CaptureContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.CaptureContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: GreaterThan() + uid: adaptive-expressions-ie11.CaptureContext.GreaterThan + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function GreaterThan(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: LessThan() + uid: adaptive-expressions-ie11.CaptureContext.LessThan + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function LessThan(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: name() + uid: adaptive-expressions-ie11.CaptureContext.name + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function name(): undefined | NameContext' + return: + description: '' + type: undefined | + - name: OpenParen() + uid: adaptive-expressions-ie11.CaptureContext.OpenParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OpenParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: QuestionMark() + uid: adaptive-expressions-ie11.CaptureContext.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QuestionMark(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_atomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_atomContext.yml new file mode 100644 index 00000000..b0d3a735 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_atomContext.yml @@ -0,0 +1,867 @@ +### YamlMime:TSType +name: Cc_atomContext +uid: adaptive-expressions-ie11.Cc_atomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Cc_atomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Cc_atomContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Cc_atomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Cc_atomContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Cc_atomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Cc_atomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Cc_atomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Cc_atomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Cc_atomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Cc_atomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Cc_atomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Cc_atomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Cc_atomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Cc_atomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Cc_atomContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Cc_atomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Cc_atomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Cc_atomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Cc_atomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Cc_atomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Cc_atomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Cc_atomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Cc_atomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Cc_atomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Cc_atomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Cc_atomContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Cc_atomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Cc_atomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Cc_atomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_atomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Cc_atomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_atomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_atomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Cc_atomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Cc_atomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Cc_atomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Cc_atomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Cc_atomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Cc_atomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Cc_atomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Cc_atomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Cc_atomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Cc_atomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Cc_atomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Cc_atomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Cc_atomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_atomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_atomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Cc_atomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Cc_atomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: cc_literal() + uid: adaptive-expressions-ie11.Cc_atomContext.cc_literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function cc_literal(): Cc_literalContext[]' + return: + description: '' + type: [] + - name: cc_literal(number) + uid: adaptive-expressions-ie11.Cc_atomContext.cc_literal_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function cc_literal(i: number): Cc_literalContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Cc_atomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Cc_atomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: Hyphen() + uid: adaptive-expressions-ie11.Cc_atomContext.Hyphen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Hyphen(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: shared_atom() + uid: adaptive-expressions-ie11.Cc_atomContext.shared_atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function shared_atom(): undefined | Shared_atomContext' + return: + description: '' + type: >- + undefined | +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_literalContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_literalContext.yml new file mode 100644 index 00000000..468e2488 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Cc_literalContext.yml @@ -0,0 +1,940 @@ +### YamlMime:TSType +name: Cc_literalContext +uid: adaptive-expressions-ie11.Cc_literalContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Cc_literalContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Cc_literalContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Cc_literalContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Cc_literalContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Cc_literalContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Cc_literalContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Cc_literalContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Cc_literalContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Cc_literalContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Cc_literalContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Cc_literalContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Cc_literalContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Cc_literalContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Cc_literalContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Cc_literalContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Cc_literalContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Cc_literalContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Cc_literalContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Cc_literalContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Cc_literalContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Cc_literalContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Cc_literalContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Cc_literalContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Cc_literalContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Cc_literalContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Cc_literalContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Cc_literalContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Cc_literalContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Cc_literalContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_literalContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Cc_literalContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_literalContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_literalContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Cc_literalContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Cc_literalContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Cc_literalContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Cc_literalContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Cc_literalContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Cc_literalContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Cc_literalContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Cc_literalContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Cc_literalContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Cc_literalContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Cc_literalContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Cc_literalContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Cc_literalContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_literalContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Cc_literalContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Cc_literalContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Cc_literalContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: Caret() + uid: adaptive-expressions-ie11.Cc_literalContext.Caret + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Caret(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CharacterClassStart() + uid: adaptive-expressions-ie11.Cc_literalContext.CharacterClassStart + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CharacterClassStart(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CloseParen() + uid: adaptive-expressions-ie11.Cc_literalContext.CloseParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseParen(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Dot() + uid: adaptive-expressions-ie11.Cc_literalContext.Dot + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Dot(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: EndOfSubject() + uid: adaptive-expressions-ie11.Cc_literalContext.EndOfSubject + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function EndOfSubject(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Cc_literalContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Cc_literalContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: OpenParen() + uid: adaptive-expressions-ie11.Cc_literalContext.OpenParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OpenParen(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Pipe() + uid: adaptive-expressions-ie11.Cc_literalContext.Pipe + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Pipe(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Plus() + uid: adaptive-expressions-ie11.Cc_literalContext.Plus + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Plus(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: QuestionMark() + uid: adaptive-expressions-ie11.Cc_literalContext.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QuestionMark(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: shared_literal() + uid: adaptive-expressions-ie11.Cc_literalContext.shared_literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function shared_literal(): undefined | Shared_literalContext' + return: + description: '' + type: >- + undefined | + - name: Star() + uid: adaptive-expressions-ie11.Cc_literalContext.Star + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Star(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Character_classContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Character_classContext.yml new file mode 100644 index 00000000..be4a2e57 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Character_classContext.yml @@ -0,0 +1,876 @@ +### YamlMime:TSType +name: Character_classContext +uid: adaptive-expressions-ie11.Character_classContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Character_classContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Character_classContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Character_classContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Character_classContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Character_classContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Character_classContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Character_classContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Character_classContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Character_classContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Character_classContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Character_classContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Character_classContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Character_classContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Character_classContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Character_classContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Character_classContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Character_classContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Character_classContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Character_classContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Character_classContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Character_classContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Character_classContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Character_classContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Character_classContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Character_classContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Character_classContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Character_classContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Character_classContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Character_classContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Character_classContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Character_classContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Character_classContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Character_classContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Character_classContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Character_classContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Character_classContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Character_classContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Character_classContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Character_classContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Character_classContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Character_classContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Character_classContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Character_classContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Character_classContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Character_classContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Character_classContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Character_classContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Character_classContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Character_classContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Character_classContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: Caret() + uid: adaptive-expressions-ie11.Character_classContext.Caret + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Caret(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: cc_atom() + uid: adaptive-expressions-ie11.Character_classContext.cc_atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function cc_atom(): Cc_atomContext[]' + return: + description: '' + type: [] + - name: cc_atom(number) + uid: adaptive-expressions-ie11.Character_classContext.cc_atom_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function cc_atom(i: number): Cc_atomContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: CharacterClassEnd() + uid: adaptive-expressions-ie11.Character_classContext.CharacterClassEnd + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CharacterClassEnd(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: CharacterClassStart() + uid: adaptive-expressions-ie11.Character_classContext.CharacterClassStart + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CharacterClassStart(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Character_classContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Character_classContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Clause.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Clause.yml new file mode 100644 index 00000000..4e2fdf6f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Clause.yml @@ -0,0 +1,538 @@ +### YamlMime:TSType +name: Clause +uid: adaptive-expressions-ie11.Clause +package: adaptive-expressions-ie11 +summary: A canonical normal form expression. +fullName: Clause +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Clause(Expression | Expression[] | Clause) + uid: adaptive-expressions-ie11.Clause.constructor + package: adaptive-expressions-ie11 + summary: Initializes a new instance of the `Clause` class. + remarks: '' + isDeprecated: false + syntax: + content: 'new Clause(clauseOrExpression?: Expression | Expression[] | Clause)' + parameters: + - id: clauseOrExpression + type: >- + | [] | + description: >- + A clause, expression or an array of expressions to initialize a + `Clause`. +properties: + - name: anyBindings + uid: adaptive-expressions-ie11.Clause.anyBindings + package: adaptive-expressions-ie11 + summary: Gets or sets the anyBinding dictionary. + fullName: anyBindings + remarks: '' + isDeprecated: false + syntax: + content: 'anyBindings: Map' + return: + description: '' + type: Map<string, string> + - name: subsumed + uid: adaptive-expressions-ie11.Clause.subsumed + package: adaptive-expressions-ie11 + summary: Gets or sets whether the clause is subsumed. + fullName: subsumed + remarks: '' + isDeprecated: false + syntax: + content: 'subsumed: boolean' + return: + description: '' + type: boolean +inheritedProperties: + - name: children + uid: adaptive-expressions-ie11.Clause.children + package: adaptive-expressions-ie11 + summary: Children expressions. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children: Expression[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Expression.children](xref:adaptive-expressions-ie11.Expression.children) + - name: evaluator + uid: adaptive-expressions-ie11.Clause.evaluator + package: adaptive-expressions-ie11 + summary: Evaluator of expression. + fullName: evaluator + remarks: '' + isDeprecated: false + syntax: + content: 'evaluator: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Expression.evaluator](xref:adaptive-expressions-ie11.Expression.evaluator) + - name: functions + uid: adaptive-expressions-ie11.Clause.functions + package: adaptive-expressions-ie11 + summary: >- + Dictionary of function => ExpressionEvaluator. + + This is all available functions, you can add custom functions to it, but + you cannot + + replace builtin functions. If you clear the dictionary, it will be reset + to the built in functions. + fullName: functions + remarks: '' + isDeprecated: false + syntax: + content: 'static functions: FunctionTable' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Expression.functions](xref:adaptive-expressions-ie11.Expression.functions) + - name: returnType + uid: adaptive-expressions-ie11.Clause.returnType + package: adaptive-expressions-ie11 + summary: Expected result of evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: The expected result of evaluating the expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.returnType](xref:adaptive-expressions-ie11.Expression.returnType) + - name: type + uid: adaptive-expressions-ie11.Clause.type + package: adaptive-expressions-ie11 + summary: Type of expression. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: The type of the expression. + type: string + inheritanceDescription: >- + Inherited From + [Expression.type](xref:adaptive-expressions-ie11.Expression.type) + - name: validate + uid: adaptive-expressions-ie11.Clause.validate + package: adaptive-expressions-ie11 + summary: Validate immediate expression. + fullName: validate + remarks: '' + isDeprecated: false + syntax: + content: 'validate: () => void' + return: + description: '' + type: () => void + inheritanceDescription: >- + Inherited From + [Expression.validate](xref:adaptive-expressions-ie11.Expression.validate) +inheritedMethods: + - name: andExpression(Expression[]) + uid: adaptive-expressions-ie11.Clause.andExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an And expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function andExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.andExpression](xref:adaptive-expressions-ie11.Expression.andExpression) + - name: deepEquals(Expression) + uid: adaptive-expressions-ie11.Clause.deepEquals + package: adaptive-expressions-ie11 + summary: Do a deep equality between expressions. + remarks: '' + isDeprecated: false + syntax: + content: 'function deepEquals(other: Expression): boolean' + parameters: + - id: other + type: + description: Other expression. + return: + description: True if expressions are the same. + type: boolean + inheritanceDescription: >- + Inherited From + [Expression.deepEquals](xref:adaptive-expressions-ie11.Expression.deepEquals) + - name: equalsExpression(Expression[]) + uid: adaptive-expressions-ie11.Clause.equalsExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Equals expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function equalsExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.equalsExpression](xref:adaptive-expressions-ie11.Expression.equalsExpression) + - name: lambaExpression(EvaluateExpressionDelegate) + uid: adaptive-expressions-ie11.Clause.lambaExpression + package: adaptive-expressions-ie11 + summary: Construct an expression from a EvaluateExpressionDelegate + remarks: '' + isDeprecated: false + syntax: + content: >- + static function lambaExpression(func: EvaluateExpressionDelegate): + Expression + parameters: + - id: func + type: + description: Function to create an expression from. + return: + description: The new expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.lambaExpression](xref:adaptive-expressions-ie11.Expression.lambaExpression) + - name: 'lambda((arg0: any) => any)' + uid: adaptive-expressions-ie11.Clause.lambda + package: adaptive-expressions-ie11 + summary: |- + Construct an expression from a lamba expression over the state. + Exceptions will be caught and surfaced as an error string. + remarks: '' + isDeprecated: false + syntax: + content: 'static function lambda(func: (arg0: any) => any): Expression' + parameters: + - id: func + type: '(arg0: any) => any' + description: ambda expression to evaluate. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.lambda](xref:adaptive-expressions-ie11.Expression.lambda) + - name: lookup(string) + uid: adaptive-expressions-ie11.Clause.lookup + package: adaptive-expressions-ie11 + summary: >- + Lookup an + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + function by name. + remarks: '' + isDeprecated: false + syntax: + content: 'static function lookup(functionName: string): ExpressionEvaluator' + parameters: + - id: functionName + type: string + description: Name of function to lookup. + return: + description: >- + An + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + corresponding to the function name. + type: + inheritanceDescription: >- + Inherited From + [Expression.lookup](xref:adaptive-expressions-ie11.Expression.lookup) + - name: makeExpression(string, ExpressionEvaluator, Expression[]) + uid: adaptive-expressions-ie11.Clause.makeExpression + package: adaptive-expressions-ie11 + summary: Make an expression and validate it. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function makeExpression(type: string, evaluator: + ExpressionEvaluator, children: Expression[]): Expression + parameters: + - id: type + type: string + description: Type of expression from ExpressionType. + - id: evaluator + type: + description: Information about how to validate and evaluate expression. + - id: children + type: [] + description: Child expressions. + return: + description: The new expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.makeExpression](xref:adaptive-expressions-ie11.Expression.makeExpression) + - name: notExpression(Expression) + uid: adaptive-expressions-ie11.Clause.notExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Not expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function notExpression(child: Expression): Expression' + parameters: + - id: child + type: + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.notExpression](xref:adaptive-expressions-ie11.Expression.notExpression) + - name: orExpression(Expression[]) + uid: adaptive-expressions-ie11.Clause.orExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Or expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function orExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.orExpression](xref:adaptive-expressions-ie11.Expression.orExpression) + - name: parse(string, EvaluatorLookup) + uid: adaptive-expressions-ie11.Clause.parse + package: adaptive-expressions-ie11 + summary: >- + Parse an expression string into an + [Expression](xref:adaptive-expressions.Expression) object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function parse(expression: string, lookup?: EvaluatorLookup): + Expression + parameters: + - id: expression + type: string + description: Expression string. + - id: lookup + type: + description: >- + Optional. + [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) + function lookup when parsing the expression. Default is + [Expression.lookup](xref:adaptive-expressions.Expression.lookup) + which uses + [Expression.functions](xref:adaptive-expressions.Expression.functions) + table. + return: + description: The expression object. + type: + inheritanceDescription: >- + Inherited From + [Expression.parse](xref:adaptive-expressions-ie11.Expression.parse) + - name: references() + uid: adaptive-expressions-ie11.Clause.references + package: adaptive-expressions-ie11 + summary: >- + Return the static reference paths to memory. + + Return all static paths to memory. If there is a computed element index, + then the path is terminated there, + + but you might get other paths from the computed part as well. + remarks: '' + isDeprecated: false + syntax: + content: 'function references(): string[]' + return: + description: List of the static reference paths. + type: string[] + inheritanceDescription: >- + Inherited From + [Expression.references](xref:adaptive-expressions-ie11.Expression.references) + - name: 'referenceWalk(Expression, (arg0: Expression) => boolean)' + uid: adaptive-expressions-ie11.Clause.referenceWalk + package: adaptive-expressions-ie11 + summary: >- + Walking function for identifying static memory references in an + expression. + remarks: '' + isDeprecated: false + syntax: + content: >- + function referenceWalk(expression: Expression, extension?: (arg0: + Expression) => boolean): { path: string, refs: Set } + parameters: + - id: expression + type: + description: Expression to analyze. + - id: extension + type: '(arg0: Expression) => boolean' + description: >- + If present, called to override lookup for things like template + expansion. + return: + description: Accessor path of expression. + type: '{ path: string, refs: Set<string> }' + inheritanceDescription: >- + Inherited From + [Expression.referenceWalk](xref:adaptive-expressions-ie11.Expression.referenceWalk) + - name: setPathToValue(Expression, any) + uid: adaptive-expressions-ie11.Clause.setPathToValue + package: adaptive-expressions-ie11 + summary: Construct and validate an Set a property expression to a value expression. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function setPathToValue(property: Expression, value: any): + Expression + parameters: + - id: property + type: + description: property expression. + - id: value + type: any + description: value expression. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.setPathToValue](xref:adaptive-expressions-ie11.Expression.setPathToValue) + - name: tryEvaluate(any, Options) + uid: adaptive-expressions-ie11.Clause.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate the expression. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryEvaluate(state: any, options?: Options): ValueWithError' + parameters: + - id: state + type: any + description: >- + Global state to evaluate accessor expressions against. Can be + Dictionary, otherwise reflection is used to access property and then + indexer. + - id: options + type: + description: Options used in the evaluation. + return: + description: >- + Computed value and an error string. If the string is non-null, then + there was an evaluation error. + type: + inheritanceDescription: >- + Inherited From + [Expression.tryEvaluate](xref:adaptive-expressions-ie11.Expression.tryEvaluate) + - name: validateTree() + uid: adaptive-expressions-ie11.Clause.validateTree + package: adaptive-expressions-ie11 + summary: Recursively validate the expression tree. + remarks: '' + isDeprecated: false + syntax: + content: function validateTree() + inheritanceDescription: >- + Inherited From + [Expression.validateTree](xref:adaptive-expressions-ie11.Expression.validateTree) +methods: + - name: matches(Clause, any) + uid: adaptive-expressions-ie11.Clause.matches + package: adaptive-expressions-ie11 + summary: Determines whether the current `Clause` matches with another `Clause`. + remarks: '' + isDeprecated: false + syntax: + content: 'function matches(clause: Clause, memory: any): boolean' + parameters: + - id: clause + type: + description: The other `Clause` instance to compare with. + - id: memory + type: any + description: The scope for looking up variables. + return: + description: A boolean value indicating whether the two clauses are matches. + type: boolean + - name: relationship(Clause, PredicateComparers) + uid: adaptive-expressions-ie11.Clause.relationship + package: adaptive-expressions-ie11 + summary: Compares the current `Clause` with another `Clause`. + remarks: '' + isDeprecated: false + syntax: + content: >- + function relationship(other: Clause, comparers: PredicateComparers): + RelationshipType + parameters: + - id: other + type: + description: The other `Clause` to compare. + - id: comparers + type: + description: >- + A comparer, which is a dictionary of `PredicateComparer` with string + keys. + return: + description: A `RelationshipType` value between two `Clause` instances. + type: + - name: splitIgnores() + uid: adaptive-expressions-ie11.Clause.splitIgnores + package: adaptive-expressions-ie11 + summary: Splits ignored child expressions. + remarks: '' + isDeprecated: false + syntax: + content: function splitIgnores() + - name: toString(string[], number) + uid: adaptive-expressions-ie11.Clause.toString + package: adaptive-expressions-ie11 + summary: Gets a string that represents the current clause. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(builder?: string[], indent?: number): string' + parameters: + - id: builder + type: string[] + description: An array of string to build the string of clause. + - id: indent + type: number + description: An integer represents the number of spaces at the start of a line. + return: + description: A string that represents the current clause. + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegex.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegex.yml new file mode 100644 index 00000000..46aad6d5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegex.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: CommonRegex +uid: adaptive-expressions-ie11.CommonRegex +package: adaptive-expressions-ie11 +summary: |- + Convert PCRE regex string to RegExp + PCRE ref: http://www.pcre.org/. + PCRE antlr g4 file: CommonRegex.g4. +fullName: CommonRegex +remarks: '' +isDeprecated: false +type: class +methods: + - name: CreateRegex(string) + uid: adaptive-expressions-ie11.CommonRegex.CreateRegex + package: adaptive-expressions-ie11 + summary: Create RegExp object from PCRE pattern string. + remarks: '' + isDeprecated: false + syntax: + content: 'static function CreateRegex(pattern: string): RegExp' + parameters: + - id: pattern + type: string + description: PCRE pattern string. + return: + description: RegExp object. + type: RegExp diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexLexer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexLexer.yml new file mode 100644 index 00000000..3d234fc9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexLexer.yml @@ -0,0 +1,2140 @@ +### YamlMime:TSType +name: CommonRegexLexer +uid: adaptive-expressions-ie11.CommonRegexLexer +package: adaptive-expressions-ie11 +summary: '' +fullName: CommonRegexLexer +remarks: '' +isDeprecated: false +type: class +constructors: + - name: CommonRegexLexer(CharStream) + uid: adaptive-expressions-ie11.CommonRegexLexer.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new CommonRegexLexer(input: CharStream)' + parameters: + - id: input + type: CharStream + description: '' +properties: + - name: ALC + uid: adaptive-expressions-ie11.CommonRegexLexer.ALC + package: adaptive-expressions-ie11 + summary: '' + fullName: ALC + remarks: '' + isDeprecated: false + syntax: + content: 'static ALC: 44 = 44' + return: + description: '' + type: '44' + - name: Ampersand + uid: adaptive-expressions-ie11.CommonRegexLexer.Ampersand + package: adaptive-expressions-ie11 + summary: '' + fullName: Ampersand + remarks: '' + isDeprecated: false + syntax: + content: 'static Ampersand: 43 = 43' + return: + description: '' + type: '43' + - name: AUC + uid: adaptive-expressions-ie11.CommonRegexLexer.AUC + package: adaptive-expressions-ie11 + summary: '' + fullName: AUC + remarks: '' + isDeprecated: false + syntax: + content: 'static AUC: 70 = 70' + return: + description: '' + type: '70' + - name: Backslash + uid: adaptive-expressions-ie11.CommonRegexLexer.Backslash + package: adaptive-expressions-ie11 + summary: '' + fullName: Backslash + remarks: '' + isDeprecated: false + syntax: + content: 'static Backslash: 10 = 10' + return: + description: '' + type: '10' + - name: BellChar + uid: adaptive-expressions-ie11.CommonRegexLexer.BellChar + package: adaptive-expressions-ie11 + summary: '' + fullName: BellChar + remarks: '' + isDeprecated: false + syntax: + content: 'static BellChar: 3 = 3' + return: + description: '' + type: '3' + - name: BLC + uid: adaptive-expressions-ie11.CommonRegexLexer.BLC + package: adaptive-expressions-ie11 + summary: '' + fullName: BLC + remarks: '' + isDeprecated: false + syntax: + content: 'static BLC: 45 = 45' + return: + description: '' + type: '45' + - name: BlockQuoted + uid: adaptive-expressions-ie11.CommonRegexLexer.BlockQuoted + package: adaptive-expressions-ie11 + summary: '' + fullName: BlockQuoted + remarks: '' + isDeprecated: false + syntax: + content: 'static BlockQuoted: 2 = 2' + return: + description: '' + type: '2' + - name: BUC + uid: adaptive-expressions-ie11.CommonRegexLexer.BUC + package: adaptive-expressions-ie11 + summary: '' + fullName: BUC + remarks: '' + isDeprecated: false + syntax: + content: 'static BUC: 71 = 71' + return: + description: '' + type: '71' + - name: Caret + uid: adaptive-expressions-ie11.CommonRegexLexer.Caret + package: adaptive-expressions-ie11 + summary: '' + fullName: Caret + remarks: '' + isDeprecated: false + syntax: + content: 'static Caret: 23 = 23' + return: + description: '' + type: '23' + - name: CarriageReturn + uid: adaptive-expressions-ie11.CommonRegexLexer.CarriageReturn + package: adaptive-expressions-ie11 + summary: '' + fullName: CarriageReturn + remarks: '' + isDeprecated: false + syntax: + content: 'static CarriageReturn: 8 = 8' + return: + description: '' + type: '8' + - name: channelNames + uid: adaptive-expressions-ie11.CommonRegexLexer.channelNames + package: adaptive-expressions-ie11 + summary: '' + fullName: channelNames + remarks: '' + isDeprecated: false + syntax: + content: 'channelNames: string[]' + return: + description: '' + type: string[] + - name: channelNames + uid: adaptive-expressions-ie11.CommonRegexLexer.channelNames + package: adaptive-expressions-ie11 + summary: '' + fullName: channelNames + remarks: '' + isDeprecated: false + syntax: + content: 'static channelNames: string[]' + return: + description: '' + type: string[] + - name: CharacterClassEnd + uid: adaptive-expressions-ie11.CommonRegexLexer.CharacterClassEnd + package: adaptive-expressions-ie11 + summary: '' + fullName: CharacterClassEnd + remarks: '' + isDeprecated: false + syntax: + content: 'static CharacterClassEnd: 22 = 22' + return: + description: '' + type: '22' + - name: CharacterClassStart + uid: adaptive-expressions-ie11.CommonRegexLexer.CharacterClassStart + package: adaptive-expressions-ie11 + summary: '' + fullName: CharacterClassStart + remarks: '' + isDeprecated: false + syntax: + content: 'static CharacterClassStart: 21 = 21' + return: + description: '' + type: '21' + - name: CharWithoutProperty + uid: adaptive-expressions-ie11.CommonRegexLexer.CharWithoutProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: CharWithoutProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static CharWithoutProperty: 16 = 16' + return: + description: '' + type: '16' + - name: CharWithProperty + uid: adaptive-expressions-ie11.CommonRegexLexer.CharWithProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: CharWithProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static CharWithProperty: 15 = 15' + return: + description: '' + type: '15' + - name: CLC + uid: adaptive-expressions-ie11.CommonRegexLexer.CLC + package: adaptive-expressions-ie11 + summary: '' + fullName: CLC + remarks: '' + isDeprecated: false + syntax: + content: 'static CLC: 46 = 46' + return: + description: '' + type: '46' + - name: CloseBrace + uid: adaptive-expressions-ie11.CommonRegexLexer.CloseBrace + package: adaptive-expressions-ie11 + summary: '' + fullName: CloseBrace + remarks: '' + isDeprecated: false + syntax: + content: 'static CloseBrace: 29 = 29' + return: + description: '' + type: '29' + - name: CloseParen + uid: adaptive-expressions-ie11.CommonRegexLexer.CloseParen + package: adaptive-expressions-ie11 + summary: '' + fullName: CloseParen + remarks: '' + isDeprecated: false + syntax: + content: 'static CloseParen: 34 = 34' + return: + description: '' + type: '34' + - name: Colon + uid: adaptive-expressions-ie11.CommonRegexLexer.Colon + package: adaptive-expressions-ie11 + summary: '' + fullName: Colon + remarks: '' + isDeprecated: false + syntax: + content: 'static Colon: 39 = 39' + return: + description: '' + type: '39' + - name: Comma + uid: adaptive-expressions-ie11.CommonRegexLexer.Comma + package: adaptive-expressions-ie11 + summary: '' + fullName: Comma + remarks: '' + isDeprecated: false + syntax: + content: 'static Comma: 30 = 30' + return: + description: '' + type: '30' + - name: ControlChar + uid: adaptive-expressions-ie11.CommonRegexLexer.ControlChar + package: adaptive-expressions-ie11 + summary: '' + fullName: ControlChar + remarks: '' + isDeprecated: false + syntax: + content: 'static ControlChar: 4 = 4' + return: + description: '' + type: '4' + - name: CUC + uid: adaptive-expressions-ie11.CommonRegexLexer.CUC + package: adaptive-expressions-ie11 + summary: '' + fullName: CUC + remarks: '' + isDeprecated: false + syntax: + content: 'static CUC: 72 = 72' + return: + description: '' + type: '72' + - name: D0 + uid: adaptive-expressions-ie11.CommonRegexLexer.D0 + package: adaptive-expressions-ie11 + summary: '' + fullName: D0 + remarks: '' + isDeprecated: false + syntax: + content: 'static D0: 105 = 105' + return: + description: '' + type: '105' + - name: D1 + uid: adaptive-expressions-ie11.CommonRegexLexer.D1 + package: adaptive-expressions-ie11 + summary: '' + fullName: D1 + remarks: '' + isDeprecated: false + syntax: + content: 'static D1: 96 = 96' + return: + description: '' + type: '96' + - name: D2 + uid: adaptive-expressions-ie11.CommonRegexLexer.D2 + package: adaptive-expressions-ie11 + summary: '' + fullName: D2 + remarks: '' + isDeprecated: false + syntax: + content: 'static D2: 97 = 97' + return: + description: '' + type: '97' + - name: D3 + uid: adaptive-expressions-ie11.CommonRegexLexer.D3 + package: adaptive-expressions-ie11 + summary: '' + fullName: D3 + remarks: '' + isDeprecated: false + syntax: + content: 'static D3: 98 = 98' + return: + description: '' + type: '98' + - name: D4 + uid: adaptive-expressions-ie11.CommonRegexLexer.D4 + package: adaptive-expressions-ie11 + summary: '' + fullName: D4 + remarks: '' + isDeprecated: false + syntax: + content: 'static D4: 99 = 99' + return: + description: '' + type: '99' + - name: D5 + uid: adaptive-expressions-ie11.CommonRegexLexer.D5 + package: adaptive-expressions-ie11 + summary: '' + fullName: D5 + remarks: '' + isDeprecated: false + syntax: + content: 'static D5: 100 = 100' + return: + description: '' + type: '100' + - name: D6 + uid: adaptive-expressions-ie11.CommonRegexLexer.D6 + package: adaptive-expressions-ie11 + summary: '' + fullName: D6 + remarks: '' + isDeprecated: false + syntax: + content: 'static D6: 101 = 101' + return: + description: '' + type: '101' + - name: D7 + uid: adaptive-expressions-ie11.CommonRegexLexer.D7 + package: adaptive-expressions-ie11 + summary: '' + fullName: D7 + remarks: '' + isDeprecated: false + syntax: + content: 'static D7: 102 = 102' + return: + description: '' + type: '102' + - name: D8 + uid: adaptive-expressions-ie11.CommonRegexLexer.D8 + package: adaptive-expressions-ie11 + summary: '' + fullName: D8 + remarks: '' + isDeprecated: false + syntax: + content: 'static D8: 103 = 103' + return: + description: '' + type: '103' + - name: D9 + uid: adaptive-expressions-ie11.CommonRegexLexer.D9 + package: adaptive-expressions-ie11 + summary: '' + fullName: D9 + remarks: '' + isDeprecated: false + syntax: + content: 'static D9: 104 = 104' + return: + description: '' + type: '104' + - name: DecimalDigit + uid: adaptive-expressions-ie11.CommonRegexLexer.DecimalDigit + package: adaptive-expressions-ie11 + summary: '' + fullName: DecimalDigit + remarks: '' + isDeprecated: false + syntax: + content: 'static DecimalDigit: 13 = 13' + return: + description: '' + type: '13' + - name: DLC + uid: adaptive-expressions-ie11.CommonRegexLexer.DLC + package: adaptive-expressions-ie11 + summary: '' + fullName: DLC + remarks: '' + isDeprecated: false + syntax: + content: 'static DLC: 47 = 47' + return: + description: '' + type: '47' + - name: Dot + uid: adaptive-expressions-ie11.CommonRegexLexer.Dot + package: adaptive-expressions-ie11 + summary: '' + fullName: Dot + remarks: '' + isDeprecated: false + syntax: + content: 'static Dot: 12 = 12' + return: + description: '' + type: '12' + - name: DUC + uid: adaptive-expressions-ie11.CommonRegexLexer.DUC + package: adaptive-expressions-ie11 + summary: '' + fullName: DUC + remarks: '' + isDeprecated: false + syntax: + content: 'static DUC: 73 = 73' + return: + description: '' + type: '73' + - name: ELC + uid: adaptive-expressions-ie11.CommonRegexLexer.ELC + package: adaptive-expressions-ie11 + summary: '' + fullName: ELC + remarks: '' + isDeprecated: false + syntax: + content: 'static ELC: 48 = 48' + return: + description: '' + type: '48' + - name: EndOfSubject + uid: adaptive-expressions-ie11.CommonRegexLexer.EndOfSubject + package: adaptive-expressions-ie11 + summary: '' + fullName: EndOfSubject + remarks: '' + isDeprecated: false + syntax: + content: 'static EndOfSubject: 31 = 31' + return: + description: '' + type: '31' + - name: Equals + uid: adaptive-expressions-ie11.CommonRegexLexer.Equals + package: adaptive-expressions-ie11 + summary: '' + fullName: Equals + remarks: '' + isDeprecated: false + syntax: + content: 'static Equals: 41 = 41' + return: + description: '' + type: '41' + - name: EscapeChar + uid: adaptive-expressions-ie11.CommonRegexLexer.EscapeChar + package: adaptive-expressions-ie11 + summary: '' + fullName: EscapeChar + remarks: '' + isDeprecated: false + syntax: + content: 'static EscapeChar: 5 = 5' + return: + description: '' + type: '5' + - name: EUC + uid: adaptive-expressions-ie11.CommonRegexLexer.EUC + package: adaptive-expressions-ie11 + summary: '' + fullName: EUC + remarks: '' + isDeprecated: false + syntax: + content: 'static EUC: 74 = 74' + return: + description: '' + type: '74' + - name: Exclamation + uid: adaptive-expressions-ie11.CommonRegexLexer.Exclamation + package: adaptive-expressions-ie11 + summary: '' + fullName: Exclamation + remarks: '' + isDeprecated: false + syntax: + content: 'static Exclamation: 42 = 42' + return: + description: '' + type: '42' + - name: FLC + uid: adaptive-expressions-ie11.CommonRegexLexer.FLC + package: adaptive-expressions-ie11 + summary: '' + fullName: FLC + remarks: '' + isDeprecated: false + syntax: + content: 'static FLC: 49 = 49' + return: + description: '' + type: '49' + - name: FormFeed + uid: adaptive-expressions-ie11.CommonRegexLexer.FormFeed + package: adaptive-expressions-ie11 + summary: '' + fullName: FormFeed + remarks: '' + isDeprecated: false + syntax: + content: 'static FormFeed: 6 = 6' + return: + description: '' + type: '6' + - name: FUC + uid: adaptive-expressions-ie11.CommonRegexLexer.FUC + package: adaptive-expressions-ie11 + summary: '' + fullName: FUC + remarks: '' + isDeprecated: false + syntax: + content: 'static FUC: 75 = 75' + return: + description: '' + type: '75' + - name: GLC + uid: adaptive-expressions-ie11.CommonRegexLexer.GLC + package: adaptive-expressions-ie11 + summary: '' + fullName: GLC + remarks: '' + isDeprecated: false + syntax: + content: 'static GLC: 50 = 50' + return: + description: '' + type: '50' + - name: grammarFileName + uid: adaptive-expressions-ie11.CommonRegexLexer.grammarFileName + package: adaptive-expressions-ie11 + summary: '' + fullName: grammarFileName + remarks: '' + isDeprecated: false + syntax: + content: 'grammarFileName: string' + return: + description: '' + type: string + - name: GreaterThan + uid: adaptive-expressions-ie11.CommonRegexLexer.GreaterThan + package: adaptive-expressions-ie11 + summary: '' + fullName: GreaterThan + remarks: '' + isDeprecated: false + syntax: + content: 'static GreaterThan: 36 = 36' + return: + description: '' + type: '36' + - name: GUC + uid: adaptive-expressions-ie11.CommonRegexLexer.GUC + package: adaptive-expressions-ie11 + summary: '' + fullName: GUC + remarks: '' + isDeprecated: false + syntax: + content: 'static GUC: 76 = 76' + return: + description: '' + type: '76' + - name: Hash + uid: adaptive-expressions-ie11.CommonRegexLexer.Hash + package: adaptive-expressions-ie11 + summary: '' + fullName: Hash + remarks: '' + isDeprecated: false + syntax: + content: 'static Hash: 40 = 40' + return: + description: '' + type: '40' + - name: HexChar + uid: adaptive-expressions-ie11.CommonRegexLexer.HexChar + package: adaptive-expressions-ie11 + summary: '' + fullName: HexChar + remarks: '' + isDeprecated: false + syntax: + content: 'static HexChar: 11 = 11' + return: + description: '' + type: '11' + - name: HLC + uid: adaptive-expressions-ie11.CommonRegexLexer.HLC + package: adaptive-expressions-ie11 + summary: '' + fullName: HLC + remarks: '' + isDeprecated: false + syntax: + content: 'static HLC: 51 = 51' + return: + description: '' + type: '51' + - name: HUC + uid: adaptive-expressions-ie11.CommonRegexLexer.HUC + package: adaptive-expressions-ie11 + summary: '' + fullName: HUC + remarks: '' + isDeprecated: false + syntax: + content: 'static HUC: 77 = 77' + return: + description: '' + type: '77' + - name: Hyphen + uid: adaptive-expressions-ie11.CommonRegexLexer.Hyphen + package: adaptive-expressions-ie11 + summary: '' + fullName: Hyphen + remarks: '' + isDeprecated: false + syntax: + content: 'static Hyphen: 24 = 24' + return: + description: '' + type: '24' + - name: ILC + uid: adaptive-expressions-ie11.CommonRegexLexer.ILC + package: adaptive-expressions-ie11 + summary: '' + fullName: ILC + remarks: '' + isDeprecated: false + syntax: + content: 'static ILC: 52 = 52' + return: + description: '' + type: '52' + - name: IUC + uid: adaptive-expressions-ie11.CommonRegexLexer.IUC + package: adaptive-expressions-ie11 + summary: '' + fullName: IUC + remarks: '' + isDeprecated: false + syntax: + content: 'static IUC: 78 = 78' + return: + description: '' + type: '78' + - name: JLC + uid: adaptive-expressions-ie11.CommonRegexLexer.JLC + package: adaptive-expressions-ie11 + summary: '' + fullName: JLC + remarks: '' + isDeprecated: false + syntax: + content: 'static JLC: 53 = 53' + return: + description: '' + type: '53' + - name: JUC + uid: adaptive-expressions-ie11.CommonRegexLexer.JUC + package: adaptive-expressions-ie11 + summary: '' + fullName: JUC + remarks: '' + isDeprecated: false + syntax: + content: 'static JUC: 79 = 79' + return: + description: '' + type: '79' + - name: KLC + uid: adaptive-expressions-ie11.CommonRegexLexer.KLC + package: adaptive-expressions-ie11 + summary: '' + fullName: KLC + remarks: '' + isDeprecated: false + syntax: + content: 'static KLC: 54 = 54' + return: + description: '' + type: '54' + - name: KUC + uid: adaptive-expressions-ie11.CommonRegexLexer.KUC + package: adaptive-expressions-ie11 + summary: '' + fullName: KUC + remarks: '' + isDeprecated: false + syntax: + content: 'static KUC: 80 = 80' + return: + description: '' + type: '80' + - name: LessThan + uid: adaptive-expressions-ie11.CommonRegexLexer.LessThan + package: adaptive-expressions-ie11 + summary: '' + fullName: LessThan + remarks: '' + isDeprecated: false + syntax: + content: 'static LessThan: 35 = 35' + return: + description: '' + type: '35' + - name: LLC + uid: adaptive-expressions-ie11.CommonRegexLexer.LLC + package: adaptive-expressions-ie11 + summary: '' + fullName: LLC + remarks: '' + isDeprecated: false + syntax: + content: 'static LLC: 55 = 55' + return: + description: '' + type: '55' + - name: LUC + uid: adaptive-expressions-ie11.CommonRegexLexer.LUC + package: adaptive-expressions-ie11 + summary: '' + fullName: LUC + remarks: '' + isDeprecated: false + syntax: + content: 'static LUC: 81 = 81' + return: + description: '' + type: '81' + - name: MLC + uid: adaptive-expressions-ie11.CommonRegexLexer.MLC + package: adaptive-expressions-ie11 + summary: '' + fullName: MLC + remarks: '' + isDeprecated: false + syntax: + content: 'static MLC: 56 = 56' + return: + description: '' + type: '56' + - name: modeNames + uid: adaptive-expressions-ie11.CommonRegexLexer.modeNames + package: adaptive-expressions-ie11 + summary: '' + fullName: modeNames + remarks: '' + isDeprecated: false + syntax: + content: 'modeNames: string[]' + return: + description: '' + type: string[] + - name: modeNames + uid: adaptive-expressions-ie11.CommonRegexLexer.modeNames + package: adaptive-expressions-ie11 + summary: '' + fullName: modeNames + remarks: '' + isDeprecated: false + syntax: + content: 'static modeNames: string[]' + return: + description: '' + type: string[] + - name: MUC + uid: adaptive-expressions-ie11.CommonRegexLexer.MUC + package: adaptive-expressions-ie11 + summary: '' + fullName: MUC + remarks: '' + isDeprecated: false + syntax: + content: 'static MUC: 82 = 82' + return: + description: '' + type: '82' + - name: NewLine + uid: adaptive-expressions-ie11.CommonRegexLexer.NewLine + package: adaptive-expressions-ie11 + summary: '' + fullName: NewLine + remarks: '' + isDeprecated: false + syntax: + content: 'static NewLine: 7 = 7' + return: + description: '' + type: '7' + - name: NLC + uid: adaptive-expressions-ie11.CommonRegexLexer.NLC + package: adaptive-expressions-ie11 + summary: '' + fullName: NLC + remarks: '' + isDeprecated: false + syntax: + content: 'static NLC: 57 = 57' + return: + description: '' + type: '57' + - name: NotDecimalDigit + uid: adaptive-expressions-ie11.CommonRegexLexer.NotDecimalDigit + package: adaptive-expressions-ie11 + summary: '' + fullName: NotDecimalDigit + remarks: '' + isDeprecated: false + syntax: + content: 'static NotDecimalDigit: 14 = 14' + return: + description: '' + type: '14' + - name: NotWhiteSpace + uid: adaptive-expressions-ie11.CommonRegexLexer.NotWhiteSpace + package: adaptive-expressions-ie11 + summary: '' + fullName: NotWhiteSpace + remarks: '' + isDeprecated: false + syntax: + content: 'static NotWhiteSpace: 18 = 18' + return: + description: '' + type: '18' + - name: NotWordChar + uid: adaptive-expressions-ie11.CommonRegexLexer.NotWordChar + package: adaptive-expressions-ie11 + summary: '' + fullName: NotWordChar + remarks: '' + isDeprecated: false + syntax: + content: 'static NotWordChar: 20 = 20' + return: + description: '' + type: '20' + - name: NUC + uid: adaptive-expressions-ie11.CommonRegexLexer.NUC + package: adaptive-expressions-ie11 + summary: '' + fullName: NUC + remarks: '' + isDeprecated: false + syntax: + content: 'static NUC: 83 = 83' + return: + description: '' + type: '83' + - name: OLC + uid: adaptive-expressions-ie11.CommonRegexLexer.OLC + package: adaptive-expressions-ie11 + summary: '' + fullName: OLC + remarks: '' + isDeprecated: false + syntax: + content: 'static OLC: 58 = 58' + return: + description: '' + type: '58' + - name: OpenBrace + uid: adaptive-expressions-ie11.CommonRegexLexer.OpenBrace + package: adaptive-expressions-ie11 + summary: '' + fullName: OpenBrace + remarks: '' + isDeprecated: false + syntax: + content: 'static OpenBrace: 28 = 28' + return: + description: '' + type: '28' + - name: OpenParen + uid: adaptive-expressions-ie11.CommonRegexLexer.OpenParen + package: adaptive-expressions-ie11 + summary: '' + fullName: OpenParen + remarks: '' + isDeprecated: false + syntax: + content: 'static OpenParen: 33 = 33' + return: + description: '' + type: '33' + - name: OtherChar + uid: adaptive-expressions-ie11.CommonRegexLexer.OtherChar + package: adaptive-expressions-ie11 + summary: '' + fullName: OtherChar + remarks: '' + isDeprecated: false + syntax: + content: 'static OtherChar: 106 = 106' + return: + description: '' + type: '106' + - name: OUC + uid: adaptive-expressions-ie11.CommonRegexLexer.OUC + package: adaptive-expressions-ie11 + summary: '' + fullName: OUC + remarks: '' + isDeprecated: false + syntax: + content: 'static OUC: 84 = 84' + return: + description: '' + type: '84' + - name: Pipe + uid: adaptive-expressions-ie11.CommonRegexLexer.Pipe + package: adaptive-expressions-ie11 + summary: '' + fullName: Pipe + remarks: '' + isDeprecated: false + syntax: + content: 'static Pipe: 32 = 32' + return: + description: '' + type: '32' + - name: PLC + uid: adaptive-expressions-ie11.CommonRegexLexer.PLC + package: adaptive-expressions-ie11 + summary: '' + fullName: PLC + remarks: '' + isDeprecated: false + syntax: + content: 'static PLC: 59 = 59' + return: + description: '' + type: '59' + - name: Plus + uid: adaptive-expressions-ie11.CommonRegexLexer.Plus + package: adaptive-expressions-ie11 + summary: '' + fullName: Plus + remarks: '' + isDeprecated: false + syntax: + content: 'static Plus: 26 = 26' + return: + description: '' + type: '26' + - name: PUC + uid: adaptive-expressions-ie11.CommonRegexLexer.PUC + package: adaptive-expressions-ie11 + summary: '' + fullName: PUC + remarks: '' + isDeprecated: false + syntax: + content: 'static PUC: 85 = 85' + return: + description: '' + type: '85' + - name: QLC + uid: adaptive-expressions-ie11.CommonRegexLexer.QLC + package: adaptive-expressions-ie11 + summary: '' + fullName: QLC + remarks: '' + isDeprecated: false + syntax: + content: 'static QLC: 60 = 60' + return: + description: '' + type: '60' + - name: QUC + uid: adaptive-expressions-ie11.CommonRegexLexer.QUC + package: adaptive-expressions-ie11 + summary: '' + fullName: QUC + remarks: '' + isDeprecated: false + syntax: + content: 'static QUC: 86 = 86' + return: + description: '' + type: '86' + - name: QuestionMark + uid: adaptive-expressions-ie11.CommonRegexLexer.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + fullName: QuestionMark + remarks: '' + isDeprecated: false + syntax: + content: 'static QuestionMark: 25 = 25' + return: + description: '' + type: '25' + - name: Quoted + uid: adaptive-expressions-ie11.CommonRegexLexer.Quoted + package: adaptive-expressions-ie11 + summary: '' + fullName: Quoted + remarks: '' + isDeprecated: false + syntax: + content: 'static Quoted: 1 = 1' + return: + description: '' + type: '1' + - name: RLC + uid: adaptive-expressions-ie11.CommonRegexLexer.RLC + package: adaptive-expressions-ie11 + summary: '' + fullName: RLC + remarks: '' + isDeprecated: false + syntax: + content: 'static RLC: 61 = 61' + return: + description: '' + type: '61' + - name: RUC + uid: adaptive-expressions-ie11.CommonRegexLexer.RUC + package: adaptive-expressions-ie11 + summary: '' + fullName: RUC + remarks: '' + isDeprecated: false + syntax: + content: 'static RUC: 87 = 87' + return: + description: '' + type: '87' + - name: ruleNames + uid: adaptive-expressions-ie11.CommonRegexLexer.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'ruleNames: string[]' + return: + description: '' + type: string[] + - name: ruleNames + uid: adaptive-expressions-ie11.CommonRegexLexer.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'static ruleNames: string[]' + return: + description: '' + type: string[] + - name: serializedATN + uid: adaptive-expressions-ie11.CommonRegexLexer.serializedATN + package: adaptive-expressions-ie11 + summary: '' + fullName: serializedATN + remarks: '' + isDeprecated: false + syntax: + content: 'serializedATN: string' + return: + description: '' + type: string + - name: SingleQuote + uid: adaptive-expressions-ie11.CommonRegexLexer.SingleQuote + package: adaptive-expressions-ie11 + summary: '' + fullName: SingleQuote + remarks: '' + isDeprecated: false + syntax: + content: 'static SingleQuote: 37 = 37' + return: + description: '' + type: '37' + - name: SLC + uid: adaptive-expressions-ie11.CommonRegexLexer.SLC + package: adaptive-expressions-ie11 + summary: '' + fullName: SLC + remarks: '' + isDeprecated: false + syntax: + content: 'static SLC: 62 = 62' + return: + description: '' + type: '62' + - name: Star + uid: adaptive-expressions-ie11.CommonRegexLexer.Star + package: adaptive-expressions-ie11 + summary: '' + fullName: Star + remarks: '' + isDeprecated: false + syntax: + content: 'static Star: 27 = 27' + return: + description: '' + type: '27' + - name: SUC + uid: adaptive-expressions-ie11.CommonRegexLexer.SUC + package: adaptive-expressions-ie11 + summary: '' + fullName: SUC + remarks: '' + isDeprecated: false + syntax: + content: 'static SUC: 88 = 88' + return: + description: '' + type: '88' + - name: Tab + uid: adaptive-expressions-ie11.CommonRegexLexer.Tab + package: adaptive-expressions-ie11 + summary: '' + fullName: Tab + remarks: '' + isDeprecated: false + syntax: + content: 'static Tab: 9 = 9' + return: + description: '' + type: '9' + - name: TLC + uid: adaptive-expressions-ie11.CommonRegexLexer.TLC + package: adaptive-expressions-ie11 + summary: '' + fullName: TLC + remarks: '' + isDeprecated: false + syntax: + content: 'static TLC: 63 = 63' + return: + description: '' + type: '63' + - name: TUC + uid: adaptive-expressions-ie11.CommonRegexLexer.TUC + package: adaptive-expressions-ie11 + summary: '' + fullName: TUC + remarks: '' + isDeprecated: false + syntax: + content: 'static TUC: 89 = 89' + return: + description: '' + type: '89' + - name: ULC + uid: adaptive-expressions-ie11.CommonRegexLexer.ULC + package: adaptive-expressions-ie11 + summary: '' + fullName: ULC + remarks: '' + isDeprecated: false + syntax: + content: 'static ULC: 64 = 64' + return: + description: '' + type: '64' + - name: Underscore + uid: adaptive-expressions-ie11.CommonRegexLexer.Underscore + package: adaptive-expressions-ie11 + summary: '' + fullName: Underscore + remarks: '' + isDeprecated: false + syntax: + content: 'static Underscore: 38 = 38' + return: + description: '' + type: '38' + - name: UUC + uid: adaptive-expressions-ie11.CommonRegexLexer.UUC + package: adaptive-expressions-ie11 + summary: '' + fullName: UUC + remarks: '' + isDeprecated: false + syntax: + content: 'static UUC: 90 = 90' + return: + description: '' + type: '90' + - name: VLC + uid: adaptive-expressions-ie11.CommonRegexLexer.VLC + package: adaptive-expressions-ie11 + summary: '' + fullName: VLC + remarks: '' + isDeprecated: false + syntax: + content: 'static VLC: 65 = 65' + return: + description: '' + type: '65' + - name: vocabulary + uid: adaptive-expressions-ie11.CommonRegexLexer.vocabulary + package: adaptive-expressions-ie11 + summary: '' + fullName: vocabulary + remarks: '' + isDeprecated: false + syntax: + content: 'vocabulary: Vocabulary' + return: + description: '' + type: Vocabulary + - name: VOCABULARY + uid: adaptive-expressions-ie11.CommonRegexLexer.VOCABULARY + package: adaptive-expressions-ie11 + summary: '' + fullName: VOCABULARY + remarks: '' + isDeprecated: false + syntax: + content: 'static VOCABULARY: Vocabulary' + return: + description: '' + type: Vocabulary + - name: VUC + uid: adaptive-expressions-ie11.CommonRegexLexer.VUC + package: adaptive-expressions-ie11 + summary: '' + fullName: VUC + remarks: '' + isDeprecated: false + syntax: + content: 'static VUC: 91 = 91' + return: + description: '' + type: '91' + - name: WhiteSpace + uid: adaptive-expressions-ie11.CommonRegexLexer.WhiteSpace + package: adaptive-expressions-ie11 + summary: '' + fullName: WhiteSpace + remarks: '' + isDeprecated: false + syntax: + content: 'static WhiteSpace: 17 = 17' + return: + description: '' + type: '17' + - name: WLC + uid: adaptive-expressions-ie11.CommonRegexLexer.WLC + package: adaptive-expressions-ie11 + summary: '' + fullName: WLC + remarks: '' + isDeprecated: false + syntax: + content: 'static WLC: 66 = 66' + return: + description: '' + type: '66' + - name: WordChar + uid: adaptive-expressions-ie11.CommonRegexLexer.WordChar + package: adaptive-expressions-ie11 + summary: '' + fullName: WordChar + remarks: '' + isDeprecated: false + syntax: + content: 'static WordChar: 19 = 19' + return: + description: '' + type: '19' + - name: WUC + uid: adaptive-expressions-ie11.CommonRegexLexer.WUC + package: adaptive-expressions-ie11 + summary: '' + fullName: WUC + remarks: '' + isDeprecated: false + syntax: + content: 'static WUC: 92 = 92' + return: + description: '' + type: '92' + - name: XLC + uid: adaptive-expressions-ie11.CommonRegexLexer.XLC + package: adaptive-expressions-ie11 + summary: '' + fullName: XLC + remarks: '' + isDeprecated: false + syntax: + content: 'static XLC: 67 = 67' + return: + description: '' + type: '67' + - name: XUC + uid: adaptive-expressions-ie11.CommonRegexLexer.XUC + package: adaptive-expressions-ie11 + summary: '' + fullName: XUC + remarks: '' + isDeprecated: false + syntax: + content: 'static XUC: 93 = 93' + return: + description: '' + type: '93' + - name: YLC + uid: adaptive-expressions-ie11.CommonRegexLexer.YLC + package: adaptive-expressions-ie11 + summary: '' + fullName: YLC + remarks: '' + isDeprecated: false + syntax: + content: 'static YLC: 68 = 68' + return: + description: '' + type: '68' + - name: YUC + uid: adaptive-expressions-ie11.CommonRegexLexer.YUC + package: adaptive-expressions-ie11 + summary: '' + fullName: YUC + remarks: '' + isDeprecated: false + syntax: + content: 'static YUC: 94 = 94' + return: + description: '' + type: '94' + - name: ZLC + uid: adaptive-expressions-ie11.CommonRegexLexer.ZLC + package: adaptive-expressions-ie11 + summary: '' + fullName: ZLC + remarks: '' + isDeprecated: false + syntax: + content: 'static ZLC: 69 = 69' + return: + description: '' + type: '69' + - name: ZUC + uid: adaptive-expressions-ie11.CommonRegexLexer.ZUC + package: adaptive-expressions-ie11 + summary: '' + fullName: ZUC + remarks: '' + isDeprecated: false + syntax: + content: 'static ZUC: 95 = 95' + return: + description: '' + type: '95' +inheritedProperties: + - name: atn + uid: adaptive-expressions-ie11.CommonRegexLexer.atn + package: adaptive-expressions-ie11 + summary: >- + Get the + used by the recognizer for prediction. + fullName: atn + remarks: '' + isDeprecated: false + syntax: + content: 'atn: ATN' + return: + description: >- + The + used by the recognizer for prediction. + type: ATN + inheritanceDescription: Inherited From Lexer.atn + - name: channel + uid: adaptive-expressions-ie11.CommonRegexLexer.channel + package: adaptive-expressions-ie11 + summary: '' + fullName: channel + remarks: '' + isDeprecated: false + syntax: + content: 'channel: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.channel + - name: charIndex + uid: adaptive-expressions-ie11.CommonRegexLexer.charIndex + package: adaptive-expressions-ie11 + summary: What is the index of the current character of lookahead? + fullName: charIndex + remarks: '' + isDeprecated: false + syntax: + content: 'charIndex: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.charIndex + - name: charPositionInLine + uid: adaptive-expressions-ie11.CommonRegexLexer.charPositionInLine + package: adaptive-expressions-ie11 + summary: '' + fullName: charPositionInLine + remarks: '' + isDeprecated: false + syntax: + content: 'charPositionInLine: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.charPositionInLine + - name: DEFAULT_MODE + uid: adaptive-expressions-ie11.CommonRegexLexer.DEFAULT_MODE + package: adaptive-expressions-ie11 + summary: '' + fullName: DEFAULT_MODE + remarks: '' + isDeprecated: false + syntax: + content: 'static DEFAULT_MODE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.DEFAULT_MODE + - name: DEFAULT_TOKEN_CHANNEL + uid: adaptive-expressions-ie11.CommonRegexLexer.DEFAULT_TOKEN_CHANNEL + package: adaptive-expressions-ie11 + summary: '' + fullName: DEFAULT_TOKEN_CHANNEL + remarks: '' + isDeprecated: false + syntax: + content: 'static DEFAULT_TOKEN_CHANNEL: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.DEFAULT_TOKEN_CHANNEL + - name: EOF + uid: adaptive-expressions-ie11.CommonRegexLexer.EOF + package: adaptive-expressions-ie11 + summary: '' + fullName: EOF + remarks: '' + isDeprecated: false + syntax: + content: 'static EOF: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.EOF + - name: HIDDEN + uid: adaptive-expressions-ie11.CommonRegexLexer.HIDDEN + package: adaptive-expressions-ie11 + summary: '' + fullName: HIDDEN + remarks: '' + isDeprecated: false + syntax: + content: 'static HIDDEN: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.HIDDEN + - name: inputStream + uid: adaptive-expressions-ie11.CommonRegexLexer.inputStream + package: adaptive-expressions-ie11 + summary: Set the char stream and reset the lexer + fullName: inputStream + remarks: '' + isDeprecated: false + syntax: + content: 'inputStream: CharStream' + return: + description: '' + type: CharStream + inheritanceDescription: Inherited From Lexer.inputStream + - name: interpreter + uid: adaptive-expressions-ie11.CommonRegexLexer.interpreter + package: adaptive-expressions-ie11 + summary: Set the ATN interpreter used by the recognizer for prediction. + fullName: interpreter + remarks: '' + isDeprecated: false + syntax: + content: 'interpreter: LexerATNSimulator' + return: + description: '' + type: LexerATNSimulator + inheritanceDescription: Inherited From Lexer.interpreter + - name: line + uid: adaptive-expressions-ie11.CommonRegexLexer.line + package: adaptive-expressions-ie11 + summary: '' + fullName: line + remarks: '' + isDeprecated: false + syntax: + content: 'line: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.line + - name: MAX_CHAR_VALUE + uid: adaptive-expressions-ie11.CommonRegexLexer.MAX_CHAR_VALUE + package: adaptive-expressions-ie11 + summary: '' + fullName: MAX_CHAR_VALUE + remarks: '' + isDeprecated: false + syntax: + content: 'static MAX_CHAR_VALUE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.MAX_CHAR_VALUE + - name: MIN_CHAR_VALUE + uid: adaptive-expressions-ie11.CommonRegexLexer.MIN_CHAR_VALUE + package: adaptive-expressions-ie11 + summary: '' + fullName: MIN_CHAR_VALUE + remarks: '' + isDeprecated: false + syntax: + content: 'static MIN_CHAR_VALUE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.MIN_CHAR_VALUE + - name: MORE + uid: adaptive-expressions-ie11.CommonRegexLexer.MORE + package: adaptive-expressions-ie11 + summary: '' + fullName: MORE + remarks: '' + isDeprecated: false + syntax: + content: 'static MORE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.MORE + - name: parseInfo + uid: adaptive-expressions-ie11.CommonRegexLexer.parseInfo + package: adaptive-expressions-ie11 + summary: |- + If profiling during the parse/lex, this will return DecisionInfo records + for each decision in recognizer in a ParseInfo object. + fullName: parseInfo + remarks: '' + isDeprecated: false + syntax: + content: 'parseInfo: Promise' + return: + description: '' + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Lexer.parseInfo + - name: SKIP + uid: adaptive-expressions-ie11.CommonRegexLexer.SKIP + package: adaptive-expressions-ie11 + summary: '' + fullName: SKIP + remarks: '' + isDeprecated: false + syntax: + content: 'static SKIP: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.SKIP + - name: sourceName + uid: adaptive-expressions-ie11.CommonRegexLexer.sourceName + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceName + remarks: '' + isDeprecated: false + syntax: + content: 'sourceName: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.sourceName + - name: state + uid: adaptive-expressions-ie11.CommonRegexLexer.state + package: adaptive-expressions-ie11 + summary: |- + Indicate that the recognizer has changed internal state that is + consistent with the ATN state passed in. This way we always know + where we are in the ATN as the parser goes along. The rule + context objects form a stack that lets us see the stack of + invoking rules. Combine this and we have complete ATN + configuration information. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.state + - name: text + uid: adaptive-expressions-ie11.CommonRegexLexer.text + package: adaptive-expressions-ie11 + summary: |- + Set the complete text of this token; it wipes any previous + changes to the text. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.text + - name: token + uid: adaptive-expressions-ie11.CommonRegexLexer.token + package: adaptive-expressions-ie11 + summary: Override if emitting multiple tokens. + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From Lexer.token + - name: tokenFactory + uid: adaptive-expressions-ie11.CommonRegexLexer.tokenFactory + package: adaptive-expressions-ie11 + summary: '' + fullName: tokenFactory + remarks: '' + isDeprecated: false + syntax: + content: 'tokenFactory: TokenFactory' + return: + description: '' + type: TokenFactory + inheritanceDescription: Inherited From Lexer.tokenFactory + - name: type + uid: adaptive-expressions-ie11.CommonRegexLexer.type + package: adaptive-expressions-ie11 + summary: '' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.type +inheritedMethods: + - name: action(undefined | RuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexLexer.action + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function action(_localctx: undefined | RuleContext, ruleIndex: number, + actionIndex: number) + parameters: + - id: _localctx + type: undefined | RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: actionIndex + type: number + description: '' + inheritanceDescription: Inherited From Lexer.action + - name: addErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.CommonRegexLexer.addErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<number> + description: '' + inheritanceDescription: Inherited From Lexer.addErrorListener + - name: emit() + uid: adaptive-expressions-ie11.CommonRegexLexer.emit_1 + package: adaptive-expressions-ie11 + summary: |- + By default does not support multiple emits per nextToken invocation + for efficiency reasons. Subclass and override this method, nextToken, + and getToken (to push tokens into a list and pull from that list + rather than a single variable as this implementation does). + remarks: '' + isDeprecated: false + syntax: + content: 'function emit(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.emit + - name: emit(Token) + uid: adaptive-expressions-ie11.CommonRegexLexer.emit + package: adaptive-expressions-ie11 + summary: |- + The standard method called to automatically emit a token at the + outermost lexical rule. The token object should point into the + char buffer start..stop. If there is a text override in 'text', + use that to set the token's text. Override this method to emit + custom Token objects or provide a new factory. + remarks: '' + isDeprecated: false + syntax: + content: 'function emit(token: Token): Token' + parameters: + - id: token + type: Token + description: '' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.emit + - name: emitEOF() + uid: adaptive-expressions-ie11.CommonRegexLexer.emitEOF + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function emitEOF(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.emitEOF + - name: getAllTokens() + uid: adaptive-expressions-ie11.CommonRegexLexer.getAllTokens + package: adaptive-expressions-ie11 + summary: |- + Return a list of all Token objects in input char stream. + Forces load of all tokens. Does not include EOF token. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllTokens(): Token[]' + return: + description: '' + type: Token[] + inheritanceDescription: Inherited From Lexer.getAllTokens + - name: getCharErrorDisplay(number) + uid: adaptive-expressions-ie11.CommonRegexLexer.getCharErrorDisplay + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getCharErrorDisplay(c: number): string' + parameters: + - id: c + type: number + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.getCharErrorDisplay + - name: getErrorDisplay(string | number) + uid: adaptive-expressions-ie11.CommonRegexLexer.getErrorDisplay + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorDisplay(s: string | number): string' + parameters: + - id: s + type: string | number + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.getErrorDisplay + - name: getErrorHeader(RecognitionException) + uid: adaptive-expressions-ie11.CommonRegexLexer.getErrorHeader + package: adaptive-expressions-ie11 + summary: What is the error header, normally line/character position information? + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorHeader(e: RecognitionException): string' + parameters: + - id: e + type: RecognitionException + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.getErrorHeader + - name: getErrorListenerDispatch() + uid: adaptive-expressions-ie11.CommonRegexLexer.getErrorListenerDispatch + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListenerDispatch(): ANTLRErrorListener' + return: + description: '' + type: ANTLRErrorListener<number> + inheritanceDescription: Inherited From Lexer.getErrorListenerDispatch + - name: getErrorListeners() + uid: adaptive-expressions-ie11.CommonRegexLexer.getErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListeners(): ANTLRErrorListener[]' + return: + description: '' + type: ANTLRErrorListener<number>[] + inheritanceDescription: Inherited From Lexer.getErrorListeners + - name: getRuleIndexMap() + uid: adaptive-expressions-ie11.CommonRegexLexer.getRuleIndexMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from rule names to rule indexes. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleIndexMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getRuleIndexMap + - name: getTokenType(string) + uid: adaptive-expressions-ie11.CommonRegexLexer.getTokenType + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenType(tokenName: string): number' + parameters: + - id: tokenName + type: string + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.getTokenType + - name: getTokenTypeMap() + uid: adaptive-expressions-ie11.CommonRegexLexer.getTokenTypeMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from token names to token types. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenTypeMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getTokenTypeMap + - name: mode(number) + uid: adaptive-expressions-ie11.CommonRegexLexer.mode + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function mode(m: number)' + parameters: + - id: m + type: number + description: '' + inheritanceDescription: Inherited From Lexer.mode + - name: more() + uid: adaptive-expressions-ie11.CommonRegexLexer.more + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function more() + inheritanceDescription: Inherited From Lexer.more + - name: nextToken() + uid: adaptive-expressions-ie11.CommonRegexLexer.nextToken + package: adaptive-expressions-ie11 + summary: |- + Return a token from this source; i.e., match a token on the char + stream. + remarks: '' + isDeprecated: false + syntax: + content: 'function nextToken(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.nextToken + - name: notifyListeners(LexerNoViableAltException) + uid: adaptive-expressions-ie11.CommonRegexLexer.notifyListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function notifyListeners(e: LexerNoViableAltException)' + parameters: + - id: e + type: LexerNoViableAltException + description: '' + inheritanceDescription: Inherited From Lexer.notifyListeners + - name: popMode() + uid: adaptive-expressions-ie11.CommonRegexLexer.popMode + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function popMode(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.popMode + - name: precpred(undefined | RuleContext, number) + uid: adaptive-expressions-ie11.CommonRegexLexer.precpred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function precpred(localctx: undefined | RuleContext, precedence: + number): boolean + parameters: + - id: localctx + type: undefined | RuleContext + description: '' + - id: precedence + type: number + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Lexer.precpred + - name: pushMode(number) + uid: adaptive-expressions-ie11.CommonRegexLexer.pushMode + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function pushMode(m: number)' + parameters: + - id: m + type: number + description: '' + inheritanceDescription: Inherited From Lexer.pushMode + - name: recover(LexerNoViableAltException) + uid: adaptive-expressions-ie11.CommonRegexLexer.recover_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function recover(re: LexerNoViableAltException)' + parameters: + - id: re + type: LexerNoViableAltException + description: '' + inheritanceDescription: Inherited From Lexer.recover + - name: recover(RecognitionException) + uid: adaptive-expressions-ie11.CommonRegexLexer.recover + package: adaptive-expressions-ie11 + summary: |- + Lexers can normally match any char in it's vocabulary after matching + a token, so do the easy thing and just kill a character and hope + it all works out. You can instead use the rule invocation stack + to do sophisticated error recovery if you are in a fragment rule. + remarks: '' + isDeprecated: false + syntax: + content: 'function recover(re: RecognitionException)' + parameters: + - id: re + type: RecognitionException + description: '' + inheritanceDescription: Inherited From Lexer.recover + - name: removeErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.CommonRegexLexer.removeErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<number> + description: '' + inheritanceDescription: Inherited From Lexer.removeErrorListener + - name: removeErrorListeners() + uid: adaptive-expressions-ie11.CommonRegexLexer.removeErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function removeErrorListeners() + inheritanceDescription: Inherited From Lexer.removeErrorListeners + - name: reset() + uid: adaptive-expressions-ie11.CommonRegexLexer.reset + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function reset() + inheritanceDescription: Inherited From Lexer.reset + - name: reset(boolean) + uid: adaptive-expressions-ie11.CommonRegexLexer.reset_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reset(resetInput: boolean)' + parameters: + - id: resetInput + type: boolean + description: '' + inheritanceDescription: Inherited From Lexer.reset + - name: sempred(undefined | RuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexLexer.sempred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function sempred(_localctx: undefined | RuleContext, ruleIndex: number, + actionIndex: number): boolean + parameters: + - id: _localctx + type: undefined | RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: actionIndex + type: number + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Lexer.sempred + - name: skip() + uid: adaptive-expressions-ie11.CommonRegexLexer.skip + package: adaptive-expressions-ie11 + summary: |- + Instruct the lexer to skip creating a token for current lexer rule + and look for another token. nextToken() knows to keep looking when + a lexer rule finishes with token set to SKIP_TOKEN. Recall that + if token==undefined at end of any token rule, it creates one for you + and emits it. + remarks: '' + isDeprecated: false + syntax: + content: function skip() + inheritanceDescription: Inherited From Lexer.skip +extends: Lexer diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexListener.yml new file mode 100644 index 00000000..5bee9a04 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexListener.yml @@ -0,0 +1,714 @@ +### YamlMime:TSType +name: CommonRegexListener +uid: adaptive-expressions-ie11.CommonRegexListener +package: adaptive-expressions-ie11 +summary: |- + This interface defines a complete listener for a parse tree produced by + `CommonRegexParser`. +fullName: CommonRegexListener +remarks: '' +isDeprecated: false +type: interface +properties: + - name: enterAlpha_nums + uid: adaptive-expressions-ie11.CommonRegexListener.enterAlpha_nums + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.alpha_nums`. + fullName: enterAlpha_nums + remarks: '' + isDeprecated: false + syntax: + content: 'enterAlpha_nums?: (ctx: Alpha_numsContext) => void' + return: + description: '' + type: '(ctx: Alpha_numsContext) => void' + - name: enterAlternation + uid: adaptive-expressions-ie11.CommonRegexListener.enterAlternation + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.alternation`. + fullName: enterAlternation + remarks: '' + isDeprecated: false + syntax: + content: 'enterAlternation?: (ctx: AlternationContext) => void' + return: + description: '' + type: '(ctx: AlternationContext) => void' + - name: enterAtom + uid: adaptive-expressions-ie11.CommonRegexListener.enterAtom + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.atom`. + fullName: enterAtom + remarks: '' + isDeprecated: false + syntax: + content: 'enterAtom?: (ctx: AtomContext) => void' + return: + description: '' + type: '(ctx: AtomContext) => void' + - name: enterCapture + uid: adaptive-expressions-ie11.CommonRegexListener.enterCapture + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.capture`. + fullName: enterCapture + remarks: '' + isDeprecated: false + syntax: + content: 'enterCapture?: (ctx: CaptureContext) => void' + return: + description: '' + type: '(ctx: CaptureContext) => void' + - name: enterCc_atom + uid: adaptive-expressions-ie11.CommonRegexListener.enterCc_atom + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.cc_atom`. + fullName: enterCc_atom + remarks: '' + isDeprecated: false + syntax: + content: 'enterCc_atom?: (ctx: Cc_atomContext) => void' + return: + description: '' + type: '(ctx: Cc_atomContext) => void' + - name: enterCc_literal + uid: adaptive-expressions-ie11.CommonRegexListener.enterCc_literal + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.cc_literal`. + fullName: enterCc_literal + remarks: '' + isDeprecated: false + syntax: + content: 'enterCc_literal?: (ctx: Cc_literalContext) => void' + return: + description: '' + type: '(ctx: Cc_literalContext) => void' + - name: enterCharacter_class + uid: adaptive-expressions-ie11.CommonRegexListener.enterCharacter_class + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.character_class`. + fullName: enterCharacter_class + remarks: '' + isDeprecated: false + syntax: + content: 'enterCharacter_class?: (ctx: Character_classContext) => void' + return: + description: '' + type: '(ctx: Character_classContext) => void' + - name: enterDigit + uid: adaptive-expressions-ie11.CommonRegexListener.enterDigit + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.digit`. + fullName: enterDigit + remarks: '' + isDeprecated: false + syntax: + content: 'enterDigit?: (ctx: DigitContext) => void' + return: + description: '' + type: '(ctx: DigitContext) => void' + - name: enterDigits + uid: adaptive-expressions-ie11.CommonRegexListener.enterDigits + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.digits`. + fullName: enterDigits + remarks: '' + isDeprecated: false + syntax: + content: 'enterDigits?: (ctx: DigitsContext) => void' + return: + description: '' + type: '(ctx: DigitsContext) => void' + - name: enterElement + uid: adaptive-expressions-ie11.CommonRegexListener.enterElement + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.element`. + fullName: enterElement + remarks: '' + isDeprecated: false + syntax: + content: 'enterElement?: (ctx: ElementContext) => void' + return: + description: '' + type: '(ctx: ElementContext) => void' + - name: enterExpr + uid: adaptive-expressions-ie11.CommonRegexListener.enterExpr + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.expr`. + fullName: enterExpr + remarks: '' + isDeprecated: false + syntax: + content: 'enterExpr?: (ctx: ExprContext) => void' + return: + description: '' + type: '(ctx: ExprContext) => void' + - name: enterLetter + uid: adaptive-expressions-ie11.CommonRegexListener.enterLetter + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.letter`. + fullName: enterLetter + remarks: '' + isDeprecated: false + syntax: + content: 'enterLetter?: (ctx: LetterContext) => void' + return: + description: '' + type: '(ctx: LetterContext) => void' + - name: enterLiteral + uid: adaptive-expressions-ie11.CommonRegexListener.enterLiteral + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.literal`. + fullName: enterLiteral + remarks: '' + isDeprecated: false + syntax: + content: 'enterLiteral?: (ctx: LiteralContext) => void' + return: + description: '' + type: '(ctx: LiteralContext) => void' + - name: enterName + uid: adaptive-expressions-ie11.CommonRegexListener.enterName + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.name`. + fullName: enterName + remarks: '' + isDeprecated: false + syntax: + content: 'enterName?: (ctx: NameContext) => void' + return: + description: '' + type: '(ctx: NameContext) => void' + - name: enterNon_capture + uid: adaptive-expressions-ie11.CommonRegexListener.enterNon_capture + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.non_capture`. + fullName: enterNon_capture + remarks: '' + isDeprecated: false + syntax: + content: 'enterNon_capture?: (ctx: Non_captureContext) => void' + return: + description: '' + type: '(ctx: Non_captureContext) => void' + - name: enterNon_close_paren + uid: adaptive-expressions-ie11.CommonRegexListener.enterNon_close_paren + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.non_close_paren`. + fullName: enterNon_close_paren + remarks: '' + isDeprecated: false + syntax: + content: 'enterNon_close_paren?: (ctx: Non_close_parenContext) => void' + return: + description: '' + type: '(ctx: Non_close_parenContext) => void' + - name: enterNon_close_parens + uid: adaptive-expressions-ie11.CommonRegexListener.enterNon_close_parens + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.non_close_parens`. + fullName: enterNon_close_parens + remarks: '' + isDeprecated: false + syntax: + content: 'enterNon_close_parens?: (ctx: Non_close_parensContext) => void' + return: + description: '' + type: '(ctx: Non_close_parensContext) => void' + - name: enterNumber + uid: adaptive-expressions-ie11.CommonRegexListener.enterNumber + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.number`. + fullName: enterNumber + remarks: '' + isDeprecated: false + syntax: + content: 'enterNumber?: (ctx: NumberContext) => void' + return: + description: '' + type: '(ctx: NumberContext) => void' + - name: enterOctal_char + uid: adaptive-expressions-ie11.CommonRegexListener.enterOctal_char + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.octal_char`. + fullName: enterOctal_char + remarks: '' + isDeprecated: false + syntax: + content: 'enterOctal_char?: (ctx: Octal_charContext) => void' + return: + description: '' + type: '(ctx: Octal_charContext) => void' + - name: enterOctal_digit + uid: adaptive-expressions-ie11.CommonRegexListener.enterOctal_digit + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.octal_digit`. + fullName: enterOctal_digit + remarks: '' + isDeprecated: false + syntax: + content: 'enterOctal_digit?: (ctx: Octal_digitContext) => void' + return: + description: '' + type: '(ctx: Octal_digitContext) => void' + - name: enterOption + uid: adaptive-expressions-ie11.CommonRegexListener.enterOption + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.option`. + fullName: enterOption + remarks: '' + isDeprecated: false + syntax: + content: 'enterOption?: (ctx: OptionContext) => void' + return: + description: '' + type: '(ctx: OptionContext) => void' + - name: enterOption_flag + uid: adaptive-expressions-ie11.CommonRegexListener.enterOption_flag + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.option_flag`. + fullName: enterOption_flag + remarks: '' + isDeprecated: false + syntax: + content: 'enterOption_flag?: (ctx: Option_flagContext) => void' + return: + description: '' + type: '(ctx: Option_flagContext) => void' + - name: enterParse + uid: adaptive-expressions-ie11.CommonRegexListener.enterParse + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.parse`. + fullName: enterParse + remarks: '' + isDeprecated: false + syntax: + content: 'enterParse?: (ctx: ParseContext) => void' + return: + description: '' + type: '(ctx: ParseContext) => void' + - name: enterQuantifier + uid: adaptive-expressions-ie11.CommonRegexListener.enterQuantifier + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.quantifier`. + fullName: enterQuantifier + remarks: '' + isDeprecated: false + syntax: + content: 'enterQuantifier?: (ctx: QuantifierContext) => void' + return: + description: '' + type: '(ctx: QuantifierContext) => void' + - name: enterQuantifier_type + uid: adaptive-expressions-ie11.CommonRegexListener.enterQuantifier_type + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.quantifier_type`. + fullName: enterQuantifier_type + remarks: '' + isDeprecated: false + syntax: + content: 'enterQuantifier_type?: (ctx: Quantifier_typeContext) => void' + return: + description: '' + type: '(ctx: Quantifier_typeContext) => void' + - name: enterShared_atom + uid: adaptive-expressions-ie11.CommonRegexListener.enterShared_atom + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.shared_atom`. + fullName: enterShared_atom + remarks: '' + isDeprecated: false + syntax: + content: 'enterShared_atom?: (ctx: Shared_atomContext) => void' + return: + description: '' + type: '(ctx: Shared_atomContext) => void' + - name: enterShared_literal + uid: adaptive-expressions-ie11.CommonRegexListener.enterShared_literal + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `CommonRegexParser.shared_literal`. + fullName: enterShared_literal + remarks: '' + isDeprecated: false + syntax: + content: 'enterShared_literal?: (ctx: Shared_literalContext) => void' + return: + description: '' + type: '(ctx: Shared_literalContext) => void' + - name: exitAlpha_nums + uid: adaptive-expressions-ie11.CommonRegexListener.exitAlpha_nums + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.alpha_nums`. + fullName: exitAlpha_nums + remarks: '' + isDeprecated: false + syntax: + content: 'exitAlpha_nums?: (ctx: Alpha_numsContext) => void' + return: + description: '' + type: '(ctx: Alpha_numsContext) => void' + - name: exitAlternation + uid: adaptive-expressions-ie11.CommonRegexListener.exitAlternation + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.alternation`. + fullName: exitAlternation + remarks: '' + isDeprecated: false + syntax: + content: 'exitAlternation?: (ctx: AlternationContext) => void' + return: + description: '' + type: '(ctx: AlternationContext) => void' + - name: exitAtom + uid: adaptive-expressions-ie11.CommonRegexListener.exitAtom + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.atom`. + fullName: exitAtom + remarks: '' + isDeprecated: false + syntax: + content: 'exitAtom?: (ctx: AtomContext) => void' + return: + description: '' + type: '(ctx: AtomContext) => void' + - name: exitCapture + uid: adaptive-expressions-ie11.CommonRegexListener.exitCapture + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.capture`. + fullName: exitCapture + remarks: '' + isDeprecated: false + syntax: + content: 'exitCapture?: (ctx: CaptureContext) => void' + return: + description: '' + type: '(ctx: CaptureContext) => void' + - name: exitCc_atom + uid: adaptive-expressions-ie11.CommonRegexListener.exitCc_atom + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.cc_atom`. + fullName: exitCc_atom + remarks: '' + isDeprecated: false + syntax: + content: 'exitCc_atom?: (ctx: Cc_atomContext) => void' + return: + description: '' + type: '(ctx: Cc_atomContext) => void' + - name: exitCc_literal + uid: adaptive-expressions-ie11.CommonRegexListener.exitCc_literal + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.cc_literal`. + fullName: exitCc_literal + remarks: '' + isDeprecated: false + syntax: + content: 'exitCc_literal?: (ctx: Cc_literalContext) => void' + return: + description: '' + type: '(ctx: Cc_literalContext) => void' + - name: exitCharacter_class + uid: adaptive-expressions-ie11.CommonRegexListener.exitCharacter_class + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.character_class`. + fullName: exitCharacter_class + remarks: '' + isDeprecated: false + syntax: + content: 'exitCharacter_class?: (ctx: Character_classContext) => void' + return: + description: '' + type: '(ctx: Character_classContext) => void' + - name: exitDigit + uid: adaptive-expressions-ie11.CommonRegexListener.exitDigit + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.digit`. + fullName: exitDigit + remarks: '' + isDeprecated: false + syntax: + content: 'exitDigit?: (ctx: DigitContext) => void' + return: + description: '' + type: '(ctx: DigitContext) => void' + - name: exitDigits + uid: adaptive-expressions-ie11.CommonRegexListener.exitDigits + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.digits`. + fullName: exitDigits + remarks: '' + isDeprecated: false + syntax: + content: 'exitDigits?: (ctx: DigitsContext) => void' + return: + description: '' + type: '(ctx: DigitsContext) => void' + - name: exitElement + uid: adaptive-expressions-ie11.CommonRegexListener.exitElement + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.element`. + fullName: exitElement + remarks: '' + isDeprecated: false + syntax: + content: 'exitElement?: (ctx: ElementContext) => void' + return: + description: '' + type: '(ctx: ElementContext) => void' + - name: exitExpr + uid: adaptive-expressions-ie11.CommonRegexListener.exitExpr + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.expr`. + fullName: exitExpr + remarks: '' + isDeprecated: false + syntax: + content: 'exitExpr?: (ctx: ExprContext) => void' + return: + description: '' + type: '(ctx: ExprContext) => void' + - name: exitLetter + uid: adaptive-expressions-ie11.CommonRegexListener.exitLetter + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.letter`. + fullName: exitLetter + remarks: '' + isDeprecated: false + syntax: + content: 'exitLetter?: (ctx: LetterContext) => void' + return: + description: '' + type: '(ctx: LetterContext) => void' + - name: exitLiteral + uid: adaptive-expressions-ie11.CommonRegexListener.exitLiteral + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.literal`. + fullName: exitLiteral + remarks: '' + isDeprecated: false + syntax: + content: 'exitLiteral?: (ctx: LiteralContext) => void' + return: + description: '' + type: '(ctx: LiteralContext) => void' + - name: exitName + uid: adaptive-expressions-ie11.CommonRegexListener.exitName + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.name`. + fullName: exitName + remarks: '' + isDeprecated: false + syntax: + content: 'exitName?: (ctx: NameContext) => void' + return: + description: '' + type: '(ctx: NameContext) => void' + - name: exitNon_capture + uid: adaptive-expressions-ie11.CommonRegexListener.exitNon_capture + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.non_capture`. + fullName: exitNon_capture + remarks: '' + isDeprecated: false + syntax: + content: 'exitNon_capture?: (ctx: Non_captureContext) => void' + return: + description: '' + type: '(ctx: Non_captureContext) => void' + - name: exitNon_close_paren + uid: adaptive-expressions-ie11.CommonRegexListener.exitNon_close_paren + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.non_close_paren`. + fullName: exitNon_close_paren + remarks: '' + isDeprecated: false + syntax: + content: 'exitNon_close_paren?: (ctx: Non_close_parenContext) => void' + return: + description: '' + type: '(ctx: Non_close_parenContext) => void' + - name: exitNon_close_parens + uid: adaptive-expressions-ie11.CommonRegexListener.exitNon_close_parens + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.non_close_parens`. + fullName: exitNon_close_parens + remarks: '' + isDeprecated: false + syntax: + content: 'exitNon_close_parens?: (ctx: Non_close_parensContext) => void' + return: + description: '' + type: '(ctx: Non_close_parensContext) => void' + - name: exitNumber + uid: adaptive-expressions-ie11.CommonRegexListener.exitNumber + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.number`. + fullName: exitNumber + remarks: '' + isDeprecated: false + syntax: + content: 'exitNumber?: (ctx: NumberContext) => void' + return: + description: '' + type: '(ctx: NumberContext) => void' + - name: exitOctal_char + uid: adaptive-expressions-ie11.CommonRegexListener.exitOctal_char + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.octal_char`. + fullName: exitOctal_char + remarks: '' + isDeprecated: false + syntax: + content: 'exitOctal_char?: (ctx: Octal_charContext) => void' + return: + description: '' + type: '(ctx: Octal_charContext) => void' + - name: exitOctal_digit + uid: adaptive-expressions-ie11.CommonRegexListener.exitOctal_digit + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.octal_digit`. + fullName: exitOctal_digit + remarks: '' + isDeprecated: false + syntax: + content: 'exitOctal_digit?: (ctx: Octal_digitContext) => void' + return: + description: '' + type: '(ctx: Octal_digitContext) => void' + - name: exitOption + uid: adaptive-expressions-ie11.CommonRegexListener.exitOption + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.option`. + fullName: exitOption + remarks: '' + isDeprecated: false + syntax: + content: 'exitOption?: (ctx: OptionContext) => void' + return: + description: '' + type: '(ctx: OptionContext) => void' + - name: exitOption_flag + uid: adaptive-expressions-ie11.CommonRegexListener.exitOption_flag + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.option_flag`. + fullName: exitOption_flag + remarks: '' + isDeprecated: false + syntax: + content: 'exitOption_flag?: (ctx: Option_flagContext) => void' + return: + description: '' + type: '(ctx: Option_flagContext) => void' + - name: exitParse + uid: adaptive-expressions-ie11.CommonRegexListener.exitParse + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.parse`. + fullName: exitParse + remarks: '' + isDeprecated: false + syntax: + content: 'exitParse?: (ctx: ParseContext) => void' + return: + description: '' + type: '(ctx: ParseContext) => void' + - name: exitQuantifier + uid: adaptive-expressions-ie11.CommonRegexListener.exitQuantifier + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.quantifier`. + fullName: exitQuantifier + remarks: '' + isDeprecated: false + syntax: + content: 'exitQuantifier?: (ctx: QuantifierContext) => void' + return: + description: '' + type: '(ctx: QuantifierContext) => void' + - name: exitQuantifier_type + uid: adaptive-expressions-ie11.CommonRegexListener.exitQuantifier_type + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.quantifier_type`. + fullName: exitQuantifier_type + remarks: '' + isDeprecated: false + syntax: + content: 'exitQuantifier_type?: (ctx: Quantifier_typeContext) => void' + return: + description: '' + type: '(ctx: Quantifier_typeContext) => void' + - name: exitShared_atom + uid: adaptive-expressions-ie11.CommonRegexListener.exitShared_atom + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.shared_atom`. + fullName: exitShared_atom + remarks: '' + isDeprecated: false + syntax: + content: 'exitShared_atom?: (ctx: Shared_atomContext) => void' + return: + description: '' + type: '(ctx: Shared_atomContext) => void' + - name: exitShared_literal + uid: adaptive-expressions-ie11.CommonRegexListener.exitShared_literal + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `CommonRegexParser.shared_literal`. + fullName: exitShared_literal + remarks: '' + isDeprecated: false + syntax: + content: 'exitShared_literal?: (ctx: Shared_literalContext) => void' + return: + description: '' + type: '(ctx: Shared_literalContext) => void' +inheritedProperties: + - name: enterEveryRule + uid: adaptive-expressions-ie11.CommonRegexListener.enterEveryRule + package: adaptive-expressions-ie11 + summary: '' + fullName: enterEveryRule + remarks: '' + isDeprecated: false + syntax: + content: 'enterEveryRule?: (ctx: ParserRuleContext) => void' + return: + description: '' + type: '(ctx: ParserRuleContext) => void' + inheritanceDescription: Inherited From ParseTreeListener.enterEveryRule + - name: exitEveryRule + uid: adaptive-expressions-ie11.CommonRegexListener.exitEveryRule + package: adaptive-expressions-ie11 + summary: '' + fullName: exitEveryRule + remarks: '' + isDeprecated: false + syntax: + content: 'exitEveryRule?: (ctx: ParserRuleContext) => void' + return: + description: '' + type: '(ctx: ParserRuleContext) => void' + inheritanceDescription: Inherited From ParseTreeListener.exitEveryRule + - name: visitErrorNode + uid: adaptive-expressions-ie11.CommonRegexListener.visitErrorNode + package: adaptive-expressions-ie11 + summary: '' + fullName: visitErrorNode + remarks: '' + isDeprecated: false + syntax: + content: 'visitErrorNode?: (node: ErrorNode) => void' + return: + description: '' + type: '(node: ErrorNode) => void' + inheritanceDescription: Inherited From ParseTreeListener.visitErrorNode + - name: visitTerminal + uid: adaptive-expressions-ie11.CommonRegexListener.visitTerminal + package: adaptive-expressions-ie11 + summary: '' + fullName: visitTerminal + remarks: '' + isDeprecated: false + syntax: + content: 'visitTerminal?: (node: TerminalNode) => void' + return: + description: '' + type: '(node: TerminalNode) => void' + inheritanceDescription: Inherited From ParseTreeListener.visitTerminal +extends: ParseTreeListener diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexParser.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexParser.yml new file mode 100644 index 00000000..aac22765 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexParser.yml @@ -0,0 +1,3122 @@ +### YamlMime:TSType +name: CommonRegexParser +uid: adaptive-expressions-ie11.CommonRegexParser +package: adaptive-expressions-ie11 +summary: '' +fullName: CommonRegexParser +remarks: '' +isDeprecated: false +type: class +constructors: + - name: CommonRegexParser(TokenStream) + uid: adaptive-expressions-ie11.CommonRegexParser.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new CommonRegexParser(input: TokenStream)' + parameters: + - id: input + type: TokenStream + description: '' +properties: + - name: ALC + uid: adaptive-expressions-ie11.CommonRegexParser.ALC + package: adaptive-expressions-ie11 + summary: '' + fullName: ALC + remarks: '' + isDeprecated: false + syntax: + content: 'static ALC: 44 = 44' + return: + description: '' + type: '44' + - name: Ampersand + uid: adaptive-expressions-ie11.CommonRegexParser.Ampersand + package: adaptive-expressions-ie11 + summary: '' + fullName: Ampersand + remarks: '' + isDeprecated: false + syntax: + content: 'static Ampersand: 43 = 43' + return: + description: '' + type: '43' + - name: AUC + uid: adaptive-expressions-ie11.CommonRegexParser.AUC + package: adaptive-expressions-ie11 + summary: '' + fullName: AUC + remarks: '' + isDeprecated: false + syntax: + content: 'static AUC: 70 = 70' + return: + description: '' + type: '70' + - name: Backslash + uid: adaptive-expressions-ie11.CommonRegexParser.Backslash + package: adaptive-expressions-ie11 + summary: '' + fullName: Backslash + remarks: '' + isDeprecated: false + syntax: + content: 'static Backslash: 10 = 10' + return: + description: '' + type: '10' + - name: BellChar + uid: adaptive-expressions-ie11.CommonRegexParser.BellChar + package: adaptive-expressions-ie11 + summary: '' + fullName: BellChar + remarks: '' + isDeprecated: false + syntax: + content: 'static BellChar: 3 = 3' + return: + description: '' + type: '3' + - name: BLC + uid: adaptive-expressions-ie11.CommonRegexParser.BLC + package: adaptive-expressions-ie11 + summary: '' + fullName: BLC + remarks: '' + isDeprecated: false + syntax: + content: 'static BLC: 45 = 45' + return: + description: '' + type: '45' + - name: BlockQuoted + uid: adaptive-expressions-ie11.CommonRegexParser.BlockQuoted + package: adaptive-expressions-ie11 + summary: '' + fullName: BlockQuoted + remarks: '' + isDeprecated: false + syntax: + content: 'static BlockQuoted: 2 = 2' + return: + description: '' + type: '2' + - name: BUC + uid: adaptive-expressions-ie11.CommonRegexParser.BUC + package: adaptive-expressions-ie11 + summary: '' + fullName: BUC + remarks: '' + isDeprecated: false + syntax: + content: 'static BUC: 71 = 71' + return: + description: '' + type: '71' + - name: Caret + uid: adaptive-expressions-ie11.CommonRegexParser.Caret + package: adaptive-expressions-ie11 + summary: '' + fullName: Caret + remarks: '' + isDeprecated: false + syntax: + content: 'static Caret: 23 = 23' + return: + description: '' + type: '23' + - name: CarriageReturn + uid: adaptive-expressions-ie11.CommonRegexParser.CarriageReturn + package: adaptive-expressions-ie11 + summary: '' + fullName: CarriageReturn + remarks: '' + isDeprecated: false + syntax: + content: 'static CarriageReturn: 8 = 8' + return: + description: '' + type: '8' + - name: CharacterClassEnd + uid: adaptive-expressions-ie11.CommonRegexParser.CharacterClassEnd + package: adaptive-expressions-ie11 + summary: '' + fullName: CharacterClassEnd + remarks: '' + isDeprecated: false + syntax: + content: 'static CharacterClassEnd: 22 = 22' + return: + description: '' + type: '22' + - name: CharacterClassStart + uid: adaptive-expressions-ie11.CommonRegexParser.CharacterClassStart + package: adaptive-expressions-ie11 + summary: '' + fullName: CharacterClassStart + remarks: '' + isDeprecated: false + syntax: + content: 'static CharacterClassStart: 21 = 21' + return: + description: '' + type: '21' + - name: CharWithoutProperty + uid: adaptive-expressions-ie11.CommonRegexParser.CharWithoutProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: CharWithoutProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static CharWithoutProperty: 16 = 16' + return: + description: '' + type: '16' + - name: CharWithProperty + uid: adaptive-expressions-ie11.CommonRegexParser.CharWithProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: CharWithProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static CharWithProperty: 15 = 15' + return: + description: '' + type: '15' + - name: CLC + uid: adaptive-expressions-ie11.CommonRegexParser.CLC + package: adaptive-expressions-ie11 + summary: '' + fullName: CLC + remarks: '' + isDeprecated: false + syntax: + content: 'static CLC: 46 = 46' + return: + description: '' + type: '46' + - name: CloseBrace + uid: adaptive-expressions-ie11.CommonRegexParser.CloseBrace + package: adaptive-expressions-ie11 + summary: '' + fullName: CloseBrace + remarks: '' + isDeprecated: false + syntax: + content: 'static CloseBrace: 29 = 29' + return: + description: '' + type: '29' + - name: CloseParen + uid: adaptive-expressions-ie11.CommonRegexParser.CloseParen + package: adaptive-expressions-ie11 + summary: '' + fullName: CloseParen + remarks: '' + isDeprecated: false + syntax: + content: 'static CloseParen: 34 = 34' + return: + description: '' + type: '34' + - name: Colon + uid: adaptive-expressions-ie11.CommonRegexParser.Colon + package: adaptive-expressions-ie11 + summary: '' + fullName: Colon + remarks: '' + isDeprecated: false + syntax: + content: 'static Colon: 39 = 39' + return: + description: '' + type: '39' + - name: Comma + uid: adaptive-expressions-ie11.CommonRegexParser.Comma + package: adaptive-expressions-ie11 + summary: '' + fullName: Comma + remarks: '' + isDeprecated: false + syntax: + content: 'static Comma: 30 = 30' + return: + description: '' + type: '30' + - name: ControlChar + uid: adaptive-expressions-ie11.CommonRegexParser.ControlChar + package: adaptive-expressions-ie11 + summary: '' + fullName: ControlChar + remarks: '' + isDeprecated: false + syntax: + content: 'static ControlChar: 4 = 4' + return: + description: '' + type: '4' + - name: CUC + uid: adaptive-expressions-ie11.CommonRegexParser.CUC + package: adaptive-expressions-ie11 + summary: '' + fullName: CUC + remarks: '' + isDeprecated: false + syntax: + content: 'static CUC: 72 = 72' + return: + description: '' + type: '72' + - name: D0 + uid: adaptive-expressions-ie11.CommonRegexParser.D0 + package: adaptive-expressions-ie11 + summary: '' + fullName: D0 + remarks: '' + isDeprecated: false + syntax: + content: 'static D0: 105 = 105' + return: + description: '' + type: '105' + - name: D1 + uid: adaptive-expressions-ie11.CommonRegexParser.D1 + package: adaptive-expressions-ie11 + summary: '' + fullName: D1 + remarks: '' + isDeprecated: false + syntax: + content: 'static D1: 96 = 96' + return: + description: '' + type: '96' + - name: D2 + uid: adaptive-expressions-ie11.CommonRegexParser.D2 + package: adaptive-expressions-ie11 + summary: '' + fullName: D2 + remarks: '' + isDeprecated: false + syntax: + content: 'static D2: 97 = 97' + return: + description: '' + type: '97' + - name: D3 + uid: adaptive-expressions-ie11.CommonRegexParser.D3 + package: adaptive-expressions-ie11 + summary: '' + fullName: D3 + remarks: '' + isDeprecated: false + syntax: + content: 'static D3: 98 = 98' + return: + description: '' + type: '98' + - name: D4 + uid: adaptive-expressions-ie11.CommonRegexParser.D4 + package: adaptive-expressions-ie11 + summary: '' + fullName: D4 + remarks: '' + isDeprecated: false + syntax: + content: 'static D4: 99 = 99' + return: + description: '' + type: '99' + - name: D5 + uid: adaptive-expressions-ie11.CommonRegexParser.D5 + package: adaptive-expressions-ie11 + summary: '' + fullName: D5 + remarks: '' + isDeprecated: false + syntax: + content: 'static D5: 100 = 100' + return: + description: '' + type: '100' + - name: D6 + uid: adaptive-expressions-ie11.CommonRegexParser.D6 + package: adaptive-expressions-ie11 + summary: '' + fullName: D6 + remarks: '' + isDeprecated: false + syntax: + content: 'static D6: 101 = 101' + return: + description: '' + type: '101' + - name: D7 + uid: adaptive-expressions-ie11.CommonRegexParser.D7 + package: adaptive-expressions-ie11 + summary: '' + fullName: D7 + remarks: '' + isDeprecated: false + syntax: + content: 'static D7: 102 = 102' + return: + description: '' + type: '102' + - name: D8 + uid: adaptive-expressions-ie11.CommonRegexParser.D8 + package: adaptive-expressions-ie11 + summary: '' + fullName: D8 + remarks: '' + isDeprecated: false + syntax: + content: 'static D8: 103 = 103' + return: + description: '' + type: '103' + - name: D9 + uid: adaptive-expressions-ie11.CommonRegexParser.D9 + package: adaptive-expressions-ie11 + summary: '' + fullName: D9 + remarks: '' + isDeprecated: false + syntax: + content: 'static D9: 104 = 104' + return: + description: '' + type: '104' + - name: DecimalDigit + uid: adaptive-expressions-ie11.CommonRegexParser.DecimalDigit + package: adaptive-expressions-ie11 + summary: '' + fullName: DecimalDigit + remarks: '' + isDeprecated: false + syntax: + content: 'static DecimalDigit: 13 = 13' + return: + description: '' + type: '13' + - name: DLC + uid: adaptive-expressions-ie11.CommonRegexParser.DLC + package: adaptive-expressions-ie11 + summary: '' + fullName: DLC + remarks: '' + isDeprecated: false + syntax: + content: 'static DLC: 47 = 47' + return: + description: '' + type: '47' + - name: Dot + uid: adaptive-expressions-ie11.CommonRegexParser.Dot + package: adaptive-expressions-ie11 + summary: '' + fullName: Dot + remarks: '' + isDeprecated: false + syntax: + content: 'static Dot: 12 = 12' + return: + description: '' + type: '12' + - name: DUC + uid: adaptive-expressions-ie11.CommonRegexParser.DUC + package: adaptive-expressions-ie11 + summary: '' + fullName: DUC + remarks: '' + isDeprecated: false + syntax: + content: 'static DUC: 73 = 73' + return: + description: '' + type: '73' + - name: ELC + uid: adaptive-expressions-ie11.CommonRegexParser.ELC + package: adaptive-expressions-ie11 + summary: '' + fullName: ELC + remarks: '' + isDeprecated: false + syntax: + content: 'static ELC: 48 = 48' + return: + description: '' + type: '48' + - name: EndOfSubject + uid: adaptive-expressions-ie11.CommonRegexParser.EndOfSubject + package: adaptive-expressions-ie11 + summary: '' + fullName: EndOfSubject + remarks: '' + isDeprecated: false + syntax: + content: 'static EndOfSubject: 31 = 31' + return: + description: '' + type: '31' + - name: Equals + uid: adaptive-expressions-ie11.CommonRegexParser.Equals + package: adaptive-expressions-ie11 + summary: '' + fullName: Equals + remarks: '' + isDeprecated: false + syntax: + content: 'static Equals: 41 = 41' + return: + description: '' + type: '41' + - name: EscapeChar + uid: adaptive-expressions-ie11.CommonRegexParser.EscapeChar + package: adaptive-expressions-ie11 + summary: '' + fullName: EscapeChar + remarks: '' + isDeprecated: false + syntax: + content: 'static EscapeChar: 5 = 5' + return: + description: '' + type: '5' + - name: EUC + uid: adaptive-expressions-ie11.CommonRegexParser.EUC + package: adaptive-expressions-ie11 + summary: '' + fullName: EUC + remarks: '' + isDeprecated: false + syntax: + content: 'static EUC: 74 = 74' + return: + description: '' + type: '74' + - name: Exclamation + uid: adaptive-expressions-ie11.CommonRegexParser.Exclamation + package: adaptive-expressions-ie11 + summary: '' + fullName: Exclamation + remarks: '' + isDeprecated: false + syntax: + content: 'static Exclamation: 42 = 42' + return: + description: '' + type: '42' + - name: FLC + uid: adaptive-expressions-ie11.CommonRegexParser.FLC + package: adaptive-expressions-ie11 + summary: '' + fullName: FLC + remarks: '' + isDeprecated: false + syntax: + content: 'static FLC: 49 = 49' + return: + description: '' + type: '49' + - name: FormFeed + uid: adaptive-expressions-ie11.CommonRegexParser.FormFeed + package: adaptive-expressions-ie11 + summary: '' + fullName: FormFeed + remarks: '' + isDeprecated: false + syntax: + content: 'static FormFeed: 6 = 6' + return: + description: '' + type: '6' + - name: FUC + uid: adaptive-expressions-ie11.CommonRegexParser.FUC + package: adaptive-expressions-ie11 + summary: '' + fullName: FUC + remarks: '' + isDeprecated: false + syntax: + content: 'static FUC: 75 = 75' + return: + description: '' + type: '75' + - name: GLC + uid: adaptive-expressions-ie11.CommonRegexParser.GLC + package: adaptive-expressions-ie11 + summary: '' + fullName: GLC + remarks: '' + isDeprecated: false + syntax: + content: 'static GLC: 50 = 50' + return: + description: '' + type: '50' + - name: grammarFileName + uid: adaptive-expressions-ie11.CommonRegexParser.grammarFileName + package: adaptive-expressions-ie11 + summary: '' + fullName: grammarFileName + remarks: '' + isDeprecated: false + syntax: + content: 'grammarFileName: string' + return: + description: '' + type: string + - name: GreaterThan + uid: adaptive-expressions-ie11.CommonRegexParser.GreaterThan + package: adaptive-expressions-ie11 + summary: '' + fullName: GreaterThan + remarks: '' + isDeprecated: false + syntax: + content: 'static GreaterThan: 36 = 36' + return: + description: '' + type: '36' + - name: GUC + uid: adaptive-expressions-ie11.CommonRegexParser.GUC + package: adaptive-expressions-ie11 + summary: '' + fullName: GUC + remarks: '' + isDeprecated: false + syntax: + content: 'static GUC: 76 = 76' + return: + description: '' + type: '76' + - name: Hash + uid: adaptive-expressions-ie11.CommonRegexParser.Hash + package: adaptive-expressions-ie11 + summary: '' + fullName: Hash + remarks: '' + isDeprecated: false + syntax: + content: 'static Hash: 40 = 40' + return: + description: '' + type: '40' + - name: HexChar + uid: adaptive-expressions-ie11.CommonRegexParser.HexChar + package: adaptive-expressions-ie11 + summary: '' + fullName: HexChar + remarks: '' + isDeprecated: false + syntax: + content: 'static HexChar: 11 = 11' + return: + description: '' + type: '11' + - name: HLC + uid: adaptive-expressions-ie11.CommonRegexParser.HLC + package: adaptive-expressions-ie11 + summary: '' + fullName: HLC + remarks: '' + isDeprecated: false + syntax: + content: 'static HLC: 51 = 51' + return: + description: '' + type: '51' + - name: HUC + uid: adaptive-expressions-ie11.CommonRegexParser.HUC + package: adaptive-expressions-ie11 + summary: '' + fullName: HUC + remarks: '' + isDeprecated: false + syntax: + content: 'static HUC: 77 = 77' + return: + description: '' + type: '77' + - name: Hyphen + uid: adaptive-expressions-ie11.CommonRegexParser.Hyphen + package: adaptive-expressions-ie11 + summary: '' + fullName: Hyphen + remarks: '' + isDeprecated: false + syntax: + content: 'static Hyphen: 24 = 24' + return: + description: '' + type: '24' + - name: ILC + uid: adaptive-expressions-ie11.CommonRegexParser.ILC + package: adaptive-expressions-ie11 + summary: '' + fullName: ILC + remarks: '' + isDeprecated: false + syntax: + content: 'static ILC: 52 = 52' + return: + description: '' + type: '52' + - name: IUC + uid: adaptive-expressions-ie11.CommonRegexParser.IUC + package: adaptive-expressions-ie11 + summary: '' + fullName: IUC + remarks: '' + isDeprecated: false + syntax: + content: 'static IUC: 78 = 78' + return: + description: '' + type: '78' + - name: JLC + uid: adaptive-expressions-ie11.CommonRegexParser.JLC + package: adaptive-expressions-ie11 + summary: '' + fullName: JLC + remarks: '' + isDeprecated: false + syntax: + content: 'static JLC: 53 = 53' + return: + description: '' + type: '53' + - name: JUC + uid: adaptive-expressions-ie11.CommonRegexParser.JUC + package: adaptive-expressions-ie11 + summary: '' + fullName: JUC + remarks: '' + isDeprecated: false + syntax: + content: 'static JUC: 79 = 79' + return: + description: '' + type: '79' + - name: KLC + uid: adaptive-expressions-ie11.CommonRegexParser.KLC + package: adaptive-expressions-ie11 + summary: '' + fullName: KLC + remarks: '' + isDeprecated: false + syntax: + content: 'static KLC: 54 = 54' + return: + description: '' + type: '54' + - name: KUC + uid: adaptive-expressions-ie11.CommonRegexParser.KUC + package: adaptive-expressions-ie11 + summary: '' + fullName: KUC + remarks: '' + isDeprecated: false + syntax: + content: 'static KUC: 80 = 80' + return: + description: '' + type: '80' + - name: LessThan + uid: adaptive-expressions-ie11.CommonRegexParser.LessThan + package: adaptive-expressions-ie11 + summary: '' + fullName: LessThan + remarks: '' + isDeprecated: false + syntax: + content: 'static LessThan: 35 = 35' + return: + description: '' + type: '35' + - name: LLC + uid: adaptive-expressions-ie11.CommonRegexParser.LLC + package: adaptive-expressions-ie11 + summary: '' + fullName: LLC + remarks: '' + isDeprecated: false + syntax: + content: 'static LLC: 55 = 55' + return: + description: '' + type: '55' + - name: LUC + uid: adaptive-expressions-ie11.CommonRegexParser.LUC + package: adaptive-expressions-ie11 + summary: '' + fullName: LUC + remarks: '' + isDeprecated: false + syntax: + content: 'static LUC: 81 = 81' + return: + description: '' + type: '81' + - name: MLC + uid: adaptive-expressions-ie11.CommonRegexParser.MLC + package: adaptive-expressions-ie11 + summary: '' + fullName: MLC + remarks: '' + isDeprecated: false + syntax: + content: 'static MLC: 56 = 56' + return: + description: '' + type: '56' + - name: MUC + uid: adaptive-expressions-ie11.CommonRegexParser.MUC + package: adaptive-expressions-ie11 + summary: '' + fullName: MUC + remarks: '' + isDeprecated: false + syntax: + content: 'static MUC: 82 = 82' + return: + description: '' + type: '82' + - name: NewLine + uid: adaptive-expressions-ie11.CommonRegexParser.NewLine + package: adaptive-expressions-ie11 + summary: '' + fullName: NewLine + remarks: '' + isDeprecated: false + syntax: + content: 'static NewLine: 7 = 7' + return: + description: '' + type: '7' + - name: NLC + uid: adaptive-expressions-ie11.CommonRegexParser.NLC + package: adaptive-expressions-ie11 + summary: '' + fullName: NLC + remarks: '' + isDeprecated: false + syntax: + content: 'static NLC: 57 = 57' + return: + description: '' + type: '57' + - name: NotDecimalDigit + uid: adaptive-expressions-ie11.CommonRegexParser.NotDecimalDigit + package: adaptive-expressions-ie11 + summary: '' + fullName: NotDecimalDigit + remarks: '' + isDeprecated: false + syntax: + content: 'static NotDecimalDigit: 14 = 14' + return: + description: '' + type: '14' + - name: NotWhiteSpace + uid: adaptive-expressions-ie11.CommonRegexParser.NotWhiteSpace + package: adaptive-expressions-ie11 + summary: '' + fullName: NotWhiteSpace + remarks: '' + isDeprecated: false + syntax: + content: 'static NotWhiteSpace: 18 = 18' + return: + description: '' + type: '18' + - name: NotWordChar + uid: adaptive-expressions-ie11.CommonRegexParser.NotWordChar + package: adaptive-expressions-ie11 + summary: '' + fullName: NotWordChar + remarks: '' + isDeprecated: false + syntax: + content: 'static NotWordChar: 20 = 20' + return: + description: '' + type: '20' + - name: NUC + uid: adaptive-expressions-ie11.CommonRegexParser.NUC + package: adaptive-expressions-ie11 + summary: '' + fullName: NUC + remarks: '' + isDeprecated: false + syntax: + content: 'static NUC: 83 = 83' + return: + description: '' + type: '83' + - name: OLC + uid: adaptive-expressions-ie11.CommonRegexParser.OLC + package: adaptive-expressions-ie11 + summary: '' + fullName: OLC + remarks: '' + isDeprecated: false + syntax: + content: 'static OLC: 58 = 58' + return: + description: '' + type: '58' + - name: OpenBrace + uid: adaptive-expressions-ie11.CommonRegexParser.OpenBrace + package: adaptive-expressions-ie11 + summary: '' + fullName: OpenBrace + remarks: '' + isDeprecated: false + syntax: + content: 'static OpenBrace: 28 = 28' + return: + description: '' + type: '28' + - name: OpenParen + uid: adaptive-expressions-ie11.CommonRegexParser.OpenParen + package: adaptive-expressions-ie11 + summary: '' + fullName: OpenParen + remarks: '' + isDeprecated: false + syntax: + content: 'static OpenParen: 33 = 33' + return: + description: '' + type: '33' + - name: OtherChar + uid: adaptive-expressions-ie11.CommonRegexParser.OtherChar + package: adaptive-expressions-ie11 + summary: '' + fullName: OtherChar + remarks: '' + isDeprecated: false + syntax: + content: 'static OtherChar: 106 = 106' + return: + description: '' + type: '106' + - name: OUC + uid: adaptive-expressions-ie11.CommonRegexParser.OUC + package: adaptive-expressions-ie11 + summary: '' + fullName: OUC + remarks: '' + isDeprecated: false + syntax: + content: 'static OUC: 84 = 84' + return: + description: '' + type: '84' + - name: Pipe + uid: adaptive-expressions-ie11.CommonRegexParser.Pipe + package: adaptive-expressions-ie11 + summary: '' + fullName: Pipe + remarks: '' + isDeprecated: false + syntax: + content: 'static Pipe: 32 = 32' + return: + description: '' + type: '32' + - name: PLC + uid: adaptive-expressions-ie11.CommonRegexParser.PLC + package: adaptive-expressions-ie11 + summary: '' + fullName: PLC + remarks: '' + isDeprecated: false + syntax: + content: 'static PLC: 59 = 59' + return: + description: '' + type: '59' + - name: Plus + uid: adaptive-expressions-ie11.CommonRegexParser.Plus + package: adaptive-expressions-ie11 + summary: '' + fullName: Plus + remarks: '' + isDeprecated: false + syntax: + content: 'static Plus: 26 = 26' + return: + description: '' + type: '26' + - name: PUC + uid: adaptive-expressions-ie11.CommonRegexParser.PUC + package: adaptive-expressions-ie11 + summary: '' + fullName: PUC + remarks: '' + isDeprecated: false + syntax: + content: 'static PUC: 85 = 85' + return: + description: '' + type: '85' + - name: QLC + uid: adaptive-expressions-ie11.CommonRegexParser.QLC + package: adaptive-expressions-ie11 + summary: '' + fullName: QLC + remarks: '' + isDeprecated: false + syntax: + content: 'static QLC: 60 = 60' + return: + description: '' + type: '60' + - name: QUC + uid: adaptive-expressions-ie11.CommonRegexParser.QUC + package: adaptive-expressions-ie11 + summary: '' + fullName: QUC + remarks: '' + isDeprecated: false + syntax: + content: 'static QUC: 86 = 86' + return: + description: '' + type: '86' + - name: QuestionMark + uid: adaptive-expressions-ie11.CommonRegexParser.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + fullName: QuestionMark + remarks: '' + isDeprecated: false + syntax: + content: 'static QuestionMark: 25 = 25' + return: + description: '' + type: '25' + - name: Quoted + uid: adaptive-expressions-ie11.CommonRegexParser.Quoted + package: adaptive-expressions-ie11 + summary: '' + fullName: Quoted + remarks: '' + isDeprecated: false + syntax: + content: 'static Quoted: 1 = 1' + return: + description: '' + type: '1' + - name: RLC + uid: adaptive-expressions-ie11.CommonRegexParser.RLC + package: adaptive-expressions-ie11 + summary: '' + fullName: RLC + remarks: '' + isDeprecated: false + syntax: + content: 'static RLC: 61 = 61' + return: + description: '' + type: '61' + - name: RUC + uid: adaptive-expressions-ie11.CommonRegexParser.RUC + package: adaptive-expressions-ie11 + summary: '' + fullName: RUC + remarks: '' + isDeprecated: false + syntax: + content: 'static RUC: 87 = 87' + return: + description: '' + type: '87' + - name: ruleNames + uid: adaptive-expressions-ie11.CommonRegexParser.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'ruleNames: string[]' + return: + description: '' + type: string[] + - name: ruleNames + uid: adaptive-expressions-ie11.CommonRegexParser.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'static ruleNames: string[]' + return: + description: '' + type: string[] + - name: RULE_alpha_nums + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_alpha_nums + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_alpha_nums + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_alpha_nums: 23 = 23' + return: + description: '' + type: '23' + - name: RULE_alternation + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_alternation + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_alternation + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_alternation: 1 = 1' + return: + description: '' + type: '1' + - name: RULE_atom + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_atom + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_atom + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_atom: 11 = 11' + return: + description: '' + type: '11' + - name: RULE_capture + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_capture + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_capture + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_capture: 7 = 7' + return: + description: '' + type: '7' + - name: RULE_cc_atom + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_cc_atom + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_cc_atom + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_cc_atom: 12 = 12' + return: + description: '' + type: '12' + - name: RULE_cc_literal + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_cc_literal + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_cc_literal + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_cc_literal: 15 = 15' + return: + description: '' + type: '15' + - name: RULE_character_class + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_character_class + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_character_class + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_character_class: 6 = 6' + return: + description: '' + type: '6' + - name: RULE_digit + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_digit + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_digit + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_digit: 21 = 21' + return: + description: '' + type: '21' + - name: RULE_digits + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_digits + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_digits + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_digits: 20 = 20' + return: + description: '' + type: '20' + - name: RULE_element + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_element + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_element + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_element: 3 = 3' + return: + description: '' + type: '3' + - name: RULE_expr + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_expr + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_expr + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_expr: 2 = 2' + return: + description: '' + type: '2' + - name: RULE_letter + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_letter + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_letter + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_letter: 26 = 26' + return: + description: '' + type: '26' + - name: RULE_literal + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_literal + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_literal + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_literal: 14 = 14' + return: + description: '' + type: '14' + - name: RULE_name + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_name + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_name + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_name: 22 = 22' + return: + description: '' + type: '22' + - name: RULE_non_capture + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_non_capture + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_non_capture + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_non_capture: 8 = 8' + return: + description: '' + type: '8' + - name: RULE_non_close_paren + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_non_close_paren + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_non_close_paren + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_non_close_paren: 25 = 25' + return: + description: '' + type: '25' + - name: RULE_non_close_parens + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_non_close_parens + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_non_close_parens + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_non_close_parens: 24 = 24' + return: + description: '' + type: '24' + - name: RULE_number + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_number + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_number + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_number: 17 = 17' + return: + description: '' + type: '17' + - name: RULE_octal_char + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_octal_char + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_octal_char + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_octal_char: 18 = 18' + return: + description: '' + type: '18' + - name: RULE_octal_digit + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_octal_digit + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_octal_digit + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_octal_digit: 19 = 19' + return: + description: '' + type: '19' + - name: RULE_option + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_option + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_option + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_option: 9 = 9' + return: + description: '' + type: '9' + - name: RULE_option_flag + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_option_flag + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_option_flag + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_option_flag: 10 = 10' + return: + description: '' + type: '10' + - name: RULE_parse + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_parse + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_parse + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_parse: 0 = 0' + return: + description: '' + type: '0' + - name: RULE_quantifier + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_quantifier + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_quantifier + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_quantifier: 4 = 4' + return: + description: '' + type: '4' + - name: RULE_quantifier_type + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_quantifier_type + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_quantifier_type + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_quantifier_type: 5 = 5' + return: + description: '' + type: '5' + - name: RULE_shared_atom + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_shared_atom + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_shared_atom + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_shared_atom: 13 = 13' + return: + description: '' + type: '13' + - name: RULE_shared_literal + uid: adaptive-expressions-ie11.CommonRegexParser.RULE_shared_literal + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_shared_literal + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_shared_literal: 16 = 16' + return: + description: '' + type: '16' + - name: serializedATN + uid: adaptive-expressions-ie11.CommonRegexParser.serializedATN + package: adaptive-expressions-ie11 + summary: '' + fullName: serializedATN + remarks: '' + isDeprecated: false + syntax: + content: 'serializedATN: string' + return: + description: '' + type: string + - name: SingleQuote + uid: adaptive-expressions-ie11.CommonRegexParser.SingleQuote + package: adaptive-expressions-ie11 + summary: '' + fullName: SingleQuote + remarks: '' + isDeprecated: false + syntax: + content: 'static SingleQuote: 37 = 37' + return: + description: '' + type: '37' + - name: SLC + uid: adaptive-expressions-ie11.CommonRegexParser.SLC + package: adaptive-expressions-ie11 + summary: '' + fullName: SLC + remarks: '' + isDeprecated: false + syntax: + content: 'static SLC: 62 = 62' + return: + description: '' + type: '62' + - name: Star + uid: adaptive-expressions-ie11.CommonRegexParser.Star + package: adaptive-expressions-ie11 + summary: '' + fullName: Star + remarks: '' + isDeprecated: false + syntax: + content: 'static Star: 27 = 27' + return: + description: '' + type: '27' + - name: SUC + uid: adaptive-expressions-ie11.CommonRegexParser.SUC + package: adaptive-expressions-ie11 + summary: '' + fullName: SUC + remarks: '' + isDeprecated: false + syntax: + content: 'static SUC: 88 = 88' + return: + description: '' + type: '88' + - name: Tab + uid: adaptive-expressions-ie11.CommonRegexParser.Tab + package: adaptive-expressions-ie11 + summary: '' + fullName: Tab + remarks: '' + isDeprecated: false + syntax: + content: 'static Tab: 9 = 9' + return: + description: '' + type: '9' + - name: TLC + uid: adaptive-expressions-ie11.CommonRegexParser.TLC + package: adaptive-expressions-ie11 + summary: '' + fullName: TLC + remarks: '' + isDeprecated: false + syntax: + content: 'static TLC: 63 = 63' + return: + description: '' + type: '63' + - name: TUC + uid: adaptive-expressions-ie11.CommonRegexParser.TUC + package: adaptive-expressions-ie11 + summary: '' + fullName: TUC + remarks: '' + isDeprecated: false + syntax: + content: 'static TUC: 89 = 89' + return: + description: '' + type: '89' + - name: ULC + uid: adaptive-expressions-ie11.CommonRegexParser.ULC + package: adaptive-expressions-ie11 + summary: '' + fullName: ULC + remarks: '' + isDeprecated: false + syntax: + content: 'static ULC: 64 = 64' + return: + description: '' + type: '64' + - name: Underscore + uid: adaptive-expressions-ie11.CommonRegexParser.Underscore + package: adaptive-expressions-ie11 + summary: '' + fullName: Underscore + remarks: '' + isDeprecated: false + syntax: + content: 'static Underscore: 38 = 38' + return: + description: '' + type: '38' + - name: UUC + uid: adaptive-expressions-ie11.CommonRegexParser.UUC + package: adaptive-expressions-ie11 + summary: '' + fullName: UUC + remarks: '' + isDeprecated: false + syntax: + content: 'static UUC: 90 = 90' + return: + description: '' + type: '90' + - name: VLC + uid: adaptive-expressions-ie11.CommonRegexParser.VLC + package: adaptive-expressions-ie11 + summary: '' + fullName: VLC + remarks: '' + isDeprecated: false + syntax: + content: 'static VLC: 65 = 65' + return: + description: '' + type: '65' + - name: vocabulary + uid: adaptive-expressions-ie11.CommonRegexParser.vocabulary + package: adaptive-expressions-ie11 + summary: '' + fullName: vocabulary + remarks: '' + isDeprecated: false + syntax: + content: 'vocabulary: Vocabulary' + return: + description: '' + type: Vocabulary + - name: VOCABULARY + uid: adaptive-expressions-ie11.CommonRegexParser.VOCABULARY + package: adaptive-expressions-ie11 + summary: '' + fullName: VOCABULARY + remarks: '' + isDeprecated: false + syntax: + content: 'static VOCABULARY: Vocabulary' + return: + description: '' + type: Vocabulary + - name: VUC + uid: adaptive-expressions-ie11.CommonRegexParser.VUC + package: adaptive-expressions-ie11 + summary: '' + fullName: VUC + remarks: '' + isDeprecated: false + syntax: + content: 'static VUC: 91 = 91' + return: + description: '' + type: '91' + - name: WhiteSpace + uid: adaptive-expressions-ie11.CommonRegexParser.WhiteSpace + package: adaptive-expressions-ie11 + summary: '' + fullName: WhiteSpace + remarks: '' + isDeprecated: false + syntax: + content: 'static WhiteSpace: 17 = 17' + return: + description: '' + type: '17' + - name: WLC + uid: adaptive-expressions-ie11.CommonRegexParser.WLC + package: adaptive-expressions-ie11 + summary: '' + fullName: WLC + remarks: '' + isDeprecated: false + syntax: + content: 'static WLC: 66 = 66' + return: + description: '' + type: '66' + - name: WordChar + uid: adaptive-expressions-ie11.CommonRegexParser.WordChar + package: adaptive-expressions-ie11 + summary: '' + fullName: WordChar + remarks: '' + isDeprecated: false + syntax: + content: 'static WordChar: 19 = 19' + return: + description: '' + type: '19' + - name: WUC + uid: adaptive-expressions-ie11.CommonRegexParser.WUC + package: adaptive-expressions-ie11 + summary: '' + fullName: WUC + remarks: '' + isDeprecated: false + syntax: + content: 'static WUC: 92 = 92' + return: + description: '' + type: '92' + - name: XLC + uid: adaptive-expressions-ie11.CommonRegexParser.XLC + package: adaptive-expressions-ie11 + summary: '' + fullName: XLC + remarks: '' + isDeprecated: false + syntax: + content: 'static XLC: 67 = 67' + return: + description: '' + type: '67' + - name: XUC + uid: adaptive-expressions-ie11.CommonRegexParser.XUC + package: adaptive-expressions-ie11 + summary: '' + fullName: XUC + remarks: '' + isDeprecated: false + syntax: + content: 'static XUC: 93 = 93' + return: + description: '' + type: '93' + - name: YLC + uid: adaptive-expressions-ie11.CommonRegexParser.YLC + package: adaptive-expressions-ie11 + summary: '' + fullName: YLC + remarks: '' + isDeprecated: false + syntax: + content: 'static YLC: 68 = 68' + return: + description: '' + type: '68' + - name: YUC + uid: adaptive-expressions-ie11.CommonRegexParser.YUC + package: adaptive-expressions-ie11 + summary: '' + fullName: YUC + remarks: '' + isDeprecated: false + syntax: + content: 'static YUC: 94 = 94' + return: + description: '' + type: '94' + - name: ZLC + uid: adaptive-expressions-ie11.CommonRegexParser.ZLC + package: adaptive-expressions-ie11 + summary: '' + fullName: ZLC + remarks: '' + isDeprecated: false + syntax: + content: 'static ZLC: 69 = 69' + return: + description: '' + type: '69' + - name: ZUC + uid: adaptive-expressions-ie11.CommonRegexParser.ZUC + package: adaptive-expressions-ie11 + summary: '' + fullName: ZUC + remarks: '' + isDeprecated: false + syntax: + content: 'static ZUC: 95 = 95' + return: + description: '' + type: '95' +inheritedProperties: + - name: atn + uid: adaptive-expressions-ie11.CommonRegexParser.atn + package: adaptive-expressions-ie11 + summary: >- + Get the + used by the recognizer for prediction. + fullName: atn + remarks: '' + isDeprecated: false + syntax: + content: 'atn: ATN' + return: + description: >- + The + used by the recognizer for prediction. + type: ATN + inheritanceDescription: Inherited From Parser.atn + - name: buildParseTree + uid: adaptive-expressions-ie11.CommonRegexParser.buildParseTree + package: adaptive-expressions-ie11 + summary: |- + Track the objects during the parse and hook + them up using the list so that it + forms a parse tree. The returned from the start + rule represents the root of the parse tree. + + Note that if we are not building parse trees, rule contexts only point + upwards. When a rule exits, it returns the context but that gets garbage + collected if nobody holds a reference. It points upwards but nobody + points at it. + + When we build parse trees, we are adding all of these contexts to + list. Contexts are then not candidates + for garbage collection. + fullName: buildParseTree + remarks: '' + isDeprecated: false + syntax: + content: 'buildParseTree: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.buildParseTree + - name: context + uid: adaptive-expressions-ie11.CommonRegexParser.context + package: adaptive-expressions-ie11 + summary: '' + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context: ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From Parser.context + - name: currentToken + uid: adaptive-expressions-ie11.CommonRegexParser.currentToken + package: adaptive-expressions-ie11 + summary: |- + Match needs to return the current input symbol, which gets put + into the label for the associated token ref; e.g., x=ID. + fullName: currentToken + remarks: '' + isDeprecated: false + syntax: + content: 'currentToken: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Parser.currentToken + - name: EOF + uid: adaptive-expressions-ie11.CommonRegexParser.EOF + package: adaptive-expressions-ie11 + summary: '' + fullName: EOF + remarks: '' + isDeprecated: false + syntax: + content: 'static EOF: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.EOF + - name: errorHandler + uid: adaptive-expressions-ie11.CommonRegexParser.errorHandler + package: adaptive-expressions-ie11 + summary: '' + fullName: errorHandler + remarks: '' + isDeprecated: false + syntax: + content: 'errorHandler: ANTLRErrorStrategy' + return: + description: '' + type: ANTLRErrorStrategy + inheritanceDescription: Inherited From Parser.errorHandler + - name: inputStream + uid: adaptive-expressions-ie11.CommonRegexParser.inputStream + package: adaptive-expressions-ie11 + summary: Set the token stream and reset the parser. + fullName: inputStream + remarks: '' + isDeprecated: false + syntax: + content: 'inputStream: TokenStream' + return: + description: '' + type: TokenStream + inheritanceDescription: Inherited From Parser.inputStream + - name: interpreter + uid: adaptive-expressions-ie11.CommonRegexParser.interpreter + package: adaptive-expressions-ie11 + summary: Set the ATN interpreter used by the recognizer for prediction. + fullName: interpreter + remarks: '' + isDeprecated: false + syntax: + content: 'interpreter: ParserATNSimulator' + return: + description: '' + type: ParserATNSimulator + inheritanceDescription: Inherited From Parser.interpreter + - name: isMatchedEOF + uid: adaptive-expressions-ie11.CommonRegexParser.isMatchedEOF + package: adaptive-expressions-ie11 + summary: '' + fullName: isMatchedEOF + remarks: '' + isDeprecated: false + syntax: + content: 'isMatchedEOF: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.isMatchedEOF + - name: isTrace + uid: adaptive-expressions-ie11.CommonRegexParser.isTrace + package: adaptive-expressions-ie11 + summary: |- + During a parse is sometimes useful to listen in on the rule entry and exit + events as well as token matches. This is for quick and dirty debugging. + fullName: isTrace + remarks: '' + isDeprecated: false + syntax: + content: 'isTrace: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.isTrace + - name: numberOfSyntaxErrors + uid: adaptive-expressions-ie11.CommonRegexParser.numberOfSyntaxErrors + package: adaptive-expressions-ie11 + summary: |- + Gets the number of syntax errors reported during parsing. This value is + incremented each time is called. + + See #notifyErrorListeners + fullName: numberOfSyntaxErrors + remarks: '' + isDeprecated: false + syntax: + content: 'numberOfSyntaxErrors: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.numberOfSyntaxErrors + - name: parseInfo + uid: adaptive-expressions-ie11.CommonRegexParser.parseInfo + package: adaptive-expressions-ie11 + summary: '' + fullName: parseInfo + remarks: '' + isDeprecated: false + syntax: + content: 'parseInfo: Promise' + return: + description: '' + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Parser.parseInfo + - name: precedence + uid: adaptive-expressions-ie11.CommonRegexParser.precedence + package: adaptive-expressions-ie11 + summary: Get the precedence level for the top-most precedence rule. + fullName: precedence + remarks: '' + isDeprecated: false + syntax: + content: 'precedence: number' + return: + description: |- + The precedence level for the top-most precedence rule, or -1 if + the parser context is not nested within a precedence rule. + type: number + inheritanceDescription: Inherited From Parser.precedence + - name: ruleContext + uid: adaptive-expressions-ie11.CommonRegexParser.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From Parser.ruleContext + - name: sourceName + uid: adaptive-expressions-ie11.CommonRegexParser.sourceName + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceName + remarks: '' + isDeprecated: false + syntax: + content: 'sourceName: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Parser.sourceName + - name: state + uid: adaptive-expressions-ie11.CommonRegexParser.state + package: adaptive-expressions-ie11 + summary: |- + Indicate that the recognizer has changed internal state that is + consistent with the ATN state passed in. This way we always know + where we are in the ATN as the parser goes along. The rule + context objects form a stack that lets us see the stack of + invoking rules. Combine this and we have complete ATN + configuration information. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.state + - name: tokenFactory + uid: adaptive-expressions-ie11.CommonRegexParser.tokenFactory + package: adaptive-expressions-ie11 + summary: '' + fullName: tokenFactory + remarks: '' + isDeprecated: false + syntax: + content: 'tokenFactory: TokenFactory' + return: + description: '' + type: TokenFactory + inheritanceDescription: Inherited From Parser.tokenFactory +inheritedMethods: + - name: action(undefined | RuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexParser.action + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function action(_localctx: undefined | RuleContext, ruleIndex: number, + actionIndex: number) + parameters: + - id: _localctx + type: undefined | RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: actionIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.action + - name: addErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.CommonRegexParser.addErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<Token> + description: '' + inheritanceDescription: Inherited From Parser.addErrorListener + - name: addParseListener(ParseTreeListener) + uid: adaptive-expressions-ie11.CommonRegexParser.addParseListener + package: adaptive-expressions-ie11 + summary: |- + Registers `listener` to receive events during the parsing process. + + To support output-preserving grammar transformations (including but not + limited to left-recursion removal, automated left-factoring, and + optimized code generation), calls to listener methods during the parse + may differ substantially from calls made by + used after the parse is complete. In + particular, rule entry and exit events may occur in a different order + during the parse than after the parser. In addition, calls to certain + rule entry methods may be omitted. + + With the following specific exceptions, calls to listener events are + *deterministic*, i.e. for identical input the calls to listener + methods will be the same. + + * Alterations to the grammar used to generate code may change the + behavior of the listener calls. + * Alterations to the command line options passed to ANTLR 4 when + generating the parser may change the behavior of the listener calls. + * Changing the version of the ANTLR Tool used to generate the parser + may change the behavior of the listener calls. + remarks: '' + isDeprecated: false + syntax: + content: 'function addParseListener(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: the listener to add + inheritanceDescription: Inherited From Parser.addParseListener + - name: compileParseTreePattern(string, number) + uid: adaptive-expressions-ie11.CommonRegexParser.compileParseTreePattern + package: adaptive-expressions-ie11 + summary: >- + The preferred method of getting a tree pattern. For example, here's a + + sample use: + + + ``` + + let t: ParseTree = parser.expr(); + + let p: ParseTreePattern = await parser.compileParseTreePattern("+0", + MyParser.RULE_expr); + + let m: ParseTreeMatch = p.match(t); + + let id: string = m.get("ID"); + + ``` + remarks: '' + isDeprecated: false + syntax: + content: >- + function compileParseTreePattern(pattern: string, patternRuleIndex: + number): Promise + parameters: + - id: pattern + type: string + description: '' + - id: patternRuleIndex + type: number + description: '' + return: + description: '' + type: Promise<ParseTreePattern> + inheritanceDescription: Inherited From Parser.compileParseTreePattern + - name: compileParseTreePattern(string, number, Lexer) + uid: adaptive-expressions-ie11.CommonRegexParser.compileParseTreePattern_1 + package: adaptive-expressions-ie11 + summary: >- + The same as [int)](xref:%23compileParseTreePattern(String%2C) but specify + a + + rather than trying to + deduce it from this parser. + remarks: '' + isDeprecated: false + syntax: + content: >- + function compileParseTreePattern(pattern: string, patternRuleIndex: + number, lexer?: Lexer): Promise + parameters: + - id: pattern + type: string + description: '' + - id: patternRuleIndex + type: number + description: '' + - id: lexer + type: Lexer + description: '' + return: + description: '' + type: Promise<ParseTreePattern> + inheritanceDescription: Inherited From Parser.compileParseTreePattern + - name: consume() + uid: adaptive-expressions-ie11.CommonRegexParser.consume + package: adaptive-expressions-ie11 + summary: >- + Consume and return the [current symbol](`currentToken`). + + + E.g., given the following input with `A` being the current + + lookahead symbol, this function moves the cursor to `B` and returns + + `A`. + + + ``` + + A B + + ^ + + ``` + + + If the parser is not in error recovery mode, the consumed symbol is added + + to the parse tree using , + and + + is called on any parse listeners. + + If the parser *is* in error recovery mode, the consumed symbol is + + added to the parse tree using + [Token)](xref:%23createErrorNode(ParserRuleContext%2C) then + + and + + is called on any parse + + listeners. + remarks: '' + isDeprecated: false + syntax: + content: 'function consume(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Parser.consume + - name: createErrorNode(ParserRuleContext, Token) + uid: adaptive-expressions-ie11.CommonRegexParser.createErrorNode + package: adaptive-expressions-ie11 + summary: |- + How to create an error node, given a token, associated with a parent. + Typically, the error node to create is not a function of the parent. + remarks: '' + isDeprecated: false + syntax: + content: 'function createErrorNode(parent: ParserRuleContext, t: Token): ErrorNode' + parameters: + - id: parent + type: ParserRuleContext + description: '' + - id: t + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From Parser.createErrorNode + - name: createTerminalNode(ParserRuleContext, Token) + uid: adaptive-expressions-ie11.CommonRegexParser.createTerminalNode + package: adaptive-expressions-ie11 + summary: |- + How to create a token leaf node associated with a parent. + Typically, the terminal node to create is not a function of the parent. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTerminalNode(parent: ParserRuleContext, t: Token): + TerminalNode + parameters: + - id: parent + type: ParserRuleContext + description: '' + - id: t + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From Parser.createTerminalNode + - name: dumpDFA() + uid: adaptive-expressions-ie11.CommonRegexParser.dumpDFA + package: adaptive-expressions-ie11 + summary: For debugging and other purposes. + remarks: '' + isDeprecated: false + syntax: + content: function dumpDFA() + inheritanceDescription: Inherited From Parser.dumpDFA + - name: enterLeftFactoredRule(ParserRuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexParser.enterLeftFactoredRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function enterLeftFactoredRule(localctx: ParserRuleContext, state: + number, ruleIndex: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterLeftFactoredRule + - name: enterOuterAlt(ParserRuleContext, number) + uid: adaptive-expressions-ie11.CommonRegexParser.enterOuterAlt + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterOuterAlt(localctx: ParserRuleContext, altNum: number)' + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: altNum + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterOuterAlt + - name: enterRecursionRule(ParserRuleContext, number, number, number) + uid: adaptive-expressions-ie11.CommonRegexParser.enterRecursionRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function enterRecursionRule(localctx: ParserRuleContext, state: number, + ruleIndex: number, precedence: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + - id: precedence + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterRecursionRule + - name: enterRule(ParserRuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexParser.enterRule + package: adaptive-expressions-ie11 + summary: |- + Always called by generated parsers upon entry to a rule. Access field + get the current context. + remarks: '' + isDeprecated: false + syntax: + content: >- + function enterRule(localctx: ParserRuleContext, state: number, + ruleIndex: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterRule + - name: exitRule() + uid: adaptive-expressions-ie11.CommonRegexParser.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function exitRule() + inheritanceDescription: Inherited From Parser.exitRule + - name: getATNWithBypassAlts() + uid: adaptive-expressions-ie11.CommonRegexParser.getATNWithBypassAlts + package: adaptive-expressions-ie11 + summary: |- + The ATN with bypass alternatives is expensive to create so we create it + lazily. + + @ if the current parser does not + implement the `serializedATN` property. + remarks: '' + isDeprecated: false + syntax: + content: 'function getATNWithBypassAlts(): ATN' + return: + description: '' + type: ATN + inheritanceDescription: Inherited From Parser.getATNWithBypassAlts + - name: getDFAStrings() + uid: adaptive-expressions-ie11.CommonRegexParser.getDFAStrings + package: adaptive-expressions-ie11 + summary: For debugging and other purposes. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDFAStrings(): string[]' + return: + description: '' + type: string[] + inheritanceDescription: Inherited From Parser.getDFAStrings + - name: getErrorHeader(RecognitionException) + uid: adaptive-expressions-ie11.CommonRegexParser.getErrorHeader + package: adaptive-expressions-ie11 + summary: What is the error header, normally line/character position information? + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorHeader(e: RecognitionException): string' + parameters: + - id: e + type: RecognitionException + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Parser.getErrorHeader + - name: getErrorListenerDispatch() + uid: adaptive-expressions-ie11.CommonRegexParser.getErrorListenerDispatch + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListenerDispatch(): ParserErrorListener' + return: + description: '' + type: ParserErrorListener + inheritanceDescription: Inherited From Parser.getErrorListenerDispatch + - name: getErrorListeners() + uid: adaptive-expressions-ie11.CommonRegexParser.getErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListeners(): ANTLRErrorListener[]' + return: + description: '' + type: ANTLRErrorListener<Token>[] + inheritanceDescription: Inherited From Parser.getErrorListeners + - name: getExpectedTokens() + uid: adaptive-expressions-ie11.CommonRegexParser.getExpectedTokens + package: adaptive-expressions-ie11 + summary: >- + Computes the set of input symbols which could follow the current parser + + state and context, as given by and + , + + respectively. + + + See ATN#getExpectedTokens(int, RuleContext) + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpectedTokens(): IntervalSet' + return: + description: '' + type: IntervalSet + inheritanceDescription: Inherited From Parser.getExpectedTokens + - name: getExpectedTokensWithinCurrentRule() + uid: >- + adaptive-expressions-ie11.CommonRegexParser.getExpectedTokensWithinCurrentRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpectedTokensWithinCurrentRule(): IntervalSet' + return: + description: '' + type: IntervalSet + inheritanceDescription: Inherited From Parser.getExpectedTokensWithinCurrentRule + - name: getInvokingContext(number) + uid: adaptive-expressions-ie11.CommonRegexParser.getInvokingContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getInvokingContext(ruleIndex: number): undefined | + ParserRuleContext + parameters: + - id: ruleIndex + type: number + description: '' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From Parser.getInvokingContext + - name: getParseListeners() + uid: adaptive-expressions-ie11.CommonRegexParser.getParseListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getParseListeners(): ParseTreeListener[]' + return: + description: '' + type: ParseTreeListener[] + inheritanceDescription: Inherited From Parser.getParseListeners + - name: getRuleIndex(string) + uid: adaptive-expressions-ie11.CommonRegexParser.getRuleIndex + package: adaptive-expressions-ie11 + summary: Get a rule's index (i.e., `RULE_ruleName` field) or -1 if not found. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleIndex(ruleName: string): number' + parameters: + - id: ruleName + type: string + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.getRuleIndex + - name: getRuleIndexMap() + uid: adaptive-expressions-ie11.CommonRegexParser.getRuleIndexMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from rule names to rule indexes. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleIndexMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getRuleIndexMap + - name: getRuleInvocationStack(RuleContext) + uid: adaptive-expressions-ie11.CommonRegexParser.getRuleInvocationStack + package: adaptive-expressions-ie11 + summary: |- + Return List<String> of the rule names in your parser instance + leading up to a call to the current rule. You could override if + you want more details such as the file/line info of where + in the ATN a rule is invoked. + + This is very useful for error messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleInvocationStack(ctx?: RuleContext): string[]' + parameters: + - id: ctx + type: RuleContext + description: '' + return: + description: '' + type: string[] + inheritanceDescription: Inherited From Parser.getRuleInvocationStack + - name: getTokenType(string) + uid: adaptive-expressions-ie11.CommonRegexParser.getTokenType + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenType(tokenName: string): number' + parameters: + - id: tokenName + type: string + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.getTokenType + - name: getTokenTypeMap() + uid: adaptive-expressions-ie11.CommonRegexParser.getTokenTypeMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from token names to token types. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenTypeMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getTokenTypeMap + - name: inContext(string) + uid: adaptive-expressions-ie11.CommonRegexParser.inContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function inContext(context: string): boolean' + parameters: + - id: context + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.inContext + - name: isExpectedToken(number) + uid: adaptive-expressions-ie11.CommonRegexParser.isExpectedToken + package: adaptive-expressions-ie11 + summary: |- + Checks whether or not `symbol` can follow the current state in the + ATN. The behavior of this method is equivalent to the following, but is + implemented such that the complete context-sensitive follow set does not + need to be explicitly constructed. + + ``` + return getExpectedTokens().contains(symbol); + ``` + remarks: '' + isDeprecated: false + syntax: + content: 'function isExpectedToken(symbol: number): boolean' + parameters: + - id: symbol + type: number + description: the symbol type to check + return: + description: |- + `true` if `symbol` can follow the current state in + the ATN, otherwise `false`. + type: boolean + inheritanceDescription: Inherited From Parser.isExpectedToken + - name: match(number) + uid: adaptive-expressions-ie11.CommonRegexParser.match + package: adaptive-expressions-ie11 + summary: >- + Match current input symbol against `ttype`. If the symbol type + + matches, and are + + called to complete the match process. + + + If the symbol type does not match, + + is called on the current error + + strategy to attempt recovery. If is + + `true` and the token index of the symbol returned by + + is -1, the symbol is added to + + the parse tree by calling + [Token)](xref:%23createErrorNode(ParserRuleContext%2C) then + + . + remarks: '' + isDeprecated: false + syntax: + content: 'function match(ttype: number): Token' + parameters: + - id: ttype + type: number + description: the token type to match + return: + description: |- + the matched symbol + @ if the current input symbol did not match + `ttype` and the error strategy could not recover from the + mismatched symbol + type: Token + inheritanceDescription: Inherited From Parser.match + - name: matchWildcard() + uid: adaptive-expressions-ie11.CommonRegexParser.matchWildcard + package: adaptive-expressions-ie11 + summary: >- + Match current input symbol as a wildcard. If the symbol type matches + + (i.e. has a value greater than 0), + + and are called to complete the match process. + + + If the symbol type does not match, + + is called on the current error + + strategy to attempt recovery. If is + + `true` and the token index of the symbol returned by + + is -1, the symbol is added to + + the parse tree by calling + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C) then + + . + remarks: '' + isDeprecated: false + syntax: + content: 'function matchWildcard(): Token' + return: + description: >- + the matched symbol + + @ if the current input symbol did not match + + a wildcard and the error strategy could not recover from the + mismatched + + symbol + type: Token + inheritanceDescription: Inherited From Parser.matchWildcard + - name: notifyErrorListeners(string) + uid: adaptive-expressions-ie11.CommonRegexParser.notifyErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function notifyErrorListeners(msg: string)' + parameters: + - id: msg + type: string + description: '' + inheritanceDescription: Inherited From Parser.notifyErrorListeners + - name: >- + notifyErrorListeners(string, null | Token, undefined | + RecognitionException) + uid: adaptive-expressions-ie11.CommonRegexParser.notifyErrorListeners_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function notifyErrorListeners(msg: string, offendingToken: null | Token, + e: undefined | RecognitionException) + parameters: + - id: msg + type: string + description: '' + - id: offendingToken + type: null | Token + description: '' + - id: e + type: undefined | RecognitionException + description: '' + inheritanceDescription: Inherited From Parser.notifyErrorListeners + - name: precpred(RuleContext, number) + uid: adaptive-expressions-ie11.CommonRegexParser.precpred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function precpred(localctx: RuleContext, precedence: number): boolean' + parameters: + - id: localctx + type: RuleContext + description: '' + - id: precedence + type: number + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.precpred + - name: pushNewRecursionContext(ParserRuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexParser.pushNewRecursionContext + package: adaptive-expressions-ie11 + summary: |- + Like but for recursive rules. + Make the current context the child of the incoming localctx. + remarks: '' + isDeprecated: false + syntax: + content: >- + function pushNewRecursionContext(localctx: ParserRuleContext, state: + number, ruleIndex: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.pushNewRecursionContext + - name: removeErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.CommonRegexParser.removeErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<Token> + description: '' + inheritanceDescription: Inherited From Parser.removeErrorListener + - name: removeErrorListeners() + uid: adaptive-expressions-ie11.CommonRegexParser.removeErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function removeErrorListeners() + inheritanceDescription: Inherited From Parser.removeErrorListeners + - name: removeParseListener(ParseTreeListener) + uid: adaptive-expressions-ie11.CommonRegexParser.removeParseListener + package: adaptive-expressions-ie11 + summary: |- + Remove `listener` from the list of parse listeners. + + If `listener` is `undefined` or has not been added as a parse + listener, this method does nothing. + + See #addParseListener + remarks: '' + isDeprecated: false + syntax: + content: 'function removeParseListener(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: the listener to remove + inheritanceDescription: Inherited From Parser.removeParseListener + - name: removeParseListeners() + uid: adaptive-expressions-ie11.CommonRegexParser.removeParseListeners + package: adaptive-expressions-ie11 + summary: |- + Remove all parse listeners. + + See #addParseListener + remarks: '' + isDeprecated: false + syntax: + content: function removeParseListeners() + inheritanceDescription: Inherited From Parser.removeParseListeners + - name: reset() + uid: adaptive-expressions-ie11.CommonRegexParser.reset + package: adaptive-expressions-ie11 + summary: reset the parser's state + remarks: '' + isDeprecated: false + syntax: + content: function reset() + inheritanceDescription: Inherited From Parser.reset + - name: reset(boolean) + uid: adaptive-expressions-ie11.CommonRegexParser.reset_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reset(resetInput: boolean)' + parameters: + - id: resetInput + type: boolean + description: '' + inheritanceDescription: Inherited From Parser.reset + - name: sempred(undefined | RuleContext, number, number) + uid: adaptive-expressions-ie11.CommonRegexParser.sempred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function sempred(_localctx: undefined | RuleContext, ruleIndex: number, + actionIndex: number): boolean + parameters: + - id: _localctx + type: undefined | RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: actionIndex + type: number + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.sempred + - name: setProfile(boolean) + uid: adaptive-expressions-ie11.CommonRegexParser.setProfile + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setProfile(profile: boolean): Promise' + parameters: + - id: profile + type: boolean + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Parser.setProfile + - name: unrollRecursionContexts(ParserRuleContext) + uid: adaptive-expressions-ie11.CommonRegexParser.unrollRecursionContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function unrollRecursionContexts(_parentctx: ParserRuleContext)' + parameters: + - id: _parentctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From Parser.unrollRecursionContexts +methods: + - name: alpha_nums() + uid: adaptive-expressions-ie11.CommonRegexParser.alpha_nums + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function alpha_nums(): Alpha_numsContext' + return: + description: '' + type: + - name: alternation() + uid: adaptive-expressions-ie11.CommonRegexParser.alternation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function alternation(): AlternationContext' + return: + description: '' + type: + - name: atom() + uid: adaptive-expressions-ie11.CommonRegexParser.atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function atom(): AtomContext' + return: + description: '' + type: + - name: capture() + uid: adaptive-expressions-ie11.CommonRegexParser.capture + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function capture(): CaptureContext' + return: + description: '' + type: + - name: cc_atom() + uid: adaptive-expressions-ie11.CommonRegexParser.cc_atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function cc_atom(): Cc_atomContext' + return: + description: '' + type: + - name: cc_literal() + uid: adaptive-expressions-ie11.CommonRegexParser.cc_literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function cc_literal(): Cc_literalContext' + return: + description: '' + type: + - name: character_class() + uid: adaptive-expressions-ie11.CommonRegexParser.character_class + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function character_class(): Character_classContext' + return: + description: '' + type: + - name: digit() + uid: adaptive-expressions-ie11.CommonRegexParser.digit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digit(): DigitContext' + return: + description: '' + type: + - name: digits() + uid: adaptive-expressions-ie11.CommonRegexParser.digits + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digits(): DigitsContext' + return: + description: '' + type: + - name: element() + uid: adaptive-expressions-ie11.CommonRegexParser.element + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function element(): ElementContext' + return: + description: '' + type: + - name: expr() + uid: adaptive-expressions-ie11.CommonRegexParser.expr + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expr(): ExprContext' + return: + description: '' + type: + - name: letter() + uid: adaptive-expressions-ie11.CommonRegexParser.letter + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function letter(): LetterContext' + return: + description: '' + type: + - name: literal() + uid: adaptive-expressions-ie11.CommonRegexParser.literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function literal(): LiteralContext' + return: + description: '' + type: + - name: name() + uid: adaptive-expressions-ie11.CommonRegexParser.name + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function name(): NameContext' + return: + description: '' + type: + - name: non_capture() + uid: adaptive-expressions-ie11.CommonRegexParser.non_capture + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function non_capture(): Non_captureContext' + return: + description: '' + type: + - name: non_close_paren() + uid: adaptive-expressions-ie11.CommonRegexParser.non_close_paren + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function non_close_paren(): Non_close_parenContext' + return: + description: '' + type: + - name: non_close_parens() + uid: adaptive-expressions-ie11.CommonRegexParser.non_close_parens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function non_close_parens(): Non_close_parensContext' + return: + description: '' + type: + - name: number() + uid: adaptive-expressions-ie11.CommonRegexParser.number + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function number(): NumberContext' + return: + description: '' + type: + - name: octal_char() + uid: adaptive-expressions-ie11.CommonRegexParser.octal_char + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function octal_char(): Octal_charContext' + return: + description: '' + type: + - name: octal_digit() + uid: adaptive-expressions-ie11.CommonRegexParser.octal_digit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function octal_digit(): Octal_digitContext' + return: + description: '' + type: + - name: option() + uid: adaptive-expressions-ie11.CommonRegexParser.option + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function option(): OptionContext' + return: + description: '' + type: + - name: option_flag() + uid: adaptive-expressions-ie11.CommonRegexParser.option_flag + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function option_flag(): Option_flagContext' + return: + description: '' + type: + - name: parse() + uid: adaptive-expressions-ie11.CommonRegexParser.parse + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function parse(): ParseContext' + return: + description: '' + type: + - name: quantifier() + uid: adaptive-expressions-ie11.CommonRegexParser.quantifier + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function quantifier(): QuantifierContext' + return: + description: '' + type: + - name: quantifier_type() + uid: adaptive-expressions-ie11.CommonRegexParser.quantifier_type + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function quantifier_type(): Quantifier_typeContext' + return: + description: '' + type: + - name: shared_atom() + uid: adaptive-expressions-ie11.CommonRegexParser.shared_atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function shared_atom(): Shared_atomContext' + return: + description: '' + type: + - name: shared_literal() + uid: adaptive-expressions-ie11.CommonRegexParser.shared_literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function shared_literal(): Shared_literalContext' + return: + description: '' + type: +extends: Parser diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexVisitor.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexVisitor.yml new file mode 100644 index 00000000..ac87150e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/CommonRegexVisitor.yml @@ -0,0 +1,412 @@ +### YamlMime:TSType +name: CommonRegexVisitor +uid: adaptive-expressions-ie11.CommonRegexVisitor +package: adaptive-expressions-ie11 +summary: |- + This interface defines a complete generic visitor for a parse tree produced + by `CommonRegexParser`. +fullName: CommonRegexVisitor +remarks: '' +isDeprecated: false +type: interface +properties: + - name: visitAlpha_nums + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitAlpha_nums + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.alpha_nums`. + fullName: visitAlpha_nums + remarks: '' + isDeprecated: false + syntax: + content: 'visitAlpha_nums?: (ctx: Alpha_numsContext) => Result' + return: + description: '' + type: '(ctx: Alpha_numsContext) => Result' + - name: visitAlternation + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitAlternation + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.alternation`. + fullName: visitAlternation + remarks: '' + isDeprecated: false + syntax: + content: 'visitAlternation?: (ctx: AlternationContext) => Result' + return: + description: '' + type: '(ctx: AlternationContext) => Result' + - name: visitAtom + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitAtom + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.atom`. + fullName: visitAtom + remarks: '' + isDeprecated: false + syntax: + content: 'visitAtom?: (ctx: AtomContext) => Result' + return: + description: '' + type: '(ctx: AtomContext) => Result' + - name: visitCapture + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitCapture + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.capture`. + fullName: visitCapture + remarks: '' + isDeprecated: false + syntax: + content: 'visitCapture?: (ctx: CaptureContext) => Result' + return: + description: '' + type: '(ctx: CaptureContext) => Result' + - name: visitCc_atom + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitCc_atom + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.cc_atom`. + fullName: visitCc_atom + remarks: '' + isDeprecated: false + syntax: + content: 'visitCc_atom?: (ctx: Cc_atomContext) => Result' + return: + description: '' + type: '(ctx: Cc_atomContext) => Result' + - name: visitCc_literal + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitCc_literal + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.cc_literal`. + fullName: visitCc_literal + remarks: '' + isDeprecated: false + syntax: + content: 'visitCc_literal?: (ctx: Cc_literalContext) => Result' + return: + description: '' + type: '(ctx: Cc_literalContext) => Result' + - name: visitCharacter_class + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitCharacter_class + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.character_class`. + fullName: visitCharacter_class + remarks: '' + isDeprecated: false + syntax: + content: 'visitCharacter_class?: (ctx: Character_classContext) => Result' + return: + description: '' + type: '(ctx: Character_classContext) => Result' + - name: visitDigit + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitDigit + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.digit`. + fullName: visitDigit + remarks: '' + isDeprecated: false + syntax: + content: 'visitDigit?: (ctx: DigitContext) => Result' + return: + description: '' + type: '(ctx: DigitContext) => Result' + - name: visitDigits + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitDigits + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.digits`. + fullName: visitDigits + remarks: '' + isDeprecated: false + syntax: + content: 'visitDigits?: (ctx: DigitsContext) => Result' + return: + description: '' + type: '(ctx: DigitsContext) => Result' + - name: visitElement + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitElement + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.element`. + fullName: visitElement + remarks: '' + isDeprecated: false + syntax: + content: 'visitElement?: (ctx: ElementContext) => Result' + return: + description: '' + type: '(ctx: ElementContext) => Result' + - name: visitExpr + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitExpr + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.expr`. + fullName: visitExpr + remarks: '' + isDeprecated: false + syntax: + content: 'visitExpr?: (ctx: ExprContext) => Result' + return: + description: '' + type: '(ctx: ExprContext) => Result' + - name: visitLetter + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitLetter + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.letter`. + fullName: visitLetter + remarks: '' + isDeprecated: false + syntax: + content: 'visitLetter?: (ctx: LetterContext) => Result' + return: + description: '' + type: '(ctx: LetterContext) => Result' + - name: visitLiteral + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitLiteral + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.literal`. + fullName: visitLiteral + remarks: '' + isDeprecated: false + syntax: + content: 'visitLiteral?: (ctx: LiteralContext) => Result' + return: + description: '' + type: '(ctx: LiteralContext) => Result' + - name: visitName + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitName + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.name`. + fullName: visitName + remarks: '' + isDeprecated: false + syntax: + content: 'visitName?: (ctx: NameContext) => Result' + return: + description: '' + type: '(ctx: NameContext) => Result' + - name: visitNon_capture + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitNon_capture + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.non_capture`. + fullName: visitNon_capture + remarks: '' + isDeprecated: false + syntax: + content: 'visitNon_capture?: (ctx: Non_captureContext) => Result' + return: + description: '' + type: '(ctx: Non_captureContext) => Result' + - name: visitNon_close_paren + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitNon_close_paren + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.non_close_paren`. + fullName: visitNon_close_paren + remarks: '' + isDeprecated: false + syntax: + content: 'visitNon_close_paren?: (ctx: Non_close_parenContext) => Result' + return: + description: '' + type: '(ctx: Non_close_parenContext) => Result' + - name: visitNon_close_parens + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitNon_close_parens + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.non_close_parens`. + fullName: visitNon_close_parens + remarks: '' + isDeprecated: false + syntax: + content: 'visitNon_close_parens?: (ctx: Non_close_parensContext) => Result' + return: + description: '' + type: '(ctx: Non_close_parensContext) => Result' + - name: visitNumber + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitNumber + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.number`. + fullName: visitNumber + remarks: '' + isDeprecated: false + syntax: + content: 'visitNumber?: (ctx: NumberContext) => Result' + return: + description: '' + type: '(ctx: NumberContext) => Result' + - name: visitOctal_char + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitOctal_char + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.octal_char`. + fullName: visitOctal_char + remarks: '' + isDeprecated: false + syntax: + content: 'visitOctal_char?: (ctx: Octal_charContext) => Result' + return: + description: '' + type: '(ctx: Octal_charContext) => Result' + - name: visitOctal_digit + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitOctal_digit + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.octal_digit`. + fullName: visitOctal_digit + remarks: '' + isDeprecated: false + syntax: + content: 'visitOctal_digit?: (ctx: Octal_digitContext) => Result' + return: + description: '' + type: '(ctx: Octal_digitContext) => Result' + - name: visitOption + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitOption + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.option`. + fullName: visitOption + remarks: '' + isDeprecated: false + syntax: + content: 'visitOption?: (ctx: OptionContext) => Result' + return: + description: '' + type: '(ctx: OptionContext) => Result' + - name: visitOption_flag + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitOption_flag + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.option_flag`. + fullName: visitOption_flag + remarks: '' + isDeprecated: false + syntax: + content: 'visitOption_flag?: (ctx: Option_flagContext) => Result' + return: + description: '' + type: '(ctx: Option_flagContext) => Result' + - name: visitParse + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitParse + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.parse`. + fullName: visitParse + remarks: '' + isDeprecated: false + syntax: + content: 'visitParse?: (ctx: ParseContext) => Result' + return: + description: '' + type: '(ctx: ParseContext) => Result' + - name: visitQuantifier + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitQuantifier + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.quantifier`. + fullName: visitQuantifier + remarks: '' + isDeprecated: false + syntax: + content: 'visitQuantifier?: (ctx: QuantifierContext) => Result' + return: + description: '' + type: '(ctx: QuantifierContext) => Result' + - name: visitQuantifier_type + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitQuantifier_type + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.quantifier_type`. + fullName: visitQuantifier_type + remarks: '' + isDeprecated: false + syntax: + content: 'visitQuantifier_type?: (ctx: Quantifier_typeContext) => Result' + return: + description: '' + type: '(ctx: Quantifier_typeContext) => Result' + - name: visitShared_atom + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitShared_atom + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.shared_atom`. + fullName: visitShared_atom + remarks: '' + isDeprecated: false + syntax: + content: 'visitShared_atom?: (ctx: Shared_atomContext) => Result' + return: + description: '' + type: '(ctx: Shared_atomContext) => Result' + - name: visitShared_literal + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitShared_literal + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `CommonRegexParser.shared_literal`. + fullName: visitShared_literal + remarks: '' + isDeprecated: false + syntax: + content: 'visitShared_literal?: (ctx: Shared_literalContext) => Result' + return: + description: '' + type: '(ctx: Shared_literalContext) => Result' +inheritedMethods: + - name: visit(ParseTree) + uid: adaptive-expressions-ie11.CommonRegexVisitor.visit + package: adaptive-expressions-ie11 + summary: Visit a parse tree, and return a user-defined result of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visit(tree: ParseTree): Result' + parameters: + - id: tree + type: ParseTree + description: >- + The + to + visit. + return: + description: The result of visiting the parse tree. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visit + - name: visitChildren(RuleNode) + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitChildren + package: adaptive-expressions-ie11 + summary: |- + Visit the children of a node, and return a user-defined result + of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visitChildren(node: RuleNode): Result' + parameters: + - id: node + type: RuleNode + description: The whose children should be visited. + return: + description: The result of visiting the children of the node. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visitChildren + - name: visitErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitErrorNode + package: adaptive-expressions-ie11 + summary: Visit an error node, and return a user-defined result of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visitErrorNode(node: ErrorNode): Result' + parameters: + - id: node + type: ErrorNode + description: >- + The to + visit. + return: + description: The result of visiting the node. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visitErrorNode + - name: visitTerminal(TerminalNode) + uid: adaptive-expressions-ie11.CommonRegexVisitor.visitTerminal + package: adaptive-expressions-ie11 + summary: Visit a terminal node, and return a user-defined result of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visitTerminal(node: TerminalNode): Result' + parameters: + - id: node + type: TerminalNode + description: >- + The + + to visit. + return: + description: The result of visiting the node. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visitTerminal +extends: ParseTreeVisitor<Result> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ComparisonEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ComparisonEvaluator.yml new file mode 100644 index 00000000..3e14ec3d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ComparisonEvaluator.yml @@ -0,0 +1,130 @@ +### YamlMime:TSType +name: ComparisonEvaluator +uid: adaptive-expressions-ie11.ComparisonEvaluator +package: adaptive-expressions-ie11 +summary: >- + Comparison operators. + + A comparison operator returns false if the comparison is false, or there is an + error. This prevents errors from short-circuiting boolean expressions. +fullName: ComparisonEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + ComparisonEvaluator(string, (arg0: any[]) => boolean, + ValidateExpressionDelegate, VerifyExpression) + uid: adaptive-expressions-ie11.ComparisonEvaluator.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [ComparisonEvaluator](xref:adaptive-expressions.ComparisonEvaluator) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new ComparisonEvaluator(type: string, func: (arg0: any[]) => boolean, + validator: ValidateExpressionDelegate, verify?: VerifyExpression) + parameters: + - id: type + type: string + description: Name of the built-in function. + - id: func + type: '(arg0: any[]) => boolean' + description: >- + The comparison function, it takes a list of objects and returns a + boolean. + - id: validator + type: + description: >- + [ValidateExpressionDelegate](xref:adaptive-expressions.ValidateExpressionDelegate) + for input arguments. + - id: verify + type: + description: >- + Optional. + [VerifyExpression](xref:adaptive-expressions.VerifyExpression) + function to verify each child's result. +inheritedProperties: + - name: negation + uid: adaptive-expressions-ie11.ComparisonEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions-ie11.ExpressionEvaluator.negation) + - name: returnType + uid: adaptive-expressions-ie11.ComparisonEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.returnType](xref:adaptive-expressions-ie11.ExpressionEvaluator.returnType) + - name: tryEvaluate + uid: adaptive-expressions-ie11.ComparisonEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions-ie11.ComparisonEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.type](xref:adaptive-expressions-ie11.ExpressionEvaluator.type) + - name: validateExpression + uid: adaptive-expressions-ie11.ComparisonEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.validateExpression](xref:adaptive-expressions-ie11.ExpressionEvaluator.validateExpression) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Constant.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Constant.yml new file mode 100644 index 00000000..1035a17e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Constant.yml @@ -0,0 +1,474 @@ +### YamlMime:TSType +name: Constant +uid: adaptive-expressions-ie11.Constant +package: adaptive-expressions-ie11 +summary: Construct an expression constant. +fullName: Constant +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Constant(any) + uid: adaptive-expressions-ie11.Constant.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [Constant](xref:adaptive-expressions.Constant) class. + + Constructs an expression constant. + remarks: '' + isDeprecated: false + syntax: + content: 'new Constant(value: any)' + parameters: + - id: value + type: any + description: Constant value. +properties: + - name: value + uid: adaptive-expressions-ie11.Constant.value + package: adaptive-expressions-ie11 + summary: Sets constant value. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any +inheritedProperties: + - name: children + uid: adaptive-expressions-ie11.Constant.children + package: adaptive-expressions-ie11 + summary: Children expressions. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children: Expression[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Expression.children](xref:adaptive-expressions-ie11.Expression.children) + - name: evaluator + uid: adaptive-expressions-ie11.Constant.evaluator + package: adaptive-expressions-ie11 + summary: Evaluator of expression. + fullName: evaluator + remarks: '' + isDeprecated: false + syntax: + content: 'evaluator: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Expression.evaluator](xref:adaptive-expressions-ie11.Expression.evaluator) + - name: functions + uid: adaptive-expressions-ie11.Constant.functions + package: adaptive-expressions-ie11 + summary: >- + Dictionary of function => ExpressionEvaluator. + + This is all available functions, you can add custom functions to it, but + you cannot + + replace builtin functions. If you clear the dictionary, it will be reset + to the built in functions. + fullName: functions + remarks: '' + isDeprecated: false + syntax: + content: 'static functions: FunctionTable' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Expression.functions](xref:adaptive-expressions-ie11.Expression.functions) + - name: returnType + uid: adaptive-expressions-ie11.Constant.returnType + package: adaptive-expressions-ie11 + summary: Expected result of evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: The expected result of evaluating the expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.returnType](xref:adaptive-expressions-ie11.Expression.returnType) + - name: type + uid: adaptive-expressions-ie11.Constant.type + package: adaptive-expressions-ie11 + summary: Type of expression. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: The type of the expression. + type: string + inheritanceDescription: >- + Inherited From + [Expression.type](xref:adaptive-expressions-ie11.Expression.type) + - name: validate + uid: adaptive-expressions-ie11.Constant.validate + package: adaptive-expressions-ie11 + summary: Validate immediate expression. + fullName: validate + remarks: '' + isDeprecated: false + syntax: + content: 'validate: () => void' + return: + description: '' + type: () => void + inheritanceDescription: >- + Inherited From + [Expression.validate](xref:adaptive-expressions-ie11.Expression.validate) +inheritedMethods: + - name: andExpression(Expression[]) + uid: adaptive-expressions-ie11.Constant.andExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an And expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function andExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.andExpression](xref:adaptive-expressions-ie11.Expression.andExpression) + - name: equalsExpression(Expression[]) + uid: adaptive-expressions-ie11.Constant.equalsExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Equals expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function equalsExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.equalsExpression](xref:adaptive-expressions-ie11.Expression.equalsExpression) + - name: lambaExpression(EvaluateExpressionDelegate) + uid: adaptive-expressions-ie11.Constant.lambaExpression + package: adaptive-expressions-ie11 + summary: Construct an expression from a EvaluateExpressionDelegate + remarks: '' + isDeprecated: false + syntax: + content: >- + static function lambaExpression(func: EvaluateExpressionDelegate): + Expression + parameters: + - id: func + type: + description: Function to create an expression from. + return: + description: The new expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.lambaExpression](xref:adaptive-expressions-ie11.Expression.lambaExpression) + - name: 'lambda((arg0: any) => any)' + uid: adaptive-expressions-ie11.Constant.lambda + package: adaptive-expressions-ie11 + summary: |- + Construct an expression from a lamba expression over the state. + Exceptions will be caught and surfaced as an error string. + remarks: '' + isDeprecated: false + syntax: + content: 'static function lambda(func: (arg0: any) => any): Expression' + parameters: + - id: func + type: '(arg0: any) => any' + description: ambda expression to evaluate. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.lambda](xref:adaptive-expressions-ie11.Expression.lambda) + - name: lookup(string) + uid: adaptive-expressions-ie11.Constant.lookup + package: adaptive-expressions-ie11 + summary: >- + Lookup an + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + function by name. + remarks: '' + isDeprecated: false + syntax: + content: 'static function lookup(functionName: string): ExpressionEvaluator' + parameters: + - id: functionName + type: string + description: Name of function to lookup. + return: + description: >- + An + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + corresponding to the function name. + type: + inheritanceDescription: >- + Inherited From + [Expression.lookup](xref:adaptive-expressions-ie11.Expression.lookup) + - name: makeExpression(string, ExpressionEvaluator, Expression[]) + uid: adaptive-expressions-ie11.Constant.makeExpression + package: adaptive-expressions-ie11 + summary: Make an expression and validate it. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function makeExpression(type: string, evaluator: + ExpressionEvaluator, children: Expression[]): Expression + parameters: + - id: type + type: string + description: Type of expression from ExpressionType. + - id: evaluator + type: + description: Information about how to validate and evaluate expression. + - id: children + type: [] + description: Child expressions. + return: + description: The new expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.makeExpression](xref:adaptive-expressions-ie11.Expression.makeExpression) + - name: notExpression(Expression) + uid: adaptive-expressions-ie11.Constant.notExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Not expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function notExpression(child: Expression): Expression' + parameters: + - id: child + type: + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.notExpression](xref:adaptive-expressions-ie11.Expression.notExpression) + - name: orExpression(Expression[]) + uid: adaptive-expressions-ie11.Constant.orExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Or expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function orExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.orExpression](xref:adaptive-expressions-ie11.Expression.orExpression) + - name: parse(string, EvaluatorLookup) + uid: adaptive-expressions-ie11.Constant.parse + package: adaptive-expressions-ie11 + summary: >- + Parse an expression string into an + [Expression](xref:adaptive-expressions.Expression) object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function parse(expression: string, lookup?: EvaluatorLookup): + Expression + parameters: + - id: expression + type: string + description: Expression string. + - id: lookup + type: + description: >- + Optional. + [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) + function lookup when parsing the expression. Default is + [Expression.lookup](xref:adaptive-expressions.Expression.lookup) + which uses + [Expression.functions](xref:adaptive-expressions.Expression.functions) + table. + return: + description: The expression object. + type: + inheritanceDescription: >- + Inherited From + [Expression.parse](xref:adaptive-expressions-ie11.Expression.parse) + - name: references() + uid: adaptive-expressions-ie11.Constant.references + package: adaptive-expressions-ie11 + summary: >- + Return the static reference paths to memory. + + Return all static paths to memory. If there is a computed element index, + then the path is terminated there, + + but you might get other paths from the computed part as well. + remarks: '' + isDeprecated: false + syntax: + content: 'function references(): string[]' + return: + description: List of the static reference paths. + type: string[] + inheritanceDescription: >- + Inherited From + [Expression.references](xref:adaptive-expressions-ie11.Expression.references) + - name: 'referenceWalk(Expression, (arg0: Expression) => boolean)' + uid: adaptive-expressions-ie11.Constant.referenceWalk + package: adaptive-expressions-ie11 + summary: >- + Walking function for identifying static memory references in an + expression. + remarks: '' + isDeprecated: false + syntax: + content: >- + function referenceWalk(expression: Expression, extension?: (arg0: + Expression) => boolean): { path: string, refs: Set } + parameters: + - id: expression + type: + description: Expression to analyze. + - id: extension + type: '(arg0: Expression) => boolean' + description: >- + If present, called to override lookup for things like template + expansion. + return: + description: Accessor path of expression. + type: '{ path: string, refs: Set<string> }' + inheritanceDescription: >- + Inherited From + [Expression.referenceWalk](xref:adaptive-expressions-ie11.Expression.referenceWalk) + - name: setPathToValue(Expression, any) + uid: adaptive-expressions-ie11.Constant.setPathToValue + package: adaptive-expressions-ie11 + summary: Construct and validate an Set a property expression to a value expression. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function setPathToValue(property: Expression, value: any): + Expression + parameters: + - id: property + type: + description: property expression. + - id: value + type: any + description: value expression. + return: + description: New expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.setPathToValue](xref:adaptive-expressions-ie11.Expression.setPathToValue) + - name: tryEvaluate(any, Options) + uid: adaptive-expressions-ie11.Constant.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate the expression. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryEvaluate(state: any, options?: Options): ValueWithError' + parameters: + - id: state + type: any + description: >- + Global state to evaluate accessor expressions against. Can be + Dictionary, otherwise reflection is used to access property and then + indexer. + - id: options + type: + description: Options used in the evaluation. + return: + description: >- + Computed value and an error string. If the string is non-null, then + there was an evaluation error. + type: + inheritanceDescription: >- + Inherited From + [Expression.tryEvaluate](xref:adaptive-expressions-ie11.Expression.tryEvaluate) + - name: validateTree() + uid: adaptive-expressions-ie11.Constant.validateTree + package: adaptive-expressions-ie11 + summary: Recursively validate the expression tree. + remarks: '' + isDeprecated: false + syntax: + content: function validateTree() + inheritanceDescription: >- + Inherited From + [Expression.validateTree](xref:adaptive-expressions-ie11.Expression.validateTree) +methods: + - name: deepEquals(Expression) + uid: adaptive-expressions-ie11.Constant.deepEquals + package: adaptive-expressions-ie11 + summary: >- + Determines if the current + [Expression](xref:adaptive-expressions.Expression) instance is deep equal + to another one. + remarks: '' + isDeprecated: false + syntax: + content: 'function deepEquals(other: Expression): boolean' + parameters: + - id: other + type: + description: >- + The other [Expression](xref:adaptive-expressions.Expression) + instance to compare. + return: + description: >- + A boolean value indicating whether the two expressions are deep equal + (`true`) or not (`false`). + type: boolean + - name: toString() + uid: adaptive-expressions-ie11.Constant.toString + package: adaptive-expressions-ie11 + summary: Returns a string that represents the current constant object. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: A string that represents the current constant object. + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitContext.yml new file mode 100644 index 00000000..785fb64e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitContext.yml @@ -0,0 +1,927 @@ +### YamlMime:TSType +name: DigitContext +uid: adaptive-expressions-ie11.DigitContext +package: adaptive-expressions-ie11 +summary: '' +fullName: DigitContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: DigitContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.DigitContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new DigitContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.DigitContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.DigitContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.DigitContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.DigitContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.DigitContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.DigitContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.DigitContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.DigitContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.DigitContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.DigitContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: DigitContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.DigitContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.DigitContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.DigitContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.DigitContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.DigitContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.DigitContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.DigitContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.DigitContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.DigitContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.DigitContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.DigitContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.DigitContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.DigitContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.DigitContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.DigitContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.DigitContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.DigitContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.DigitContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.DigitContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.DigitContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.DigitContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.DigitContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.DigitContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.DigitContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.DigitContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.DigitContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.DigitContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.DigitContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.DigitContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.DigitContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: D0() + uid: adaptive-expressions-ie11.DigitContext.D0 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D0(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D1() + uid: adaptive-expressions-ie11.DigitContext.D1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D1(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D2() + uid: adaptive-expressions-ie11.DigitContext.D2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D2(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D3() + uid: adaptive-expressions-ie11.DigitContext.D3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D3(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D4() + uid: adaptive-expressions-ie11.DigitContext.D4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D4(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D5() + uid: adaptive-expressions-ie11.DigitContext.D5 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D5(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D6() + uid: adaptive-expressions-ie11.DigitContext.D6 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D6(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D7() + uid: adaptive-expressions-ie11.DigitContext.D7 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D7(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D8() + uid: adaptive-expressions-ie11.DigitContext.D8 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D8(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D9() + uid: adaptive-expressions-ie11.DigitContext.D9 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D9(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.DigitContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.DigitContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitsContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitsContext.yml new file mode 100644 index 00000000..69d686d7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/DigitsContext.yml @@ -0,0 +1,843 @@ +### YamlMime:TSType +name: DigitsContext +uid: adaptive-expressions-ie11.DigitsContext +package: adaptive-expressions-ie11 +summary: '' +fullName: DigitsContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: DigitsContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.DigitsContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new DigitsContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.DigitsContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.DigitsContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.DigitsContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.DigitsContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.DigitsContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.DigitsContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.DigitsContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.DigitsContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.DigitsContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.DigitsContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: DigitsContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.DigitsContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.DigitsContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.DigitsContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.DigitsContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.DigitsContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.DigitsContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.DigitsContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.DigitsContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.DigitsContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.DigitsContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.DigitsContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.DigitsContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.DigitsContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.DigitsContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitsContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.DigitsContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitsContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitsContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.DigitsContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.DigitsContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.DigitsContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.DigitsContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.DigitsContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.DigitsContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.DigitsContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.DigitsContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.DigitsContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.DigitsContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.DigitsContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.DigitsContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.DigitsContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitsContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.DigitsContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.DigitsContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.DigitsContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: digit() + uid: adaptive-expressions-ie11.DigitsContext.digit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digit(): DigitContext[]' + return: + description: '' + type: [] + - name: digit(number) + uid: adaptive-expressions-ie11.DigitsContext.digit_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digit(i: number): DigitContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.DigitsContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.DigitsContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ElementContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ElementContext.yml new file mode 100644 index 00000000..693ad074 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ElementContext.yml @@ -0,0 +1,839 @@ +### YamlMime:TSType +name: ElementContext +uid: adaptive-expressions-ie11.ElementContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ElementContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ElementContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.ElementContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ElementContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.ElementContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ElementContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.ElementContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.ElementContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.ElementContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.ElementContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.ElementContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.ElementContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.ElementContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.ElementContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ElementContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.ElementContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.ElementContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.ElementContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.ElementContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ElementContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ElementContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ElementContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.ElementContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ElementContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ElementContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.ElementContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.ElementContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.ElementContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.ElementContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ElementContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ElementContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ElementContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ElementContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ElementContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.ElementContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.ElementContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ElementContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ElementContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.ElementContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ElementContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ElementContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ElementContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ElementContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.ElementContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ElementContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ElementContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ElementContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ElementContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ElementContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.ElementContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: atom() + uid: adaptive-expressions-ie11.ElementContext.atom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function atom(): AtomContext' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.ElementContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.ElementContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: quantifier() + uid: adaptive-expressions-ie11.ElementContext.quantifier + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function quantifier(): undefined | QuantifierContext' + return: + description: '' + type: undefined | +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpression.yml new file mode 100644 index 00000000..92ac9aa8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpression.yml @@ -0,0 +1,138 @@ +### YamlMime:TSType +name: EnumExpression +uid: adaptive-expressions-ie11.EnumExpression +package: adaptive-expressions-ie11 +summary: >- + EnumExpression - represents a property which is either an enum of T or a + string expression which resolves to an enum. +fullName: EnumExpression +remarks: >- + String values are always interpreted as an expression whether it has '=' + prefix or not, as string values cannot be parsed to enum values. +isDeprecated: false +type: class +constructors: + - name: EnumExpression(string | Expression | T) + uid: adaptive-expressions-ie11.EnumExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [EnumExpression](xref:adaptive-expressions.EnumExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new EnumExpression(value: string | Expression | T)' + parameters: + - id: value + type: string | | T + description: An enum of `T` or a `string` expression which resolves to an `enum`. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.EnumExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.EnumExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.EnumExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): T' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: T + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.EnumExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.EnumExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.EnumExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: T }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: T }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +methods: + - name: setValue(string | Expression | T) + uid: adaptive-expressions-ie11.EnumExpression.setValue + package: adaptive-expressions-ie11 + summary: Set an enum value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | Expression | T)' + parameters: + - id: value + type: string | | T + description: value to set. +extends: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpressionConverter.yml new file mode 100644 index 00000000..cd1dad80 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EnumExpressionConverter.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: EnumExpressionConverter +uid: adaptive-expressions-ie11.EnumExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `string` to json [EnumExpression](xref:adaptive-expressions.EnumExpression) + converter. +fullName: EnumExpressionConverter +remarks: '' +isDeprecated: false +type: class +constructors: + - name: EnumExpressionConverter(unknown) + uid: adaptive-expressions-ie11.EnumExpressionConverter.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [EnumExpressionConverter](xref:adaptive-expressions.EnumExpressionConverter) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new EnumExpressionConverter(enumValue: unknown)' + parameters: + - id: enumValue + type: unknown + description: The enum value of the `string` to convert. +methods: + - name: convert(Input | EnumExpression) + uid: adaptive-expressions-ie11.EnumExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts a `string` into an + [EnumExpression](xref:adaptive-expressions.EnumExpression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: Input | EnumExpression): EnumExpression' + parameters: + - id: value + type: >- + Input<T> | <T> + description: '`string` to convert.' + return: + description: The [EnumExpression](xref:adaptive-expressions.EnumExpression). + type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluateExpressionDelegate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluateExpressionDelegate.yml new file mode 100644 index 00000000..15b9a88a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluateExpressionDelegate.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: EvaluateExpressionDelegate +uid: adaptive-expressions-ie11.EvaluateExpressionDelegate +package: adaptive-expressions-ie11 +summary: >- + Delegate to evaluate an expression. + + Evaluators should verify runtime arguments when appropriate and return an + error rather than throw exceptions if possible. +fullName: EvaluateExpressionDelegate +remarks: '' +isDeprecated: false +syntax: | + type EvaluateExpressionDelegate = ( + expression: Expression, + state: MemoryInterface, + options: Options + ) => ValueWithError diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluatorLookup.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluatorLookup.yml new file mode 100644 index 00000000..a482428f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/EvaluatorLookup.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: EvaluatorLookup +uid: adaptive-expressions-ie11.EvaluatorLookup +package: adaptive-expressions-ie11 +summary: Delegate to lookup function information from the type. +fullName: EvaluatorLookup +remarks: '' +isDeprecated: false +syntax: | + type EvaluatorLookup = (type: string) => ExpressionEvaluator diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExprContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExprContext.yml new file mode 100644 index 00000000..11f72c7b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExprContext.yml @@ -0,0 +1,843 @@ +### YamlMime:TSType +name: ExprContext +uid: adaptive-expressions-ie11.ExprContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ExprContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ExprContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.ExprContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ExprContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.ExprContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ExprContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.ExprContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.ExprContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.ExprContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.ExprContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.ExprContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.ExprContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.ExprContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.ExprContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ExprContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.ExprContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.ExprContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.ExprContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.ExprContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ExprContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ExprContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ExprContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.ExprContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ExprContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ExprContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.ExprContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.ExprContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.ExprContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.ExprContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExprContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ExprContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExprContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ExprContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ExprContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.ExprContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.ExprContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ExprContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ExprContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.ExprContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ExprContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ExprContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ExprContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ExprContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.ExprContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ExprContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ExprContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExprContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExprContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ExprContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.ExprContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: element() + uid: adaptive-expressions-ie11.ExprContext.element + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function element(): ElementContext[]' + return: + description: '' + type: [] + - name: element(number) + uid: adaptive-expressions-ie11.ExprContext.element_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function element(i: number): ElementContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.ExprContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.ExprContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Expression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Expression.yml new file mode 100644 index 00000000..503f7367 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Expression.yml @@ -0,0 +1,407 @@ +### YamlMime:TSType +name: Expression +uid: adaptive-expressions-ie11.Expression +package: adaptive-expressions-ie11 +summary: >- + An expression which can be analyzed or evaluated to produce a value. + + This provides an open-ended wrapper that supports a number of built-in + functions and can also be extended at runtime. + + It also supports validation of the correctness of an expression and evaluation + that should be exception free. +fullName: Expression +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Expression(string, ExpressionEvaluator, Expression[]) + uid: adaptive-expressions-ie11.Expression.constructor + package: adaptive-expressions-ie11 + summary: expression constructor. + remarks: '' + isDeprecated: false + syntax: + content: >- + new Expression(type: string, evaluator: ExpressionEvaluator, children: + Expression[]) + parameters: + - id: type + type: string + description: Type of expression from ExpressionType + - id: evaluator + type: + description: Information about how to validate and evaluate expression. + - id: children + type: [] + description: Child expressions. +properties: + - name: children + uid: adaptive-expressions-ie11.Expression.children + package: adaptive-expressions-ie11 + summary: Children expressions. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children: Expression[]' + return: + description: '' + type: [] + - name: evaluator + uid: adaptive-expressions-ie11.Expression.evaluator + package: adaptive-expressions-ie11 + summary: Evaluator of expression. + fullName: evaluator + remarks: '' + isDeprecated: false + syntax: + content: 'evaluator: ExpressionEvaluator' + return: + description: '' + type: + - name: functions + uid: adaptive-expressions-ie11.Expression.functions + package: adaptive-expressions-ie11 + summary: >- + Dictionary of function => ExpressionEvaluator. + + This is all available functions, you can add custom functions to it, but + you cannot + + replace builtin functions. If you clear the dictionary, it will be reset + to the built in functions. + fullName: functions + remarks: '' + isDeprecated: false + syntax: + content: 'static functions: FunctionTable' + return: + description: '' + type: + - name: returnType + uid: adaptive-expressions-ie11.Expression.returnType + package: adaptive-expressions-ie11 + summary: Expected result of evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: The expected result of evaluating the expression. + type: + - name: type + uid: adaptive-expressions-ie11.Expression.type + package: adaptive-expressions-ie11 + summary: Type of expression. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: The type of the expression. + type: string + - name: validate + uid: adaptive-expressions-ie11.Expression.validate + package: adaptive-expressions-ie11 + summary: Validate immediate expression. + fullName: validate + remarks: '' + isDeprecated: false + syntax: + content: 'validate: () => void' + return: + description: '' + type: () => void +methods: + - name: andExpression(Expression[]) + uid: adaptive-expressions-ie11.Expression.andExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an And expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function andExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + - name: deepEquals(Expression) + uid: adaptive-expressions-ie11.Expression.deepEquals + package: adaptive-expressions-ie11 + summary: Do a deep equality between expressions. + remarks: '' + isDeprecated: false + syntax: + content: 'function deepEquals(other: Expression): boolean' + parameters: + - id: other + type: + description: Other expression. + return: + description: True if expressions are the same. + type: boolean + - name: equalsExpression(Expression[]) + uid: adaptive-expressions-ie11.Expression.equalsExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Equals expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function equalsExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + - name: lambaExpression(EvaluateExpressionDelegate) + uid: adaptive-expressions-ie11.Expression.lambaExpression + package: adaptive-expressions-ie11 + summary: Construct an expression from a EvaluateExpressionDelegate + remarks: '' + isDeprecated: false + syntax: + content: >- + static function lambaExpression(func: EvaluateExpressionDelegate): + Expression + parameters: + - id: func + type: + description: Function to create an expression from. + return: + description: The new expression. + type: + - name: 'lambda((arg0: any) => any)' + uid: adaptive-expressions-ie11.Expression.lambda + package: adaptive-expressions-ie11 + summary: |- + Construct an expression from a lamba expression over the state. + Exceptions will be caught and surfaced as an error string. + remarks: '' + isDeprecated: false + syntax: + content: 'static function lambda(func: (arg0: any) => any): Expression' + parameters: + - id: func + type: '(arg0: any) => any' + description: ambda expression to evaluate. + return: + description: New expression. + type: + - name: lookup(string) + uid: adaptive-expressions-ie11.Expression.lookup + package: adaptive-expressions-ie11 + summary: >- + Lookup an + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + function by name. + remarks: '' + isDeprecated: false + syntax: + content: 'static function lookup(functionName: string): ExpressionEvaluator' + parameters: + - id: functionName + type: string + description: Name of function to lookup. + return: + description: >- + An + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + corresponding to the function name. + type: + - name: makeExpression(string, ExpressionEvaluator, Expression[]) + uid: adaptive-expressions-ie11.Expression.makeExpression + package: adaptive-expressions-ie11 + summary: Make an expression and validate it. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function makeExpression(type: string, evaluator: + ExpressionEvaluator, children: Expression[]): Expression + parameters: + - id: type + type: string + description: Type of expression from ExpressionType. + - id: evaluator + type: + description: Information about how to validate and evaluate expression. + - id: children + type: [] + description: Child expressions. + return: + description: The new expression. + type: + - name: notExpression(Expression) + uid: adaptive-expressions-ie11.Expression.notExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Not expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function notExpression(child: Expression): Expression' + parameters: + - id: child + type: + description: Child clauses. + return: + description: New expression. + type: + - name: orExpression(Expression[]) + uid: adaptive-expressions-ie11.Expression.orExpression + package: adaptive-expressions-ie11 + summary: Construct and validate an Or expression. + remarks: '' + isDeprecated: false + syntax: + content: 'static function orExpression(children: Expression[]): Expression' + parameters: + - id: children + type: [] + description: Child clauses. + return: + description: New expression. + type: + - name: parse(string, EvaluatorLookup) + uid: adaptive-expressions-ie11.Expression.parse + package: adaptive-expressions-ie11 + summary: >- + Parse an expression string into an + [Expression](xref:adaptive-expressions.Expression) object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function parse(expression: string, lookup?: EvaluatorLookup): + Expression + parameters: + - id: expression + type: string + description: Expression string. + - id: lookup + type: + description: >- + Optional. + [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) + function lookup when parsing the expression. Default is + [Expression.lookup](xref:adaptive-expressions.Expression.lookup) + which uses + [Expression.functions](xref:adaptive-expressions.Expression.functions) + table. + return: + description: The expression object. + type: + - name: references() + uid: adaptive-expressions-ie11.Expression.references + package: adaptive-expressions-ie11 + summary: >- + Return the static reference paths to memory. + + Return all static paths to memory. If there is a computed element index, + then the path is terminated there, + + but you might get other paths from the computed part as well. + remarks: '' + isDeprecated: false + syntax: + content: 'function references(): string[]' + return: + description: List of the static reference paths. + type: string[] + - name: 'referenceWalk(Expression, (arg0: Expression) => boolean)' + uid: adaptive-expressions-ie11.Expression.referenceWalk + package: adaptive-expressions-ie11 + summary: >- + Walking function for identifying static memory references in an + expression. + remarks: '' + isDeprecated: false + syntax: + content: >- + function referenceWalk(expression: Expression, extension?: (arg0: + Expression) => boolean): { path: string, refs: Set } + parameters: + - id: expression + type: + description: Expression to analyze. + - id: extension + type: '(arg0: Expression) => boolean' + description: >- + If present, called to override lookup for things like template + expansion. + return: + description: Accessor path of expression. + type: '{ path: string, refs: Set<string> }' + - name: setPathToValue(Expression, any) + uid: adaptive-expressions-ie11.Expression.setPathToValue + package: adaptive-expressions-ie11 + summary: Construct and validate an Set a property expression to a value expression. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function setPathToValue(property: Expression, value: any): + Expression + parameters: + - id: property + type: + description: property expression. + - id: value + type: any + description: value expression. + return: + description: New expression. + type: + - name: toString() + uid: adaptive-expressions-ie11.Expression.toString + package: adaptive-expressions-ie11 + summary: >- + Returns a string that represents the current + [Expression](xref:adaptive-expressions.Expression) object. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: >- + A string that represents the current + [Expression](xref:adaptive-expressions.Expression) object. + type: string + - name: tryEvaluate(any, Options) + uid: adaptive-expressions-ie11.Expression.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate the expression. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryEvaluate(state: any, options?: Options): ValueWithError' + parameters: + - id: state + type: any + description: >- + Global state to evaluate accessor expressions against. Can be + Dictionary, otherwise reflection is used to access property and then + indexer. + - id: options + type: + description: Options used in the evaluation. + return: + description: >- + Computed value and an error string. If the string is non-null, then + there was an evaluation error. + type: + - name: validateTree() + uid: adaptive-expressions-ie11.Expression.validateTree + package: adaptive-expressions-ie11 + summary: Recursively validate the expression tree. + remarks: '' + isDeprecated: false + syntax: + content: function validateTree() diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrLexer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrLexer.yml new file mode 100644 index 00000000..017b1a97 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrLexer.yml @@ -0,0 +1,1347 @@ +### YamlMime:TSType +name: ExpressionAntlrLexer +uid: adaptive-expressions-ie11.ExpressionAntlrLexer +package: adaptive-expressions-ie11 +summary: '' +fullName: ExpressionAntlrLexer +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ExpressionAntlrLexer(CharStream) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ExpressionAntlrLexer(input: CharStream)' + parameters: + - id: input + type: CharStream + description: '' +properties: + - name: ARROW + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.ARROW + package: adaptive-expressions-ie11 + summary: '' + fullName: ARROW + remarks: '' + isDeprecated: false + syntax: + content: 'static ARROW: 27 = 27' + return: + description: '' + type: '27' + - name: ASTERISK + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.ASTERISK + package: adaptive-expressions-ie11 + summary: '' + fullName: ASTERISK + remarks: '' + isDeprecated: false + syntax: + content: 'static ASTERISK: 6 = 6' + return: + description: '' + type: '6' + - name: channelNames + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.channelNames + package: adaptive-expressions-ie11 + summary: '' + fullName: channelNames + remarks: '' + isDeprecated: false + syntax: + content: 'channelNames: string[]' + return: + description: '' + type: string[] + - name: channelNames + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.channelNames + package: adaptive-expressions-ie11 + summary: '' + fullName: channelNames + remarks: '' + isDeprecated: false + syntax: + content: 'static channelNames: string[]' + return: + description: '' + type: string[] + - name: CLOSE_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.CLOSE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: CLOSE_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static CLOSE_BRACKET: 19 = 19' + return: + description: '' + type: '19' + - name: CLOSE_CURLY_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.CLOSE_CURLY_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: CLOSE_CURLY_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static CLOSE_CURLY_BRACKET: 24 = 24' + return: + description: '' + type: '24' + - name: CLOSE_SQUARE_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.CLOSE_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: CLOSE_SQUARE_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static CLOSE_SQUARE_BRACKET: 22 = 22' + return: + description: '' + type: '22' + - name: COLON + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.COLON + package: adaptive-expressions-ie11 + summary: '' + fullName: COLON + remarks: '' + isDeprecated: false + syntax: + content: 'static COLON: 26 = 26' + return: + description: '' + type: '26' + - name: COMMA + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.COMMA + package: adaptive-expressions-ie11 + summary: '' + fullName: COMMA + remarks: '' + isDeprecated: false + syntax: + content: 'static COMMA: 25 = 25' + return: + description: '' + type: '25' + - name: DOT + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.DOT + package: adaptive-expressions-ie11 + summary: '' + fullName: DOT + remarks: '' + isDeprecated: false + syntax: + content: 'static DOT: 20 = 20' + return: + description: '' + type: '20' + - name: DOUBLE_AND + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.DOUBLE_AND + package: adaptive-expressions-ie11 + summary: '' + fullName: DOUBLE_AND + remarks: '' + isDeprecated: false + syntax: + content: 'static DOUBLE_AND: 12 = 12' + return: + description: '' + type: '12' + - name: DOUBLE_EQUAL + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.DOUBLE_EQUAL + package: adaptive-expressions-ie11 + summary: '' + fullName: DOUBLE_EQUAL + remarks: '' + isDeprecated: false + syntax: + content: 'static DOUBLE_EQUAL: 9 = 9' + return: + description: '' + type: '9' + - name: DOUBLE_VERTICAL_CYLINDER + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.DOUBLE_VERTICAL_CYLINDER + package: adaptive-expressions-ie11 + summary: '' + fullName: DOUBLE_VERTICAL_CYLINDER + remarks: '' + isDeprecated: false + syntax: + content: 'static DOUBLE_VERTICAL_CYLINDER: 13 = 13' + return: + description: '' + type: '13' + - name: ESCAPE_CHARACTER + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.ESCAPE_CHARACTER + package: adaptive-expressions-ie11 + summary: '' + fullName: ESCAPE_CHARACTER + remarks: '' + isDeprecated: false + syntax: + content: 'static ESCAPE_CHARACTER: 37 = 37' + return: + description: '' + type: '37' + - name: grammarFileName + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.grammarFileName + package: adaptive-expressions-ie11 + summary: '' + fullName: grammarFileName + remarks: '' + isDeprecated: false + syntax: + content: 'grammarFileName: string' + return: + description: '' + type: string + - name: IDENTIFIER + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.IDENTIFIER + package: adaptive-expressions-ie11 + summary: '' + fullName: IDENTIFIER + remarks: '' + isDeprecated: false + syntax: + content: 'static IDENTIFIER: 32 = 32' + return: + description: '' + type: '32' + - name: ignoreWS + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.ignoreWS + package: adaptive-expressions-ie11 + summary: '' + fullName: ignoreWS + remarks: '' + isDeprecated: false + syntax: + content: 'ignoreWS: boolean' + return: + description: '' + type: boolean + - name: INVALID_TOKEN_DEFAULT_MODE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.INVALID_TOKEN_DEFAULT_MODE + package: adaptive-expressions-ie11 + summary: '' + fullName: INVALID_TOKEN_DEFAULT_MODE + remarks: '' + isDeprecated: false + syntax: + content: 'static INVALID_TOKEN_DEFAULT_MODE: 35 = 35' + return: + description: '' + type: '35' + - name: LESS_OR_EQUAl + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.LESS_OR_EQUAl + package: adaptive-expressions-ie11 + summary: '' + fullName: LESS_OR_EQUAl + remarks: '' + isDeprecated: false + syntax: + content: 'static LESS_OR_EQUAl: 16 = 16' + return: + description: '' + type: '16' + - name: LESS_THAN + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.LESS_THAN + package: adaptive-expressions-ie11 + summary: '' + fullName: LESS_THAN + remarks: '' + isDeprecated: false + syntax: + content: 'static LESS_THAN: 14 = 14' + return: + description: '' + type: '14' + - name: modeNames + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.modeNames + package: adaptive-expressions-ie11 + summary: '' + fullName: modeNames + remarks: '' + isDeprecated: false + syntax: + content: 'modeNames: string[]' + return: + description: '' + type: string[] + - name: modeNames + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.modeNames + package: adaptive-expressions-ie11 + summary: '' + fullName: modeNames + remarks: '' + isDeprecated: false + syntax: + content: 'static modeNames: string[]' + return: + description: '' + type: string[] + - name: MORE_OR_EQUAL + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.MORE_OR_EQUAL + package: adaptive-expressions-ie11 + summary: '' + fullName: MORE_OR_EQUAL + remarks: '' + isDeprecated: false + syntax: + content: 'static MORE_OR_EQUAL: 17 = 17' + return: + description: '' + type: '17' + - name: MORE_THAN + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.MORE_THAN + package: adaptive-expressions-ie11 + summary: '' + fullName: MORE_THAN + remarks: '' + isDeprecated: false + syntax: + content: 'static MORE_THAN: 15 = 15' + return: + description: '' + type: '15' + - name: NEWLINE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.NEWLINE + package: adaptive-expressions-ie11 + summary: '' + fullName: NEWLINE + remarks: '' + isDeprecated: false + syntax: + content: 'static NEWLINE: 33 = 33' + return: + description: '' + type: '33' + - name: NON + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.NON + package: adaptive-expressions-ie11 + summary: '' + fullName: NON + remarks: '' + isDeprecated: false + syntax: + content: 'static NON: 4 = 4' + return: + description: '' + type: '4' + - name: NOT_EQUAL + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.NOT_EQUAL + package: adaptive-expressions-ie11 + summary: '' + fullName: NOT_EQUAL + remarks: '' + isDeprecated: false + syntax: + content: 'static NOT_EQUAL: 10 = 10' + return: + description: '' + type: '10' + - name: NULL_COALESCE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.NULL_COALESCE + package: adaptive-expressions-ie11 + summary: '' + fullName: NULL_COALESCE + remarks: '' + isDeprecated: false + syntax: + content: 'static NULL_COALESCE: 28 = 28' + return: + description: '' + type: '28' + - name: NUMBER + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.NUMBER + package: adaptive-expressions-ie11 + summary: '' + fullName: NUMBER + remarks: '' + isDeprecated: false + syntax: + content: 'static NUMBER: 30 = 30' + return: + description: '' + type: '30' + - name: OPEN_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.OPEN_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: OPEN_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static OPEN_BRACKET: 18 = 18' + return: + description: '' + type: '18' + - name: OPEN_CURLY_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.OPEN_CURLY_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: OPEN_CURLY_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static OPEN_CURLY_BRACKET: 23 = 23' + return: + description: '' + type: '23' + - name: OPEN_SQUARE_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.OPEN_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: OPEN_SQUARE_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static OPEN_SQUARE_BRACKET: 21 = 21' + return: + description: '' + type: '21' + - name: PERCENT + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.PERCENT + package: adaptive-expressions-ie11 + summary: '' + fullName: PERCENT + remarks: '' + isDeprecated: false + syntax: + content: 'static PERCENT: 8 = 8' + return: + description: '' + type: '8' + - name: PLUS + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.PLUS + package: adaptive-expressions-ie11 + summary: '' + fullName: PLUS + remarks: '' + isDeprecated: false + syntax: + content: 'static PLUS: 2 = 2' + return: + description: '' + type: '2' + - name: QUESTION_MARK + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.QUESTION_MARK + package: adaptive-expressions-ie11 + summary: '' + fullName: QUESTION_MARK + remarks: '' + isDeprecated: false + syntax: + content: 'static QUESTION_MARK: 29 = 29' + return: + description: '' + type: '29' + - name: ruleNames + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'ruleNames: string[]' + return: + description: '' + type: string[] + - name: ruleNames + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'static ruleNames: string[]' + return: + description: '' + type: string[] + - name: serializedATN + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.serializedATN + package: adaptive-expressions-ie11 + summary: '' + fullName: serializedATN + remarks: '' + isDeprecated: false + syntax: + content: 'serializedATN: string' + return: + description: '' + type: string + - name: SINGLE_AND + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.SINGLE_AND + package: adaptive-expressions-ie11 + summary: '' + fullName: SINGLE_AND + remarks: '' + isDeprecated: false + syntax: + content: 'static SINGLE_AND: 11 = 11' + return: + description: '' + type: '11' + - name: SLASH + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.SLASH + package: adaptive-expressions-ie11 + summary: '' + fullName: SLASH + remarks: '' + isDeprecated: false + syntax: + content: 'static SLASH: 7 = 7' + return: + description: '' + type: '7' + - name: STRING + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.STRING + package: adaptive-expressions-ie11 + summary: '' + fullName: STRING + remarks: '' + isDeprecated: false + syntax: + content: 'static STRING: 34 = 34' + return: + description: '' + type: '34' + - name: STRING_INTERPOLATION_MODE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.STRING_INTERPOLATION_MODE + package: adaptive-expressions-ie11 + summary: '' + fullName: STRING_INTERPOLATION_MODE + remarks: '' + isDeprecated: false + syntax: + content: 'static STRING_INTERPOLATION_MODE: 1 = 1' + return: + description: '' + type: '1' + - name: STRING_INTERPOLATION_START + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.STRING_INTERPOLATION_START + package: adaptive-expressions-ie11 + summary: '' + fullName: STRING_INTERPOLATION_START + remarks: '' + isDeprecated: false + syntax: + content: 'static STRING_INTERPOLATION_START: 1 = 1' + return: + description: '' + type: '1' + - name: SUBSTRACT + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.SUBSTRACT + package: adaptive-expressions-ie11 + summary: '' + fullName: SUBSTRACT + remarks: '' + isDeprecated: false + syntax: + content: 'static SUBSTRACT: 3 = 3' + return: + description: '' + type: '3' + - name: TEMPLATE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.TEMPLATE + package: adaptive-expressions-ie11 + summary: '' + fullName: TEMPLATE + remarks: '' + isDeprecated: false + syntax: + content: 'static TEMPLATE: 36 = 36' + return: + description: '' + type: '36' + - name: TEXT_CONTENT + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.TEXT_CONTENT + package: adaptive-expressions-ie11 + summary: '' + fullName: TEXT_CONTENT + remarks: '' + isDeprecated: false + syntax: + content: 'static TEXT_CONTENT: 38 = 38' + return: + description: '' + type: '38' + - name: vocabulary + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.vocabulary + package: adaptive-expressions-ie11 + summary: '' + fullName: vocabulary + remarks: '' + isDeprecated: false + syntax: + content: 'vocabulary: Vocabulary' + return: + description: '' + type: Vocabulary + - name: VOCABULARY + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.VOCABULARY + package: adaptive-expressions-ie11 + summary: '' + fullName: VOCABULARY + remarks: '' + isDeprecated: false + syntax: + content: 'static VOCABULARY: Vocabulary' + return: + description: '' + type: Vocabulary + - name: WHITESPACE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.WHITESPACE + package: adaptive-expressions-ie11 + summary: '' + fullName: WHITESPACE + remarks: '' + isDeprecated: false + syntax: + content: 'static WHITESPACE: 31 = 31' + return: + description: '' + type: '31' + - name: XOR + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.XOR + package: adaptive-expressions-ie11 + summary: '' + fullName: XOR + remarks: '' + isDeprecated: false + syntax: + content: 'static XOR: 5 = 5' + return: + description: '' + type: '5' +inheritedProperties: + - name: atn + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.atn + package: adaptive-expressions-ie11 + summary: >- + Get the + used by the recognizer for prediction. + fullName: atn + remarks: '' + isDeprecated: false + syntax: + content: 'atn: ATN' + return: + description: >- + The + used by the recognizer for prediction. + type: ATN + inheritanceDescription: Inherited From Lexer.atn + - name: channel + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.channel + package: adaptive-expressions-ie11 + summary: '' + fullName: channel + remarks: '' + isDeprecated: false + syntax: + content: 'channel: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.channel + - name: charIndex + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.charIndex + package: adaptive-expressions-ie11 + summary: What is the index of the current character of lookahead? + fullName: charIndex + remarks: '' + isDeprecated: false + syntax: + content: 'charIndex: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.charIndex + - name: charPositionInLine + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.charPositionInLine + package: adaptive-expressions-ie11 + summary: '' + fullName: charPositionInLine + remarks: '' + isDeprecated: false + syntax: + content: 'charPositionInLine: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.charPositionInLine + - name: DEFAULT_MODE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.DEFAULT_MODE + package: adaptive-expressions-ie11 + summary: '' + fullName: DEFAULT_MODE + remarks: '' + isDeprecated: false + syntax: + content: 'static DEFAULT_MODE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.DEFAULT_MODE + - name: DEFAULT_TOKEN_CHANNEL + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.DEFAULT_TOKEN_CHANNEL + package: adaptive-expressions-ie11 + summary: '' + fullName: DEFAULT_TOKEN_CHANNEL + remarks: '' + isDeprecated: false + syntax: + content: 'static DEFAULT_TOKEN_CHANNEL: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.DEFAULT_TOKEN_CHANNEL + - name: EOF + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.EOF + package: adaptive-expressions-ie11 + summary: '' + fullName: EOF + remarks: '' + isDeprecated: false + syntax: + content: 'static EOF: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.EOF + - name: HIDDEN + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.HIDDEN + package: adaptive-expressions-ie11 + summary: '' + fullName: HIDDEN + remarks: '' + isDeprecated: false + syntax: + content: 'static HIDDEN: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.HIDDEN + - name: inputStream + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.inputStream + package: adaptive-expressions-ie11 + summary: Set the char stream and reset the lexer + fullName: inputStream + remarks: '' + isDeprecated: false + syntax: + content: 'inputStream: CharStream' + return: + description: '' + type: CharStream + inheritanceDescription: Inherited From Lexer.inputStream + - name: interpreter + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.interpreter + package: adaptive-expressions-ie11 + summary: Set the ATN interpreter used by the recognizer for prediction. + fullName: interpreter + remarks: '' + isDeprecated: false + syntax: + content: 'interpreter: LexerATNSimulator' + return: + description: '' + type: LexerATNSimulator + inheritanceDescription: Inherited From Lexer.interpreter + - name: line + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.line + package: adaptive-expressions-ie11 + summary: '' + fullName: line + remarks: '' + isDeprecated: false + syntax: + content: 'line: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.line + - name: MAX_CHAR_VALUE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.MAX_CHAR_VALUE + package: adaptive-expressions-ie11 + summary: '' + fullName: MAX_CHAR_VALUE + remarks: '' + isDeprecated: false + syntax: + content: 'static MAX_CHAR_VALUE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.MAX_CHAR_VALUE + - name: MIN_CHAR_VALUE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.MIN_CHAR_VALUE + package: adaptive-expressions-ie11 + summary: '' + fullName: MIN_CHAR_VALUE + remarks: '' + isDeprecated: false + syntax: + content: 'static MIN_CHAR_VALUE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.MIN_CHAR_VALUE + - name: MORE + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.MORE + package: adaptive-expressions-ie11 + summary: '' + fullName: MORE + remarks: '' + isDeprecated: false + syntax: + content: 'static MORE: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.MORE + - name: parseInfo + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.parseInfo + package: adaptive-expressions-ie11 + summary: |- + If profiling during the parse/lex, this will return DecisionInfo records + for each decision in recognizer in a ParseInfo object. + fullName: parseInfo + remarks: '' + isDeprecated: false + syntax: + content: 'parseInfo: Promise' + return: + description: '' + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Lexer.parseInfo + - name: SKIP + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.SKIP + package: adaptive-expressions-ie11 + summary: '' + fullName: SKIP + remarks: '' + isDeprecated: false + syntax: + content: 'static SKIP: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.SKIP + - name: sourceName + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.sourceName + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceName + remarks: '' + isDeprecated: false + syntax: + content: 'sourceName: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.sourceName + - name: state + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.state + package: adaptive-expressions-ie11 + summary: |- + Indicate that the recognizer has changed internal state that is + consistent with the ATN state passed in. This way we always know + where we are in the ATN as the parser goes along. The rule + context objects form a stack that lets us see the stack of + invoking rules. Combine this and we have complete ATN + configuration information. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.state + - name: text + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.text + package: adaptive-expressions-ie11 + summary: |- + Set the complete text of this token; it wipes any previous + changes to the text. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.text + - name: token + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.token + package: adaptive-expressions-ie11 + summary: Override if emitting multiple tokens. + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From Lexer.token + - name: tokenFactory + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.tokenFactory + package: adaptive-expressions-ie11 + summary: '' + fullName: tokenFactory + remarks: '' + isDeprecated: false + syntax: + content: 'tokenFactory: TokenFactory' + return: + description: '' + type: TokenFactory + inheritanceDescription: Inherited From Lexer.tokenFactory + - name: type + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.type + package: adaptive-expressions-ie11 + summary: '' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.type +inheritedMethods: + - name: addErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.addErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<number> + description: '' + inheritanceDescription: Inherited From Lexer.addErrorListener + - name: emit() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.emit_1 + package: adaptive-expressions-ie11 + summary: |- + By default does not support multiple emits per nextToken invocation + for efficiency reasons. Subclass and override this method, nextToken, + and getToken (to push tokens into a list and pull from that list + rather than a single variable as this implementation does). + remarks: '' + isDeprecated: false + syntax: + content: 'function emit(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.emit + - name: emit(Token) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.emit + package: adaptive-expressions-ie11 + summary: |- + The standard method called to automatically emit a token at the + outermost lexical rule. The token object should point into the + char buffer start..stop. If there is a text override in 'text', + use that to set the token's text. Override this method to emit + custom Token objects or provide a new factory. + remarks: '' + isDeprecated: false + syntax: + content: 'function emit(token: Token): Token' + parameters: + - id: token + type: Token + description: '' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.emit + - name: emitEOF() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.emitEOF + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function emitEOF(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.emitEOF + - name: getAllTokens() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getAllTokens + package: adaptive-expressions-ie11 + summary: |- + Return a list of all Token objects in input char stream. + Forces load of all tokens. Does not include EOF token. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllTokens(): Token[]' + return: + description: '' + type: Token[] + inheritanceDescription: Inherited From Lexer.getAllTokens + - name: getCharErrorDisplay(number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getCharErrorDisplay + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getCharErrorDisplay(c: number): string' + parameters: + - id: c + type: number + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.getCharErrorDisplay + - name: getErrorDisplay(string | number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getErrorDisplay + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorDisplay(s: string | number): string' + parameters: + - id: s + type: string | number + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.getErrorDisplay + - name: getErrorHeader(RecognitionException) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getErrorHeader + package: adaptive-expressions-ie11 + summary: What is the error header, normally line/character position information? + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorHeader(e: RecognitionException): string' + parameters: + - id: e + type: RecognitionException + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Lexer.getErrorHeader + - name: getErrorListenerDispatch() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getErrorListenerDispatch + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListenerDispatch(): ANTLRErrorListener' + return: + description: '' + type: ANTLRErrorListener<number> + inheritanceDescription: Inherited From Lexer.getErrorListenerDispatch + - name: getErrorListeners() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListeners(): ANTLRErrorListener[]' + return: + description: '' + type: ANTLRErrorListener<number>[] + inheritanceDescription: Inherited From Lexer.getErrorListeners + - name: getRuleIndexMap() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getRuleIndexMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from rule names to rule indexes. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleIndexMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getRuleIndexMap + - name: getTokenType(string) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getTokenType + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenType(tokenName: string): number' + parameters: + - id: tokenName + type: string + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.getTokenType + - name: getTokenTypeMap() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.getTokenTypeMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from token names to token types. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenTypeMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getTokenTypeMap + - name: mode(number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.mode + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function mode(m: number)' + parameters: + - id: m + type: number + description: '' + inheritanceDescription: Inherited From Lexer.mode + - name: more() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.more + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function more() + inheritanceDescription: Inherited From Lexer.more + - name: nextToken() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.nextToken + package: adaptive-expressions-ie11 + summary: |- + Return a token from this source; i.e., match a token on the char + stream. + remarks: '' + isDeprecated: false + syntax: + content: 'function nextToken(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Lexer.nextToken + - name: notifyListeners(LexerNoViableAltException) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.notifyListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function notifyListeners(e: LexerNoViableAltException)' + parameters: + - id: e + type: LexerNoViableAltException + description: '' + inheritanceDescription: Inherited From Lexer.notifyListeners + - name: popMode() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.popMode + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function popMode(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Lexer.popMode + - name: precpred(undefined | RuleContext, number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.precpred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function precpred(localctx: undefined | RuleContext, precedence: + number): boolean + parameters: + - id: localctx + type: undefined | RuleContext + description: '' + - id: precedence + type: number + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Lexer.precpred + - name: pushMode(number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.pushMode + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function pushMode(m: number)' + parameters: + - id: m + type: number + description: '' + inheritanceDescription: Inherited From Lexer.pushMode + - name: recover(LexerNoViableAltException) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.recover_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function recover(re: LexerNoViableAltException)' + parameters: + - id: re + type: LexerNoViableAltException + description: '' + inheritanceDescription: Inherited From Lexer.recover + - name: recover(RecognitionException) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.recover + package: adaptive-expressions-ie11 + summary: |- + Lexers can normally match any char in it's vocabulary after matching + a token, so do the easy thing and just kill a character and hope + it all works out. You can instead use the rule invocation stack + to do sophisticated error recovery if you are in a fragment rule. + remarks: '' + isDeprecated: false + syntax: + content: 'function recover(re: RecognitionException)' + parameters: + - id: re + type: RecognitionException + description: '' + inheritanceDescription: Inherited From Lexer.recover + - name: removeErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.removeErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<number> + description: '' + inheritanceDescription: Inherited From Lexer.removeErrorListener + - name: removeErrorListeners() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.removeErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function removeErrorListeners() + inheritanceDescription: Inherited From Lexer.removeErrorListeners + - name: reset() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.reset + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function reset() + inheritanceDescription: Inherited From Lexer.reset + - name: reset(boolean) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.reset_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reset(resetInput: boolean)' + parameters: + - id: resetInput + type: boolean + description: '' + inheritanceDescription: Inherited From Lexer.reset + - name: skip() + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.skip + package: adaptive-expressions-ie11 + summary: |- + Instruct the lexer to skip creating a token for current lexer rule + and look for another token. nextToken() knows to keep looking when + a lexer rule finishes with token set to SKIP_TOKEN. Recall that + if token==undefined at end of any token rule, it creates one for you + and emits it. + remarks: '' + isDeprecated: false + syntax: + content: function skip() + inheritanceDescription: Inherited From Lexer.skip +methods: + - name: action(RuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.action + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function action(_localctx: RuleContext, ruleIndex: number, actionIndex: + number) + parameters: + - id: _localctx + type: RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: actionIndex + type: number + description: '' + - name: sempred(RuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrLexer.sempred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function sempred(_localctx: RuleContext, ruleIndex: number, predIndex: + number): boolean + parameters: + - id: _localctx + type: RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: predIndex + type: number + description: '' + return: + description: '' + type: boolean +extends: Lexer diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParser.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParser.yml new file mode 100644 index 00000000..20b63937 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParser.yml @@ -0,0 +1,1944 @@ +### YamlMime:TSType +name: ExpressionAntlrParser +uid: adaptive-expressions-ie11.ExpressionAntlrParser +package: adaptive-expressions-ie11 +summary: '' +fullName: ExpressionAntlrParser +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ExpressionAntlrParser(TokenStream) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ExpressionAntlrParser(input: TokenStream)' + parameters: + - id: input + type: TokenStream + description: '' +properties: + - name: ARROW + uid: adaptive-expressions-ie11.ExpressionAntlrParser.ARROW + package: adaptive-expressions-ie11 + summary: '' + fullName: ARROW + remarks: '' + isDeprecated: false + syntax: + content: 'static ARROW: 27 = 27' + return: + description: '' + type: '27' + - name: ASTERISK + uid: adaptive-expressions-ie11.ExpressionAntlrParser.ASTERISK + package: adaptive-expressions-ie11 + summary: '' + fullName: ASTERISK + remarks: '' + isDeprecated: false + syntax: + content: 'static ASTERISK: 6 = 6' + return: + description: '' + type: '6' + - name: CLOSE_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrParser.CLOSE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: CLOSE_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static CLOSE_BRACKET: 19 = 19' + return: + description: '' + type: '19' + - name: CLOSE_CURLY_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrParser.CLOSE_CURLY_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: CLOSE_CURLY_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static CLOSE_CURLY_BRACKET: 24 = 24' + return: + description: '' + type: '24' + - name: CLOSE_SQUARE_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrParser.CLOSE_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: CLOSE_SQUARE_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static CLOSE_SQUARE_BRACKET: 22 = 22' + return: + description: '' + type: '22' + - name: COLON + uid: adaptive-expressions-ie11.ExpressionAntlrParser.COLON + package: adaptive-expressions-ie11 + summary: '' + fullName: COLON + remarks: '' + isDeprecated: false + syntax: + content: 'static COLON: 26 = 26' + return: + description: '' + type: '26' + - name: COMMA + uid: adaptive-expressions-ie11.ExpressionAntlrParser.COMMA + package: adaptive-expressions-ie11 + summary: '' + fullName: COMMA + remarks: '' + isDeprecated: false + syntax: + content: 'static COMMA: 25 = 25' + return: + description: '' + type: '25' + - name: DOT + uid: adaptive-expressions-ie11.ExpressionAntlrParser.DOT + package: adaptive-expressions-ie11 + summary: '' + fullName: DOT + remarks: '' + isDeprecated: false + syntax: + content: 'static DOT: 20 = 20' + return: + description: '' + type: '20' + - name: DOUBLE_AND + uid: adaptive-expressions-ie11.ExpressionAntlrParser.DOUBLE_AND + package: adaptive-expressions-ie11 + summary: '' + fullName: DOUBLE_AND + remarks: '' + isDeprecated: false + syntax: + content: 'static DOUBLE_AND: 12 = 12' + return: + description: '' + type: '12' + - name: DOUBLE_EQUAL + uid: adaptive-expressions-ie11.ExpressionAntlrParser.DOUBLE_EQUAL + package: adaptive-expressions-ie11 + summary: '' + fullName: DOUBLE_EQUAL + remarks: '' + isDeprecated: false + syntax: + content: 'static DOUBLE_EQUAL: 9 = 9' + return: + description: '' + type: '9' + - name: DOUBLE_VERTICAL_CYLINDER + uid: adaptive-expressions-ie11.ExpressionAntlrParser.DOUBLE_VERTICAL_CYLINDER + package: adaptive-expressions-ie11 + summary: '' + fullName: DOUBLE_VERTICAL_CYLINDER + remarks: '' + isDeprecated: false + syntax: + content: 'static DOUBLE_VERTICAL_CYLINDER: 13 = 13' + return: + description: '' + type: '13' + - name: ESCAPE_CHARACTER + uid: adaptive-expressions-ie11.ExpressionAntlrParser.ESCAPE_CHARACTER + package: adaptive-expressions-ie11 + summary: '' + fullName: ESCAPE_CHARACTER + remarks: '' + isDeprecated: false + syntax: + content: 'static ESCAPE_CHARACTER: 37 = 37' + return: + description: '' + type: '37' + - name: grammarFileName + uid: adaptive-expressions-ie11.ExpressionAntlrParser.grammarFileName + package: adaptive-expressions-ie11 + summary: '' + fullName: grammarFileName + remarks: '' + isDeprecated: false + syntax: + content: 'grammarFileName: string' + return: + description: '' + type: string + - name: IDENTIFIER + uid: adaptive-expressions-ie11.ExpressionAntlrParser.IDENTIFIER + package: adaptive-expressions-ie11 + summary: '' + fullName: IDENTIFIER + remarks: '' + isDeprecated: false + syntax: + content: 'static IDENTIFIER: 32 = 32' + return: + description: '' + type: '32' + - name: INVALID_TOKEN_DEFAULT_MODE + uid: adaptive-expressions-ie11.ExpressionAntlrParser.INVALID_TOKEN_DEFAULT_MODE + package: adaptive-expressions-ie11 + summary: '' + fullName: INVALID_TOKEN_DEFAULT_MODE + remarks: '' + isDeprecated: false + syntax: + content: 'static INVALID_TOKEN_DEFAULT_MODE: 35 = 35' + return: + description: '' + type: '35' + - name: LESS_OR_EQUAl + uid: adaptive-expressions-ie11.ExpressionAntlrParser.LESS_OR_EQUAl + package: adaptive-expressions-ie11 + summary: '' + fullName: LESS_OR_EQUAl + remarks: '' + isDeprecated: false + syntax: + content: 'static LESS_OR_EQUAl: 16 = 16' + return: + description: '' + type: '16' + - name: LESS_THAN + uid: adaptive-expressions-ie11.ExpressionAntlrParser.LESS_THAN + package: adaptive-expressions-ie11 + summary: '' + fullName: LESS_THAN + remarks: '' + isDeprecated: false + syntax: + content: 'static LESS_THAN: 14 = 14' + return: + description: '' + type: '14' + - name: MORE_OR_EQUAL + uid: adaptive-expressions-ie11.ExpressionAntlrParser.MORE_OR_EQUAL + package: adaptive-expressions-ie11 + summary: '' + fullName: MORE_OR_EQUAL + remarks: '' + isDeprecated: false + syntax: + content: 'static MORE_OR_EQUAL: 17 = 17' + return: + description: '' + type: '17' + - name: MORE_THAN + uid: adaptive-expressions-ie11.ExpressionAntlrParser.MORE_THAN + package: adaptive-expressions-ie11 + summary: '' + fullName: MORE_THAN + remarks: '' + isDeprecated: false + syntax: + content: 'static MORE_THAN: 15 = 15' + return: + description: '' + type: '15' + - name: NEWLINE + uid: adaptive-expressions-ie11.ExpressionAntlrParser.NEWLINE + package: adaptive-expressions-ie11 + summary: '' + fullName: NEWLINE + remarks: '' + isDeprecated: false + syntax: + content: 'static NEWLINE: 33 = 33' + return: + description: '' + type: '33' + - name: NON + uid: adaptive-expressions-ie11.ExpressionAntlrParser.NON + package: adaptive-expressions-ie11 + summary: '' + fullName: NON + remarks: '' + isDeprecated: false + syntax: + content: 'static NON: 4 = 4' + return: + description: '' + type: '4' + - name: NOT_EQUAL + uid: adaptive-expressions-ie11.ExpressionAntlrParser.NOT_EQUAL + package: adaptive-expressions-ie11 + summary: '' + fullName: NOT_EQUAL + remarks: '' + isDeprecated: false + syntax: + content: 'static NOT_EQUAL: 10 = 10' + return: + description: '' + type: '10' + - name: NULL_COALESCE + uid: adaptive-expressions-ie11.ExpressionAntlrParser.NULL_COALESCE + package: adaptive-expressions-ie11 + summary: '' + fullName: NULL_COALESCE + remarks: '' + isDeprecated: false + syntax: + content: 'static NULL_COALESCE: 28 = 28' + return: + description: '' + type: '28' + - name: NUMBER + uid: adaptive-expressions-ie11.ExpressionAntlrParser.NUMBER + package: adaptive-expressions-ie11 + summary: '' + fullName: NUMBER + remarks: '' + isDeprecated: false + syntax: + content: 'static NUMBER: 30 = 30' + return: + description: '' + type: '30' + - name: OPEN_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrParser.OPEN_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: OPEN_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static OPEN_BRACKET: 18 = 18' + return: + description: '' + type: '18' + - name: OPEN_CURLY_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrParser.OPEN_CURLY_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: OPEN_CURLY_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static OPEN_CURLY_BRACKET: 23 = 23' + return: + description: '' + type: '23' + - name: OPEN_SQUARE_BRACKET + uid: adaptive-expressions-ie11.ExpressionAntlrParser.OPEN_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + fullName: OPEN_SQUARE_BRACKET + remarks: '' + isDeprecated: false + syntax: + content: 'static OPEN_SQUARE_BRACKET: 21 = 21' + return: + description: '' + type: '21' + - name: PERCENT + uid: adaptive-expressions-ie11.ExpressionAntlrParser.PERCENT + package: adaptive-expressions-ie11 + summary: '' + fullName: PERCENT + remarks: '' + isDeprecated: false + syntax: + content: 'static PERCENT: 8 = 8' + return: + description: '' + type: '8' + - name: PLUS + uid: adaptive-expressions-ie11.ExpressionAntlrParser.PLUS + package: adaptive-expressions-ie11 + summary: '' + fullName: PLUS + remarks: '' + isDeprecated: false + syntax: + content: 'static PLUS: 2 = 2' + return: + description: '' + type: '2' + - name: QUESTION_MARK + uid: adaptive-expressions-ie11.ExpressionAntlrParser.QUESTION_MARK + package: adaptive-expressions-ie11 + summary: '' + fullName: QUESTION_MARK + remarks: '' + isDeprecated: false + syntax: + content: 'static QUESTION_MARK: 29 = 29' + return: + description: '' + type: '29' + - name: ruleNames + uid: adaptive-expressions-ie11.ExpressionAntlrParser.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'ruleNames: string[]' + return: + description: '' + type: string[] + - name: ruleNames + uid: adaptive-expressions-ie11.ExpressionAntlrParser.ruleNames + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleNames + remarks: '' + isDeprecated: false + syntax: + content: 'static ruleNames: string[]' + return: + description: '' + type: string[] + - name: RULE_argsList + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_argsList + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_argsList + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_argsList: 5 = 5' + return: + description: '' + type: '5' + - name: RULE_expression + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_expression + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_expression + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_expression: 1 = 1' + return: + description: '' + type: '1' + - name: RULE_file + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_file + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_file + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_file: 0 = 0' + return: + description: '' + type: '0' + - name: RULE_key + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_key + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_key + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_key: 9 = 9' + return: + description: '' + type: '9' + - name: RULE_keyValuePair + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_keyValuePair + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_keyValuePair + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_keyValuePair: 8 = 8' + return: + description: '' + type: '8' + - name: RULE_keyValuePairList + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_keyValuePairList + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_keyValuePairList + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_keyValuePairList: 7 = 7' + return: + description: '' + type: '7' + - name: RULE_lambda + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_lambda + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_lambda + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_lambda: 6 = 6' + return: + description: '' + type: '6' + - name: RULE_primaryExpression + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_primaryExpression + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_primaryExpression + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_primaryExpression: 2 = 2' + return: + description: '' + type: '2' + - name: RULE_stringInterpolation + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_stringInterpolation + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_stringInterpolation + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_stringInterpolation: 3 = 3' + return: + description: '' + type: '3' + - name: RULE_textContent + uid: adaptive-expressions-ie11.ExpressionAntlrParser.RULE_textContent + package: adaptive-expressions-ie11 + summary: '' + fullName: RULE_textContent + remarks: '' + isDeprecated: false + syntax: + content: 'static RULE_textContent: 4 = 4' + return: + description: '' + type: '4' + - name: serializedATN + uid: adaptive-expressions-ie11.ExpressionAntlrParser.serializedATN + package: adaptive-expressions-ie11 + summary: '' + fullName: serializedATN + remarks: '' + isDeprecated: false + syntax: + content: 'serializedATN: string' + return: + description: '' + type: string + - name: SINGLE_AND + uid: adaptive-expressions-ie11.ExpressionAntlrParser.SINGLE_AND + package: adaptive-expressions-ie11 + summary: '' + fullName: SINGLE_AND + remarks: '' + isDeprecated: false + syntax: + content: 'static SINGLE_AND: 11 = 11' + return: + description: '' + type: '11' + - name: SLASH + uid: adaptive-expressions-ie11.ExpressionAntlrParser.SLASH + package: adaptive-expressions-ie11 + summary: '' + fullName: SLASH + remarks: '' + isDeprecated: false + syntax: + content: 'static SLASH: 7 = 7' + return: + description: '' + type: '7' + - name: STRING + uid: adaptive-expressions-ie11.ExpressionAntlrParser.STRING + package: adaptive-expressions-ie11 + summary: '' + fullName: STRING + remarks: '' + isDeprecated: false + syntax: + content: 'static STRING: 34 = 34' + return: + description: '' + type: '34' + - name: STRING_INTERPOLATION_START + uid: adaptive-expressions-ie11.ExpressionAntlrParser.STRING_INTERPOLATION_START + package: adaptive-expressions-ie11 + summary: '' + fullName: STRING_INTERPOLATION_START + remarks: '' + isDeprecated: false + syntax: + content: 'static STRING_INTERPOLATION_START: 1 = 1' + return: + description: '' + type: '1' + - name: SUBSTRACT + uid: adaptive-expressions-ie11.ExpressionAntlrParser.SUBSTRACT + package: adaptive-expressions-ie11 + summary: '' + fullName: SUBSTRACT + remarks: '' + isDeprecated: false + syntax: + content: 'static SUBSTRACT: 3 = 3' + return: + description: '' + type: '3' + - name: TEMPLATE + uid: adaptive-expressions-ie11.ExpressionAntlrParser.TEMPLATE + package: adaptive-expressions-ie11 + summary: '' + fullName: TEMPLATE + remarks: '' + isDeprecated: false + syntax: + content: 'static TEMPLATE: 36 = 36' + return: + description: '' + type: '36' + - name: TEXT_CONTENT + uid: adaptive-expressions-ie11.ExpressionAntlrParser.TEXT_CONTENT + package: adaptive-expressions-ie11 + summary: '' + fullName: TEXT_CONTENT + remarks: '' + isDeprecated: false + syntax: + content: 'static TEXT_CONTENT: 38 = 38' + return: + description: '' + type: '38' + - name: vocabulary + uid: adaptive-expressions-ie11.ExpressionAntlrParser.vocabulary + package: adaptive-expressions-ie11 + summary: '' + fullName: vocabulary + remarks: '' + isDeprecated: false + syntax: + content: 'vocabulary: Vocabulary' + return: + description: '' + type: Vocabulary + - name: VOCABULARY + uid: adaptive-expressions-ie11.ExpressionAntlrParser.VOCABULARY + package: adaptive-expressions-ie11 + summary: '' + fullName: VOCABULARY + remarks: '' + isDeprecated: false + syntax: + content: 'static VOCABULARY: Vocabulary' + return: + description: '' + type: Vocabulary + - name: WHITESPACE + uid: adaptive-expressions-ie11.ExpressionAntlrParser.WHITESPACE + package: adaptive-expressions-ie11 + summary: '' + fullName: WHITESPACE + remarks: '' + isDeprecated: false + syntax: + content: 'static WHITESPACE: 31 = 31' + return: + description: '' + type: '31' + - name: XOR + uid: adaptive-expressions-ie11.ExpressionAntlrParser.XOR + package: adaptive-expressions-ie11 + summary: '' + fullName: XOR + remarks: '' + isDeprecated: false + syntax: + content: 'static XOR: 5 = 5' + return: + description: '' + type: '5' +inheritedProperties: + - name: atn + uid: adaptive-expressions-ie11.ExpressionAntlrParser.atn + package: adaptive-expressions-ie11 + summary: >- + Get the + used by the recognizer for prediction. + fullName: atn + remarks: '' + isDeprecated: false + syntax: + content: 'atn: ATN' + return: + description: >- + The + used by the recognizer for prediction. + type: ATN + inheritanceDescription: Inherited From Parser.atn + - name: buildParseTree + uid: adaptive-expressions-ie11.ExpressionAntlrParser.buildParseTree + package: adaptive-expressions-ie11 + summary: |- + Track the objects during the parse and hook + them up using the list so that it + forms a parse tree. The returned from the start + rule represents the root of the parse tree. + + Note that if we are not building parse trees, rule contexts only point + upwards. When a rule exits, it returns the context but that gets garbage + collected if nobody holds a reference. It points upwards but nobody + points at it. + + When we build parse trees, we are adding all of these contexts to + list. Contexts are then not candidates + for garbage collection. + fullName: buildParseTree + remarks: '' + isDeprecated: false + syntax: + content: 'buildParseTree: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.buildParseTree + - name: context + uid: adaptive-expressions-ie11.ExpressionAntlrParser.context + package: adaptive-expressions-ie11 + summary: '' + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context: ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From Parser.context + - name: currentToken + uid: adaptive-expressions-ie11.ExpressionAntlrParser.currentToken + package: adaptive-expressions-ie11 + summary: |- + Match needs to return the current input symbol, which gets put + into the label for the associated token ref; e.g., x=ID. + fullName: currentToken + remarks: '' + isDeprecated: false + syntax: + content: 'currentToken: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Parser.currentToken + - name: EOF + uid: adaptive-expressions-ie11.ExpressionAntlrParser.EOF + package: adaptive-expressions-ie11 + summary: '' + fullName: EOF + remarks: '' + isDeprecated: false + syntax: + content: 'static EOF: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.EOF + - name: errorHandler + uid: adaptive-expressions-ie11.ExpressionAntlrParser.errorHandler + package: adaptive-expressions-ie11 + summary: '' + fullName: errorHandler + remarks: '' + isDeprecated: false + syntax: + content: 'errorHandler: ANTLRErrorStrategy' + return: + description: '' + type: ANTLRErrorStrategy + inheritanceDescription: Inherited From Parser.errorHandler + - name: inputStream + uid: adaptive-expressions-ie11.ExpressionAntlrParser.inputStream + package: adaptive-expressions-ie11 + summary: Set the token stream and reset the parser. + fullName: inputStream + remarks: '' + isDeprecated: false + syntax: + content: 'inputStream: TokenStream' + return: + description: '' + type: TokenStream + inheritanceDescription: Inherited From Parser.inputStream + - name: interpreter + uid: adaptive-expressions-ie11.ExpressionAntlrParser.interpreter + package: adaptive-expressions-ie11 + summary: Set the ATN interpreter used by the recognizer for prediction. + fullName: interpreter + remarks: '' + isDeprecated: false + syntax: + content: 'interpreter: ParserATNSimulator' + return: + description: '' + type: ParserATNSimulator + inheritanceDescription: Inherited From Parser.interpreter + - name: isMatchedEOF + uid: adaptive-expressions-ie11.ExpressionAntlrParser.isMatchedEOF + package: adaptive-expressions-ie11 + summary: '' + fullName: isMatchedEOF + remarks: '' + isDeprecated: false + syntax: + content: 'isMatchedEOF: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.isMatchedEOF + - name: isTrace + uid: adaptive-expressions-ie11.ExpressionAntlrParser.isTrace + package: adaptive-expressions-ie11 + summary: |- + During a parse is sometimes useful to listen in on the rule entry and exit + events as well as token matches. This is for quick and dirty debugging. + fullName: isTrace + remarks: '' + isDeprecated: false + syntax: + content: 'isTrace: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.isTrace + - name: numberOfSyntaxErrors + uid: adaptive-expressions-ie11.ExpressionAntlrParser.numberOfSyntaxErrors + package: adaptive-expressions-ie11 + summary: |- + Gets the number of syntax errors reported during parsing. This value is + incremented each time is called. + + See #notifyErrorListeners + fullName: numberOfSyntaxErrors + remarks: '' + isDeprecated: false + syntax: + content: 'numberOfSyntaxErrors: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.numberOfSyntaxErrors + - name: parseInfo + uid: adaptive-expressions-ie11.ExpressionAntlrParser.parseInfo + package: adaptive-expressions-ie11 + summary: '' + fullName: parseInfo + remarks: '' + isDeprecated: false + syntax: + content: 'parseInfo: Promise' + return: + description: '' + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Parser.parseInfo + - name: precedence + uid: adaptive-expressions-ie11.ExpressionAntlrParser.precedence + package: adaptive-expressions-ie11 + summary: Get the precedence level for the top-most precedence rule. + fullName: precedence + remarks: '' + isDeprecated: false + syntax: + content: 'precedence: number' + return: + description: |- + The precedence level for the top-most precedence rule, or -1 if + the parser context is not nested within a precedence rule. + type: number + inheritanceDescription: Inherited From Parser.precedence + - name: ruleContext + uid: adaptive-expressions-ie11.ExpressionAntlrParser.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From Parser.ruleContext + - name: sourceName + uid: adaptive-expressions-ie11.ExpressionAntlrParser.sourceName + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceName + remarks: '' + isDeprecated: false + syntax: + content: 'sourceName: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Parser.sourceName + - name: state + uid: adaptive-expressions-ie11.ExpressionAntlrParser.state + package: adaptive-expressions-ie11 + summary: |- + Indicate that the recognizer has changed internal state that is + consistent with the ATN state passed in. This way we always know + where we are in the ATN as the parser goes along. The rule + context objects form a stack that lets us see the stack of + invoking rules. Combine this and we have complete ATN + configuration information. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.state + - name: tokenFactory + uid: adaptive-expressions-ie11.ExpressionAntlrParser.tokenFactory + package: adaptive-expressions-ie11 + summary: '' + fullName: tokenFactory + remarks: '' + isDeprecated: false + syntax: + content: 'tokenFactory: TokenFactory' + return: + description: '' + type: TokenFactory + inheritanceDescription: Inherited From Parser.tokenFactory +inheritedMethods: + - name: action(undefined | RuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.action + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function action(_localctx: undefined | RuleContext, ruleIndex: number, + actionIndex: number) + parameters: + - id: _localctx + type: undefined | RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: actionIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.action + - name: addErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.addErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<Token> + description: '' + inheritanceDescription: Inherited From Parser.addErrorListener + - name: addParseListener(ParseTreeListener) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.addParseListener + package: adaptive-expressions-ie11 + summary: |- + Registers `listener` to receive events during the parsing process. + + To support output-preserving grammar transformations (including but not + limited to left-recursion removal, automated left-factoring, and + optimized code generation), calls to listener methods during the parse + may differ substantially from calls made by + used after the parse is complete. In + particular, rule entry and exit events may occur in a different order + during the parse than after the parser. In addition, calls to certain + rule entry methods may be omitted. + + With the following specific exceptions, calls to listener events are + *deterministic*, i.e. for identical input the calls to listener + methods will be the same. + + * Alterations to the grammar used to generate code may change the + behavior of the listener calls. + * Alterations to the command line options passed to ANTLR 4 when + generating the parser may change the behavior of the listener calls. + * Changing the version of the ANTLR Tool used to generate the parser + may change the behavior of the listener calls. + remarks: '' + isDeprecated: false + syntax: + content: 'function addParseListener(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: the listener to add + inheritanceDescription: Inherited From Parser.addParseListener + - name: compileParseTreePattern(string, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.compileParseTreePattern + package: adaptive-expressions-ie11 + summary: >- + The preferred method of getting a tree pattern. For example, here's a + + sample use: + + + ``` + + let t: ParseTree = parser.expr(); + + let p: ParseTreePattern = await parser.compileParseTreePattern("+0", + MyParser.RULE_expr); + + let m: ParseTreeMatch = p.match(t); + + let id: string = m.get("ID"); + + ``` + remarks: '' + isDeprecated: false + syntax: + content: >- + function compileParseTreePattern(pattern: string, patternRuleIndex: + number): Promise + parameters: + - id: pattern + type: string + description: '' + - id: patternRuleIndex + type: number + description: '' + return: + description: '' + type: Promise<ParseTreePattern> + inheritanceDescription: Inherited From Parser.compileParseTreePattern + - name: compileParseTreePattern(string, number, Lexer) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.compileParseTreePattern_1 + package: adaptive-expressions-ie11 + summary: >- + The same as [int)](xref:%23compileParseTreePattern(String%2C) but specify + a + + rather than trying to + deduce it from this parser. + remarks: '' + isDeprecated: false + syntax: + content: >- + function compileParseTreePattern(pattern: string, patternRuleIndex: + number, lexer?: Lexer): Promise + parameters: + - id: pattern + type: string + description: '' + - id: patternRuleIndex + type: number + description: '' + - id: lexer + type: Lexer + description: '' + return: + description: '' + type: Promise<ParseTreePattern> + inheritanceDescription: Inherited From Parser.compileParseTreePattern + - name: consume() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.consume + package: adaptive-expressions-ie11 + summary: >- + Consume and return the [current symbol](`currentToken`). + + + E.g., given the following input with `A` being the current + + lookahead symbol, this function moves the cursor to `B` and returns + + `A`. + + + ``` + + A B + + ^ + + ``` + + + If the parser is not in error recovery mode, the consumed symbol is added + + to the parse tree using , + and + + is called on any parse listeners. + + If the parser *is* in error recovery mode, the consumed symbol is + + added to the parse tree using + [Token)](xref:%23createErrorNode(ParserRuleContext%2C) then + + and + + is called on any parse + + listeners. + remarks: '' + isDeprecated: false + syntax: + content: 'function consume(): Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From Parser.consume + - name: createErrorNode(ParserRuleContext, Token) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.createErrorNode + package: adaptive-expressions-ie11 + summary: |- + How to create an error node, given a token, associated with a parent. + Typically, the error node to create is not a function of the parent. + remarks: '' + isDeprecated: false + syntax: + content: 'function createErrorNode(parent: ParserRuleContext, t: Token): ErrorNode' + parameters: + - id: parent + type: ParserRuleContext + description: '' + - id: t + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From Parser.createErrorNode + - name: createTerminalNode(ParserRuleContext, Token) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.createTerminalNode + package: adaptive-expressions-ie11 + summary: |- + How to create a token leaf node associated with a parent. + Typically, the terminal node to create is not a function of the parent. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTerminalNode(parent: ParserRuleContext, t: Token): + TerminalNode + parameters: + - id: parent + type: ParserRuleContext + description: '' + - id: t + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From Parser.createTerminalNode + - name: dumpDFA() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.dumpDFA + package: adaptive-expressions-ie11 + summary: For debugging and other purposes. + remarks: '' + isDeprecated: false + syntax: + content: function dumpDFA() + inheritanceDescription: Inherited From Parser.dumpDFA + - name: enterLeftFactoredRule(ParserRuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.enterLeftFactoredRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function enterLeftFactoredRule(localctx: ParserRuleContext, state: + number, ruleIndex: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterLeftFactoredRule + - name: enterOuterAlt(ParserRuleContext, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.enterOuterAlt + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterOuterAlt(localctx: ParserRuleContext, altNum: number)' + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: altNum + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterOuterAlt + - name: enterRecursionRule(ParserRuleContext, number, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.enterRecursionRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function enterRecursionRule(localctx: ParserRuleContext, state: number, + ruleIndex: number, precedence: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + - id: precedence + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterRecursionRule + - name: enterRule(ParserRuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.enterRule + package: adaptive-expressions-ie11 + summary: |- + Always called by generated parsers upon entry to a rule. Access field + get the current context. + remarks: '' + isDeprecated: false + syntax: + content: >- + function enterRule(localctx: ParserRuleContext, state: number, + ruleIndex: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.enterRule + - name: exitRule() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function exitRule() + inheritanceDescription: Inherited From Parser.exitRule + - name: getATNWithBypassAlts() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getATNWithBypassAlts + package: adaptive-expressions-ie11 + summary: |- + The ATN with bypass alternatives is expensive to create so we create it + lazily. + + @ if the current parser does not + implement the `serializedATN` property. + remarks: '' + isDeprecated: false + syntax: + content: 'function getATNWithBypassAlts(): ATN' + return: + description: '' + type: ATN + inheritanceDescription: Inherited From Parser.getATNWithBypassAlts + - name: getDFAStrings() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getDFAStrings + package: adaptive-expressions-ie11 + summary: For debugging and other purposes. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDFAStrings(): string[]' + return: + description: '' + type: string[] + inheritanceDescription: Inherited From Parser.getDFAStrings + - name: getErrorHeader(RecognitionException) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getErrorHeader + package: adaptive-expressions-ie11 + summary: What is the error header, normally line/character position information? + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorHeader(e: RecognitionException): string' + parameters: + - id: e + type: RecognitionException + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From Parser.getErrorHeader + - name: getErrorListenerDispatch() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getErrorListenerDispatch + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListenerDispatch(): ParserErrorListener' + return: + description: '' + type: ParserErrorListener + inheritanceDescription: Inherited From Parser.getErrorListenerDispatch + - name: getErrorListeners() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getErrorListeners(): ANTLRErrorListener[]' + return: + description: '' + type: ANTLRErrorListener<Token>[] + inheritanceDescription: Inherited From Parser.getErrorListeners + - name: getExpectedTokens() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getExpectedTokens + package: adaptive-expressions-ie11 + summary: >- + Computes the set of input symbols which could follow the current parser + + state and context, as given by and + , + + respectively. + + + See ATN#getExpectedTokens(int, RuleContext) + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpectedTokens(): IntervalSet' + return: + description: '' + type: IntervalSet + inheritanceDescription: Inherited From Parser.getExpectedTokens + - name: getExpectedTokensWithinCurrentRule() + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParser.getExpectedTokensWithinCurrentRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpectedTokensWithinCurrentRule(): IntervalSet' + return: + description: '' + type: IntervalSet + inheritanceDescription: Inherited From Parser.getExpectedTokensWithinCurrentRule + - name: getInvokingContext(number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getInvokingContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getInvokingContext(ruleIndex: number): undefined | + ParserRuleContext + parameters: + - id: ruleIndex + type: number + description: '' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From Parser.getInvokingContext + - name: getParseListeners() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getParseListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getParseListeners(): ParseTreeListener[]' + return: + description: '' + type: ParseTreeListener[] + inheritanceDescription: Inherited From Parser.getParseListeners + - name: getRuleIndex(string) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getRuleIndex + package: adaptive-expressions-ie11 + summary: Get a rule's index (i.e., `RULE_ruleName` field) or -1 if not found. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleIndex(ruleName: string): number' + parameters: + - id: ruleName + type: string + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.getRuleIndex + - name: getRuleIndexMap() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getRuleIndexMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from rule names to rule indexes. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleIndexMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getRuleIndexMap + - name: getRuleInvocationStack(RuleContext) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getRuleInvocationStack + package: adaptive-expressions-ie11 + summary: |- + Return List<String> of the rule names in your parser instance + leading up to a call to the current rule. You could override if + you want more details such as the file/line info of where + in the ATN a rule is invoked. + + This is very useful for error messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleInvocationStack(ctx?: RuleContext): string[]' + parameters: + - id: ctx + type: RuleContext + description: '' + return: + description: '' + type: string[] + inheritanceDescription: Inherited From Parser.getRuleInvocationStack + - name: getTokenType(string) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getTokenType + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenType(tokenName: string): number' + parameters: + - id: tokenName + type: string + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From Parser.getTokenType + - name: getTokenTypeMap() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.getTokenTypeMap + package: adaptive-expressions-ie11 + summary: |- + Get a map from token names to token types. + + Used for XPath and tree pattern compilation. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenTypeMap(): ReadonlyMap' + return: + description: '' + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getTokenTypeMap + - name: inContext(string) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.inContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function inContext(context: string): boolean' + parameters: + - id: context + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.inContext + - name: isExpectedToken(number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.isExpectedToken + package: adaptive-expressions-ie11 + summary: |- + Checks whether or not `symbol` can follow the current state in the + ATN. The behavior of this method is equivalent to the following, but is + implemented such that the complete context-sensitive follow set does not + need to be explicitly constructed. + + ``` + return getExpectedTokens().contains(symbol); + ``` + remarks: '' + isDeprecated: false + syntax: + content: 'function isExpectedToken(symbol: number): boolean' + parameters: + - id: symbol + type: number + description: the symbol type to check + return: + description: |- + `true` if `symbol` can follow the current state in + the ATN, otherwise `false`. + type: boolean + inheritanceDescription: Inherited From Parser.isExpectedToken + - name: match(number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.match + package: adaptive-expressions-ie11 + summary: >- + Match current input symbol against `ttype`. If the symbol type + + matches, and are + + called to complete the match process. + + + If the symbol type does not match, + + is called on the current error + + strategy to attempt recovery. If is + + `true` and the token index of the symbol returned by + + is -1, the symbol is added to + + the parse tree by calling + [Token)](xref:%23createErrorNode(ParserRuleContext%2C) then + + . + remarks: '' + isDeprecated: false + syntax: + content: 'function match(ttype: number): Token' + parameters: + - id: ttype + type: number + description: the token type to match + return: + description: |- + the matched symbol + @ if the current input symbol did not match + `ttype` and the error strategy could not recover from the + mismatched symbol + type: Token + inheritanceDescription: Inherited From Parser.match + - name: matchWildcard() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.matchWildcard + package: adaptive-expressions-ie11 + summary: >- + Match current input symbol as a wildcard. If the symbol type matches + + (i.e. has a value greater than 0), + + and are called to complete the match process. + + + If the symbol type does not match, + + is called on the current error + + strategy to attempt recovery. If is + + `true` and the token index of the symbol returned by + + is -1, the symbol is added to + + the parse tree by calling + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C) then + + . + remarks: '' + isDeprecated: false + syntax: + content: 'function matchWildcard(): Token' + return: + description: >- + the matched symbol + + @ if the current input symbol did not match + + a wildcard and the error strategy could not recover from the + mismatched + + symbol + type: Token + inheritanceDescription: Inherited From Parser.matchWildcard + - name: notifyErrorListeners(string) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.notifyErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function notifyErrorListeners(msg: string)' + parameters: + - id: msg + type: string + description: '' + inheritanceDescription: Inherited From Parser.notifyErrorListeners + - name: >- + notifyErrorListeners(string, null | Token, undefined | + RecognitionException) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.notifyErrorListeners_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function notifyErrorListeners(msg: string, offendingToken: null | Token, + e: undefined | RecognitionException) + parameters: + - id: msg + type: string + description: '' + - id: offendingToken + type: null | Token + description: '' + - id: e + type: undefined | RecognitionException + description: '' + inheritanceDescription: Inherited From Parser.notifyErrorListeners + - name: precpred(RuleContext, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.precpred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function precpred(localctx: RuleContext, precedence: number): boolean' + parameters: + - id: localctx + type: RuleContext + description: '' + - id: precedence + type: number + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Parser.precpred + - name: pushNewRecursionContext(ParserRuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.pushNewRecursionContext + package: adaptive-expressions-ie11 + summary: |- + Like but for recursive rules. + Make the current context the child of the incoming localctx. + remarks: '' + isDeprecated: false + syntax: + content: >- + function pushNewRecursionContext(localctx: ParserRuleContext, state: + number, ruleIndex: number) + parameters: + - id: localctx + type: ParserRuleContext + description: '' + - id: state + type: number + description: '' + - id: ruleIndex + type: number + description: '' + inheritanceDescription: Inherited From Parser.pushNewRecursionContext + - name: removeErrorListener(ANTLRErrorListener) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.removeErrorListener + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeErrorListener(listener: ANTLRErrorListener)' + parameters: + - id: listener + type: ANTLRErrorListener<Token> + description: '' + inheritanceDescription: Inherited From Parser.removeErrorListener + - name: removeErrorListeners() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.removeErrorListeners + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function removeErrorListeners() + inheritanceDescription: Inherited From Parser.removeErrorListeners + - name: removeParseListener(ParseTreeListener) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.removeParseListener + package: adaptive-expressions-ie11 + summary: |- + Remove `listener` from the list of parse listeners. + + If `listener` is `undefined` or has not been added as a parse + listener, this method does nothing. + + See #addParseListener + remarks: '' + isDeprecated: false + syntax: + content: 'function removeParseListener(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: the listener to remove + inheritanceDescription: Inherited From Parser.removeParseListener + - name: removeParseListeners() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.removeParseListeners + package: adaptive-expressions-ie11 + summary: |- + Remove all parse listeners. + + See #addParseListener + remarks: '' + isDeprecated: false + syntax: + content: function removeParseListeners() + inheritanceDescription: Inherited From Parser.removeParseListeners + - name: reset() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.reset + package: adaptive-expressions-ie11 + summary: reset the parser's state + remarks: '' + isDeprecated: false + syntax: + content: function reset() + inheritanceDescription: Inherited From Parser.reset + - name: reset(boolean) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.reset_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function reset(resetInput: boolean)' + parameters: + - id: resetInput + type: boolean + description: '' + inheritanceDescription: Inherited From Parser.reset + - name: setProfile(boolean) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.setProfile + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setProfile(profile: boolean): Promise' + parameters: + - id: profile + type: boolean + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Parser.setProfile + - name: unrollRecursionContexts(ParserRuleContext) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.unrollRecursionContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function unrollRecursionContexts(_parentctx: ParserRuleContext)' + parameters: + - id: _parentctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From Parser.unrollRecursionContexts +methods: + - name: argsList() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.argsList + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function argsList(): ArgsListContext' + return: + description: '' + type: + - name: expression() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: + - name: expression(number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.expression_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(_p: number): ExpressionContext' + parameters: + - id: _p + type: number + description: '' + return: + description: '' + type: + - name: file() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.file + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function file(): FileContext' + return: + description: '' + type: + - name: key() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.key + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function key(): KeyContext' + return: + description: '' + type: + - name: keyValuePair() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.keyValuePair + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function keyValuePair(): KeyValuePairContext' + return: + description: '' + type: + - name: keyValuePairList() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.keyValuePairList + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function keyValuePairList(): KeyValuePairListContext' + return: + description: '' + type: + - name: lambda() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.lambda + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function lambda(): LambdaContext' + return: + description: '' + type: + - name: primaryExpression() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.primaryExpression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function primaryExpression(): PrimaryExpressionContext' + return: + description: '' + type: + - name: primaryExpression(number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.primaryExpression_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function primaryExpression(_p: number): PrimaryExpressionContext' + parameters: + - id: _p + type: number + description: '' + return: + description: '' + type: + - name: sempred(RuleContext, number, number) + uid: adaptive-expressions-ie11.ExpressionAntlrParser.sempred + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function sempred(_localctx: RuleContext, ruleIndex: number, predIndex: + number): boolean + parameters: + - id: _localctx + type: RuleContext + description: '' + - id: ruleIndex + type: number + description: '' + - id: predIndex + type: number + description: '' + return: + description: '' + type: boolean + - name: stringInterpolation() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.stringInterpolation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function stringInterpolation(): StringInterpolationContext' + return: + description: '' + type: + - name: textContent() + uid: adaptive-expressions-ie11.ExpressionAntlrParser.textContent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function textContent(): TextContentContext' + return: + description: '' + type: +extends: Parser diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserListener.yml new file mode 100644 index 00000000..7dd9a890 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserListener.yml @@ -0,0 +1,720 @@ +### YamlMime:TSType +name: ExpressionAntlrParserListener +uid: adaptive-expressions-ie11.ExpressionAntlrParserListener +package: adaptive-expressions-ie11 +summary: |- + This interface defines a complete listener for a parse tree produced by + `ExpressionAntlrParser`. +fullName: ExpressionAntlrParserListener +remarks: '' +isDeprecated: false +type: interface +properties: + - name: enterArgsList + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterArgsList + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.argsList`. + fullName: enterArgsList + remarks: '' + isDeprecated: false + syntax: + content: 'enterArgsList?: (ctx: ArgsListContext) => void' + return: + description: '' + type: '(ctx: ArgsListContext) => void' + - name: enterArrayCreationExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterArrayCreationExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `arrayCreationExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterArrayCreationExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterArrayCreationExp?: (ctx: ArrayCreationExpContext) => void' + return: + description: '' + type: '(ctx: ArrayCreationExpContext) => void' + - name: enterBinaryOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterBinaryOpExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `binaryOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: enterBinaryOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterBinaryOpExp?: (ctx: BinaryOpExpContext) => void' + return: + description: '' + type: '(ctx: BinaryOpExpContext) => void' + - name: enterExpression + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterExpression + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.expression`. + fullName: enterExpression + remarks: '' + isDeprecated: false + syntax: + content: 'enterExpression?: (ctx: ExpressionContext) => void' + return: + description: '' + type: '(ctx: ExpressionContext) => void' + - name: enterFile + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterFile + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.file`. + fullName: enterFile + remarks: '' + isDeprecated: false + syntax: + content: 'enterFile?: (ctx: FileContext) => void' + return: + description: '' + type: '(ctx: FileContext) => void' + - name: enterFuncInvokeExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterFuncInvokeExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `funcInvokeExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterFuncInvokeExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterFuncInvokeExp?: (ctx: FuncInvokeExpContext) => void' + return: + description: '' + type: '(ctx: FuncInvokeExpContext) => void' + - name: enterIdAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterIdAtom + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `idAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterIdAtom + remarks: '' + isDeprecated: false + syntax: + content: 'enterIdAtom?: (ctx: IdAtomContext) => void' + return: + description: '' + type: '(ctx: IdAtomContext) => void' + - name: enterIndexAccessExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterIndexAccessExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `indexAccessExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterIndexAccessExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterIndexAccessExp?: (ctx: IndexAccessExpContext) => void' + return: + description: '' + type: '(ctx: IndexAccessExpContext) => void' + - name: enterJsonCreationExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterJsonCreationExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `jsonCreationExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterJsonCreationExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterJsonCreationExp?: (ctx: JsonCreationExpContext) => void' + return: + description: '' + type: '(ctx: JsonCreationExpContext) => void' + - name: enterKey + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterKey + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.key`. + fullName: enterKey + remarks: '' + isDeprecated: false + syntax: + content: 'enterKey?: (ctx: KeyContext) => void' + return: + description: '' + type: '(ctx: KeyContext) => void' + - name: enterKeyValuePair + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterKeyValuePair + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.keyValuePair`. + fullName: enterKeyValuePair + remarks: '' + isDeprecated: false + syntax: + content: 'enterKeyValuePair?: (ctx: KeyValuePairContext) => void' + return: + description: '' + type: '(ctx: KeyValuePairContext) => void' + - name: enterKeyValuePairList + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterKeyValuePairList + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.keyValuePairList`. + fullName: enterKeyValuePairList + remarks: '' + isDeprecated: false + syntax: + content: 'enterKeyValuePairList?: (ctx: KeyValuePairListContext) => void' + return: + description: '' + type: '(ctx: KeyValuePairListContext) => void' + - name: enterLambda + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterLambda + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.lambda`. + fullName: enterLambda + remarks: '' + isDeprecated: false + syntax: + content: 'enterLambda?: (ctx: LambdaContext) => void' + return: + description: '' + type: '(ctx: LambdaContext) => void' + - name: enterMemberAccessExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterMemberAccessExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `memberAccessExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterMemberAccessExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterMemberAccessExp?: (ctx: MemberAccessExpContext) => void' + return: + description: '' + type: '(ctx: MemberAccessExpContext) => void' + - name: enterNumericAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterNumericAtom + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `numericAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterNumericAtom + remarks: '' + isDeprecated: false + syntax: + content: 'enterNumericAtom?: (ctx: NumericAtomContext) => void' + return: + description: '' + type: '(ctx: NumericAtomContext) => void' + - name: enterParenthesisExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterParenthesisExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `parenthesisExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterParenthesisExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterParenthesisExp?: (ctx: ParenthesisExpContext) => void' + return: + description: '' + type: '(ctx: ParenthesisExpContext) => void' + - name: enterPrimaryExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterPrimaryExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `primaryExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: enterPrimaryExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterPrimaryExp?: (ctx: PrimaryExpContext) => void' + return: + description: '' + type: '(ctx: PrimaryExpContext) => void' + - name: enterPrimaryExpression + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterPrimaryExpression + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.primaryExpression`. + fullName: enterPrimaryExpression + remarks: '' + isDeprecated: false + syntax: + content: 'enterPrimaryExpression?: (ctx: PrimaryExpressionContext) => void' + return: + description: '' + type: '(ctx: PrimaryExpressionContext) => void' + - name: enterStringAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterStringAtom + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `stringAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterStringAtom + remarks: '' + isDeprecated: false + syntax: + content: 'enterStringAtom?: (ctx: StringAtomContext) => void' + return: + description: '' + type: '(ctx: StringAtomContext) => void' + - name: enterStringInterpolation + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterStringInterpolation + package: adaptive-expressions-ie11 + summary: >- + Enter a parse tree produced by + `ExpressionAntlrParser.stringInterpolation`. + fullName: enterStringInterpolation + remarks: '' + isDeprecated: false + syntax: + content: 'enterStringInterpolation?: (ctx: StringInterpolationContext) => void' + return: + description: '' + type: '(ctx: StringInterpolationContext) => void' + - name: enterStringInterpolationAtom + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.enterStringInterpolationAtom + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `stringInterpolationAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: enterStringInterpolationAtom + remarks: '' + isDeprecated: false + syntax: + content: >- + enterStringInterpolationAtom?: (ctx: StringInterpolationAtomContext) => + void + return: + description: '' + type: '(ctx: StringInterpolationAtomContext) => void' + - name: enterTextContent + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterTextContent + package: adaptive-expressions-ie11 + summary: Enter a parse tree produced by `ExpressionAntlrParser.textContent`. + fullName: enterTextContent + remarks: '' + isDeprecated: false + syntax: + content: 'enterTextContent?: (ctx: TextContentContext) => void' + return: + description: '' + type: '(ctx: TextContentContext) => void' + - name: enterTripleOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterTripleOpExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `tripleOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: enterTripleOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterTripleOpExp?: (ctx: TripleOpExpContext) => void' + return: + description: '' + type: '(ctx: TripleOpExpContext) => void' + - name: enterUnaryOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterUnaryOpExp + package: adaptive-expressions-ie11 + summary: |- + Enter a parse tree produced by the `unaryOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: enterUnaryOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'enterUnaryOpExp?: (ctx: UnaryOpExpContext) => void' + return: + description: '' + type: '(ctx: UnaryOpExpContext) => void' + - name: exitArgsList + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitArgsList + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.argsList`. + fullName: exitArgsList + remarks: '' + isDeprecated: false + syntax: + content: 'exitArgsList?: (ctx: ArgsListContext) => void' + return: + description: '' + type: '(ctx: ArgsListContext) => void' + - name: exitArrayCreationExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitArrayCreationExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `arrayCreationExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitArrayCreationExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitArrayCreationExp?: (ctx: ArrayCreationExpContext) => void' + return: + description: '' + type: '(ctx: ArrayCreationExpContext) => void' + - name: exitBinaryOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitBinaryOpExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `binaryOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: exitBinaryOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitBinaryOpExp?: (ctx: BinaryOpExpContext) => void' + return: + description: '' + type: '(ctx: BinaryOpExpContext) => void' + - name: exitExpression + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitExpression + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.expression`. + fullName: exitExpression + remarks: '' + isDeprecated: false + syntax: + content: 'exitExpression?: (ctx: ExpressionContext) => void' + return: + description: '' + type: '(ctx: ExpressionContext) => void' + - name: exitFile + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitFile + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.file`. + fullName: exitFile + remarks: '' + isDeprecated: false + syntax: + content: 'exitFile?: (ctx: FileContext) => void' + return: + description: '' + type: '(ctx: FileContext) => void' + - name: exitFuncInvokeExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitFuncInvokeExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `funcInvokeExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitFuncInvokeExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitFuncInvokeExp?: (ctx: FuncInvokeExpContext) => void' + return: + description: '' + type: '(ctx: FuncInvokeExpContext) => void' + - name: exitIdAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitIdAtom + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `idAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitIdAtom + remarks: '' + isDeprecated: false + syntax: + content: 'exitIdAtom?: (ctx: IdAtomContext) => void' + return: + description: '' + type: '(ctx: IdAtomContext) => void' + - name: exitIndexAccessExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitIndexAccessExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `indexAccessExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitIndexAccessExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitIndexAccessExp?: (ctx: IndexAccessExpContext) => void' + return: + description: '' + type: '(ctx: IndexAccessExpContext) => void' + - name: exitJsonCreationExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitJsonCreationExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `jsonCreationExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitJsonCreationExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitJsonCreationExp?: (ctx: JsonCreationExpContext) => void' + return: + description: '' + type: '(ctx: JsonCreationExpContext) => void' + - name: exitKey + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitKey + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.key`. + fullName: exitKey + remarks: '' + isDeprecated: false + syntax: + content: 'exitKey?: (ctx: KeyContext) => void' + return: + description: '' + type: '(ctx: KeyContext) => void' + - name: exitKeyValuePair + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitKeyValuePair + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.keyValuePair`. + fullName: exitKeyValuePair + remarks: '' + isDeprecated: false + syntax: + content: 'exitKeyValuePair?: (ctx: KeyValuePairContext) => void' + return: + description: '' + type: '(ctx: KeyValuePairContext) => void' + - name: exitKeyValuePairList + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitKeyValuePairList + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.keyValuePairList`. + fullName: exitKeyValuePairList + remarks: '' + isDeprecated: false + syntax: + content: 'exitKeyValuePairList?: (ctx: KeyValuePairListContext) => void' + return: + description: '' + type: '(ctx: KeyValuePairListContext) => void' + - name: exitLambda + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitLambda + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.lambda`. + fullName: exitLambda + remarks: '' + isDeprecated: false + syntax: + content: 'exitLambda?: (ctx: LambdaContext) => void' + return: + description: '' + type: '(ctx: LambdaContext) => void' + - name: exitMemberAccessExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitMemberAccessExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `memberAccessExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitMemberAccessExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitMemberAccessExp?: (ctx: MemberAccessExpContext) => void' + return: + description: '' + type: '(ctx: MemberAccessExpContext) => void' + - name: exitNumericAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitNumericAtom + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `numericAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitNumericAtom + remarks: '' + isDeprecated: false + syntax: + content: 'exitNumericAtom?: (ctx: NumericAtomContext) => void' + return: + description: '' + type: '(ctx: NumericAtomContext) => void' + - name: exitParenthesisExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitParenthesisExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `parenthesisExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitParenthesisExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitParenthesisExp?: (ctx: ParenthesisExpContext) => void' + return: + description: '' + type: '(ctx: ParenthesisExpContext) => void' + - name: exitPrimaryExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitPrimaryExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `primaryExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: exitPrimaryExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitPrimaryExp?: (ctx: PrimaryExpContext) => void' + return: + description: '' + type: '(ctx: PrimaryExpContext) => void' + - name: exitPrimaryExpression + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitPrimaryExpression + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.primaryExpression`. + fullName: exitPrimaryExpression + remarks: '' + isDeprecated: false + syntax: + content: 'exitPrimaryExpression?: (ctx: PrimaryExpressionContext) => void' + return: + description: '' + type: '(ctx: PrimaryExpressionContext) => void' + - name: exitStringAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitStringAtom + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `stringAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitStringAtom + remarks: '' + isDeprecated: false + syntax: + content: 'exitStringAtom?: (ctx: StringAtomContext) => void' + return: + description: '' + type: '(ctx: StringAtomContext) => void' + - name: exitStringInterpolation + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitStringInterpolation + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.stringInterpolation`. + fullName: exitStringInterpolation + remarks: '' + isDeprecated: false + syntax: + content: 'exitStringInterpolation?: (ctx: StringInterpolationContext) => void' + return: + description: '' + type: '(ctx: StringInterpolationContext) => void' + - name: exitStringInterpolationAtom + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserListener.exitStringInterpolationAtom + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `stringInterpolationAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: exitStringInterpolationAtom + remarks: '' + isDeprecated: false + syntax: + content: >- + exitStringInterpolationAtom?: (ctx: StringInterpolationAtomContext) => + void + return: + description: '' + type: '(ctx: StringInterpolationAtomContext) => void' + - name: exitTextContent + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitTextContent + package: adaptive-expressions-ie11 + summary: Exit a parse tree produced by `ExpressionAntlrParser.textContent`. + fullName: exitTextContent + remarks: '' + isDeprecated: false + syntax: + content: 'exitTextContent?: (ctx: TextContentContext) => void' + return: + description: '' + type: '(ctx: TextContentContext) => void' + - name: exitTripleOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitTripleOpExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `tripleOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: exitTripleOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitTripleOpExp?: (ctx: TripleOpExpContext) => void' + return: + description: '' + type: '(ctx: TripleOpExpContext) => void' + - name: exitUnaryOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitUnaryOpExp + package: adaptive-expressions-ie11 + summary: |- + Exit a parse tree produced by the `unaryOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: exitUnaryOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'exitUnaryOpExp?: (ctx: UnaryOpExpContext) => void' + return: + description: '' + type: '(ctx: UnaryOpExpContext) => void' +inheritedProperties: + - name: enterEveryRule + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.enterEveryRule + package: adaptive-expressions-ie11 + summary: '' + fullName: enterEveryRule + remarks: '' + isDeprecated: false + syntax: + content: 'enterEveryRule?: (ctx: ParserRuleContext) => void' + return: + description: '' + type: '(ctx: ParserRuleContext) => void' + inheritanceDescription: Inherited From ParseTreeListener.enterEveryRule + - name: exitEveryRule + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.exitEveryRule + package: adaptive-expressions-ie11 + summary: '' + fullName: exitEveryRule + remarks: '' + isDeprecated: false + syntax: + content: 'exitEveryRule?: (ctx: ParserRuleContext) => void' + return: + description: '' + type: '(ctx: ParserRuleContext) => void' + inheritanceDescription: Inherited From ParseTreeListener.exitEveryRule + - name: visitErrorNode + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.visitErrorNode + package: adaptive-expressions-ie11 + summary: '' + fullName: visitErrorNode + remarks: '' + isDeprecated: false + syntax: + content: 'visitErrorNode?: (node: ErrorNode) => void' + return: + description: '' + type: '(node: ErrorNode) => void' + inheritanceDescription: Inherited From ParseTreeListener.visitErrorNode + - name: visitTerminal + uid: adaptive-expressions-ie11.ExpressionAntlrParserListener.visitTerminal + package: adaptive-expressions-ie11 + summary: '' + fullName: visitTerminal + remarks: '' + isDeprecated: false + syntax: + content: 'visitTerminal?: (node: TerminalNode) => void' + return: + description: '' + type: '(node: TerminalNode) => void' + inheritanceDescription: Inherited From ParseTreeListener.visitTerminal +extends: ParseTreeListener diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserVisitor.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserVisitor.yml new file mode 100644 index 00000000..7b86c5d9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionAntlrParserVisitor.yml @@ -0,0 +1,415 @@ +### YamlMime:TSType +name: ExpressionAntlrParserVisitor +uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor +package: adaptive-expressions-ie11 +summary: |- + This interface defines a complete generic visitor for a parse tree produced + by `ExpressionAntlrParser`. +fullName: ExpressionAntlrParserVisitor +remarks: '' +isDeprecated: false +type: interface +properties: + - name: visitArgsList + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitArgsList + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.argsList`. + fullName: visitArgsList + remarks: '' + isDeprecated: false + syntax: + content: 'visitArgsList?: (ctx: ArgsListContext) => Result' + return: + description: '' + type: '(ctx: ArgsListContext) => Result' + - name: visitArrayCreationExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitArrayCreationExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `arrayCreationExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitArrayCreationExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitArrayCreationExp?: (ctx: ArrayCreationExpContext) => Result' + return: + description: '' + type: '(ctx: ArrayCreationExpContext) => Result' + - name: visitBinaryOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitBinaryOpExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `binaryOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: visitBinaryOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitBinaryOpExp?: (ctx: BinaryOpExpContext) => Result' + return: + description: '' + type: '(ctx: BinaryOpExpContext) => Result' + - name: visitExpression + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitExpression + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.expression`. + fullName: visitExpression + remarks: '' + isDeprecated: false + syntax: + content: 'visitExpression?: (ctx: ExpressionContext) => Result' + return: + description: '' + type: '(ctx: ExpressionContext) => Result' + - name: visitFile + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitFile + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.file`. + fullName: visitFile + remarks: '' + isDeprecated: false + syntax: + content: 'visitFile?: (ctx: FileContext) => Result' + return: + description: '' + type: '(ctx: FileContext) => Result' + - name: visitFuncInvokeExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitFuncInvokeExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `funcInvokeExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitFuncInvokeExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitFuncInvokeExp?: (ctx: FuncInvokeExpContext) => Result' + return: + description: '' + type: '(ctx: FuncInvokeExpContext) => Result' + - name: visitIdAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitIdAtom + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `idAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitIdAtom + remarks: '' + isDeprecated: false + syntax: + content: 'visitIdAtom?: (ctx: IdAtomContext) => Result' + return: + description: '' + type: '(ctx: IdAtomContext) => Result' + - name: visitIndexAccessExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitIndexAccessExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `indexAccessExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitIndexAccessExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitIndexAccessExp?: (ctx: IndexAccessExpContext) => Result' + return: + description: '' + type: '(ctx: IndexAccessExpContext) => Result' + - name: visitJsonCreationExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitJsonCreationExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `jsonCreationExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitJsonCreationExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitJsonCreationExp?: (ctx: JsonCreationExpContext) => Result' + return: + description: '' + type: '(ctx: JsonCreationExpContext) => Result' + - name: visitKey + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitKey + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.key`. + fullName: visitKey + remarks: '' + isDeprecated: false + syntax: + content: 'visitKey?: (ctx: KeyContext) => Result' + return: + description: '' + type: '(ctx: KeyContext) => Result' + - name: visitKeyValuePair + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitKeyValuePair + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.keyValuePair`. + fullName: visitKeyValuePair + remarks: '' + isDeprecated: false + syntax: + content: 'visitKeyValuePair?: (ctx: KeyValuePairContext) => Result' + return: + description: '' + type: '(ctx: KeyValuePairContext) => Result' + - name: visitKeyValuePairList + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitKeyValuePairList + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.keyValuePairList`. + fullName: visitKeyValuePairList + remarks: '' + isDeprecated: false + syntax: + content: 'visitKeyValuePairList?: (ctx: KeyValuePairListContext) => Result' + return: + description: '' + type: '(ctx: KeyValuePairListContext) => Result' + - name: visitLambda + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitLambda + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.lambda`. + fullName: visitLambda + remarks: '' + isDeprecated: false + syntax: + content: 'visitLambda?: (ctx: LambdaContext) => Result' + return: + description: '' + type: '(ctx: LambdaContext) => Result' + - name: visitMemberAccessExp + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitMemberAccessExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `memberAccessExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitMemberAccessExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitMemberAccessExp?: (ctx: MemberAccessExpContext) => Result' + return: + description: '' + type: '(ctx: MemberAccessExpContext) => Result' + - name: visitNumericAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitNumericAtom + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `numericAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitNumericAtom + remarks: '' + isDeprecated: false + syntax: + content: 'visitNumericAtom?: (ctx: NumericAtomContext) => Result' + return: + description: '' + type: '(ctx: NumericAtomContext) => Result' + - name: visitParenthesisExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitParenthesisExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `parenthesisExp` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitParenthesisExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitParenthesisExp?: (ctx: ParenthesisExpContext) => Result' + return: + description: '' + type: '(ctx: ParenthesisExpContext) => Result' + - name: visitPrimaryExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitPrimaryExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `primaryExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: visitPrimaryExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitPrimaryExp?: (ctx: PrimaryExpContext) => Result' + return: + description: '' + type: '(ctx: PrimaryExpContext) => Result' + - name: visitPrimaryExpression + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitPrimaryExpression + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.primaryExpression`. + fullName: visitPrimaryExpression + remarks: '' + isDeprecated: false + syntax: + content: 'visitPrimaryExpression?: (ctx: PrimaryExpressionContext) => Result' + return: + description: '' + type: '(ctx: PrimaryExpressionContext) => Result' + - name: visitStringAtom + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitStringAtom + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `stringAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitStringAtom + remarks: '' + isDeprecated: false + syntax: + content: 'visitStringAtom?: (ctx: StringAtomContext) => Result' + return: + description: '' + type: '(ctx: StringAtomContext) => Result' + - name: visitStringInterpolation + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitStringInterpolation + package: adaptive-expressions-ie11 + summary: >- + Visit a parse tree produced by + `ExpressionAntlrParser.stringInterpolation`. + fullName: visitStringInterpolation + remarks: '' + isDeprecated: false + syntax: + content: 'visitStringInterpolation?: (ctx: StringInterpolationContext) => Result' + return: + description: '' + type: '(ctx: StringInterpolationContext) => Result' + - name: visitStringInterpolationAtom + uid: >- + adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitStringInterpolationAtom + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `stringInterpolationAtom` + labeled alternative in `ExpressionAntlrParser.primaryExpression`. + fullName: visitStringInterpolationAtom + remarks: '' + isDeprecated: false + syntax: + content: >- + visitStringInterpolationAtom?: (ctx: StringInterpolationAtomContext) => + Result + return: + description: '' + type: '(ctx: StringInterpolationAtomContext) => Result' + - name: visitTextContent + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitTextContent + package: adaptive-expressions-ie11 + summary: Visit a parse tree produced by `ExpressionAntlrParser.textContent`. + fullName: visitTextContent + remarks: '' + isDeprecated: false + syntax: + content: 'visitTextContent?: (ctx: TextContentContext) => Result' + return: + description: '' + type: '(ctx: TextContentContext) => Result' + - name: visitTripleOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitTripleOpExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `tripleOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: visitTripleOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitTripleOpExp?: (ctx: TripleOpExpContext) => Result' + return: + description: '' + type: '(ctx: TripleOpExpContext) => Result' + - name: visitUnaryOpExp + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitUnaryOpExp + package: adaptive-expressions-ie11 + summary: |- + Visit a parse tree produced by the `unaryOpExp` + labeled alternative in `ExpressionAntlrParser.expression`. + fullName: visitUnaryOpExp + remarks: '' + isDeprecated: false + syntax: + content: 'visitUnaryOpExp?: (ctx: UnaryOpExpContext) => Result' + return: + description: '' + type: '(ctx: UnaryOpExpContext) => Result' +inheritedMethods: + - name: visit(ParseTree) + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visit + package: adaptive-expressions-ie11 + summary: Visit a parse tree, and return a user-defined result of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visit(tree: ParseTree): Result' + parameters: + - id: tree + type: ParseTree + description: >- + The + to + visit. + return: + description: The result of visiting the parse tree. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visit + - name: visitChildren(RuleNode) + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitChildren + package: adaptive-expressions-ie11 + summary: |- + Visit the children of a node, and return a user-defined result + of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visitChildren(node: RuleNode): Result' + parameters: + - id: node + type: RuleNode + description: The whose children should be visited. + return: + description: The result of visiting the children of the node. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visitChildren + - name: visitErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitErrorNode + package: adaptive-expressions-ie11 + summary: Visit an error node, and return a user-defined result of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visitErrorNode(node: ErrorNode): Result' + parameters: + - id: node + type: ErrorNode + description: >- + The to + visit. + return: + description: The result of visiting the node. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visitErrorNode + - name: visitTerminal(TerminalNode) + uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor.visitTerminal + package: adaptive-expressions-ie11 + summary: Visit a terminal node, and return a user-defined result of the operation. + remarks: '' + isDeprecated: false + syntax: + content: 'function visitTerminal(node: TerminalNode): Result' + parameters: + - id: node + type: TerminalNode + description: >- + The + + to visit. + return: + description: The result of visiting the node. + type: Result + inheritanceDescription: Inherited From ParseTreeVisitor.visitTerminal +extends: ParseTreeVisitor<Result> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionContext.yml new file mode 100644 index 00000000..a77291f2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionContext.yml @@ -0,0 +1,806 @@ +### YamlMime:TSType +name: ExpressionContext +uid: adaptive-expressions-ie11.ExpressionContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ExpressionContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ExpressionContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.ExpressionContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ExpressionContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.ExpressionContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ExpressionContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.ExpressionContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.ExpressionContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.ExpressionContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.ExpressionContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.ExpressionContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.ExpressionContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.ExpressionContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.ExpressionContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ExpressionContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.ExpressionContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.ExpressionContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.ExpressionContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.ExpressionContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: accept(ParseTreeVisitor) + uid: adaptive-expressions-ie11.ExpressionContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: ParseTreeVisitor): T' + parameters: + - id: visitor + type: ParseTreeVisitor<T> + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.accept + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ExpressionContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ExpressionContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ExpressionContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.ExpressionContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ExpressionContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ExpressionContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: depth() + uid: adaptive-expressions-ie11.ExpressionContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.ExpressionContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: enterRule(ParseTreeListener) + uid: adaptive-expressions-ie11.ExpressionContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: '' + inheritanceDescription: Inherited From ParserRuleContext.enterRule + - name: exitRule(ParseTreeListener) + uid: adaptive-expressions-ie11.ExpressionContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: '' + inheritanceDescription: Inherited From ParserRuleContext.exitRule + - name: getChild(number) + uid: adaptive-expressions-ie11.ExpressionContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExpressionContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ExpressionContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExpressionContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ExpressionContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ExpressionContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.ExpressionContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.ExpressionContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ExpressionContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ExpressionContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.ExpressionContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ExpressionContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ExpressionContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ExpressionContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ExpressionContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.ExpressionContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ExpressionContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ExpressionContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExpressionContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ExpressionContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ExpressionContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: copyFrom(ExpressionContext) + uid: adaptive-expressions-ie11.ExpressionContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionConverter.yml new file mode 100644 index 00000000..8664d07f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionConverter.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: ExpressionConverter +uid: adaptive-expressions-ie11.ExpressionConverter +package: adaptive-expressions-ie11 +summary: '`string` to json [Expression](xref:adaptive-expressions.Expression) converter.' +fullName: ExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(string | Expression) + uid: adaptive-expressions-ie11.ExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts a `string` into an + [Expression](xref:adaptive-expressions.Expression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: string | Expression): Expression' + parameters: + - id: value + type: string | + description: '`string` to convert.' + return: + description: The [Expression](xref:adaptive-expressions.Expression). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionEvaluator.yml new file mode 100644 index 00000000..7b2a2452 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionEvaluator.yml @@ -0,0 +1,101 @@ +### YamlMime:TSType +name: ExpressionEvaluator +uid: adaptive-expressions-ie11.ExpressionEvaluator +package: adaptive-expressions-ie11 +summary: Information on how to evaluate an expression. +fullName: ExpressionEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + ExpressionEvaluator(string, EvaluateExpressionDelegate, ReturnType, + ValidateExpressionDelegate) + uid: adaptive-expressions-ie11.ExpressionEvaluator.constructor + package: adaptive-expressions-ie11 + summary: Initializes a new instance of the class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new ExpressionEvaluator(type: string, evaluator: + EvaluateExpressionDelegate, returnType?: ReturnType, validator?: + ValidateExpressionDelegate) + parameters: + - id: type + type: string + description: Expression type. + - id: evaluator + type: + description: Delegate to evaluate an expression. + - id: returnType + type: + description: Type expected from evaluation. + - id: validator + type: + description: Static validation of expression. +properties: + - name: negation + uid: adaptive-expressions-ie11.ExpressionEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + - name: returnType + uid: adaptive-expressions-ie11.ExpressionEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + - name: tryEvaluate + uid: adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + - name: type + uid: adaptive-expressions-ie11.ExpressionEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: validateExpression + uid: adaptive-expressions-ie11.ExpressionEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionFunctions.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionFunctions.yml new file mode 100644 index 00000000..e8e06894 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionFunctions.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: ExpressionFunctions +uid: adaptive-expressions-ie11.ExpressionFunctions +package: adaptive-expressions-ie11 +summary: |- + + Definition of default built-in functions for expressions. + + + These functions are largely from WDL https://docs.microsoft.com/en-us/azure/logic-apps/workflow-definition-language-functions-reference + with a few extensions like infix operators for math, logic and comparisons. + This class also has some methods that are useful to use when defining custom functions. + You can always construct a directly which gives the maximum amount of control over validation and evaluation. + Validators are static checkers that should throw an exception if something is not valid statically. + Evaluators are called to evaluate an expression and should try not to throw. + There are some evaluators in this file that take in a verifier that is called at runtime to verify arguments are proper. + +fullName: ExpressionFunctions +remarks: '' +isDeprecated: false +type: class +properties: + - name: standardFunctions + uid: adaptive-expressions-ie11.ExpressionFunctions.standardFunctions + package: adaptive-expressions-ie11 + summary: Read only Dictionary of built in functions. + fullName: standardFunctions + remarks: '' + isDeprecated: false + syntax: + content: 'static standardFunctions: ReadonlyMap' + return: + description: '' + type: >- + ReadonlyMap<string, > diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParser.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParser.yml new file mode 100644 index 00000000..bf05f523 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParser.yml @@ -0,0 +1,55 @@ +### YamlMime:TSType +name: ExpressionParser +uid: adaptive-expressions-ie11.ExpressionParser +package: adaptive-expressions-ie11 +summary: Parser to turn strings into Expression +fullName: ExpressionParser +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ExpressionParser(EvaluatorLookup) + uid: adaptive-expressions-ie11.ExpressionParser.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [ExpressionParser](xref:adaptive-expressions.ExpressionParser) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new ExpressionParser(lookup?: EvaluatorLookup)' + parameters: + - id: lookup + type: + description: >- + [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) for + information from type string. +properties: + - name: EvaluatorLookup + uid: adaptive-expressions-ie11.ExpressionParser.EvaluatorLookup + package: adaptive-expressions-ie11 + summary: The delegate to lookup function information from the type. + fullName: EvaluatorLookup + remarks: '' + isDeprecated: false + syntax: + content: 'EvaluatorLookup: EvaluatorLookup' + return: + description: '' + type: +methods: + - name: parse(string) + uid: adaptive-expressions-ie11.ExpressionParser.parse + package: adaptive-expressions-ie11 + summary: Parse the input into an expression. + remarks: '' + isDeprecated: false + syntax: + content: 'function parse(expression: string): Expression' + parameters: + - id: expression + type: string + description: Expression to parse. + return: + description: Expression tree. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParserInterface.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParserInterface.yml new file mode 100644 index 00000000..74658c58 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionParserInterface.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: ExpressionParserInterface +uid: adaptive-expressions-ie11.ExpressionParserInterface +package: adaptive-expressions-ie11 +summary: Interface to parse a string into an Expression +fullName: ExpressionParserInterface +remarks: '' +isDeprecated: false +type: interface +methods: + - name: parse(string) + uid: adaptive-expressions-ie11.ExpressionParserInterface.parse + package: adaptive-expressions-ie11 + summary: Parse a string into an Expression + remarks: '' + isDeprecated: false + syntax: + content: 'function parse(expression: string): Expression' + parameters: + - id: expression + type: string + description: Expression to parse. + return: + description: The resulting expression. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionProperty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionProperty.yml new file mode 100644 index 00000000..cfe74604 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionProperty.yml @@ -0,0 +1,120 @@ +### YamlMime:TSType +name: ExpressionProperty +uid: adaptive-expressions-ie11.ExpressionProperty +package: adaptive-expressions-ie11 +summary: Base class which defines an Expression or value for a property. +fullName: ExpressionProperty +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ExpressionProperty(string | Expression | T, T) + uid: adaptive-expressions-ie11.ExpressionProperty.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [ExpressionProperty](xref:adaptive-expressions.ExpressionProperty) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new ExpressionProperty(value?: string | Expression | T, defaultValue?: + T) + parameters: + - id: value + type: string | | T + description: Optional. Raw value of the expression property. + - id: defaultValue + type: T + description: Optional. Default value for the property. +properties: + - name: expressionText + uid: adaptive-expressions-ie11.ExpressionProperty.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + - name: value + uid: adaptive-expressions-ie11.ExpressionProperty.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T' + return: + description: '' + type: T +methods: + - name: getValue(object) + uid: adaptive-expressions-ie11.ExpressionProperty.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): T' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: T + - name: setValue(string | Expression | T) + uid: adaptive-expressions-ie11.ExpressionProperty.setValue + package: adaptive-expressions-ie11 + summary: Set the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | Expression | T)' + parameters: + - id: value + type: string | | T + description: Value to set. + - name: toExpression() + uid: adaptive-expressions-ie11.ExpressionProperty.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + - name: toString() + uid: adaptive-expressions-ie11.ExpressionProperty.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.ExpressionProperty.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: T }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: T }' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionType.yml new file mode 100644 index 00000000..d448b8bd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ExpressionType.yml @@ -0,0 +1,1930 @@ +### YamlMime:TSType +name: ExpressionType +uid: adaptive-expressions-ie11.ExpressionType +package: adaptive-expressions-ie11 +summary: Built-in expression types. +fullName: ExpressionType +remarks: '' +isDeprecated: false +type: class +properties: + - name: Abs + uid: adaptive-expressions-ie11.ExpressionType.Abs + package: adaptive-expressions-ie11 + summary: '' + fullName: Abs + remarks: '' + isDeprecated: false + syntax: + content: 'static Abs: string' + return: + description: '' + type: string + - name: Accessor + uid: adaptive-expressions-ie11.ExpressionType.Accessor + package: adaptive-expressions-ie11 + summary: '' + fullName: Accessor + remarks: '' + isDeprecated: false + syntax: + content: 'static Accessor: string' + return: + description: '' + type: string + - name: Add + uid: adaptive-expressions-ie11.ExpressionType.Add + package: adaptive-expressions-ie11 + summary: '' + fullName: Add + remarks: '' + isDeprecated: false + syntax: + content: 'static Add: string' + return: + description: '' + type: string + - name: AddDays + uid: adaptive-expressions-ie11.ExpressionType.AddDays + package: adaptive-expressions-ie11 + summary: '' + fullName: AddDays + remarks: '' + isDeprecated: false + syntax: + content: 'static AddDays: string' + return: + description: '' + type: string + - name: AddHours + uid: adaptive-expressions-ie11.ExpressionType.AddHours + package: adaptive-expressions-ie11 + summary: '' + fullName: AddHours + remarks: '' + isDeprecated: false + syntax: + content: 'static AddHours: string' + return: + description: '' + type: string + - name: AddMinutes + uid: adaptive-expressions-ie11.ExpressionType.AddMinutes + package: adaptive-expressions-ie11 + summary: '' + fullName: AddMinutes + remarks: '' + isDeprecated: false + syntax: + content: 'static AddMinutes: string' + return: + description: '' + type: string + - name: AddOrdinal + uid: adaptive-expressions-ie11.ExpressionType.AddOrdinal + package: adaptive-expressions-ie11 + summary: '' + fullName: AddOrdinal + remarks: '' + isDeprecated: false + syntax: + content: 'static AddOrdinal: string' + return: + description: '' + type: string + - name: AddProperty + uid: adaptive-expressions-ie11.ExpressionType.AddProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: AddProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static AddProperty: string' + return: + description: '' + type: string + - name: AddSeconds + uid: adaptive-expressions-ie11.ExpressionType.AddSeconds + package: adaptive-expressions-ie11 + summary: '' + fullName: AddSeconds + remarks: '' + isDeprecated: false + syntax: + content: 'static AddSeconds: string' + return: + description: '' + type: string + - name: AddToTime + uid: adaptive-expressions-ie11.ExpressionType.AddToTime + package: adaptive-expressions-ie11 + summary: '' + fullName: AddToTime + remarks: '' + isDeprecated: false + syntax: + content: 'static AddToTime: string' + return: + description: '' + type: string + - name: All + uid: adaptive-expressions-ie11.ExpressionType.All + package: adaptive-expressions-ie11 + summary: '' + fullName: All + remarks: '' + isDeprecated: false + syntax: + content: 'static All: string' + return: + description: '' + type: string + - name: And + uid: adaptive-expressions-ie11.ExpressionType.And + package: adaptive-expressions-ie11 + summary: '' + fullName: And + remarks: '' + isDeprecated: false + syntax: + content: 'static And: string' + return: + description: '' + type: string + - name: Any + uid: adaptive-expressions-ie11.ExpressionType.Any + package: adaptive-expressions-ie11 + summary: '' + fullName: Any + remarks: '' + isDeprecated: false + syntax: + content: 'static Any: string' + return: + description: '' + type: string + - name: Average + uid: adaptive-expressions-ie11.ExpressionType.Average + package: adaptive-expressions-ie11 + summary: '' + fullName: Average + remarks: '' + isDeprecated: false + syntax: + content: 'static Average: string' + return: + description: '' + type: string + - name: Base64 + uid: adaptive-expressions-ie11.ExpressionType.Base64 + package: adaptive-expressions-ie11 + summary: '' + fullName: Base64 + remarks: '' + isDeprecated: false + syntax: + content: 'static Base64: string' + return: + description: '' + type: string + - name: Base64ToBinary + uid: adaptive-expressions-ie11.ExpressionType.Base64ToBinary + package: adaptive-expressions-ie11 + summary: '' + fullName: Base64ToBinary + remarks: '' + isDeprecated: false + syntax: + content: 'static Base64ToBinary: string' + return: + description: '' + type: string + - name: Base64ToString + uid: adaptive-expressions-ie11.ExpressionType.Base64ToString + package: adaptive-expressions-ie11 + summary: '' + fullName: Base64ToString + remarks: '' + isDeprecated: false + syntax: + content: 'static Base64ToString: string' + return: + description: '' + type: string + - name: Binary + uid: adaptive-expressions-ie11.ExpressionType.Binary + package: adaptive-expressions-ie11 + summary: '' + fullName: Binary + remarks: '' + isDeprecated: false + syntax: + content: 'static Binary: string' + return: + description: '' + type: string + - name: Bool + uid: adaptive-expressions-ie11.ExpressionType.Bool + package: adaptive-expressions-ie11 + summary: '' + fullName: Bool + remarks: '' + isDeprecated: false + syntax: + content: 'static Bool: string' + return: + description: '' + type: string + - name: Ceiling + uid: adaptive-expressions-ie11.ExpressionType.Ceiling + package: adaptive-expressions-ie11 + summary: '' + fullName: Ceiling + remarks: '' + isDeprecated: false + syntax: + content: 'static Ceiling: string' + return: + description: '' + type: string + - name: Coalesce + uid: adaptive-expressions-ie11.ExpressionType.Coalesce + package: adaptive-expressions-ie11 + summary: '' + fullName: Coalesce + remarks: '' + isDeprecated: false + syntax: + content: 'static Coalesce: string' + return: + description: '' + type: string + - name: Concat + uid: adaptive-expressions-ie11.ExpressionType.Concat + package: adaptive-expressions-ie11 + summary: '' + fullName: Concat + remarks: '' + isDeprecated: false + syntax: + content: 'static Concat: string' + return: + description: '' + type: string + - name: Constant + uid: adaptive-expressions-ie11.ExpressionType.Constant + package: adaptive-expressions-ie11 + summary: '' + fullName: Constant + remarks: '' + isDeprecated: false + syntax: + content: 'static Constant: string' + return: + description: '' + type: string + - name: Contains + uid: adaptive-expressions-ie11.ExpressionType.Contains + package: adaptive-expressions-ie11 + summary: '' + fullName: Contains + remarks: '' + isDeprecated: false + syntax: + content: 'static Contains: string' + return: + description: '' + type: string + - name: ConvertFromUTC + uid: adaptive-expressions-ie11.ExpressionType.ConvertFromUTC + package: adaptive-expressions-ie11 + summary: '' + fullName: ConvertFromUTC + remarks: '' + isDeprecated: false + syntax: + content: 'static ConvertFromUTC: string' + return: + description: '' + type: string + - name: ConvertToUTC + uid: adaptive-expressions-ie11.ExpressionType.ConvertToUTC + package: adaptive-expressions-ie11 + summary: '' + fullName: ConvertToUTC + remarks: '' + isDeprecated: false + syntax: + content: 'static ConvertToUTC: string' + return: + description: '' + type: string + - name: Count + uid: adaptive-expressions-ie11.ExpressionType.Count + package: adaptive-expressions-ie11 + summary: '' + fullName: Count + remarks: '' + isDeprecated: false + syntax: + content: 'static Count: string' + return: + description: '' + type: string + - name: CountWord + uid: adaptive-expressions-ie11.ExpressionType.CountWord + package: adaptive-expressions-ie11 + summary: '' + fullName: CountWord + remarks: '' + isDeprecated: false + syntax: + content: 'static CountWord: string' + return: + description: '' + type: string + - name: CreateArray + uid: adaptive-expressions-ie11.ExpressionType.CreateArray + package: adaptive-expressions-ie11 + summary: '' + fullName: CreateArray + remarks: '' + isDeprecated: false + syntax: + content: 'static CreateArray: string' + return: + description: '' + type: string + - name: DataUri + uid: adaptive-expressions-ie11.ExpressionType.DataUri + package: adaptive-expressions-ie11 + summary: '' + fullName: DataUri + remarks: '' + isDeprecated: false + syntax: + content: 'static DataUri: string' + return: + description: '' + type: string + - name: DataUriToBinary + uid: adaptive-expressions-ie11.ExpressionType.DataUriToBinary + package: adaptive-expressions-ie11 + summary: '' + fullName: DataUriToBinary + remarks: '' + isDeprecated: false + syntax: + content: 'static DataUriToBinary: string' + return: + description: '' + type: string + - name: DataUriToString + uid: adaptive-expressions-ie11.ExpressionType.DataUriToString + package: adaptive-expressions-ie11 + summary: '' + fullName: DataUriToString + remarks: '' + isDeprecated: false + syntax: + content: 'static DataUriToString: string' + return: + description: '' + type: string + - name: Date + uid: adaptive-expressions-ie11.ExpressionType.Date + package: adaptive-expressions-ie11 + summary: '' + fullName: Date + remarks: '' + isDeprecated: false + syntax: + content: 'static Date: string' + return: + description: '' + type: string + - name: DateReadBack + uid: adaptive-expressions-ie11.ExpressionType.DateReadBack + package: adaptive-expressions-ie11 + summary: '' + fullName: DateReadBack + remarks: '' + isDeprecated: false + syntax: + content: 'static DateReadBack: string' + return: + description: '' + type: string + - name: DateTimeDiff + uid: adaptive-expressions-ie11.ExpressionType.DateTimeDiff + package: adaptive-expressions-ie11 + summary: '' + fullName: DateTimeDiff + remarks: '' + isDeprecated: false + syntax: + content: 'static DateTimeDiff: string' + return: + description: '' + type: string + - name: DayOfMonth + uid: adaptive-expressions-ie11.ExpressionType.DayOfMonth + package: adaptive-expressions-ie11 + summary: '' + fullName: DayOfMonth + remarks: '' + isDeprecated: false + syntax: + content: 'static DayOfMonth: string' + return: + description: '' + type: string + - name: DayOfWeek + uid: adaptive-expressions-ie11.ExpressionType.DayOfWeek + package: adaptive-expressions-ie11 + summary: '' + fullName: DayOfWeek + remarks: '' + isDeprecated: false + syntax: + content: 'static DayOfWeek: string' + return: + description: '' + type: string + - name: DayOfYear + uid: adaptive-expressions-ie11.ExpressionType.DayOfYear + package: adaptive-expressions-ie11 + summary: '' + fullName: DayOfYear + remarks: '' + isDeprecated: false + syntax: + content: 'static DayOfYear: string' + return: + description: '' + type: string + - name: Divide + uid: adaptive-expressions-ie11.ExpressionType.Divide + package: adaptive-expressions-ie11 + summary: '' + fullName: Divide + remarks: '' + isDeprecated: false + syntax: + content: 'static Divide: string' + return: + description: '' + type: string + - name: Element + uid: adaptive-expressions-ie11.ExpressionType.Element + package: adaptive-expressions-ie11 + summary: '' + fullName: Element + remarks: '' + isDeprecated: false + syntax: + content: 'static Element: string' + return: + description: '' + type: string + - name: Empty + uid: adaptive-expressions-ie11.ExpressionType.Empty + package: adaptive-expressions-ie11 + summary: '' + fullName: Empty + remarks: '' + isDeprecated: false + syntax: + content: 'static Empty: string' + return: + description: '' + type: string + - name: EndsWith + uid: adaptive-expressions-ie11.ExpressionType.EndsWith + package: adaptive-expressions-ie11 + summary: '' + fullName: EndsWith + remarks: '' + isDeprecated: false + syntax: + content: 'static EndsWith: string' + return: + description: '' + type: string + - name: EOL + uid: adaptive-expressions-ie11.ExpressionType.EOL + package: adaptive-expressions-ie11 + summary: '' + fullName: EOL + remarks: '' + isDeprecated: false + syntax: + content: 'static EOL: string' + return: + description: '' + type: string + - name: Equal + uid: adaptive-expressions-ie11.ExpressionType.Equal + package: adaptive-expressions-ie11 + summary: '' + fullName: Equal + remarks: '' + isDeprecated: false + syntax: + content: 'static Equal: string' + return: + description: '' + type: string + - name: Exists + uid: adaptive-expressions-ie11.ExpressionType.Exists + package: adaptive-expressions-ie11 + summary: '' + fullName: Exists + remarks: '' + isDeprecated: false + syntax: + content: 'static Exists: string' + return: + description: '' + type: string + - name: FilterNotEqual + uid: adaptive-expressions-ie11.ExpressionType.FilterNotEqual + package: adaptive-expressions-ie11 + summary: '' + fullName: FilterNotEqual + remarks: '' + isDeprecated: false + syntax: + content: 'static FilterNotEqual: string' + return: + description: '' + type: string + - name: First + uid: adaptive-expressions-ie11.ExpressionType.First + package: adaptive-expressions-ie11 + summary: '' + fullName: First + remarks: '' + isDeprecated: false + syntax: + content: 'static First: string' + return: + description: '' + type: string + - name: Flatten + uid: adaptive-expressions-ie11.ExpressionType.Flatten + package: adaptive-expressions-ie11 + summary: '' + fullName: Flatten + remarks: '' + isDeprecated: false + syntax: + content: 'static Flatten: string' + return: + description: '' + type: string + - name: Float + uid: adaptive-expressions-ie11.ExpressionType.Float + package: adaptive-expressions-ie11 + summary: '' + fullName: Float + remarks: '' + isDeprecated: false + syntax: + content: 'static Float: string' + return: + description: '' + type: string + - name: Floor + uid: adaptive-expressions-ie11.ExpressionType.Floor + package: adaptive-expressions-ie11 + summary: '' + fullName: Floor + remarks: '' + isDeprecated: false + syntax: + content: 'static Floor: string' + return: + description: '' + type: string + - name: Foreach + uid: adaptive-expressions-ie11.ExpressionType.Foreach + package: adaptive-expressions-ie11 + summary: '' + fullName: Foreach + remarks: '' + isDeprecated: false + syntax: + content: 'static Foreach: string' + return: + description: '' + type: string + - name: FormatDateTime + uid: adaptive-expressions-ie11.ExpressionType.FormatDateTime + package: adaptive-expressions-ie11 + summary: '' + fullName: FormatDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'static FormatDateTime: string' + return: + description: '' + type: string + - name: FormatEpoch + uid: adaptive-expressions-ie11.ExpressionType.FormatEpoch + package: adaptive-expressions-ie11 + summary: '' + fullName: FormatEpoch + remarks: '' + isDeprecated: false + syntax: + content: 'static FormatEpoch: string' + return: + description: '' + type: string + - name: FormatNumber + uid: adaptive-expressions-ie11.ExpressionType.FormatNumber + package: adaptive-expressions-ie11 + summary: '' + fullName: FormatNumber + remarks: '' + isDeprecated: false + syntax: + content: 'static FormatNumber: string' + return: + description: '' + type: string + - name: FormatTicks + uid: adaptive-expressions-ie11.ExpressionType.FormatTicks + package: adaptive-expressions-ie11 + summary: '' + fullName: FormatTicks + remarks: '' + isDeprecated: false + syntax: + content: 'static FormatTicks: string' + return: + description: '' + type: string + - name: GetFutureTime + uid: adaptive-expressions-ie11.ExpressionType.GetFutureTime + package: adaptive-expressions-ie11 + summary: '' + fullName: GetFutureTime + remarks: '' + isDeprecated: false + syntax: + content: 'static GetFutureTime: string' + return: + description: '' + type: string + - name: GetNextViableDate + uid: adaptive-expressions-ie11.ExpressionType.GetNextViableDate + package: adaptive-expressions-ie11 + summary: '' + fullName: GetNextViableDate + remarks: '' + isDeprecated: false + syntax: + content: 'static GetNextViableDate: string' + return: + description: '' + type: string + - name: GetNextViableTime + uid: adaptive-expressions-ie11.ExpressionType.GetNextViableTime + package: adaptive-expressions-ie11 + summary: '' + fullName: GetNextViableTime + remarks: '' + isDeprecated: false + syntax: + content: 'static GetNextViableTime: string' + return: + description: '' + type: string + - name: GetPastTime + uid: adaptive-expressions-ie11.ExpressionType.GetPastTime + package: adaptive-expressions-ie11 + summary: '' + fullName: GetPastTime + remarks: '' + isDeprecated: false + syntax: + content: 'static GetPastTime: string' + return: + description: '' + type: string + - name: GetPreviousViableDate + uid: adaptive-expressions-ie11.ExpressionType.GetPreviousViableDate + package: adaptive-expressions-ie11 + summary: '' + fullName: GetPreviousViableDate + remarks: '' + isDeprecated: false + syntax: + content: 'static GetPreviousViableDate: string' + return: + description: '' + type: string + - name: GetPreviousViableTime + uid: adaptive-expressions-ie11.ExpressionType.GetPreviousViableTime + package: adaptive-expressions-ie11 + summary: '' + fullName: GetPreviousViableTime + remarks: '' + isDeprecated: false + syntax: + content: 'static GetPreviousViableTime: string' + return: + description: '' + type: string + - name: GetProperty + uid: adaptive-expressions-ie11.ExpressionType.GetProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: GetProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static GetProperty: string' + return: + description: '' + type: string + - name: GetTimeOfDay + uid: adaptive-expressions-ie11.ExpressionType.GetTimeOfDay + package: adaptive-expressions-ie11 + summary: '' + fullName: GetTimeOfDay + remarks: '' + isDeprecated: false + syntax: + content: 'static GetTimeOfDay: string' + return: + description: '' + type: string + - name: GreaterThan + uid: adaptive-expressions-ie11.ExpressionType.GreaterThan + package: adaptive-expressions-ie11 + summary: '' + fullName: GreaterThan + remarks: '' + isDeprecated: false + syntax: + content: 'static GreaterThan: string' + return: + description: '' + type: string + - name: GreaterThanOrEqual + uid: adaptive-expressions-ie11.ExpressionType.GreaterThanOrEqual + package: adaptive-expressions-ie11 + summary: '' + fullName: GreaterThanOrEqual + remarks: '' + isDeprecated: false + syntax: + content: 'static GreaterThanOrEqual: string' + return: + description: '' + type: string + - name: If + uid: adaptive-expressions-ie11.ExpressionType.If + package: adaptive-expressions-ie11 + summary: '' + fullName: If + remarks: '' + isDeprecated: false + syntax: + content: 'static If: string' + return: + description: '' + type: string + - name: Ignore + uid: adaptive-expressions-ie11.ExpressionType.Ignore + package: adaptive-expressions-ie11 + summary: '' + fullName: Ignore + remarks: '' + isDeprecated: false + syntax: + content: 'static Ignore: string' + return: + description: '' + type: string + - name: IndexOf + uid: adaptive-expressions-ie11.ExpressionType.IndexOf + package: adaptive-expressions-ie11 + summary: '' + fullName: IndexOf + remarks: '' + isDeprecated: false + syntax: + content: 'static IndexOf: string' + return: + description: '' + type: string + - name: IndicesAndValues + uid: adaptive-expressions-ie11.ExpressionType.IndicesAndValues + package: adaptive-expressions-ie11 + summary: '' + fullName: IndicesAndValues + remarks: '' + isDeprecated: false + syntax: + content: 'static IndicesAndValues: string' + return: + description: '' + type: string + - name: Int + uid: adaptive-expressions-ie11.ExpressionType.Int + package: adaptive-expressions-ie11 + summary: '' + fullName: Int + remarks: '' + isDeprecated: false + syntax: + content: 'static Int: string' + return: + description: '' + type: string + - name: Intersection + uid: adaptive-expressions-ie11.ExpressionType.Intersection + package: adaptive-expressions-ie11 + summary: '' + fullName: Intersection + remarks: '' + isDeprecated: false + syntax: + content: 'static Intersection: string' + return: + description: '' + type: string + - name: IsArray + uid: adaptive-expressions-ie11.ExpressionType.IsArray + package: adaptive-expressions-ie11 + summary: '' + fullName: IsArray + remarks: '' + isDeprecated: false + syntax: + content: 'static IsArray: string' + return: + description: '' + type: string + - name: IsBoolean + uid: adaptive-expressions-ie11.ExpressionType.IsBoolean + package: adaptive-expressions-ie11 + summary: '' + fullName: IsBoolean + remarks: '' + isDeprecated: false + syntax: + content: 'static IsBoolean: string' + return: + description: '' + type: string + - name: IsDate + uid: adaptive-expressions-ie11.ExpressionType.IsDate + package: adaptive-expressions-ie11 + summary: '' + fullName: IsDate + remarks: '' + isDeprecated: false + syntax: + content: 'static IsDate: string' + return: + description: '' + type: string + - name: IsDateRange + uid: adaptive-expressions-ie11.ExpressionType.IsDateRange + package: adaptive-expressions-ie11 + summary: '' + fullName: IsDateRange + remarks: '' + isDeprecated: false + syntax: + content: 'static IsDateRange: string' + return: + description: '' + type: string + - name: IsDateTime + uid: adaptive-expressions-ie11.ExpressionType.IsDateTime + package: adaptive-expressions-ie11 + summary: '' + fullName: IsDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'static IsDateTime: string' + return: + description: '' + type: string + - name: IsDefinite + uid: adaptive-expressions-ie11.ExpressionType.IsDefinite + package: adaptive-expressions-ie11 + summary: '' + fullName: IsDefinite + remarks: '' + isDeprecated: false + syntax: + content: 'static IsDefinite: string' + return: + description: '' + type: string + - name: IsDuration + uid: adaptive-expressions-ie11.ExpressionType.IsDuration + package: adaptive-expressions-ie11 + summary: '' + fullName: IsDuration + remarks: '' + isDeprecated: false + syntax: + content: 'static IsDuration: string' + return: + description: '' + type: string + - name: IsFloat + uid: adaptive-expressions-ie11.ExpressionType.IsFloat + package: adaptive-expressions-ie11 + summary: '' + fullName: IsFloat + remarks: '' + isDeprecated: false + syntax: + content: 'static IsFloat: string' + return: + description: '' + type: string + - name: IsInteger + uid: adaptive-expressions-ie11.ExpressionType.IsInteger + package: adaptive-expressions-ie11 + summary: '' + fullName: IsInteger + remarks: '' + isDeprecated: false + syntax: + content: 'static IsInteger: string' + return: + description: '' + type: string + - name: IsMatch + uid: adaptive-expressions-ie11.ExpressionType.IsMatch + package: adaptive-expressions-ie11 + summary: '' + fullName: IsMatch + remarks: '' + isDeprecated: false + syntax: + content: 'static IsMatch: string' + return: + description: '' + type: string + - name: IsObject + uid: adaptive-expressions-ie11.ExpressionType.IsObject + package: adaptive-expressions-ie11 + summary: '' + fullName: IsObject + remarks: '' + isDeprecated: false + syntax: + content: 'static IsObject: string' + return: + description: '' + type: string + - name: IsPresent + uid: adaptive-expressions-ie11.ExpressionType.IsPresent + package: adaptive-expressions-ie11 + summary: '' + fullName: IsPresent + remarks: '' + isDeprecated: false + syntax: + content: 'static IsPresent: string' + return: + description: '' + type: string + - name: IsString + uid: adaptive-expressions-ie11.ExpressionType.IsString + package: adaptive-expressions-ie11 + summary: '' + fullName: IsString + remarks: '' + isDeprecated: false + syntax: + content: 'static IsString: string' + return: + description: '' + type: string + - name: IsTime + uid: adaptive-expressions-ie11.ExpressionType.IsTime + package: adaptive-expressions-ie11 + summary: '' + fullName: IsTime + remarks: '' + isDeprecated: false + syntax: + content: 'static IsTime: string' + return: + description: '' + type: string + - name: IsTimeRange + uid: adaptive-expressions-ie11.ExpressionType.IsTimeRange + package: adaptive-expressions-ie11 + summary: '' + fullName: IsTimeRange + remarks: '' + isDeprecated: false + syntax: + content: 'static IsTimeRange: string' + return: + description: '' + type: string + - name: Join + uid: adaptive-expressions-ie11.ExpressionType.Join + package: adaptive-expressions-ie11 + summary: '' + fullName: Join + remarks: '' + isDeprecated: false + syntax: + content: 'static Join: string' + return: + description: '' + type: string + - name: JPath + uid: adaptive-expressions-ie11.ExpressionType.JPath + package: adaptive-expressions-ie11 + summary: '' + fullName: JPath + remarks: '' + isDeprecated: false + syntax: + content: 'static JPath: string' + return: + description: '' + type: string + - name: Json + uid: adaptive-expressions-ie11.ExpressionType.Json + package: adaptive-expressions-ie11 + summary: '' + fullName: Json + remarks: '' + isDeprecated: false + syntax: + content: 'static Json: string' + return: + description: '' + type: string + - name: JsonStringify + uid: adaptive-expressions-ie11.ExpressionType.JsonStringify + package: adaptive-expressions-ie11 + summary: '' + fullName: JsonStringify + remarks: '' + isDeprecated: false + syntax: + content: 'static JsonStringify: string' + return: + description: '' + type: string + - name: Lambda + uid: adaptive-expressions-ie11.ExpressionType.Lambda + package: adaptive-expressions-ie11 + summary: '' + fullName: Lambda + remarks: '' + isDeprecated: false + syntax: + content: 'static Lambda: string' + return: + description: '' + type: string + - name: Last + uid: adaptive-expressions-ie11.ExpressionType.Last + package: adaptive-expressions-ie11 + summary: '' + fullName: Last + remarks: '' + isDeprecated: false + syntax: + content: 'static Last: string' + return: + description: '' + type: string + - name: LastIndexOf + uid: adaptive-expressions-ie11.ExpressionType.LastIndexOf + package: adaptive-expressions-ie11 + summary: '' + fullName: LastIndexOf + remarks: '' + isDeprecated: false + syntax: + content: 'static LastIndexOf: string' + return: + description: '' + type: string + - name: Length + uid: adaptive-expressions-ie11.ExpressionType.Length + package: adaptive-expressions-ie11 + summary: '' + fullName: Length + remarks: '' + isDeprecated: false + syntax: + content: 'static Length: string' + return: + description: '' + type: string + - name: LessThan + uid: adaptive-expressions-ie11.ExpressionType.LessThan + package: adaptive-expressions-ie11 + summary: '' + fullName: LessThan + remarks: '' + isDeprecated: false + syntax: + content: 'static LessThan: string' + return: + description: '' + type: string + - name: LessThanOrEqual + uid: adaptive-expressions-ie11.ExpressionType.LessThanOrEqual + package: adaptive-expressions-ie11 + summary: '' + fullName: LessThanOrEqual + remarks: '' + isDeprecated: false + syntax: + content: 'static LessThanOrEqual: string' + return: + description: '' + type: string + - name: Max + uid: adaptive-expressions-ie11.ExpressionType.Max + package: adaptive-expressions-ie11 + summary: '' + fullName: Max + remarks: '' + isDeprecated: false + syntax: + content: 'static Max: string' + return: + description: '' + type: string + - name: Merge + uid: adaptive-expressions-ie11.ExpressionType.Merge + package: adaptive-expressions-ie11 + summary: '' + fullName: Merge + remarks: '' + isDeprecated: false + syntax: + content: 'static Merge: string' + return: + description: '' + type: string + - name: Min + uid: adaptive-expressions-ie11.ExpressionType.Min + package: adaptive-expressions-ie11 + summary: '' + fullName: Min + remarks: '' + isDeprecated: false + syntax: + content: 'static Min: string' + return: + description: '' + type: string + - name: Mod + uid: adaptive-expressions-ie11.ExpressionType.Mod + package: adaptive-expressions-ie11 + summary: '' + fullName: Mod + remarks: '' + isDeprecated: false + syntax: + content: 'static Mod: string' + return: + description: '' + type: string + - name: Month + uid: adaptive-expressions-ie11.ExpressionType.Month + package: adaptive-expressions-ie11 + summary: '' + fullName: Month + remarks: '' + isDeprecated: false + syntax: + content: 'static Month: string' + return: + description: '' + type: string + - name: Multiply + uid: adaptive-expressions-ie11.ExpressionType.Multiply + package: adaptive-expressions-ie11 + summary: '' + fullName: Multiply + remarks: '' + isDeprecated: false + syntax: + content: 'static Multiply: string' + return: + description: '' + type: string + - name: NewGuid + uid: adaptive-expressions-ie11.ExpressionType.NewGuid + package: adaptive-expressions-ie11 + summary: '' + fullName: NewGuid + remarks: '' + isDeprecated: false + syntax: + content: 'static NewGuid: string' + return: + description: '' + type: string + - name: Not + uid: adaptive-expressions-ie11.ExpressionType.Not + package: adaptive-expressions-ie11 + summary: '' + fullName: Not + remarks: '' + isDeprecated: false + syntax: + content: 'static Not: string' + return: + description: '' + type: string + - name: NotEqual + uid: adaptive-expressions-ie11.ExpressionType.NotEqual + package: adaptive-expressions-ie11 + summary: '' + fullName: NotEqual + remarks: '' + isDeprecated: false + syntax: + content: 'static NotEqual: string' + return: + description: '' + type: string + - name: Optional + uid: adaptive-expressions-ie11.ExpressionType.Optional + package: adaptive-expressions-ie11 + summary: '' + fullName: Optional + remarks: '' + isDeprecated: false + syntax: + content: 'static Optional: string' + return: + description: '' + type: string + - name: Or + uid: adaptive-expressions-ie11.ExpressionType.Or + package: adaptive-expressions-ie11 + summary: '' + fullName: Or + remarks: '' + isDeprecated: false + syntax: + content: 'static Or: string' + return: + description: '' + type: string + - name: Power + uid: adaptive-expressions-ie11.ExpressionType.Power + package: adaptive-expressions-ie11 + summary: '' + fullName: Power + remarks: '' + isDeprecated: false + syntax: + content: 'static Power: string' + return: + description: '' + type: string + - name: Rand + uid: adaptive-expressions-ie11.ExpressionType.Rand + package: adaptive-expressions-ie11 + summary: '' + fullName: Rand + remarks: '' + isDeprecated: false + syntax: + content: 'static Rand: string' + return: + description: '' + type: string + - name: Range + uid: adaptive-expressions-ie11.ExpressionType.Range + package: adaptive-expressions-ie11 + summary: '' + fullName: Range + remarks: '' + isDeprecated: false + syntax: + content: 'static Range: string' + return: + description: '' + type: string + - name: RemoveProperty + uid: adaptive-expressions-ie11.ExpressionType.RemoveProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: RemoveProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static RemoveProperty: string' + return: + description: '' + type: string + - name: Replace + uid: adaptive-expressions-ie11.ExpressionType.Replace + package: adaptive-expressions-ie11 + summary: '' + fullName: Replace + remarks: '' + isDeprecated: false + syntax: + content: 'static Replace: string' + return: + description: '' + type: string + - name: ReplaceIgnoreCase + uid: adaptive-expressions-ie11.ExpressionType.ReplaceIgnoreCase + package: adaptive-expressions-ie11 + summary: '' + fullName: ReplaceIgnoreCase + remarks: '' + isDeprecated: false + syntax: + content: 'static ReplaceIgnoreCase: string' + return: + description: '' + type: string + - name: Reverse + uid: adaptive-expressions-ie11.ExpressionType.Reverse + package: adaptive-expressions-ie11 + summary: '' + fullName: Reverse + remarks: '' + isDeprecated: false + syntax: + content: 'static Reverse: string' + return: + description: '' + type: string + - name: Round + uid: adaptive-expressions-ie11.ExpressionType.Round + package: adaptive-expressions-ie11 + summary: '' + fullName: Round + remarks: '' + isDeprecated: false + syntax: + content: 'static Round: string' + return: + description: '' + type: string + - name: Select + uid: adaptive-expressions-ie11.ExpressionType.Select + package: adaptive-expressions-ie11 + summary: '' + fullName: Select + remarks: '' + isDeprecated: false + syntax: + content: 'static Select: string' + return: + description: '' + type: string + - name: SentenceCase + uid: adaptive-expressions-ie11.ExpressionType.SentenceCase + package: adaptive-expressions-ie11 + summary: '' + fullName: SentenceCase + remarks: '' + isDeprecated: false + syntax: + content: 'static SentenceCase: string' + return: + description: '' + type: string + - name: SetPathToValue + uid: adaptive-expressions-ie11.ExpressionType.SetPathToValue + package: adaptive-expressions-ie11 + summary: '' + fullName: SetPathToValue + remarks: '' + isDeprecated: false + syntax: + content: 'static SetPathToValue: string' + return: + description: '' + type: string + - name: SetProperty + uid: adaptive-expressions-ie11.ExpressionType.SetProperty + package: adaptive-expressions-ie11 + summary: '' + fullName: SetProperty + remarks: '' + isDeprecated: false + syntax: + content: 'static SetProperty: string' + return: + description: '' + type: string + - name: Skip + uid: adaptive-expressions-ie11.ExpressionType.Skip + package: adaptive-expressions-ie11 + summary: '' + fullName: Skip + remarks: '' + isDeprecated: false + syntax: + content: 'static Skip: string' + return: + description: '' + type: string + - name: SortBy + uid: adaptive-expressions-ie11.ExpressionType.SortBy + package: adaptive-expressions-ie11 + summary: '' + fullName: SortBy + remarks: '' + isDeprecated: false + syntax: + content: 'static SortBy: string' + return: + description: '' + type: string + - name: SortByDescending + uid: adaptive-expressions-ie11.ExpressionType.SortByDescending + package: adaptive-expressions-ie11 + summary: '' + fullName: SortByDescending + remarks: '' + isDeprecated: false + syntax: + content: 'static SortByDescending: string' + return: + description: '' + type: string + - name: Split + uid: adaptive-expressions-ie11.ExpressionType.Split + package: adaptive-expressions-ie11 + summary: '' + fullName: Split + remarks: '' + isDeprecated: false + syntax: + content: 'static Split: string' + return: + description: '' + type: string + - name: Sqrt + uid: adaptive-expressions-ie11.ExpressionType.Sqrt + package: adaptive-expressions-ie11 + summary: '' + fullName: Sqrt + remarks: '' + isDeprecated: false + syntax: + content: 'static Sqrt: string' + return: + description: '' + type: string + - name: StartOfDay + uid: adaptive-expressions-ie11.ExpressionType.StartOfDay + package: adaptive-expressions-ie11 + summary: '' + fullName: StartOfDay + remarks: '' + isDeprecated: false + syntax: + content: 'static StartOfDay: string' + return: + description: '' + type: string + - name: StartOfHour + uid: adaptive-expressions-ie11.ExpressionType.StartOfHour + package: adaptive-expressions-ie11 + summary: '' + fullName: StartOfHour + remarks: '' + isDeprecated: false + syntax: + content: 'static StartOfHour: string' + return: + description: '' + type: string + - name: StartOfMonth + uid: adaptive-expressions-ie11.ExpressionType.StartOfMonth + package: adaptive-expressions-ie11 + summary: '' + fullName: StartOfMonth + remarks: '' + isDeprecated: false + syntax: + content: 'static StartOfMonth: string' + return: + description: '' + type: string + - name: StartsWith + uid: adaptive-expressions-ie11.ExpressionType.StartsWith + package: adaptive-expressions-ie11 + summary: '' + fullName: StartsWith + remarks: '' + isDeprecated: false + syntax: + content: 'static StartsWith: string' + return: + description: '' + type: string + - name: String + uid: adaptive-expressions-ie11.ExpressionType.String + package: adaptive-expressions-ie11 + summary: '' + fullName: String + remarks: '' + isDeprecated: false + syntax: + content: 'static String: string' + return: + description: '' + type: string + - name: StringOrValue + uid: adaptive-expressions-ie11.ExpressionType.StringOrValue + package: adaptive-expressions-ie11 + summary: '' + fullName: StringOrValue + remarks: '' + isDeprecated: false + syntax: + content: 'static StringOrValue: string' + return: + description: '' + type: string + - name: SubArray + uid: adaptive-expressions-ie11.ExpressionType.SubArray + package: adaptive-expressions-ie11 + summary: '' + fullName: SubArray + remarks: '' + isDeprecated: false + syntax: + content: 'static SubArray: string' + return: + description: '' + type: string + - name: Substring + uid: adaptive-expressions-ie11.ExpressionType.Substring + package: adaptive-expressions-ie11 + summary: '' + fullName: Substring + remarks: '' + isDeprecated: false + syntax: + content: 'static Substring: string' + return: + description: '' + type: string + - name: Subtract + uid: adaptive-expressions-ie11.ExpressionType.Subtract + package: adaptive-expressions-ie11 + summary: '' + fullName: Subtract + remarks: '' + isDeprecated: false + syntax: + content: 'static Subtract: string' + return: + description: '' + type: string + - name: SubtractFromTime + uid: adaptive-expressions-ie11.ExpressionType.SubtractFromTime + package: adaptive-expressions-ie11 + summary: '' + fullName: SubtractFromTime + remarks: '' + isDeprecated: false + syntax: + content: 'static SubtractFromTime: string' + return: + description: '' + type: string + - name: Sum + uid: adaptive-expressions-ie11.ExpressionType.Sum + package: adaptive-expressions-ie11 + summary: '' + fullName: Sum + remarks: '' + isDeprecated: false + syntax: + content: 'static Sum: string' + return: + description: '' + type: string + - name: Take + uid: adaptive-expressions-ie11.ExpressionType.Take + package: adaptive-expressions-ie11 + summary: '' + fullName: Take + remarks: '' + isDeprecated: false + syntax: + content: 'static Take: string' + return: + description: '' + type: string + - name: Ticks + uid: adaptive-expressions-ie11.ExpressionType.Ticks + package: adaptive-expressions-ie11 + summary: '' + fullName: Ticks + remarks: '' + isDeprecated: false + syntax: + content: 'static Ticks: string' + return: + description: '' + type: string + - name: TicksToDays + uid: adaptive-expressions-ie11.ExpressionType.TicksToDays + package: adaptive-expressions-ie11 + summary: '' + fullName: TicksToDays + remarks: '' + isDeprecated: false + syntax: + content: 'static TicksToDays: string' + return: + description: '' + type: string + - name: TicksToHours + uid: adaptive-expressions-ie11.ExpressionType.TicksToHours + package: adaptive-expressions-ie11 + summary: '' + fullName: TicksToHours + remarks: '' + isDeprecated: false + syntax: + content: 'static TicksToHours: string' + return: + description: '' + type: string + - name: TicksToMinutes + uid: adaptive-expressions-ie11.ExpressionType.TicksToMinutes + package: adaptive-expressions-ie11 + summary: '' + fullName: TicksToMinutes + remarks: '' + isDeprecated: false + syntax: + content: 'static TicksToMinutes: string' + return: + description: '' + type: string + - name: TimexResolve + uid: adaptive-expressions-ie11.ExpressionType.TimexResolve + package: adaptive-expressions-ie11 + summary: '' + fullName: TimexResolve + remarks: '' + isDeprecated: false + syntax: + content: 'static TimexResolve: string' + return: + description: '' + type: string + - name: TitleCase + uid: adaptive-expressions-ie11.ExpressionType.TitleCase + package: adaptive-expressions-ie11 + summary: '' + fullName: TitleCase + remarks: '' + isDeprecated: false + syntax: + content: 'static TitleCase: string' + return: + description: '' + type: string + - name: ToLower + uid: adaptive-expressions-ie11.ExpressionType.ToLower + package: adaptive-expressions-ie11 + summary: '' + fullName: ToLower + remarks: '' + isDeprecated: false + syntax: + content: 'static ToLower: string' + return: + description: '' + type: string + - name: ToUpper + uid: adaptive-expressions-ie11.ExpressionType.ToUpper + package: adaptive-expressions-ie11 + summary: '' + fullName: ToUpper + remarks: '' + isDeprecated: false + syntax: + content: 'static ToUpper: string' + return: + description: '' + type: string + - name: Trim + uid: adaptive-expressions-ie11.ExpressionType.Trim + package: adaptive-expressions-ie11 + summary: '' + fullName: Trim + remarks: '' + isDeprecated: false + syntax: + content: 'static Trim: string' + return: + description: '' + type: string + - name: Union + uid: adaptive-expressions-ie11.ExpressionType.Union + package: adaptive-expressions-ie11 + summary: '' + fullName: Union + remarks: '' + isDeprecated: false + syntax: + content: 'static Union: string' + return: + description: '' + type: string + - name: Unique + uid: adaptive-expressions-ie11.ExpressionType.Unique + package: adaptive-expressions-ie11 + summary: '' + fullName: Unique + remarks: '' + isDeprecated: false + syntax: + content: 'static Unique: string' + return: + description: '' + type: string + - name: UriComponent + uid: adaptive-expressions-ie11.ExpressionType.UriComponent + package: adaptive-expressions-ie11 + summary: '' + fullName: UriComponent + remarks: '' + isDeprecated: false + syntax: + content: 'static UriComponent: string' + return: + description: '' + type: string + - name: UriComponentToString + uid: adaptive-expressions-ie11.ExpressionType.UriComponentToString + package: adaptive-expressions-ie11 + summary: '' + fullName: UriComponentToString + remarks: '' + isDeprecated: false + syntax: + content: 'static UriComponentToString: string' + return: + description: '' + type: string + - name: UriHost + uid: adaptive-expressions-ie11.ExpressionType.UriHost + package: adaptive-expressions-ie11 + summary: '' + fullName: UriHost + remarks: '' + isDeprecated: false + syntax: + content: 'static UriHost: string' + return: + description: '' + type: string + - name: UriPath + uid: adaptive-expressions-ie11.ExpressionType.UriPath + package: adaptive-expressions-ie11 + summary: '' + fullName: UriPath + remarks: '' + isDeprecated: false + syntax: + content: 'static UriPath: string' + return: + description: '' + type: string + - name: UriPathAndQuery + uid: adaptive-expressions-ie11.ExpressionType.UriPathAndQuery + package: adaptive-expressions-ie11 + summary: '' + fullName: UriPathAndQuery + remarks: '' + isDeprecated: false + syntax: + content: 'static UriPathAndQuery: string' + return: + description: '' + type: string + - name: UriPort + uid: adaptive-expressions-ie11.ExpressionType.UriPort + package: adaptive-expressions-ie11 + summary: '' + fullName: UriPort + remarks: '' + isDeprecated: false + syntax: + content: 'static UriPort: string' + return: + description: '' + type: string + - name: UriQuery + uid: adaptive-expressions-ie11.ExpressionType.UriQuery + package: adaptive-expressions-ie11 + summary: '' + fullName: UriQuery + remarks: '' + isDeprecated: false + syntax: + content: 'static UriQuery: string' + return: + description: '' + type: string + - name: UriScheme + uid: adaptive-expressions-ie11.ExpressionType.UriScheme + package: adaptive-expressions-ie11 + summary: '' + fullName: UriScheme + remarks: '' + isDeprecated: false + syntax: + content: 'static UriScheme: string' + return: + description: '' + type: string + - name: UtcNow + uid: adaptive-expressions-ie11.ExpressionType.UtcNow + package: adaptive-expressions-ie11 + summary: '' + fullName: UtcNow + remarks: '' + isDeprecated: false + syntax: + content: 'static UtcNow: string' + return: + description: '' + type: string + - name: Where + uid: adaptive-expressions-ie11.ExpressionType.Where + package: adaptive-expressions-ie11 + summary: '' + fullName: Where + remarks: '' + isDeprecated: false + syntax: + content: 'static Where: string' + return: + description: '' + type: string + - name: XML + uid: adaptive-expressions-ie11.ExpressionType.XML + package: adaptive-expressions-ie11 + summary: '' + fullName: XML + remarks: '' + isDeprecated: false + syntax: + content: 'static XML: string' + return: + description: '' + type: string + - name: XPath + uid: adaptive-expressions-ie11.ExpressionType.XPath + package: adaptive-expressions-ie11 + summary: '' + fullName: XPath + remarks: '' + isDeprecated: false + syntax: + content: 'static XPath: string' + return: + description: '' + type: string + - name: Year + uid: adaptive-expressions-ie11.ExpressionType.Year + package: adaptive-expressions-ie11 + summary: '' + fullName: Year + remarks: '' + isDeprecated: false + syntax: + content: 'static Year: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Extensions.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Extensions.yml new file mode 100644 index 00000000..f44baf87 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Extensions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Extensions +uid: adaptive-expressions-ie11.Extensions +package: adaptive-expressions-ie11 +summary: Some util and extension functions +fullName: Extensions +remarks: '' +isDeprecated: false +type: class +methods: + - name: isMemoryInterface(any) + uid: adaptive-expressions-ie11.Extensions.isMemoryInterface + package: adaptive-expressions-ie11 + summary: >- + Patch method + + TODO: is there any better solution? + + To judge if an object is implements MemoryInterface. Same with 'is + MemoryInterface' in C# + remarks: '' + isDeprecated: false + syntax: + content: 'static function isMemoryInterface(obj: any): boolean' + parameters: + - id: obj + type: any + description: The object to evaluate. + return: + description: True if the object implements MemoryInterface; False if it isn't. + type: boolean + - name: randomNext(MemoryInterface, number, number) + uid: adaptive-expressions-ie11.Extensions.randomNext + package: adaptive-expressions-ie11 + summary: >- + Generator random seed and value from properties. + + If value is not null, the mock random value result would be: min + (value + % (max - min)). + remarks: '' + isDeprecated: false + syntax: + content: >- + static function randomNext(memory: MemoryInterface, min: number, max: + number): number + parameters: + - id: memory + type: + description: memory state. + - id: min + type: number + description: The inclusive lower bound of the random number returned. + - id: max + type: number + description: >- + The exclusive upper bound of the random number returned. max must be + greater than or equal to min. + return: + description: Random value. + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FileContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FileContext.yml new file mode 100644 index 00000000..aa5042ba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FileContext.yml @@ -0,0 +1,845 @@ +### YamlMime:TSType +name: FileContext +uid: adaptive-expressions-ie11.FileContext +package: adaptive-expressions-ie11 +summary: '' +fullName: FileContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: FileContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.FileContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new FileContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.FileContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.FileContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.FileContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.FileContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.FileContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.FileContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.FileContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.FileContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.FileContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.FileContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: FileContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.FileContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.FileContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.FileContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.FileContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.FileContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.FileContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.FileContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.FileContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.FileContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.FileContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.FileContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.FileContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.FileContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.FileContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FileContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.FileContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FileContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.FileContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.FileContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.FileContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.FileContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.FileContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.FileContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.FileContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.FileContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.FileContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.FileContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.FileContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.FileContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.FileContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.FileContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FileContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FileContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.FileContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.FileContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.FileContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: EOF() + uid: adaptive-expressions-ie11.FileContext.EOF + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function EOF(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.FileContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.FileContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FuncInvokeExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FuncInvokeExpContext.yml new file mode 100644 index 00000000..f64f3b4c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FuncInvokeExpContext.yml @@ -0,0 +1,950 @@ +### YamlMime:TSType +name: FuncInvokeExpContext +uid: adaptive-expressions-ie11.FuncInvokeExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: FuncInvokeExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: FuncInvokeExpContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new FuncInvokeExpContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.FuncInvokeExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.FuncInvokeExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.FuncInvokeExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.FuncInvokeExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.FuncInvokeExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.FuncInvokeExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.FuncInvokeExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.FuncInvokeExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.FuncInvokeExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: FuncInvokeExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.FuncInvokeExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.FuncInvokeExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.FuncInvokeExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.FuncInvokeExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.FuncInvokeExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FuncInvokeExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.FuncInvokeExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: argsList() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.argsList + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function argsList(): undefined | ArgsListContext' + return: + description: '' + type: undefined | + - name: CLOSE_BRACKET() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.CLOSE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CLOSE_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.FuncInvokeExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: NON() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.NON + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NON(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: OPEN_BRACKET() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.OPEN_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OPEN_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: primaryExpression() + uid: adaptive-expressions-ie11.FuncInvokeExpContext.primaryExpression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function primaryExpression(): PrimaryExpressionContext' + return: + description: '' + type: +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionTable.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionTable.yml new file mode 100644 index 00000000..88dd33a5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionTable.yml @@ -0,0 +1,273 @@ +### YamlMime:TSType +name: FunctionTable +uid: adaptive-expressions-ie11.FunctionTable +package: adaptive-expressions-ie11 +summary: >- + FunctionTable is a dictionary which merges BuiltinFunctions.Functions with a + CustomDictionary. +fullName: FunctionTable +remarks: '' +isDeprecated: false +type: class +properties: + - name: isReadOnly + uid: adaptive-expressions-ie11.FunctionTable.isReadOnly + package: adaptive-expressions-ie11 + summary: >- + Gets a value indicating whether the + [FunctionTable](xref:adaptive-expressions.FunctionTable) is readonly. + fullName: isReadOnly + remarks: '' + isDeprecated: false + syntax: + content: 'isReadOnly: boolean' + return: + description: >- + A boolean value indicating whether the + [FunctionTable](xref:adaptive-expressions.FunctionTable) is readonly. + type: boolean + - name: size + uid: adaptive-expressions-ie11.FunctionTable.size + package: adaptive-expressions-ie11 + summary: >- + Gets the total number of + [ExpressionFunctions.standardFunctions](xref:adaptive-expressions.ExpressionFunctions.standardFunctions) + and user + [customFunctions](xref:adaptive-expressions.FunctionTable.customFunctions). + fullName: size + remarks: '' + isDeprecated: false + syntax: + content: 'size: number' + return: + description: An integer value. + type: number + - name: '[iterator]' + uid: adaptive-expressions-ie11.FunctionTable.[iterator] + package: adaptive-expressions-ie11 + summary: |- + Returns an iterable of key, value pairs. + Not implemented. + fullName: '[iterator]' + remarks: '' + isDeprecated: false + syntax: + content: '[iterator]: () => IterableIterator<[string, ExpressionEvaluator]>' + return: + description: '' + type: () => IterableIterator<[string, ExpressionEvaluator]> + - name: '[toStringTag]' + uid: adaptive-expressions-ie11.FunctionTable.[toStringTag] + package: adaptive-expressions-ie11 + summary: |- + Returns a string value. + Not implemented. + fullName: '[toStringTag]' + remarks: '' + isDeprecated: false + syntax: + content: '[toStringTag]: string' + return: + description: '' + type: string +methods: + - name: add(string, customFunction) + uid: adaptive-expressions-ie11.FunctionTable.add_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function add(key: string, value: customFunction)' + parameters: + - id: key + type: string + description: '' + - id: value + type: customFunction + description: '' + - name: add(string, ExpressionEvaluator) + uid: adaptive-expressions-ie11.FunctionTable.add_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function add(key: string, value: ExpressionEvaluator)' + parameters: + - id: key + type: string + description: '' + - id: value + type: + description: '' + - name: 'add({ key: string, value: ExpressionEvaluator })' + uid: adaptive-expressions-ie11.FunctionTable.add + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function add(item: { key: string, value: ExpressionEvaluator })' + parameters: + - id: item + type: '{ key: string, value: ExpressionEvaluator }' + description: '' + - name: clear() + uid: adaptive-expressions-ie11.FunctionTable.clear + package: adaptive-expressions-ie11 + summary: >- + Clears the user + [customFunctions](xref:adaptive-expressions.FunctionTable.customFunctions). + remarks: '' + isDeprecated: false + syntax: + content: function clear() + - name: delete(string) + uid: adaptive-expressions-ie11.FunctionTable.delete + package: adaptive-expressions-ie11 + summary: >- + Deletes a specified key from user + [customFunctions](xref:adaptive-expressions.FunctionTable.customFunctions). + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(key: string): boolean' + parameters: + - id: key + type: string + description: A string key of function name. + return: + description: A boolean value indicating whether the key is successfully deleted. + type: boolean + - name: entries() + uid: adaptive-expressions-ie11.FunctionTable.entries + package: adaptive-expressions-ie11 + summary: |- + Returns an iterable of key, value pairs for every entry in the map. + Not implemented. + remarks: '' + isDeprecated: false + syntax: + content: 'function entries(): IterableIterator<[string, ExpressionEvaluator]>' + return: + description: '' + type: IterableIterator<[string, ExpressionEvaluator]> + - name: >- + forEach((value: ExpressionEvaluator, key: string, map: Map) => void, any) + uid: adaptive-expressions-ie11.FunctionTable.forEach + package: adaptive-expressions-ie11 + summary: >- + Operates on each element of the + [ExpressionFunctions.standardFunctions](xref:adaptive-expressions.ExpressionFunctions.standardFunctions). + + Not implemented. + remarks: '' + isDeprecated: false + syntax: + content: >- + function forEach(_callbackfn: (value: ExpressionEvaluator, key: string, + map: Map) => void, _thisArg?: any) + parameters: + - id: _callbackfn + type: >- + (value: ExpressionEvaluator, key: string, map: Map<string, + ExpressionEvaluator>) => void + description: Callback function. + - id: _thisArg + type: any + description: Optional. This args. + - name: get(string) + uid: adaptive-expressions-ie11.FunctionTable.get + package: adaptive-expressions-ie11 + summary: >- + Gets a value of + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + corresponding to the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function get(key: string): ExpressionEvaluator' + parameters: + - id: key + type: string + description: A string value of function name. + return: + description: >- + An + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator). + type: + - name: has(string) + uid: adaptive-expressions-ie11.FunctionTable.has + package: adaptive-expressions-ie11 + summary: >- + Determines if the [FunctionTable](xref:adaptive-expressions.FunctionTable) + has a given string key. + remarks: '' + isDeprecated: false + syntax: + content: 'function has(key: string): boolean' + parameters: + - id: key + type: string + description: A string key. + return: + description: '`True` if the key is contained, otherwise returns `False`.' + type: boolean + - name: keys() + uid: adaptive-expressions-ie11.FunctionTable.keys + package: adaptive-expressions-ie11 + summary: >- + Gets a collection of string values that represent the keys of the + [ExpressionFunctions.standardFunctions](xref:adaptive-expressions.ExpressionFunctions.standardFunctions). + remarks: '' + isDeprecated: false + syntax: + content: 'function keys(): IterableIterator' + return: + description: A list of string values. + type: IterableIterator<string> + - name: set(string, ExpressionEvaluator) + uid: adaptive-expressions-ie11.FunctionTable.set + package: adaptive-expressions-ie11 + summary: >- + Sets a value of + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) + corresponding to the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function set(key: string, value: ExpressionEvaluator): FunctionTable' + parameters: + - id: key + type: string + description: A string value of function name. + - id: value + type: + description: >- + The value to set for the + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator). + return: + description: >- + The value of the + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator). + type: + - name: values() + uid: adaptive-expressions-ie11.FunctionTable.values + package: adaptive-expressions-ie11 + summary: >- + Gets a collection of + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) which + is the value of the StandardFunctions. + remarks: '' + isDeprecated: false + syntax: + content: 'function values(): IterableIterator' + return: + description: >- + A list of + [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator). + type: >- + IterableIterator<> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionUtils.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionUtils.yml new file mode 100644 index 00000000..d4aa2385 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/FunctionUtils.yml @@ -0,0 +1,819 @@ +### YamlMime:TSType +name: FunctionUtils +uid: adaptive-expressions-ie11.FunctionUtils +package: adaptive-expressions-ie11 +summary: Utility functions in AdaptiveExpression. +fullName: FunctionUtils +remarks: '' +isDeprecated: false +type: class +properties: + - name: DefaultDateTimeFormat + uid: adaptive-expressions-ie11.FunctionUtils.DefaultDateTimeFormat + package: adaptive-expressions-ie11 + summary: The default date time format string. + fullName: DefaultDateTimeFormat + remarks: '' + isDeprecated: false + syntax: + content: 'static DefaultDateTimeFormat: string' + return: + description: '' + type: string +methods: + - name: 'apply((arg0: unknown[]) => unknown, VerifyExpression)' + uid: adaptive-expressions-ie11.FunctionUtils.apply + package: adaptive-expressions-ie11 + summary: >- + Generate an expression delegate that applies function after verifying all + children. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function apply(func: (arg0: unknown[]) => unknown, verify?: + VerifyExpression): EvaluateExpressionDelegate + parameters: + - id: func + type: '(arg0: unknown[]) => unknown' + description: Function to apply. + - id: verify + type: + description: Function to check each arg for validity. + return: + description: Delegate for evaluating an expression. + type: + - name: 'applySequence((arg0: any[]) => any, VerifyExpression)' + uid: adaptive-expressions-ie11.FunctionUtils.applySequence + package: adaptive-expressions-ie11 + summary: >- + Generate an expression delegate that applies function on the accumulated + value after verifying all children. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function applySequence(func: (arg0: any[]) => any, verify?: + VerifyExpression): EvaluateExpressionDelegate + parameters: + - id: func + type: '(arg0: any[]) => any' + description: Function to apply. + - id: verify + type: + description: Function to check each arg for validity. + return: + description: Delegate for evaluating an expression. + type: + - name: 'applySequenceWithError((arg0: any[]) => any, VerifyExpression)' + uid: adaptive-expressions-ie11.FunctionUtils.applySequenceWithError + package: adaptive-expressions-ie11 + summary: >- + Generate an expression delegate that applies function on the accumulated + value after verifying all children. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function applySequenceWithError(func: (arg0: any[]) => any, + verify?: VerifyExpression): EvaluateExpressionDelegate + parameters: + - id: func + type: '(arg0: any[]) => any' + description: Function to apply. + - id: verify + type: + description: Function to check each arg for validity. + return: + description: Delegate for evaluating an expression. + type: + - name: 'applyWithError((arg0: any[]) => ValueWithError, VerifyExpression)' + uid: adaptive-expressions-ie11.FunctionUtils.applyWithError + package: adaptive-expressions-ie11 + summary: >- + Generate an expression delegate that applies function after verifying all + children. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function applyWithError(func: (arg0: any[]) => ValueWithError, + verify?: VerifyExpression): EvaluateExpressionDelegate + parameters: + - id: func + type: '(arg0: any[]) => ValueWithError' + description: Function to apply. + - id: verify + type: + description: Function to check each arg for validity. + return: + description: Delegate for evaluating an expression. + type: + - name: >- + applyWithOptions((arg0: unknown[], options: Options) => unknown, + VerifyExpression) + uid: adaptive-expressions-ie11.FunctionUtils.applyWithOptions + package: adaptive-expressions-ie11 + summary: >- + Generate an expression delegate that applies function after verifying all + children. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function applyWithOptions(func: (arg0: unknown[], options: + Options) => unknown, verify?: VerifyExpression): + EvaluateExpressionDelegate + parameters: + - id: func + type: '(arg0: unknown[], options: Options) => unknown' + description: Function to apply. + - id: verify + type: + description: Function to check each arg for validity. + return: + description: Delegate for evaluating an expression. + type: + - name: >- + applyWithOptionsAndError((arg0: unknown[], options: Options) => { error: + string, value: unknown }, VerifyExpression) + uid: adaptive-expressions-ie11.FunctionUtils.applyWithOptionsAndError + package: adaptive-expressions-ie11 + summary: >- + Generate an expression delegate that applies function after verifying all + children. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function applyWithOptionsAndError(func: (arg0: unknown[], + options: Options) => { error: string, value: unknown }, verify?: + VerifyExpression): EvaluateExpressionDelegate + parameters: + - id: func + type: >- + (arg0: unknown[], options: Options) => { error: string, value: + unknown } + description: Function to apply. + - id: verify + type: + description: Function to check each arg for validity. + return: + description: Delegate for evaluating an expression. + type: + - name: commonEquals(unknown, unknown) + uid: adaptive-expressions-ie11.FunctionUtils.commonEquals + package: adaptive-expressions-ie11 + summary: |- + Equal helper function. + Compare the first param and second param. + remarks: '' + isDeprecated: false + syntax: + content: 'static function commonEquals(obj1: unknown, obj2: unknown): boolean' + parameters: + - id: obj1 + type: unknown + description: The first value to compare. + - id: obj2 + type: unknown + description: The second value to compare. + return: + description: A boolean based on the comparison. + type: boolean + - name: determineFormatAndLocale(unknown[], number, string, string) + uid: adaptive-expressions-ie11.FunctionUtils.determineFormatAndLocale + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function determineFormatAndLocale(args: unknown[], maxArgsLength: + number, format: string, locale?: string): { format: string, locale: + string } + parameters: + - id: args + type: unknown[] + description: An array of arguments. + - id: maxArgsLength + type: number + description: The max length of a given function. + - id: format + type: string + description: A format string. + - id: locale + type: string + description: A locale string. + return: + description: >- + The format and the locale from the args param, otherwise the locale + and format strings. + type: '{ format: string, locale: string }' + - name: determineLocale(unknown[], number, string) + uid: adaptive-expressions-ie11.FunctionUtils.determineLocale + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function determineLocale(args: unknown[], maxArgsLength: number, + locale?: string): string + parameters: + - id: args + type: unknown[] + description: An array of arguments. + - id: maxArgsLength + type: number + description: The max length of a given function. + - id: locale + type: string + description: A locale string + return: + description: The last item from the args param, otherwise the locale string. + type: string + - name: evaluateChildren(Expression, MemoryInterface, Options, VerifyExpression) + uid: adaptive-expressions-ie11.FunctionUtils.evaluateChildren + package: adaptive-expressions-ie11 + summary: Evaluate expression children and return them. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function evaluateChildren(expression: Expression, state: + MemoryInterface, options: Options, verify?: VerifyExpression): { args: + any[], error: string } + parameters: + - id: expression + type: + description: Expression with children. + - id: state + type: + description: Global state. + - id: options + type: + description: Options used in evaluation. + - id: verify + type: + description: Optional function to verify each child's result. + return: + description: List of child values or error message. + type: '{ args: any[], error: string }' + - name: isNumber(any) + uid: adaptive-expressions-ie11.FunctionUtils.isNumber + package: adaptive-expressions-ie11 + summary: Is number helper function. + remarks: '' + isDeprecated: false + syntax: + content: 'static function isNumber(instance: any): instance' + parameters: + - id: instance + type: any + description: Input. + return: + description: True if the input is a number. + type: instance + - name: timestampFormatter(string) + uid: adaptive-expressions-ie11.FunctionUtils.timestampFormatter + package: adaptive-expressions-ie11 + summary: Timestamp formatter, convert C# datetime to day.js format. + remarks: '' + isDeprecated: false + syntax: + content: 'static function timestampFormatter(formatter: string): string' + parameters: + - id: formatter + type: string + description: C# datetime format + return: + description: The formated datetime. + type: string + - name: tryAccumulatePath(Expression, MemoryInterface, Options) + uid: adaptive-expressions-ie11.FunctionUtils.tryAccumulatePath + package: adaptive-expressions-ie11 + summary: State object for resolving memory paths. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function tryAccumulatePath(expression: Expression, state: + MemoryInterface, options: Options): { error: string, left: any, path: + string } + parameters: + - id: expression + type: + description: Expression. + - id: state + type: + description: Scope. + - id: options + type: + description: Options used in evaluation. + return: + description: >- + Return the accumulated path and the expression left unable to + accumulate. + type: '{ error: string, left: any, path: string }' + - name: validateArityAndAnyType(Expression, number, number, ReturnType) + uid: adaptive-expressions-ie11.FunctionUtils.validateArityAndAnyType + package: adaptive-expressions-ie11 + summary: >- + Validate that expression has a certain number of children that are of any + of the supported types. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function validateArityAndAnyType(expression: Expression, + minArity: number, maxArity: number, returnType?: ReturnType) + parameters: + - id: expression + type: + description: Expression to validate. + - id: minArity + type: number + description: Minimum number of children. + - id: maxArity + type: number + description: Maximum number of children. + - id: returnType + type: + description: >- + Allowed return types for children. + + If a child has a return type of Object then validation will happen + at runtime. + - name: validateAtLeastOne(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateAtLeastOne + package: adaptive-expressions-ie11 + summary: Validate at least 1 argument of any type. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateAtLeastOne(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateBinary(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateBinary + package: adaptive-expressions-ie11 + summary: Validate there are two children. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateBinary(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateBinaryNumber(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateBinaryNumber + package: adaptive-expressions-ie11 + summary: Validate 2 numeric arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateBinaryNumber(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateBinaryNumberOrString(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateBinaryNumberOrString + package: adaptive-expressions-ie11 + summary: Validate there are 2 numeric or string arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateBinaryNumberOrString(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateNumber(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateNumber + package: adaptive-expressions-ie11 + summary: Validate 1 or more numeric arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateNumber(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateOrder(Expression, ReturnType[], ReturnType[]) + uid: adaptive-expressions-ie11.FunctionUtils.validateOrder + package: adaptive-expressions-ie11 + summary: Validate the number and type of arguments to a function. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function validateOrder(expression: Expression, optional: + ReturnType[], types: ReturnType[]) + parameters: + - id: expression + type: + description: Expression to validate. + - id: optional + type: [] + description: Optional types in order. + - id: types + type: [] + description: Expected types in order. + - name: validateString(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateString + package: adaptive-expressions-ie11 + summary: Validate 1 or more string arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateString(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateTwoOrMoreThanTwoNumbers(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateTwoOrMoreThanTwoNumbers + package: adaptive-expressions-ie11 + summary: Validate 2 or more than 2 numeric arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateTwoOrMoreThanTwoNumbers(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateUnary(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateUnary + package: adaptive-expressions-ie11 + summary: Validate there is a single argument. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateUnary(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateUnaryBoolean(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateUnaryBoolean + package: adaptive-expressions-ie11 + summary: Validate there is a single boolean argument. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateUnaryBoolean(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateUnaryNumber(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateUnaryNumber + package: adaptive-expressions-ie11 + summary: Validate there is a single argument. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateUnaryNumber(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateUnaryOrBinaryNumber(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateUnaryOrBinaryNumber + package: adaptive-expressions-ie11 + summary: Validate 1 or 2 numeric arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateUnaryOrBinaryNumber(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateUnaryOrBinaryString(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateUnaryOrBinaryString + package: adaptive-expressions-ie11 + summary: Validate there is one or two string arguments. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateUnaryOrBinaryString(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: validateUnaryString(Expression) + uid: adaptive-expressions-ie11.FunctionUtils.validateUnaryString + package: adaptive-expressions-ie11 + summary: Validate there is a single string argument. + remarks: '' + isDeprecated: false + syntax: + content: 'static function validateUnaryString(expression: Expression)' + parameters: + - id: expression + type: + description: Expression to validate. + - name: verifyBoolean(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyBoolean + package: adaptive-expressions-ie11 + summary: Verify value is boolean. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyBoolean(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyContainer(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyContainer + package: adaptive-expressions-ie11 + summary: Verify value contains elements. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyContainer(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyContainerOrNull(unknown, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyContainerOrNull + package: adaptive-expressions-ie11 + summary: Verify value contains elements or null. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyContainerOrNull(value: unknown, expression: + Expression, _: number): undefined | string + parameters: + - id: value + type: unknown + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyInteger(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyInteger + package: adaptive-expressions-ie11 + summary: Verify value is an integer. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyInteger(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyList(any, Expression) + uid: adaptive-expressions-ie11.FunctionUtils.verifyList + package: adaptive-expressions-ie11 + summary: Verify value is an list. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyList(value: any, expression: Expression): + undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyNotNull(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyNotNull + package: adaptive-expressions-ie11 + summary: Verify value is not null or undefined. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyNotNull(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if valid. + type: undefined | string + - name: verifyNumber(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyNumber + package: adaptive-expressions-ie11 + summary: Verify value is numeric. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyNumber(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyNumberOrNumericList(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyNumberOrNumericList + package: adaptive-expressions-ie11 + summary: Verify value is numeric. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyNumberOrNumericList(value: any, expression: + Expression, _: number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyNumberOrString(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyNumberOrString + package: adaptive-expressions-ie11 + summary: Verify value is a number or string. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyNumberOrString(value: any, expression: Expression, + _: number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyNumberOrStringOrNull(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyNumberOrStringOrNull + package: adaptive-expressions-ie11 + summary: Verify value is a number or string or null. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyNumberOrStringOrNull(value: any, expression: + Expression, _: number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyNumericList(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyNumericList + package: adaptive-expressions-ie11 + summary: Verify value is numeric list. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyNumericList(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyString(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyString + package: adaptive-expressions-ie11 + summary: Verify value is a string. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyString(value: any, expression: Expression, _: + number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string + - name: verifyStringOrNull(any, Expression, number) + uid: adaptive-expressions-ie11.FunctionUtils.verifyStringOrNull + package: adaptive-expressions-ie11 + summary: Verify an object is neither a string nor null. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function verifyStringOrNull(value: any, expression: Expression, + _: number): undefined | string + parameters: + - id: value + type: any + description: Value to check. + - id: expression + type: + description: Expression that led to value. + - id: _ + type: number + description: No function. + return: + description: Error or undefined if invalid. + type: undefined | string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IdAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IdAtomContext.yml new file mode 100644 index 00000000..862a9189 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IdAtomContext.yml @@ -0,0 +1,906 @@ +### YamlMime:TSType +name: IdAtomContext +uid: adaptive-expressions-ie11.IdAtomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: IdAtomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: IdAtomContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.IdAtomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new IdAtomContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.IdAtomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.IdAtomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.IdAtomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.IdAtomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.IdAtomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.IdAtomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.IdAtomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.IdAtomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.IdAtomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: IdAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.IdAtomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.IdAtomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.IdAtomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.IdAtomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.IdAtomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.IdAtomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.IdAtomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.IdAtomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.IdAtomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.IdAtomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.IdAtomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.IdAtomContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.IdAtomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.IdAtomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.IdAtomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IdAtomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.IdAtomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IdAtomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.IdAtomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.IdAtomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.IdAtomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.IdAtomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.IdAtomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.IdAtomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.IdAtomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.IdAtomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.IdAtomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.IdAtomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.IdAtomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.IdAtomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.IdAtomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.IdAtomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IdAtomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IdAtomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.IdAtomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.IdAtomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.IdAtomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.IdAtomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: IDENTIFIER() + uid: adaptive-expressions-ie11.IdAtomContext.IDENTIFIER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function IDENTIFIER(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IndexAccessExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IndexAccessExpContext.yml new file mode 100644 index 00000000..7027b88b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IndexAccessExpContext.yml @@ -0,0 +1,939 @@ +### YamlMime:TSType +name: IndexAccessExpContext +uid: adaptive-expressions-ie11.IndexAccessExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: IndexAccessExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: IndexAccessExpContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.IndexAccessExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new IndexAccessExpContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.IndexAccessExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.IndexAccessExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.IndexAccessExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.IndexAccessExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.IndexAccessExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.IndexAccessExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.IndexAccessExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.IndexAccessExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.IndexAccessExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: IndexAccessExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.IndexAccessExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.IndexAccessExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.IndexAccessExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.IndexAccessExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.IndexAccessExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.IndexAccessExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.IndexAccessExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.IndexAccessExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.IndexAccessExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.IndexAccessExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.IndexAccessExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.IndexAccessExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.IndexAccessExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.IndexAccessExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.IndexAccessExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IndexAccessExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.IndexAccessExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IndexAccessExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.IndexAccessExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.IndexAccessExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.IndexAccessExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.IndexAccessExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.IndexAccessExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.IndexAccessExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.IndexAccessExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.IndexAccessExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IndexAccessExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.IndexAccessExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.IndexAccessExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.IndexAccessExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CLOSE_SQUARE_BRACKET() + uid: adaptive-expressions-ie11.IndexAccessExpContext.CLOSE_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CLOSE_SQUARE_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.IndexAccessExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.IndexAccessExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.IndexAccessExpContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: + - name: OPEN_SQUARE_BRACKET() + uid: adaptive-expressions-ie11.IndexAccessExpContext.OPEN_SQUARE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OPEN_SQUARE_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: primaryExpression() + uid: adaptive-expressions-ie11.IndexAccessExpContext.primaryExpression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function primaryExpression(): PrimaryExpressionContext' + return: + description: '' + type: +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpression.yml new file mode 100644 index 00000000..c324d357 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpression.yml @@ -0,0 +1,141 @@ +### YamlMime:TSType +name: IntExpression +uid: adaptive-expressions-ie11.IntExpression +package: adaptive-expressions-ie11 +summary: >- + Represents a property which is either a int or a string expression which + resolves to a int. +fullName: IntExpression +remarks: >- + String values are always interpreted as an expression, whether it has '=' + prefix or not. +isDeprecated: false +type: class +constructors: + - name: IntExpression(string | number | Expression) + uid: adaptive-expressions-ie11.IntExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [IntExpression](xref:adaptive-expressions.IntExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new IntExpression(value?: string | number | Expression)' + parameters: + - id: value + type: >- + string | number | + description: >- + An int `number` or `string` expression which resolves to an int + `number`. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.IntExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.IntExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.IntExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): number' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: number + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.IntExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.IntExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) +methods: + - name: setValue(string | number | Expression) + uid: adaptive-expressions-ie11.IntExpression.setValue + package: adaptive-expressions-ie11 + summary: Set an integer value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | number | Expression)' + parameters: + - id: value + type: >- + string | number | + description: Value to set. + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.IntExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: number }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: Value of int number + type: '{ error: Error, value: number }' +extends: <number> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpressionConverter.yml new file mode 100644 index 00000000..a9b3ab71 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/IntExpressionConverter.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: IntExpressionConverter +uid: adaptive-expressions-ie11.IntExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `string` or `number` to json + [IntExpression](xref:adaptive-expressions.IntExpression) converter. +fullName: IntExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(Input | IntExpression) + uid: adaptive-expressions-ie11.IntExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts a `string` or `number` into an + [IntExpression](xref:adaptive-expressions.IntExpression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: Input | IntExpression): IntExpression' + parameters: + - id: value + type: Input | + description: '`string` or `number` to convert.' + return: + description: The [IntExpression](xref:adaptive-expressions.IntExpression). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/JsonCreationExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/JsonCreationExpContext.yml new file mode 100644 index 00000000..b3aff899 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/JsonCreationExpContext.yml @@ -0,0 +1,930 @@ +### YamlMime:TSType +name: JsonCreationExpContext +uid: adaptive-expressions-ie11.JsonCreationExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: JsonCreationExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: JsonCreationExpContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.JsonCreationExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new JsonCreationExpContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.JsonCreationExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.JsonCreationExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.JsonCreationExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.JsonCreationExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.JsonCreationExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.JsonCreationExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.JsonCreationExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.JsonCreationExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.JsonCreationExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: JsonCreationExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.JsonCreationExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.JsonCreationExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.JsonCreationExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.JsonCreationExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.JsonCreationExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.JsonCreationExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.JsonCreationExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.JsonCreationExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.JsonCreationExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.JsonCreationExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.JsonCreationExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.JsonCreationExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.JsonCreationExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.JsonCreationExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.JsonCreationExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.JsonCreationExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.JsonCreationExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.JsonCreationExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.JsonCreationExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.JsonCreationExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.JsonCreationExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.JsonCreationExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.JsonCreationExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.JsonCreationExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.JsonCreationExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.JsonCreationExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.JsonCreationExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.JsonCreationExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.JsonCreationExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.JsonCreationExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CLOSE_CURLY_BRACKET() + uid: adaptive-expressions-ie11.JsonCreationExpContext.CLOSE_CURLY_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CLOSE_CURLY_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.JsonCreationExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.JsonCreationExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: keyValuePairList() + uid: adaptive-expressions-ie11.JsonCreationExpContext.keyValuePairList + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function keyValuePairList(): undefined | KeyValuePairListContext' + return: + description: '' + type: >- + undefined | + - name: OPEN_CURLY_BRACKET() + uid: adaptive-expressions-ie11.JsonCreationExpContext.OPEN_CURLY_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OPEN_CURLY_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyContext.yml new file mode 100644 index 00000000..d49aad75 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyContext.yml @@ -0,0 +1,845 @@ +### YamlMime:TSType +name: KeyContext +uid: adaptive-expressions-ie11.KeyContext +package: adaptive-expressions-ie11 +summary: '' +fullName: KeyContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: KeyContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.KeyContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new KeyContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.KeyContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.KeyContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.KeyContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.KeyContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.KeyContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.KeyContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.KeyContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.KeyContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.KeyContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.KeyContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: KeyContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.KeyContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.KeyContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.KeyContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.KeyContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.KeyContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.KeyContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.KeyContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.KeyContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.KeyContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.KeyContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.KeyContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.KeyContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.KeyContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.KeyContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.KeyContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.KeyContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.KeyContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.KeyContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.KeyContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.KeyContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.KeyContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.KeyContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.KeyContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.KeyContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.KeyContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.KeyContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.KeyContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.KeyContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.KeyContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.KeyContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.KeyContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.KeyContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: IDENTIFIER() + uid: adaptive-expressions-ie11.KeyContext.IDENTIFIER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function IDENTIFIER(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: STRING() + uid: adaptive-expressions-ie11.KeyContext.STRING + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function STRING(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairContext.yml new file mode 100644 index 00000000..3ec30615 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairContext.yml @@ -0,0 +1,856 @@ +### YamlMime:TSType +name: KeyValuePairContext +uid: adaptive-expressions-ie11.KeyValuePairContext +package: adaptive-expressions-ie11 +summary: '' +fullName: KeyValuePairContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: KeyValuePairContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.KeyValuePairContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new KeyValuePairContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.KeyValuePairContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.KeyValuePairContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.KeyValuePairContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.KeyValuePairContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.KeyValuePairContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.KeyValuePairContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.KeyValuePairContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.KeyValuePairContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.KeyValuePairContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.KeyValuePairContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: KeyValuePairContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.KeyValuePairContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.KeyValuePairContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.KeyValuePairContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.KeyValuePairContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.KeyValuePairContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.KeyValuePairContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.KeyValuePairContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.KeyValuePairContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.KeyValuePairContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.KeyValuePairContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.KeyValuePairContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.KeyValuePairContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.KeyValuePairContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.KeyValuePairContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.KeyValuePairContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.KeyValuePairContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.KeyValuePairContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.KeyValuePairContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.KeyValuePairContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.KeyValuePairContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.KeyValuePairContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.KeyValuePairContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.KeyValuePairContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.KeyValuePairContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.KeyValuePairContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.KeyValuePairContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: COLON() + uid: adaptive-expressions-ie11.KeyValuePairContext.COLON + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function COLON(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.KeyValuePairContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.KeyValuePairContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.KeyValuePairContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: + - name: key() + uid: adaptive-expressions-ie11.KeyValuePairContext.key + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function key(): KeyContext' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairListContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairListContext.yml new file mode 100644 index 00000000..5872ec3c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/KeyValuePairListContext.yml @@ -0,0 +1,875 @@ +### YamlMime:TSType +name: KeyValuePairListContext +uid: adaptive-expressions-ie11.KeyValuePairListContext +package: adaptive-expressions-ie11 +summary: '' +fullName: KeyValuePairListContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: KeyValuePairListContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new KeyValuePairListContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.KeyValuePairListContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.KeyValuePairListContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.KeyValuePairListContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.KeyValuePairListContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.KeyValuePairListContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.KeyValuePairListContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.KeyValuePairListContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.KeyValuePairListContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.KeyValuePairListContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.KeyValuePairListContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: KeyValuePairListContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.KeyValuePairListContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.KeyValuePairListContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.KeyValuePairListContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.KeyValuePairListContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.KeyValuePairListContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairListContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.KeyValuePairListContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.KeyValuePairListContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.KeyValuePairListContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.KeyValuePairListContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.KeyValuePairListContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.KeyValuePairListContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.KeyValuePairListContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairListContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairListContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairListContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.KeyValuePairListContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairListContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.KeyValuePairListContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.KeyValuePairListContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.KeyValuePairListContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairListContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.KeyValuePairListContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.KeyValuePairListContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: COMMA() + uid: adaptive-expressions-ie11.KeyValuePairListContext.COMMA + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function COMMA(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: COMMA(number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.COMMA_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function COMMA(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.KeyValuePairListContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.KeyValuePairListContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: keyValuePair() + uid: adaptive-expressions-ie11.KeyValuePairListContext.keyValuePair + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function keyValuePair(): KeyValuePairContext[]' + return: + description: '' + type: [] + - name: keyValuePair(number) + uid: adaptive-expressions-ie11.KeyValuePairListContext.keyValuePair_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function keyValuePair(i: number): KeyValuePairContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LambdaContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LambdaContext.yml new file mode 100644 index 00000000..277eab9c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LambdaContext.yml @@ -0,0 +1,856 @@ +### YamlMime:TSType +name: LambdaContext +uid: adaptive-expressions-ie11.LambdaContext +package: adaptive-expressions-ie11 +summary: '' +fullName: LambdaContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: LambdaContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.LambdaContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new LambdaContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.LambdaContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.LambdaContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.LambdaContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.LambdaContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.LambdaContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.LambdaContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.LambdaContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.LambdaContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.LambdaContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.LambdaContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: LambdaContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.LambdaContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.LambdaContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.LambdaContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.LambdaContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.LambdaContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.LambdaContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.LambdaContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.LambdaContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.LambdaContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.LambdaContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.LambdaContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.LambdaContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.LambdaContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.LambdaContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LambdaContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.LambdaContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LambdaContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.LambdaContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.LambdaContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.LambdaContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.LambdaContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.LambdaContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.LambdaContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.LambdaContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.LambdaContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.LambdaContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.LambdaContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.LambdaContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.LambdaContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.LambdaContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.LambdaContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LambdaContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LambdaContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.LambdaContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.LambdaContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: ARROW() + uid: adaptive-expressions-ie11.LambdaContext.ARROW + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ARROW(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.LambdaContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.LambdaContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.LambdaContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: + - name: IDENTIFIER() + uid: adaptive-expressions-ie11.LambdaContext.IDENTIFIER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function IDENTIFIER(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LetterContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LetterContext.yml new file mode 100644 index 00000000..adea3225 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LetterContext.yml @@ -0,0 +1,1389 @@ +### YamlMime:TSType +name: LetterContext +uid: adaptive-expressions-ie11.LetterContext +package: adaptive-expressions-ie11 +summary: '' +fullName: LetterContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: LetterContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.LetterContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new LetterContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.LetterContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.LetterContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.LetterContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.LetterContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.LetterContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.LetterContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.LetterContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.LetterContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.LetterContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.LetterContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: LetterContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.LetterContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.LetterContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.LetterContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.LetterContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.LetterContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.LetterContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.LetterContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.LetterContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.LetterContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.LetterContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.LetterContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.LetterContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.LetterContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.LetterContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LetterContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.LetterContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LetterContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.LetterContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.LetterContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.LetterContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.LetterContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.LetterContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.LetterContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.LetterContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.LetterContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.LetterContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.LetterContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.LetterContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.LetterContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.LetterContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.LetterContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LetterContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LetterContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.LetterContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.LetterContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: ALC() + uid: adaptive-expressions-ie11.LetterContext.ALC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ALC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: AUC() + uid: adaptive-expressions-ie11.LetterContext.AUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function AUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: BLC() + uid: adaptive-expressions-ie11.LetterContext.BLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function BLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: BUC() + uid: adaptive-expressions-ie11.LetterContext.BUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function BUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CLC() + uid: adaptive-expressions-ie11.LetterContext.CLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CUC() + uid: adaptive-expressions-ie11.LetterContext.CUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: DLC() + uid: adaptive-expressions-ie11.LetterContext.DLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: DUC() + uid: adaptive-expressions-ie11.LetterContext.DUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: ELC() + uid: adaptive-expressions-ie11.LetterContext.ELC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ELC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.LetterContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: EUC() + uid: adaptive-expressions-ie11.LetterContext.EUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function EUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.LetterContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: FLC() + uid: adaptive-expressions-ie11.LetterContext.FLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function FLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: FUC() + uid: adaptive-expressions-ie11.LetterContext.FUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function FUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: GLC() + uid: adaptive-expressions-ie11.LetterContext.GLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function GLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: GUC() + uid: adaptive-expressions-ie11.LetterContext.GUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function GUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: HLC() + uid: adaptive-expressions-ie11.LetterContext.HLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function HLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: HUC() + uid: adaptive-expressions-ie11.LetterContext.HUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function HUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: ILC() + uid: adaptive-expressions-ie11.LetterContext.ILC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ILC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: IUC() + uid: adaptive-expressions-ie11.LetterContext.IUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function IUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: JLC() + uid: adaptive-expressions-ie11.LetterContext.JLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function JLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: JUC() + uid: adaptive-expressions-ie11.LetterContext.JUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function JUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: KLC() + uid: adaptive-expressions-ie11.LetterContext.KLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function KLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: KUC() + uid: adaptive-expressions-ie11.LetterContext.KUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function KUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: LLC() + uid: adaptive-expressions-ie11.LetterContext.LLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function LLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: LUC() + uid: adaptive-expressions-ie11.LetterContext.LUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function LUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: MLC() + uid: adaptive-expressions-ie11.LetterContext.MLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function MLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: MUC() + uid: adaptive-expressions-ie11.LetterContext.MUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function MUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: NLC() + uid: adaptive-expressions-ie11.LetterContext.NLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: NUC() + uid: adaptive-expressions-ie11.LetterContext.NUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: OLC() + uid: adaptive-expressions-ie11.LetterContext.OLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: OUC() + uid: adaptive-expressions-ie11.LetterContext.OUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: PLC() + uid: adaptive-expressions-ie11.LetterContext.PLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function PLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: PUC() + uid: adaptive-expressions-ie11.LetterContext.PUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function PUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: QLC() + uid: adaptive-expressions-ie11.LetterContext.QLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: QUC() + uid: adaptive-expressions-ie11.LetterContext.QUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: RLC() + uid: adaptive-expressions-ie11.LetterContext.RLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function RLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: RUC() + uid: adaptive-expressions-ie11.LetterContext.RUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function RUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SLC() + uid: adaptive-expressions-ie11.LetterContext.SLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SUC() + uid: adaptive-expressions-ie11.LetterContext.SUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: TLC() + uid: adaptive-expressions-ie11.LetterContext.TLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function TLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: TUC() + uid: adaptive-expressions-ie11.LetterContext.TUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function TUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: ULC() + uid: adaptive-expressions-ie11.LetterContext.ULC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ULC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: UUC() + uid: adaptive-expressions-ie11.LetterContext.UUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function UUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: VLC() + uid: adaptive-expressions-ie11.LetterContext.VLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function VLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: VUC() + uid: adaptive-expressions-ie11.LetterContext.VUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function VUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: WLC() + uid: adaptive-expressions-ie11.LetterContext.WLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function WLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: WUC() + uid: adaptive-expressions-ie11.LetterContext.WUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function WUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: XLC() + uid: adaptive-expressions-ie11.LetterContext.XLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function XLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: XUC() + uid: adaptive-expressions-ie11.LetterContext.XUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function XUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: YLC() + uid: adaptive-expressions-ie11.LetterContext.YLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function YLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: YUC() + uid: adaptive-expressions-ie11.LetterContext.YUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function YUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: ZLC() + uid: adaptive-expressions-ie11.LetterContext.ZLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ZLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: ZUC() + uid: adaptive-expressions-ie11.LetterContext.ZUC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ZUC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LiteralContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LiteralContext.yml new file mode 100644 index 00000000..435263b0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/LiteralContext.yml @@ -0,0 +1,841 @@ +### YamlMime:TSType +name: LiteralContext +uid: adaptive-expressions-ie11.LiteralContext +package: adaptive-expressions-ie11 +summary: '' +fullName: LiteralContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: LiteralContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.LiteralContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new LiteralContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.LiteralContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.LiteralContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.LiteralContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.LiteralContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.LiteralContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.LiteralContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.LiteralContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.LiteralContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.LiteralContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.LiteralContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: LiteralContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.LiteralContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.LiteralContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.LiteralContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.LiteralContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.LiteralContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.LiteralContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.LiteralContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.LiteralContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.LiteralContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.LiteralContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.LiteralContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.LiteralContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.LiteralContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.LiteralContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LiteralContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.LiteralContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LiteralContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.LiteralContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.LiteralContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.LiteralContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.LiteralContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.LiteralContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.LiteralContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.LiteralContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.LiteralContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.LiteralContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.LiteralContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.LiteralContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.LiteralContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.LiteralContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.LiteralContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LiteralContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.LiteralContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.LiteralContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.LiteralContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CharacterClassEnd() + uid: adaptive-expressions-ie11.LiteralContext.CharacterClassEnd + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CharacterClassEnd(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.LiteralContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.LiteralContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: shared_literal() + uid: adaptive-expressions-ie11.LiteralContext.shared_literal + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function shared_literal(): undefined | Shared_literalContext' + return: + description: '' + type: >- + undefined | +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemberAccessExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemberAccessExpContext.yml new file mode 100644 index 00000000..21476574 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemberAccessExpContext.yml @@ -0,0 +1,928 @@ +### YamlMime:TSType +name: MemberAccessExpContext +uid: adaptive-expressions-ie11.MemberAccessExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: MemberAccessExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MemberAccessExpContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.MemberAccessExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new MemberAccessExpContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.MemberAccessExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.MemberAccessExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.MemberAccessExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.MemberAccessExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.MemberAccessExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.MemberAccessExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.MemberAccessExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.MemberAccessExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.MemberAccessExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: MemberAccessExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.MemberAccessExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.MemberAccessExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.MemberAccessExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.MemberAccessExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.MemberAccessExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.MemberAccessExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.MemberAccessExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.MemberAccessExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.MemberAccessExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.MemberAccessExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.MemberAccessExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.MemberAccessExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.MemberAccessExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.MemberAccessExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.MemberAccessExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.MemberAccessExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.MemberAccessExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.MemberAccessExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.MemberAccessExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.MemberAccessExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.MemberAccessExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.MemberAccessExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.MemberAccessExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.MemberAccessExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.MemberAccessExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.MemberAccessExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.MemberAccessExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.MemberAccessExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.MemberAccessExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.MemberAccessExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: DOT() + uid: adaptive-expressions-ie11.MemberAccessExpContext.DOT + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DOT(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.MemberAccessExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.MemberAccessExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: IDENTIFIER() + uid: adaptive-expressions-ie11.MemberAccessExpContext.IDENTIFIER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function IDENTIFIER(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: primaryExpression() + uid: adaptive-expressions-ie11.MemberAccessExpContext.primaryExpression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function primaryExpression(): PrimaryExpressionContext' + return: + description: '' + type: +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemoryInterface.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemoryInterface.yml new file mode 100644 index 00000000..0d830915 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MemoryInterface.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: MemoryInterface +uid: adaptive-expressions-ie11.MemoryInterface +package: adaptive-expressions-ie11 +summary: Interface to parse a string into an Expression +fullName: MemoryInterface +remarks: '' +isDeprecated: false +type: interface +methods: + - name: getValue(string) + uid: adaptive-expressions-ie11.MemoryInterface.getValue + package: adaptive-expressions-ie11 + summary: >- + get value from a given path, it can be a simple indenfiter like "a", or + + a combined path like "a.b", "a.b[2]", "a.b[2].c", inside [] is guranteed + to be a int number or a string. + remarks: '' + isDeprecated: false + syntax: + content: 'function getValue(path: string): any' + parameters: + - id: path + type: string + description: memory path. + return: + description: value. + type: any + - name: setValue(string, any) + uid: adaptive-expressions-ie11.MemoryInterface.setValue + package: adaptive-expressions-ie11 + summary: Set value to a given path. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(path: string, value: any)' + parameters: + - id: path + type: string + description: memory path. + - id: value + type: any + description: value to set. + - name: version() + uid: adaptive-expressions-ie11.MemoryInterface.version + package: adaptive-expressions-ie11 + summary: >- + Version is used to identify whether the a particular memory instance has + been updated or not. + + If version is not changed, the caller may choose to use the cached result + instead of recomputing everything. + remarks: '' + isDeprecated: false + syntax: + content: 'function version(): string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MultivariateNumericEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MultivariateNumericEvaluator.yml new file mode 100644 index 00000000..f58a8ddb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/MultivariateNumericEvaluator.yml @@ -0,0 +1,121 @@ +### YamlMime:TSType +name: MultivariateNumericEvaluator +uid: adaptive-expressions-ie11.MultivariateNumericEvaluator +package: adaptive-expressions-ie11 +summary: Numeric operators that can have 2 or more args. +fullName: MultivariateNumericEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + MultivariateNumericEvaluator(string, (args: any[]) => number, + VerifyExpression) + uid: adaptive-expressions-ie11.MultivariateNumericEvaluator.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [MultivariateNumericEvaluator](xref:adaptive-expressions.MultivariateNumericEvaluator) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MultivariateNumericEvaluator(type: string, func: (args: any[]) => + number, verify?: VerifyExpression) + parameters: + - id: type + type: string + description: Name of the built-in function. + - id: func + type: '(args: any[]) => number' + description: >- + The evaluation function, it takes a list of objects and returns a + number. + - id: verify + type: + description: >- + Optional. + [VerifyExpression](xref:adaptive-expressions.VerifyExpression) + function to verify each child's result. +inheritedProperties: + - name: negation + uid: adaptive-expressions-ie11.MultivariateNumericEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions-ie11.ExpressionEvaluator.negation) + - name: returnType + uid: adaptive-expressions-ie11.MultivariateNumericEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.returnType](xref:adaptive-expressions-ie11.ExpressionEvaluator.returnType) + - name: tryEvaluate + uid: adaptive-expressions-ie11.MultivariateNumericEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions-ie11.MultivariateNumericEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.type](xref:adaptive-expressions-ie11.ExpressionEvaluator.type) + - name: validateExpression + uid: adaptive-expressions-ie11.MultivariateNumericEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.validateExpression](xref:adaptive-expressions-ie11.ExpressionEvaluator.validateExpression) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NameContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NameContext.yml new file mode 100644 index 00000000..0bc6c741 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NameContext.yml @@ -0,0 +1,828 @@ +### YamlMime:TSType +name: NameContext +uid: adaptive-expressions-ie11.NameContext +package: adaptive-expressions-ie11 +summary: '' +fullName: NameContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: NameContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.NameContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new NameContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.NameContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.NameContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.NameContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.NameContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.NameContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.NameContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.NameContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.NameContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.NameContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.NameContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: NameContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.NameContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.NameContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.NameContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.NameContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.NameContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.NameContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.NameContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.NameContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.NameContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.NameContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.NameContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.NameContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.NameContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.NameContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NameContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.NameContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NameContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.NameContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.NameContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.NameContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.NameContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.NameContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.NameContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.NameContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.NameContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.NameContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.NameContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.NameContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.NameContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.NameContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.NameContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NameContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NameContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.NameContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.NameContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: alpha_nums() + uid: adaptive-expressions-ie11.NameContext.alpha_nums + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function alpha_nums(): Alpha_numsContext' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.NameContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.NameContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Node.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Node.yml new file mode 100644 index 00000000..f550f620 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Node.yml @@ -0,0 +1,172 @@ +### YamlMime:TSType +name: Node +uid: adaptive-expressions-ie11.Node +package: adaptive-expressions-ie11 +summary: Node in a trigger tree. +fullName: Node +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Node(Clause, TriggerTree, Trigger) + uid: adaptive-expressions-ie11.Node.constructor + package: adaptive-expressions-ie11 + summary: Intializes a new instance of the `Node` class. + remarks: '' + isDeprecated: false + syntax: + content: 'new Node(clause: Clause, tree: TriggerTree, trigger?: Trigger)' + parameters: + - id: clause + type: + description: The logical conjunction this node represents. + - id: tree + type: + description: The trigger tree this node is found in. + - id: trigger + type: + description: The trigger to initialize this node. +properties: + - name: allTriggers + uid: adaptive-expressions-ie11.Node.allTriggers + package: adaptive-expressions-ie11 + summary: Gets all triggers that contain the `Clause` in this node. + fullName: allTriggers + remarks: '' + isDeprecated: false + syntax: + content: 'allTriggers: Trigger[]' + return: + description: All triggers that contain the `Clause` in this node. + type: [] + - name: clause + uid: adaptive-expressions-ie11.Node.clause + package: adaptive-expressions-ie11 + summary: Gets the logical conjunction this node represents. + fullName: clause + remarks: '' + isDeprecated: false + syntax: + content: 'clause: Clause' + return: + description: '' + type: + - name: specializations + uid: adaptive-expressions-ie11.Node.specializations + package: adaptive-expressions-ie11 + summary: Gets specialized children of this node. + fullName: specializations + remarks: '' + isDeprecated: false + syntax: + content: 'specializations: Node[]' + return: + description: Specialized children of this node. + type: [] + - name: tree + uid: adaptive-expressions-ie11.Node.tree + package: adaptive-expressions-ie11 + summary: Gets the tree this node is found in. + fullName: tree + remarks: '' + isDeprecated: false + syntax: + content: 'tree: TriggerTree' + return: + description: '' + type: + - name: triggers + uid: adaptive-expressions-ie11.Node.triggers + package: adaptive-expressions-ie11 + summary: >- + Gets all of the most specific triggers that contains the `Clause` in this + node. + fullName: triggers + remarks: '' + isDeprecated: false + syntax: + content: 'triggers: Trigger[]' + return: + description: >- + All of the most specific triggers that contains the `Clause` in this + node. + type: [] +methods: + - name: addNode(Node) + uid: adaptive-expressions-ie11.Node.addNode + package: adaptive-expressions-ie11 + summary: Adds a child node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addNode(triggerNode: Node): boolean' + parameters: + - id: triggerNode + type: + description: The node to be added. + return: + description: Whether adding node operation is successful. + type: boolean + - name: matches(any) + uid: adaptive-expressions-ie11.Node.matches + package: adaptive-expressions-ie11 + summary: Gets the most specific matches below this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function matches(state: any): Trigger[]' + parameters: + - id: state + type: any + description: Frame to evaluate against. + return: + description: List of the most specific matches found. + type: [] + - name: relationship(Node) + uid: adaptive-expressions-ie11.Node.relationship + package: adaptive-expressions-ie11 + summary: Identify the relationship between two nodes. + remarks: '' + isDeprecated: false + syntax: + content: 'function relationship(other: Node): RelationshipType' + parameters: + - id: other + type: + description: Node to compare against. + return: + description: Relationship between this node an the other. + type: + - name: removeTrigger(Trigger) + uid: adaptive-expressions-ie11.Node.removeTrigger + package: adaptive-expressions-ie11 + summary: Removes a trigger from node. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeTrigger(trigger: Trigger): boolean' + parameters: + - id: trigger + type: + description: The trigger to be removed. + return: + description: Whether removing trigger operation is successful. + type: boolean + - name: toString(string[], number) + uid: adaptive-expressions-ie11.Node.toString + package: adaptive-expressions-ie11 + summary: Gets a string that represents the current node. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(builder?: string[], indent?: number): string' + parameters: + - id: builder + type: string[] + description: An array of string to build the string of node. + - id: indent + type: number + description: An integer representing the number of spaces at the start of a line. + return: + description: A string that represents the current node. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_captureContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_captureContext.yml new file mode 100644 index 00000000..7452d941 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_captureContext.yml @@ -0,0 +1,872 @@ +### YamlMime:TSType +name: Non_captureContext +uid: adaptive-expressions-ie11.Non_captureContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Non_captureContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Non_captureContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Non_captureContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Non_captureContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Non_captureContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Non_captureContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Non_captureContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Non_captureContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Non_captureContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Non_captureContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Non_captureContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Non_captureContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Non_captureContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Non_captureContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Non_captureContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Non_captureContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Non_captureContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Non_captureContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Non_captureContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Non_captureContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Non_captureContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Non_captureContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Non_captureContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Non_captureContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Non_captureContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Non_captureContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Non_captureContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Non_captureContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Non_captureContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_captureContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Non_captureContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_captureContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_captureContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Non_captureContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Non_captureContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Non_captureContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Non_captureContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Non_captureContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Non_captureContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Non_captureContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Non_captureContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Non_captureContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Non_captureContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Non_captureContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Non_captureContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Non_captureContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_captureContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_captureContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Non_captureContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Non_captureContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: alternation() + uid: adaptive-expressions-ie11.Non_captureContext.alternation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function alternation(): AlternationContext' + return: + description: '' + type: + - name: CloseParen() + uid: adaptive-expressions-ie11.Non_captureContext.CloseParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: Colon() + uid: adaptive-expressions-ie11.Non_captureContext.Colon + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Colon(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Non_captureContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Non_captureContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: OpenParen() + uid: adaptive-expressions-ie11.Non_captureContext.OpenParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OpenParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: QuestionMark() + uid: adaptive-expressions-ie11.Non_captureContext.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QuestionMark(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parenContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parenContext.yml new file mode 100644 index 00000000..907fae43 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parenContext.yml @@ -0,0 +1,828 @@ +### YamlMime:TSType +name: Non_close_parenContext +uid: adaptive-expressions-ie11.Non_close_parenContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Non_close_parenContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Non_close_parenContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Non_close_parenContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Non_close_parenContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Non_close_parenContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Non_close_parenContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Non_close_parenContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Non_close_parenContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Non_close_parenContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Non_close_parenContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Non_close_parenContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Non_close_parenContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Non_close_parenContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Non_close_parenContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Non_close_parenContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Non_close_parenContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Non_close_parenContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Non_close_parenContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Non_close_parenContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Non_close_parenContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Non_close_parenContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Non_close_parenContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Non_close_parenContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Non_close_parenContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Non_close_parenContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Non_close_parenContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Non_close_parenContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Non_close_parenContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Non_close_parenContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parenContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Non_close_parenContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parenContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parenContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Non_close_parenContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Non_close_parenContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Non_close_parenContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Non_close_parenContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Non_close_parenContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Non_close_parenContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Non_close_parenContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Non_close_parenContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Non_close_parenContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Non_close_parenContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Non_close_parenContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Non_close_parenContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Non_close_parenContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parenContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parenContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Non_close_parenContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Non_close_parenContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CloseParen() + uid: adaptive-expressions-ie11.Non_close_parenContext.CloseParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Non_close_parenContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Non_close_parenContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parensContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parensContext.yml new file mode 100644 index 00000000..22d9091b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Non_close_parensContext.yml @@ -0,0 +1,843 @@ +### YamlMime:TSType +name: Non_close_parensContext +uid: adaptive-expressions-ie11.Non_close_parensContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Non_close_parensContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Non_close_parensContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Non_close_parensContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Non_close_parensContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Non_close_parensContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Non_close_parensContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Non_close_parensContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Non_close_parensContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Non_close_parensContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Non_close_parensContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Non_close_parensContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Non_close_parensContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Non_close_parensContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Non_close_parensContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Non_close_parensContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Non_close_parensContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Non_close_parensContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Non_close_parensContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Non_close_parensContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Non_close_parensContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Non_close_parensContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Non_close_parensContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Non_close_parensContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Non_close_parensContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Non_close_parensContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Non_close_parensContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Non_close_parensContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Non_close_parensContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Non_close_parensContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parensContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Non_close_parensContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parensContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parensContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Non_close_parensContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Non_close_parensContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Non_close_parensContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Non_close_parensContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Non_close_parensContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Non_close_parensContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Non_close_parensContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Non_close_parensContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Non_close_parensContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Non_close_parensContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Non_close_parensContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Non_close_parensContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Non_close_parensContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parensContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Non_close_parensContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Non_close_parensContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Non_close_parensContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Non_close_parensContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Non_close_parensContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: non_close_paren() + uid: adaptive-expressions-ie11.Non_close_parensContext.non_close_paren + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function non_close_paren(): Non_close_parenContext[]' + return: + description: '' + type: [] + - name: non_close_paren(number) + uid: adaptive-expressions-ie11.Non_close_parensContext.non_close_paren_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function non_close_paren(i: number): Non_close_parenContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberContext.yml new file mode 100644 index 00000000..732816dc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberContext.yml @@ -0,0 +1,828 @@ +### YamlMime:TSType +name: NumberContext +uid: adaptive-expressions-ie11.NumberContext +package: adaptive-expressions-ie11 +summary: '' +fullName: NumberContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: NumberContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.NumberContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new NumberContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.NumberContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.NumberContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.NumberContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.NumberContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.NumberContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.NumberContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.NumberContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.NumberContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.NumberContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.NumberContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: NumberContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.NumberContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.NumberContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.NumberContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.NumberContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.NumberContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.NumberContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.NumberContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.NumberContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.NumberContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.NumberContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.NumberContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.NumberContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.NumberContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.NumberContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumberContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.NumberContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumberContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.NumberContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.NumberContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.NumberContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.NumberContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.NumberContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.NumberContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.NumberContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.NumberContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.NumberContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.NumberContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.NumberContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.NumberContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.NumberContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.NumberContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumberContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumberContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.NumberContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.NumberContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: digits() + uid: adaptive-expressions-ie11.NumberContext.digits + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digits(): DigitsContext' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.NumberContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.NumberContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpression.yml new file mode 100644 index 00000000..a3dbeab9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpression.yml @@ -0,0 +1,144 @@ +### YamlMime:TSType +name: NumberExpression +uid: adaptive-expressions-ie11.NumberExpression +package: adaptive-expressions-ie11 +summary: >- + Represents a property which is either a float or a string expression which + resolves to a float. +fullName: NumberExpression +remarks: >- + String values are always interpreted as an expression, whether it has '=' + prefix or not. +isDeprecated: false +type: class +constructors: + - name: NumberExpression(string | number | Expression) + uid: adaptive-expressions-ie11.NumberExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [NumberExpression](xref:adaptive-expressions.NumberExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new NumberExpression(value?: string | number | Expression)' + parameters: + - id: value + type: >- + string | number | + description: >- + A float `number` or `string` expression which resolves to a float + `number`. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.NumberExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.NumberExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.NumberExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): number' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: number + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.NumberExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.NumberExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.NumberExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: number }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: number }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +methods: + - name: setValue(string | number | Expression) + uid: adaptive-expressions-ie11.NumberExpression.setValue + package: adaptive-expressions-ie11 + summary: Set a number value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | number | Expression)' + parameters: + - id: value + type: >- + string | number | + description: Value to set. +extends: <number> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpressionConverter.yml new file mode 100644 index 00000000..65c626ed --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberExpressionConverter.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: NumberExpressionConverter +uid: adaptive-expressions-ie11.NumberExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `string` or `number` to json + [NumberExpression](xref:adaptive-expressions.NumberExpression) converter. +fullName: NumberExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(Input | NumberExpression) + uid: adaptive-expressions-ie11.NumberExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts a `string` or `number` into a + [NumberExpression](xref:adaptive-expressions.NumberExpression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: Input | NumberExpression): NumberExpression' + parameters: + - id: value + type: Input | + description: '`string` or `number` to convert.' + return: + description: The [NumberExpression](xref:adaptive-expressions.NumberExpression). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberTransformEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberTransformEvaluator.yml new file mode 100644 index 00000000..1be9d801 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumberTransformEvaluator.yml @@ -0,0 +1,113 @@ +### YamlMime:TSType +name: NumberTransformEvaluator +uid: adaptive-expressions-ie11.NumberTransformEvaluator +package: adaptive-expressions-ie11 +summary: Evaluator that transforms a number to another number. +fullName: NumberTransformEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: 'NumberTransformEvaluator(string, (args: any[]) => number)' + uid: adaptive-expressions-ie11.NumberTransformEvaluator.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [NumberTransformEvaluator](xref:adaptive-expressions.NumberTransformEvaluator) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new NumberTransformEvaluator(type: string, func: (args: any[]) => + number) + parameters: + - id: type + type: string + description: Name of the built-in function. + - id: func + type: '(args: any[]) => number' + description: >- + The evaluation function, it takes a list of objects and returns a + number. +inheritedProperties: + - name: negation + uid: adaptive-expressions-ie11.NumberTransformEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions-ie11.ExpressionEvaluator.negation) + - name: returnType + uid: adaptive-expressions-ie11.NumberTransformEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.returnType](xref:adaptive-expressions-ie11.ExpressionEvaluator.returnType) + - name: tryEvaluate + uid: adaptive-expressions-ie11.NumberTransformEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions-ie11.NumberTransformEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.type](xref:adaptive-expressions-ie11.ExpressionEvaluator.type) + - name: validateExpression + uid: adaptive-expressions-ie11.NumberTransformEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.validateExpression](xref:adaptive-expressions-ie11.ExpressionEvaluator.validateExpression) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericAtomContext.yml new file mode 100644 index 00000000..9eb3cbee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericAtomContext.yml @@ -0,0 +1,906 @@ +### YamlMime:TSType +name: NumericAtomContext +uid: adaptive-expressions-ie11.NumericAtomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: NumericAtomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: NumericAtomContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.NumericAtomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new NumericAtomContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.NumericAtomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.NumericAtomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.NumericAtomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.NumericAtomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.NumericAtomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.NumericAtomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.NumericAtomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.NumericAtomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.NumericAtomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: NumericAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.NumericAtomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.NumericAtomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.NumericAtomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.NumericAtomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.NumericAtomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.NumericAtomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.NumericAtomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.NumericAtomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.NumericAtomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.NumericAtomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.NumericAtomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.NumericAtomContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.NumericAtomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.NumericAtomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.NumericAtomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumericAtomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.NumericAtomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumericAtomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.NumericAtomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.NumericAtomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.NumericAtomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.NumericAtomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.NumericAtomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.NumericAtomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.NumericAtomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.NumericAtomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.NumericAtomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.NumericAtomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.NumericAtomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.NumericAtomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.NumericAtomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.NumericAtomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumericAtomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.NumericAtomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.NumericAtomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.NumericAtomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.NumericAtomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.NumericAtomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: NUMBER() + uid: adaptive-expressions-ie11.NumericAtomContext.NUMBER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NUMBER(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericEvaluator.yml new file mode 100644 index 00000000..44d60178 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/NumericEvaluator.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: NumericEvaluator +uid: adaptive-expressions-ie11.NumericEvaluator +package: adaptive-expressions-ie11 +summary: Numeric operators that can have 1 or more args. +fullName: NumericEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: 'NumericEvaluator(string, (args: any[]) => any)' + uid: adaptive-expressions-ie11.NumericEvaluator.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [NumericEvaluator](xref:adaptive-expressions.NumericEvaluator) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new NumericEvaluator(type: string, func: (args: any[]) => any)' + parameters: + - id: type + type: string + description: Name of the built-in function. + - id: func + type: '(args: any[]) => any' + description: >- + The evaluation function, it takes a list of objects and returns a + number. +inheritedProperties: + - name: negation + uid: adaptive-expressions-ie11.NumericEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions-ie11.ExpressionEvaluator.negation) + - name: returnType + uid: adaptive-expressions-ie11.NumericEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.returnType](xref:adaptive-expressions-ie11.ExpressionEvaluator.returnType) + - name: tryEvaluate + uid: adaptive-expressions-ie11.NumericEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions-ie11.NumericEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.type](xref:adaptive-expressions-ie11.ExpressionEvaluator.type) + - name: validateExpression + uid: adaptive-expressions-ie11.NumericEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.validateExpression](xref:adaptive-expressions-ie11.ExpressionEvaluator.validateExpression) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpression.yml new file mode 100644 index 00000000..0c618157 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpression.yml @@ -0,0 +1,144 @@ +### YamlMime:TSType +name: ObjectExpression +uid: adaptive-expressions-ie11.ObjectExpression +package: adaptive-expressions-ie11 +summary: >- + Represents a property which is either an object of type T or a string + expression which resolves + + to a object of type T. +fullName: ObjectExpression +remarks: >- + String values are always interpreted as an expression, whether it has '=' + prefix or not. +isDeprecated: false +type: class +constructors: + - name: ObjectExpression(string | Expression | T) + uid: adaptive-expressions-ie11.ObjectExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [ObjectExpression](xref:adaptive-expressions.ObjectExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new ObjectExpression(value?: string | Expression | T)' + parameters: + - id: value + type: string | | T + description: >- + An object of type `T` or a `string` expression which resolves to a + object of type `T`. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.ObjectExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.ObjectExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.ObjectExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): T' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: T + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: setValue(string | Expression | T) + uid: adaptive-expressions-ie11.ObjectExpression.setValue + package: adaptive-expressions-ie11 + summary: Set the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | Expression | T)' + parameters: + - id: value + type: string | | T + description: Value to set. + inheritanceDescription: >- + Inherited From + [ExpressionProperty.setValue](xref:adaptive-expressions-ie11.ExpressionProperty.setValue) + - name: toExpression() + uid: adaptive-expressions-ie11.ObjectExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.ObjectExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.ObjectExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: T }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: T }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +extends: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpressionConverter.yml new file mode 100644 index 00000000..aa83f56a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ObjectExpressionConverter.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ObjectExpressionConverter +uid: adaptive-expressions-ie11.ObjectExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `any` value to json + [ObjectExpressionConverter](xref:adaptive-expressions.ObjectExpressionConverter) + converter. +fullName: ObjectExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(Input | ObjectExpression) + uid: adaptive-expressions-ie11.ObjectExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts value of type `T` into an + [ObjectExpression](xref:adaptive-expressions.ObjectExpression). + remarks: '' + isDeprecated: false + syntax: + content: >- + function convert(value: Input | ObjectExpression): + ObjectExpression + parameters: + - id: value + type: >- + Input<T> | <T> + description: Value of type `T` to convert. + return: + description: The [ObjectExpression](xref:adaptive-expressions.ObjectExpression). + type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_charContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_charContext.yml new file mode 100644 index 00000000..03573405 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_charContext.yml @@ -0,0 +1,898 @@ +### YamlMime:TSType +name: Octal_charContext +uid: adaptive-expressions-ie11.Octal_charContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Octal_charContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Octal_charContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Octal_charContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Octal_charContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Octal_charContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Octal_charContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Octal_charContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Octal_charContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Octal_charContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Octal_charContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Octal_charContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Octal_charContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Octal_charContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Octal_charContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Octal_charContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Octal_charContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Octal_charContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Octal_charContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Octal_charContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Octal_charContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Octal_charContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Octal_charContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Octal_charContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Octal_charContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Octal_charContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Octal_charContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Octal_charContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Octal_charContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Octal_charContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_charContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Octal_charContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_charContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_charContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Octal_charContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Octal_charContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Octal_charContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Octal_charContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Octal_charContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Octal_charContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Octal_charContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Octal_charContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Octal_charContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Octal_charContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Octal_charContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Octal_charContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Octal_charContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_charContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_charContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Octal_charContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Octal_charContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: Backslash() + uid: adaptive-expressions-ie11.Octal_charContext.Backslash + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Backslash(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D0() + uid: adaptive-expressions-ie11.Octal_charContext.D0 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D0(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D1() + uid: adaptive-expressions-ie11.Octal_charContext.D1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D1(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D2() + uid: adaptive-expressions-ie11.Octal_charContext.D2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D2(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D3() + uid: adaptive-expressions-ie11.Octal_charContext.D3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D3(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Octal_charContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Octal_charContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: octal_digit() + uid: adaptive-expressions-ie11.Octal_charContext.octal_digit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function octal_digit(): Octal_digitContext[]' + return: + description: '' + type: [] + - name: octal_digit(number) + uid: adaptive-expressions-ie11.Octal_charContext.octal_digit_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function octal_digit(i: number): Octal_digitContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_digitContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_digitContext.yml new file mode 100644 index 00000000..93f262f4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Octal_digitContext.yml @@ -0,0 +1,905 @@ +### YamlMime:TSType +name: Octal_digitContext +uid: adaptive-expressions-ie11.Octal_digitContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Octal_digitContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Octal_digitContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Octal_digitContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Octal_digitContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Octal_digitContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Octal_digitContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Octal_digitContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Octal_digitContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Octal_digitContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Octal_digitContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Octal_digitContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Octal_digitContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Octal_digitContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Octal_digitContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Octal_digitContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Octal_digitContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Octal_digitContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Octal_digitContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Octal_digitContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Octal_digitContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Octal_digitContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Octal_digitContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Octal_digitContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Octal_digitContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Octal_digitContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Octal_digitContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Octal_digitContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Octal_digitContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Octal_digitContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_digitContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Octal_digitContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_digitContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_digitContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Octal_digitContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Octal_digitContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Octal_digitContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Octal_digitContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Octal_digitContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Octal_digitContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Octal_digitContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Octal_digitContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Octal_digitContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Octal_digitContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Octal_digitContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Octal_digitContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Octal_digitContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_digitContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Octal_digitContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Octal_digitContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Octal_digitContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: D0() + uid: adaptive-expressions-ie11.Octal_digitContext.D0 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D0(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D1() + uid: adaptive-expressions-ie11.Octal_digitContext.D1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D1(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D2() + uid: adaptive-expressions-ie11.Octal_digitContext.D2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D2(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D3() + uid: adaptive-expressions-ie11.Octal_digitContext.D3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D3(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D4() + uid: adaptive-expressions-ie11.Octal_digitContext.D4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D4(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D5() + uid: adaptive-expressions-ie11.Octal_digitContext.D5 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D5(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D6() + uid: adaptive-expressions-ie11.Octal_digitContext.D6 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D6(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: D7() + uid: adaptive-expressions-ie11.Octal_digitContext.D7 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function D7(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Octal_digitContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Octal_digitContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Optimizer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Optimizer.yml new file mode 100644 index 00000000..57a02199 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Optimizer.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: Optimizer +uid: adaptive-expressions-ie11.Optimizer +package: adaptive-expressions-ie11 +summary: Optimize a clause by rewriting it. +fullName: Optimizer +remarks: '' +isDeprecated: false +type: interface +methods: + - name: optimize(Clause) + uid: adaptive-expressions-ie11.Optimizer.optimize + package: adaptive-expressions-ie11 + summary: Optionally rewrite a clause. + remarks: '' + isDeprecated: false + syntax: + content: 'function optimize(clause: Clause): Clause' + parameters: + - id: clause + type: + description: Original clause. + return: + description: Optimized clause. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/OptionContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/OptionContext.yml new file mode 100644 index 00000000..b5ad7be3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/OptionContext.yml @@ -0,0 +1,876 @@ +### YamlMime:TSType +name: OptionContext +uid: adaptive-expressions-ie11.OptionContext +package: adaptive-expressions-ie11 +summary: '' +fullName: OptionContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OptionContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.OptionContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new OptionContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.OptionContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.OptionContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.OptionContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.OptionContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.OptionContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.OptionContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.OptionContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.OptionContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.OptionContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.OptionContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: OptionContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.OptionContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.OptionContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.OptionContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.OptionContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.OptionContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.OptionContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.OptionContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.OptionContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.OptionContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.OptionContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.OptionContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.OptionContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.OptionContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.OptionContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.OptionContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.OptionContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.OptionContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.OptionContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.OptionContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.OptionContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.OptionContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.OptionContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.OptionContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.OptionContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.OptionContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.OptionContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.OptionContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.OptionContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.OptionContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.OptionContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.OptionContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.OptionContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.OptionContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.OptionContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.OptionContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CloseParen() + uid: adaptive-expressions-ie11.OptionContext.CloseParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.OptionContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.OptionContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: OpenParen() + uid: adaptive-expressions-ie11.OptionContext.OpenParen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OpenParen(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: option_flag() + uid: adaptive-expressions-ie11.OptionContext.option_flag + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function option_flag(): Option_flagContext[]' + return: + description: '' + type: [] + - name: option_flag(number) + uid: adaptive-expressions-ie11.OptionContext.option_flag_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function option_flag(i: number): Option_flagContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: QuestionMark() + uid: adaptive-expressions-ie11.OptionContext.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QuestionMark(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Option_flagContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Option_flagContext.yml new file mode 100644 index 00000000..dcf84830 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Option_flagContext.yml @@ -0,0 +1,850 @@ +### YamlMime:TSType +name: Option_flagContext +uid: adaptive-expressions-ie11.Option_flagContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Option_flagContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Option_flagContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Option_flagContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Option_flagContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Option_flagContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Option_flagContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Option_flagContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Option_flagContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Option_flagContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Option_flagContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Option_flagContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Option_flagContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Option_flagContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Option_flagContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Option_flagContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Option_flagContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Option_flagContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Option_flagContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Option_flagContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Option_flagContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Option_flagContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Option_flagContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Option_flagContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Option_flagContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Option_flagContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Option_flagContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Option_flagContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Option_flagContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Option_flagContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Option_flagContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Option_flagContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Option_flagContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Option_flagContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Option_flagContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Option_flagContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Option_flagContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Option_flagContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Option_flagContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Option_flagContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Option_flagContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Option_flagContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Option_flagContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Option_flagContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Option_flagContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Option_flagContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Option_flagContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Option_flagContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Option_flagContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Option_flagContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Option_flagContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Option_flagContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Option_flagContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: ILC() + uid: adaptive-expressions-ie11.Option_flagContext.ILC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ILC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: MLC() + uid: adaptive-expressions-ie11.Option_flagContext.MLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function MLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SLC() + uid: adaptive-expressions-ie11.Option_flagContext.SLC + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SLC(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Options.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Options.yml new file mode 100644 index 00000000..17ff7826 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Options.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Options +uid: adaptive-expressions-ie11.Options +package: adaptive-expressions-ie11 +summary: Options used to define evaluation behaviors. +fullName: Options +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Options(Options) + uid: adaptive-expressions-ie11.Options.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [Options](xref:adaptive-expressions.Options) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new Options(opt?: Options)' + parameters: + - id: opt + type: + description: Optional. An [Options](xref:adaptive-expressions.Options) instance. +properties: + - name: locale + uid: adaptive-expressions-ie11.Options.locale + package: adaptive-expressions-ie11 + summary: The locale info for evaluating Expressions. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale: string' + return: + description: '' + type: string + - name: nullSubstitution + uid: adaptive-expressions-ie11.Options.nullSubstitution + package: adaptive-expressions-ie11 + summary: '' + fullName: nullSubstitution + remarks: '' + isDeprecated: false + syntax: + content: 'nullSubstitution: (path: string) => unknown' + return: + description: '' + type: '(path: string) => unknown' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParenthesisExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParenthesisExpContext.yml new file mode 100644 index 00000000..87708969 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParenthesisExpContext.yml @@ -0,0 +1,928 @@ +### YamlMime:TSType +name: ParenthesisExpContext +uid: adaptive-expressions-ie11.ParenthesisExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ParenthesisExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ParenthesisExpContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.ParenthesisExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ParenthesisExpContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ParenthesisExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.ParenthesisExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.ParenthesisExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.ParenthesisExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.ParenthesisExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.ParenthesisExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.ParenthesisExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.ParenthesisExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.ParenthesisExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ParenthesisExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.ParenthesisExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.ParenthesisExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.ParenthesisExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.ParenthesisExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.ParenthesisExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ParenthesisExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ParenthesisExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ParenthesisExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.ParenthesisExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ParenthesisExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ParenthesisExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.ParenthesisExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.ParenthesisExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.ParenthesisExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.ParenthesisExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParenthesisExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ParenthesisExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParenthesisExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ParenthesisExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ParenthesisExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.ParenthesisExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.ParenthesisExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ParenthesisExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.ParenthesisExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.ParenthesisExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ParenthesisExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParenthesisExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParenthesisExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ParenthesisExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.ParenthesisExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CLOSE_BRACKET() + uid: adaptive-expressions-ie11.ParenthesisExpContext.CLOSE_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CLOSE_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.ParenthesisExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.ParenthesisExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.ParenthesisExpContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: + - name: OPEN_BRACKET() + uid: adaptive-expressions-ie11.ParenthesisExpContext.OPEN_BRACKET + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OPEN_BRACKET(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseContext.yml new file mode 100644 index 00000000..ba5ddfdb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseContext.yml @@ -0,0 +1,839 @@ +### YamlMime:TSType +name: ParseContext +uid: adaptive-expressions-ie11.ParseContext +package: adaptive-expressions-ie11 +summary: '' +fullName: ParseContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ParseContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.ParseContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ParseContext(parent: undefined | ParserRuleContext, invokingState: + number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.ParseContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.ParseContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.ParseContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.ParseContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.ParseContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.ParseContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.ParseContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.ParseContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.ParseContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.ParseContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: ParseContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.ParseContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.ParseContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.ParseContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.ParseContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.ParseContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.ParseContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.ParseContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.ParseContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.ParseContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.ParseContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.ParseContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.ParseContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.ParseContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.ParseContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParseContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.ParseContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParseContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.ParseContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.ParseContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.ParseContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.ParseContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.ParseContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.ParseContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.ParseContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.ParseContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.ParseContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.ParseContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.ParseContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.ParseContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.ParseContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.ParseContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParseContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.ParseContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.ParseContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.ParseContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: alternation() + uid: adaptive-expressions-ie11.ParseContext.alternation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function alternation(): AlternationContext' + return: + description: '' + type: + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.ParseContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: EOF() + uid: adaptive-expressions-ie11.ParseContext.EOF + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function EOF(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.ParseContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseErrorListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseErrorListener.yml new file mode 100644 index 00000000..a5f01271 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ParseErrorListener.yml @@ -0,0 +1,55 @@ +### YamlMime:TSType +name: ParseErrorListener +uid: adaptive-expressions-ie11.ParseErrorListener +package: adaptive-expressions-ie11 +summary: Expression parser error listener. +fullName: ParseErrorListener +remarks: '' +isDeprecated: false +type: class +properties: + - name: Instance + uid: adaptive-expressions-ie11.ParseErrorListener.Instance + package: adaptive-expressions-ie11 + summary: '' + fullName: Instance + remarks: '' + isDeprecated: false + syntax: + content: 'static Instance: ParseErrorListener' + return: + description: '' + type: +methods: + - name: >- + syntaxError(Recognizer, T, number, number, string, undefined | + RecognitionException) + uid: adaptive-expressions-ie11.ParseErrorListener.syntaxError + package: adaptive-expressions-ie11 + summary: Throws a syntax error based on the current context. + remarks: '' + isDeprecated: false + syntax: + content: >- + function syntaxError(_recognizer: Recognizer, + _offendingSymbol: T, line: number, charPositionInLine: number, _msg: + string, _e: undefined | RecognitionException) + parameters: + - id: _recognizer + type: Recognizer<T, any> + description: An Antlr4 runtime recognizer. + - id: _offendingSymbol + type: T + description: The token violating the lexer rules. + - id: line + type: number + description: The line number where the error occurred. + - id: charPositionInLine + type: number + description: The position of character in the line where the error occurred. + - id: _msg + type: string + description: The error message. + - id: _e + type: undefined | RecognitionException + description: The `RecognitionException`. diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparer.yml new file mode 100644 index 00000000..927dbf11 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparer.yml @@ -0,0 +1,43 @@ +### YamlMime:TSType +name: PredicateComparer +uid: adaptive-expressions-ie11.PredicateComparer +package: adaptive-expressions-ie11 +summary: Compare two predicates to identifiy the relationship between them. +fullName: PredicateComparer +remarks: '' +isDeprecated: false +type: interface +properties: + - name: predicate + uid: adaptive-expressions-ie11.PredicateComparer.predicate + package: adaptive-expressions-ie11 + summary: Name of the predicate. + fullName: predicate + remarks: '' + isDeprecated: false + syntax: + content: 'predicate: string' + return: + description: '' + type: string +methods: + - name: relationship(Expression, Expression) + uid: adaptive-expressions-ie11.PredicateComparer.relationship + package: adaptive-expressions-ie11 + summary: Identify the relationship between two predicates. + remarks: '' + isDeprecated: false + syntax: + content: >- + function relationship(predicate: Expression, other: Expression): + RelationshipType + parameters: + - id: predicate + type: + description: First predicate. + - id: other + type: + description: Second predicate. + return: + description: Relationship between predicates. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparers.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparers.yml new file mode 100644 index 00000000..01bdad16 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PredicateComparers.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: PredicateComparers +uid: adaptive-expressions-ie11.PredicateComparers +package: adaptive-expressions-ie11 +summary: '' +fullName: PredicateComparers +remarks: '' +isDeprecated: false +syntax: | + type PredicateComparers = { [name: string]: PredicateComparer } diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpContext.yml new file mode 100644 index 00000000..42bb5472 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpContext.yml @@ -0,0 +1,906 @@ +### YamlMime:TSType +name: PrimaryExpContext +uid: adaptive-expressions-ie11.PrimaryExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: PrimaryExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: PrimaryExpContext(ExpressionContext) + uid: adaptive-expressions-ie11.PrimaryExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new PrimaryExpContext(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.PrimaryExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions-ie11.ExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.PrimaryExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions-ie11.ExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.PrimaryExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions-ie11.ExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.PrimaryExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions-ie11.ExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.PrimaryExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions-ie11.ExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.PrimaryExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions-ie11.ExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.PrimaryExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions-ie11.ExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.PrimaryExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions-ie11.ExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.PrimaryExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: PrimaryExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions-ie11.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.PrimaryExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.ExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.PrimaryExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.ExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.PrimaryExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions-ie11.ExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.PrimaryExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions-ie11.ExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.PrimaryExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions-ie11.ExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.PrimaryExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.ExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.PrimaryExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.PrimaryExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.PrimaryExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.PrimaryExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: copyFrom(ExpressionContext) + uid: adaptive-expressions-ie11.PrimaryExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.copyFrom](xref:adaptive-expressions-ie11.ExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.PrimaryExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions-ie11.ExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.PrimaryExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions-ie11.ExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.PrimaryExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.PrimaryExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions-ie11.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.PrimaryExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions-ie11.ExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.PrimaryExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions-ie11.ExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.PrimaryExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.ExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions-ie11.ExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.PrimaryExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions-ie11.ExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.PrimaryExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.PrimaryExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.PrimaryExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.PrimaryExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.PrimaryExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.PrimaryExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.PrimaryExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.ExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.PrimaryExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.PrimaryExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.PrimaryExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: primaryExpression() + uid: adaptive-expressions-ie11.PrimaryExpContext.primaryExpression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function primaryExpression(): PrimaryExpressionContext' + return: + description: '' + type: +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpressionContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpressionContext.yml new file mode 100644 index 00000000..10c03485 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/PrimaryExpressionContext.yml @@ -0,0 +1,806 @@ +### YamlMime:TSType +name: PrimaryExpressionContext +uid: adaptive-expressions-ie11.PrimaryExpressionContext +package: adaptive-expressions-ie11 +summary: '' +fullName: PrimaryExpressionContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: PrimaryExpressionContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new PrimaryExpressionContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.PrimaryExpressionContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.PrimaryExpressionContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.PrimaryExpressionContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.PrimaryExpressionContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.PrimaryExpressionContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.PrimaryExpressionContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.PrimaryExpressionContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: PrimaryExpressionContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.PrimaryExpressionContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.PrimaryExpressionContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.PrimaryExpressionContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: accept(ParseTreeVisitor) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: ParseTreeVisitor): T' + parameters: + - id: visitor + type: ParseTreeVisitor<T> + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.accept + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: depth() + uid: adaptive-expressions-ie11.PrimaryExpressionContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: enterRule(ParseTreeListener) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: '' + inheritanceDescription: Inherited From ParserRuleContext.enterRule + - name: exitRule(ParseTreeListener) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ParseTreeListener)' + parameters: + - id: listener + type: ParseTreeListener + description: '' + inheritanceDescription: Inherited From ParserRuleContext.exitRule + - name: getChild(number) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier.yml new file mode 100644 index 00000000..dab2770e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Quantifier +uid: adaptive-expressions-ie11.Quantifier +package: adaptive-expressions-ie11 +summary: Quantifier for allowing runtime expansion of expressions. +fullName: Quantifier +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Quantifier(string, QuantifierType, string[]) + uid: adaptive-expressions-ie11.Quantifier.constructor + package: adaptive-expressions-ie11 + summary: Initializes a new instance of the `Quantifier` class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new Quantifier(variable: string, type: QuantifierType, bindings: + string[]) + parameters: + - id: variable + type: string + description: Name of variable to replace. + - id: type + type: + description: Type of quantifier. + - id: bindings + type: string[] + description: Possible bindings for variable. +properties: + - name: bindings + uid: adaptive-expressions-ie11.Quantifier.bindings + package: adaptive-expressions-ie11 + summary: '' + fullName: bindings + remarks: '' + isDeprecated: false + syntax: + content: 'bindings: string[]' + return: + description: '' + type: string[] + - name: type + uid: adaptive-expressions-ie11.Quantifier.type + package: adaptive-expressions-ie11 + summary: '' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: QuantifierType' + return: + description: '' + type: + - name: variable + uid: adaptive-expressions-ie11.Quantifier.variable + package: adaptive-expressions-ie11 + summary: '' + fullName: variable + remarks: '' + isDeprecated: false + syntax: + content: 'variable: string' + return: + description: '' + type: string +methods: + - name: toString() + uid: adaptive-expressions-ie11.Quantifier.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: A string that represents the quantifier. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierContext.yml new file mode 100644 index 00000000..9192d798 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierContext.yml @@ -0,0 +1,920 @@ +### YamlMime:TSType +name: QuantifierContext +uid: adaptive-expressions-ie11.QuantifierContext +package: adaptive-expressions-ie11 +summary: '' +fullName: QuantifierContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: QuantifierContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.QuantifierContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new QuantifierContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.QuantifierContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.QuantifierContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.QuantifierContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.QuantifierContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.QuantifierContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.QuantifierContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.QuantifierContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.QuantifierContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.QuantifierContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.QuantifierContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: QuantifierContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.QuantifierContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.QuantifierContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.QuantifierContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.QuantifierContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.QuantifierContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.QuantifierContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.QuantifierContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.QuantifierContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.QuantifierContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.QuantifierContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.QuantifierContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.QuantifierContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.QuantifierContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.QuantifierContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.QuantifierContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.QuantifierContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.QuantifierContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.QuantifierContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.QuantifierContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.QuantifierContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.QuantifierContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.QuantifierContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.QuantifierContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.QuantifierContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.QuantifierContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.QuantifierContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.QuantifierContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.QuantifierContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.QuantifierContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.QuantifierContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.QuantifierContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.QuantifierContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.QuantifierContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.QuantifierContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.QuantifierContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CloseBrace() + uid: adaptive-expressions-ie11.QuantifierContext.CloseBrace + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseBrace(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Comma() + uid: adaptive-expressions-ie11.QuantifierContext.Comma + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Comma(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.QuantifierContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.QuantifierContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: number() + uid: adaptive-expressions-ie11.QuantifierContext.number + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function number(): NumberContext[]' + return: + description: '' + type: [] + - name: number(number) + uid: adaptive-expressions-ie11.QuantifierContext.number_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function number(i: number): NumberContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: OpenBrace() + uid: adaptive-expressions-ie11.QuantifierContext.OpenBrace + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OpenBrace(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Plus() + uid: adaptive-expressions-ie11.QuantifierContext.Plus + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Plus(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: quantifier_type() + uid: adaptive-expressions-ie11.QuantifierContext.quantifier_type + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function quantifier_type(): Quantifier_typeContext' + return: + description: '' + type: + - name: QuestionMark() + uid: adaptive-expressions-ie11.QuantifierContext.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QuestionMark(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Star() + uid: adaptive-expressions-ie11.QuantifierContext.Star + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Star(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierType.yml new file mode 100644 index 00000000..d00802c1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/QuantifierType.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: QuantifierType +uid: adaptive-expressions-ie11.QuantifierType +package: adaptive-expressions-ie11 +summary: Type of quantifier for expanding trigger expressions. +fullName: QuantifierType +remarks: '' +isDeprecated: false +fields: + - name: all + uid: adaptive-expressions-ie11.QuantifierType.all + package: adaptive-expressions-ie11 + summary: >- + Within a clause, duplicate any predicate with variable for each possible + binding. + - name: any + uid: adaptive-expressions-ie11.QuantifierType.any + package: adaptive-expressions-ie11 + summary: Create a new clause for each possible binding of variable. diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier_typeContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier_typeContext.yml new file mode 100644 index 00000000..f240c691 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Quantifier_typeContext.yml @@ -0,0 +1,839 @@ +### YamlMime:TSType +name: Quantifier_typeContext +uid: adaptive-expressions-ie11.Quantifier_typeContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Quantifier_typeContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Quantifier_typeContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Quantifier_typeContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Quantifier_typeContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Quantifier_typeContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Quantifier_typeContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Quantifier_typeContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Quantifier_typeContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Quantifier_typeContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Quantifier_typeContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Quantifier_typeContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Quantifier_typeContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Quantifier_typeContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Quantifier_typeContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Quantifier_typeContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Quantifier_typeContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Quantifier_typeContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Quantifier_typeContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Quantifier_typeContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Quantifier_typeContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Quantifier_typeContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Quantifier_typeContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Quantifier_typeContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Quantifier_typeContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Quantifier_typeContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Quantifier_typeContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Quantifier_typeContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Quantifier_typeContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Quantifier_typeContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Quantifier_typeContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Quantifier_typeContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Quantifier_typeContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Quantifier_typeContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Quantifier_typeContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Quantifier_typeContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Quantifier_typeContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Quantifier_typeContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Quantifier_typeContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Quantifier_typeContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Quantifier_typeContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Quantifier_typeContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Quantifier_typeContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Quantifier_typeContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Quantifier_typeContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Quantifier_typeContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Quantifier_typeContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: Plus() + uid: adaptive-expressions-ie11.Quantifier_typeContext.Plus + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Plus(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: QuestionMark() + uid: adaptive-expressions-ie11.Quantifier_typeContext.QuestionMark + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QuestionMark(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RegexErrorListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RegexErrorListener.yml new file mode 100644 index 00000000..a35f1dfb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RegexErrorListener.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: RegexErrorListener +uid: adaptive-expressions-ie11.RegexErrorListener +package: adaptive-expressions-ie11 +summary: Error listener for Regex. +fullName: RegexErrorListener +remarks: '' +isDeprecated: false +type: class +properties: + - name: Instance + uid: adaptive-expressions-ie11.RegexErrorListener.Instance + package: adaptive-expressions-ie11 + summary: '' + fullName: Instance + remarks: '' + isDeprecated: false + syntax: + content: 'static Instance: RegexErrorListener' + return: + description: '' + type: +methods: + - name: >- + syntaxError(Recognizer, T, number, number, string, undefined | + RecognitionException) + uid: adaptive-expressions-ie11.RegexErrorListener.syntaxError + package: adaptive-expressions-ie11 + summary: Upon syntax error, notify any interested parties. + remarks: '' + isDeprecated: false + syntax: + content: >- + function syntaxError(_recognizer: Recognizer, + _offendingSymbol: T, _line: number, _charPositionInLine: number, _msg: + string, _e: undefined | RecognitionException) + parameters: + - id: _recognizer + type: Recognizer<T, any> + description: >- + What parser got the error. From this object, you can access the + context as well as the input stream. + - id: _offendingSymbol + type: T + description: >- + Offending token in the input token stream, unless recognizer is a + lexer, then it's null. + - id: _line + type: number + description: Line number in the input where the error occurred. + - id: _charPositionInLine + type: number + description: Character position within the line where the error occurred. + - id: _msg + type: string + description: Message to emit. + - id: _e + type: undefined | RecognitionException + description: >- + Exception generated by the parser that led to the reporting of an + error. diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RelationshipType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RelationshipType.yml new file mode 100644 index 00000000..2eca437f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/RelationshipType.yml @@ -0,0 +1,29 @@ +### YamlMime:TSEnum +name: RelationshipType +uid: adaptive-expressions-ie11.RelationshipType +package: adaptive-expressions-ie11 +summary: Relationship between trigger expressions. +fullName: RelationshipType +remarks: '' +isDeprecated: false +fields: + - name: equal + uid: adaptive-expressions-ie11.RelationshipType.equal + package: adaptive-expressions-ie11 + summary: First and second argument are the same expression. + - name: generalizes + uid: adaptive-expressions-ie11.RelationshipType.generalizes + package: adaptive-expressions-ie11 + summary: >- + First argument generalizes the second, i.e. applies to a superset of the + states the second argument covers. + - name: incomparable + uid: adaptive-expressions-ie11.RelationshipType.incomparable + package: adaptive-expressions-ie11 + summary: Connot tell how the first and second arguments relate. + - name: specializes + uid: adaptive-expressions-ie11.RelationshipType.specializes + package: adaptive-expressions-ie11 + summary: >- + First argument specializes the second, i.e. applies to a subset of the + states the second argument covers. diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ReturnType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ReturnType.yml new file mode 100644 index 00000000..6e074cf5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ReturnType.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: ReturnType +uid: adaptive-expressions-ie11.ReturnType +package: adaptive-expressions-ie11 +summary: Type expected from evalating an expression. +fullName: ReturnType +remarks: '' +isDeprecated: false +fields: + - name: Boolean + uid: adaptive-expressions-ie11.ReturnType.Boolean + package: adaptive-expressions-ie11 + summary: True or false boolean value. + numericValue: 1 + - name: Number + uid: adaptive-expressions-ie11.ReturnType.Number + package: adaptive-expressions-ie11 + summary: Numerical value like int, float, double, ... + numericValue: 2 + - name: Object + uid: adaptive-expressions-ie11.ReturnType.Object + package: adaptive-expressions-ie11 + summary: Any value is possible. + numericValue: 4 + - name: String + uid: adaptive-expressions-ie11.ReturnType.String + package: adaptive-expressions-ie11 + summary: String value. + numericValue: 8 + - name: Array + uid: adaptive-expressions-ie11.ReturnType.Array + package: adaptive-expressions-ie11 + summary: Array value. + numericValue: 16 diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_atomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_atomContext.yml new file mode 100644 index 00000000..2267aff2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_atomContext.yml @@ -0,0 +1,916 @@ +### YamlMime:TSType +name: Shared_atomContext +uid: adaptive-expressions-ie11.Shared_atomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Shared_atomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Shared_atomContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Shared_atomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Shared_atomContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Shared_atomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Shared_atomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Shared_atomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Shared_atomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Shared_atomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Shared_atomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Shared_atomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Shared_atomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Shared_atomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Shared_atomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Shared_atomContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Shared_atomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Shared_atomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Shared_atomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Shared_atomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Shared_atomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Shared_atomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Shared_atomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Shared_atomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Shared_atomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Shared_atomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Shared_atomContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Shared_atomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Shared_atomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Shared_atomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_atomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Shared_atomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_atomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_atomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Shared_atomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Shared_atomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Shared_atomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Shared_atomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Shared_atomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Shared_atomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Shared_atomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Shared_atomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Shared_atomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Shared_atomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Shared_atomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Shared_atomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Shared_atomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_atomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_atomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Shared_atomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Shared_atomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: CharWithoutProperty() + uid: adaptive-expressions-ie11.Shared_atomContext.CharWithoutProperty + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CharWithoutProperty(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CharWithProperty() + uid: adaptive-expressions-ie11.Shared_atomContext.CharWithProperty + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CharWithProperty(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: ControlChar() + uid: adaptive-expressions-ie11.Shared_atomContext.ControlChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ControlChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: DecimalDigit() + uid: adaptive-expressions-ie11.Shared_atomContext.DecimalDigit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function DecimalDigit(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Shared_atomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Shared_atomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: NotDecimalDigit() + uid: adaptive-expressions-ie11.Shared_atomContext.NotDecimalDigit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NotDecimalDigit(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: NotWhiteSpace() + uid: adaptive-expressions-ie11.Shared_atomContext.NotWhiteSpace + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NotWhiteSpace(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: NotWordChar() + uid: adaptive-expressions-ie11.Shared_atomContext.NotWordChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NotWordChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: WhiteSpace() + uid: adaptive-expressions-ie11.Shared_atomContext.WhiteSpace + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function WhiteSpace(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: WordChar() + uid: adaptive-expressions-ie11.Shared_atomContext.WordChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function WordChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_literalContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_literalContext.yml new file mode 100644 index 00000000..fbcc2eb7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Shared_literalContext.yml @@ -0,0 +1,1103 @@ +### YamlMime:TSType +name: Shared_literalContext +uid: adaptive-expressions-ie11.Shared_literalContext +package: adaptive-expressions-ie11 +summary: '' +fullName: Shared_literalContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Shared_literalContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.Shared_literalContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Shared_literalContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.Shared_literalContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.Shared_literalContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.Shared_literalContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.Shared_literalContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.Shared_literalContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.Shared_literalContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.Shared_literalContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.Shared_literalContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.Shared_literalContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.Shared_literalContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: Shared_literalContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.Shared_literalContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.Shared_literalContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.Shared_literalContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.Shared_literalContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.Shared_literalContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.Shared_literalContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.Shared_literalContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.Shared_literalContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.Shared_literalContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.Shared_literalContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.Shared_literalContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.Shared_literalContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.Shared_literalContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.Shared_literalContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_literalContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.Shared_literalContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_literalContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_literalContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.Shared_literalContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.Shared_literalContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.Shared_literalContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.Shared_literalContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.Shared_literalContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.Shared_literalContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.Shared_literalContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.Shared_literalContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.Shared_literalContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.Shared_literalContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.Shared_literalContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.Shared_literalContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.Shared_literalContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_literalContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.Shared_literalContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.Shared_literalContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(CommonRegexVisitor) + uid: adaptive-expressions-ie11.Shared_literalContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function accept(visitor: CommonRegexVisitor): Result' + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: Ampersand() + uid: adaptive-expressions-ie11.Shared_literalContext.Ampersand + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Ampersand(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: BellChar() + uid: adaptive-expressions-ie11.Shared_literalContext.BellChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function BellChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: BlockQuoted() + uid: adaptive-expressions-ie11.Shared_literalContext.BlockQuoted + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function BlockQuoted(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CarriageReturn() + uid: adaptive-expressions-ie11.Shared_literalContext.CarriageReturn + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CarriageReturn(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: CloseBrace() + uid: adaptive-expressions-ie11.Shared_literalContext.CloseBrace + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function CloseBrace(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Colon() + uid: adaptive-expressions-ie11.Shared_literalContext.Colon + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Colon(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Comma() + uid: adaptive-expressions-ie11.Shared_literalContext.Comma + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Comma(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: digit() + uid: adaptive-expressions-ie11.Shared_literalContext.digit + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function digit(): undefined | DigitContext' + return: + description: '' + type: undefined | + - name: enterRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Shared_literalContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: Equals() + uid: adaptive-expressions-ie11.Shared_literalContext.Equals + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Equals(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: EscapeChar() + uid: adaptive-expressions-ie11.Shared_literalContext.EscapeChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function EscapeChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Exclamation() + uid: adaptive-expressions-ie11.Shared_literalContext.Exclamation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Exclamation(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: exitRule(CommonRegexListener) + uid: adaptive-expressions-ie11.Shared_literalContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: CommonRegexListener)' + parameters: + - id: listener + type: + description: '' + - name: FormFeed() + uid: adaptive-expressions-ie11.Shared_literalContext.FormFeed + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function FormFeed(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: GreaterThan() + uid: adaptive-expressions-ie11.Shared_literalContext.GreaterThan + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function GreaterThan(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Hash() + uid: adaptive-expressions-ie11.Shared_literalContext.Hash + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Hash(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: HexChar() + uid: adaptive-expressions-ie11.Shared_literalContext.HexChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function HexChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Hyphen() + uid: adaptive-expressions-ie11.Shared_literalContext.Hyphen + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Hyphen(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: LessThan() + uid: adaptive-expressions-ie11.Shared_literalContext.LessThan + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function LessThan(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: letter() + uid: adaptive-expressions-ie11.Shared_literalContext.letter + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function letter(): undefined | LetterContext' + return: + description: '' + type: undefined | + - name: NewLine() + uid: adaptive-expressions-ie11.Shared_literalContext.NewLine + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NewLine(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: octal_char() + uid: adaptive-expressions-ie11.Shared_literalContext.octal_char + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function octal_char(): undefined | Octal_charContext' + return: + description: '' + type: undefined | + - name: OpenBrace() + uid: adaptive-expressions-ie11.Shared_literalContext.OpenBrace + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OpenBrace(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: OtherChar() + uid: adaptive-expressions-ie11.Shared_literalContext.OtherChar + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function OtherChar(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Quoted() + uid: adaptive-expressions-ie11.Shared_literalContext.Quoted + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Quoted(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SingleQuote() + uid: adaptive-expressions-ie11.Shared_literalContext.SingleQuote + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SingleQuote(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Tab() + uid: adaptive-expressions-ie11.Shared_literalContext.Tab + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Tab(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: Underscore() + uid: adaptive-expressions-ie11.Shared_literalContext.Underscore + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function Underscore(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/SimpleObjectMemory.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/SimpleObjectMemory.yml new file mode 100644 index 00000000..82c0fc07 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/SimpleObjectMemory.yml @@ -0,0 +1,113 @@ +### YamlMime:TSType +name: SimpleObjectMemory +uid: adaptive-expressions-ie11.SimpleObjectMemory +package: adaptive-expressions-ie11 +summary: Simple implement of MemoryInterface +fullName: SimpleObjectMemory +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SimpleObjectMemory(any) + uid: adaptive-expressions-ie11.SimpleObjectMemory.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [SimpleObjectMemory](xref:adaptive-expressions.SimpleObjectMemory) class. + + This wraps a simple object as + [MemoryInterface](xref:adaptive-expressions.MemoryInterface). + remarks: '' + isDeprecated: false + syntax: + content: 'new SimpleObjectMemory(memory: any)' + parameters: + - id: memory + type: any + description: The object to wrap. +methods: + - name: getValue(string) + uid: adaptive-expressions-ie11.SimpleObjectMemory.getValue + package: adaptive-expressions-ie11 + summary: Gets the value from a given path. + remarks: '' + isDeprecated: false + syntax: + content: 'function getValue(path: string): any' + parameters: + - id: path + type: string + description: Given path. + return: + description: The value in the given path or undefined. + type: any + - name: setValue(string, any) + uid: adaptive-expressions-ie11.SimpleObjectMemory.setValue + package: adaptive-expressions-ie11 + summary: >- + In this simple object scope, we don't allow you to set a path in which + some parts in middle don't exist + + for example + + if you set dialog.a.b = x, but dialog.a don't exist, this will result in + an error + + because we can't and shouldn't smart create structure in the middle + + you can implement a customzied Scope that support such behavior + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(path: string, input: any)' + parameters: + - id: path + type: string + description: Memory path. + - id: input + type: any + description: Value to set. + - name: toString() + uid: adaptive-expressions-ie11.SimpleObjectMemory.toString + package: adaptive-expressions-ie11 + summary: >- + Returns a string that represents the current + [SimpleObjectMemory](xref:adaptive-expressions.SimpleObjectMemory) object. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: >- + A string value representing the current + [SimpleObjectMemory](xref:adaptive-expressions.SimpleObjectMemory) + object. + type: string + - name: version() + uid: adaptive-expressions-ie11.SimpleObjectMemory.version + package: adaptive-expressions-ie11 + summary: >- + Returns the version info of + [SimpleObjectMemory](xref:adaptive-expressions.SimpleObjectMemory). + remarks: '' + isDeprecated: false + syntax: + content: 'function version(): string' + return: + description: A string value representing the version info. + type: string + - name: wrap(any) + uid: adaptive-expressions-ie11.SimpleObjectMemory.wrap + package: adaptive-expressions-ie11 + summary: Transfer a common object to simple memory. + remarks: '' + isDeprecated: false + syntax: + content: 'static function wrap(obj: any): MemoryInterface' + parameters: + - id: obj + type: any + description: Common object. + return: + description: Simple memory instance. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StackedMemory.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StackedMemory.yml new file mode 100644 index 00000000..87a18e45 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StackedMemory.yml @@ -0,0 +1,1367 @@ +### YamlMime:TSType +name: StackedMemory +uid: adaptive-expressions-ie11.StackedMemory +package: adaptive-expressions-ie11 +summary: |- + Stack implements of MemoryInterface. + Memory variables have a hierarchical relationship. +fullName: StackedMemory +remarks: '' +isDeprecated: false +type: class +constructors: + - name: StackedMemory(MemoryInterface[]) + uid: adaptive-expressions-ie11.StackedMemory.constructor_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StackedMemory(items: MemoryInterface[])' + parameters: + - id: items + type: [] + description: '' + - name: StackedMemory(number) + uid: adaptive-expressions-ie11.StackedMemory.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StackedMemory(arrayLength: number)' + parameters: + - id: arrayLength + type: number + description: '' +inheritedProperties: + - name: length + uid: adaptive-expressions-ie11.StackedMemory.length + package: adaptive-expressions-ie11 + summary: >- + Gets or sets the length of the array. This is a number one higher than the + highest index in the array. + fullName: length + remarks: '' + isDeprecated: false + syntax: + content: 'length: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.length + - name: '[species]' + uid: adaptive-expressions-ie11.StackedMemory.[species] + package: adaptive-expressions-ie11 + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: ArrayConstructor' + return: + description: '' + type: ArrayConstructor + inheritanceDescription: Inherited From Array.__@species@2758 +inheritedMethods: + - name: at(number) + uid: adaptive-expressions-ie11.StackedMemory.at + package: adaptive-expressions-ie11 + summary: |- + Takes an integer value and returns the item at that index, + allowing for positive and negative integers. + Negative integers count back from the last item in the array. + remarks: '' + isDeprecated: false + syntax: + content: 'function at(index: number): undefined | MemoryInterface' + parameters: + - id: index + type: number + description: '' + return: + description: '' + type: undefined | + inheritanceDescription: Inherited From Array.at + - name: concat((MemoryInterface | ConcatArray)[]) + uid: adaptive-expressions-ie11.StackedMemory.concat_1 + package: adaptive-expressions-ie11 + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. + remarks: '' + isDeprecated: false + syntax: + content: >- + function concat(items: (MemoryInterface | + ConcatArray)[]): MemoryInterface[] + parameters: + - id: items + type: >- + ( | + ConcatArray<>)[] + description: Additional arrays and/or items to add to the end of the array. + return: + description: '' + type: [] + inheritanceDescription: Inherited From Array.concat + - name: concat(ConcatArray[]) + uid: adaptive-expressions-ie11.StackedMemory.concat + package: adaptive-expressions-ie11 + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. + remarks: '' + isDeprecated: false + syntax: + content: >- + function concat(items: ConcatArray[]): + MemoryInterface[] + parameters: + - id: items + type: >- + ConcatArray<>[] + description: Additional arrays and/or items to add to the end of the array. + return: + description: '' + type: [] + inheritanceDescription: Inherited From Array.concat + - name: copyWithin(number, number, number) + uid: adaptive-expressions-ie11.StackedMemory.copyWithin + package: adaptive-expressions-ie11 + summary: >- + Returns the this object after copying a section of the array identified by + start and end + + to the same array starting at position target + remarks: '' + isDeprecated: false + syntax: + content: >- + function copyWithin(target: number, start: number, end?: number): + StackedMemory + parameters: + - id: target + type: number + description: >- + If target is negative, it is treated as length+target where length + is the + + length of the array. + - id: start + type: number + description: >- + If start is negative, it is treated as length+start. If end is + negative, it + + is treated as length+end. + - id: end + type: number + description: >- + If not specified, length of the this object is used as its default + value. + return: + description: '' + type: + inheritanceDescription: Inherited From Array.copyWithin + - name: entries() + uid: adaptive-expressions-ie11.StackedMemory.entries + package: adaptive-expressions-ie11 + summary: Returns an iterable of key, value pairs for every entry in the array + remarks: '' + isDeprecated: false + syntax: + content: 'function entries(): IterableIterator<[number, MemoryInterface]>' + return: + description: '' + type: IterableIterator<[number, MemoryInterface]> + inheritanceDescription: Inherited From Array.entries + - name: >- + every((value: MemoryInterface, index: number, array: MemoryInterface[]) => + unknown, any) + uid: adaptive-expressions-ie11.StackedMemory.every_1 + package: adaptive-expressions-ie11 + summary: Determines whether all the members of an array satisfy the specified test. + remarks: '' + isDeprecated: false + syntax: + content: >- + function every(predicate: (value: MemoryInterface, index: number, array: + MemoryInterface[]) => unknown, thisArg?: any): boolean + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => unknown + description: >- + A function that accepts up to three arguments. The every method + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Array.every + - name: >- + every((value: MemoryInterface, index: number, array: MemoryInterface[]) + => value, any) + uid: adaptive-expressions-ie11.StackedMemory.every + package: adaptive-expressions-ie11 + summary: Determines whether all the members of an array satisfy the specified test. + remarks: '' + isDeprecated: false + syntax: + content: >- + function every(predicate: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => value, thisArg?: any): this + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => value + description: >- + A function that accepts up to three arguments. The every method + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: this + inheritanceDescription: Inherited From Array.every + - name: fill(MemoryInterface, number, number) + uid: adaptive-expressions-ie11.StackedMemory.fill + package: adaptive-expressions-ie11 + summary: >- + Changes all array elements from `start` to `end` index to a static `value` + and returns the modified array + remarks: '' + isDeprecated: false + syntax: + content: >- + function fill(value: MemoryInterface, start?: number, end?: number): + StackedMemory + parameters: + - id: value + type: + description: value to fill array section with + - id: start + type: number + description: >- + index to start filling the array at. If start is negative, it is + treated as + + length+start where length is the length of the array. + - id: end + type: number + description: >- + index to stop filling the array at. If end is negative, it is + treated as + + length+end. + return: + description: '' + type: + inheritanceDescription: Inherited From Array.fill + - name: >- + filter((value: MemoryInterface, index: number, array: MemoryInterface[]) + => unknown, any) + uid: adaptive-expressions-ie11.StackedMemory.filter_1 + package: adaptive-expressions-ie11 + summary: >- + Returns the elements of an array that meet the condition specified in a + callback function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function filter(predicate: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => unknown, thisArg?: any): MemoryInterface[] + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => unknown + description: >- + A function that accepts up to three arguments. The filter method + calls the predicate function one time for each element in the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. If thisArg is omitted, undefined is used as the this + value. + return: + description: '' + type: [] + inheritanceDescription: Inherited From Array.filter + - name: >- + filter((value: MemoryInterface, index: number, array: + MemoryInterface[]) => value, any) + uid: adaptive-expressions-ie11.StackedMemory.filter + package: adaptive-expressions-ie11 + summary: >- + Returns the elements of an array that meet the condition specified in a + callback function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function filter(predicate: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => value, thisArg?: any): S[] + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => value + description: >- + A function that accepts up to three arguments. The filter method + calls the predicate function one time for each element in the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. If thisArg is omitted, undefined is used as the this + value. + return: + description: '' + type: S[] + inheritanceDescription: Inherited From Array.filter + - name: >- + find((value: MemoryInterface, index: number, obj: MemoryInterface[]) => + unknown, any) + uid: adaptive-expressions-ie11.StackedMemory.find_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function find(predicate: (value: MemoryInterface, index: number, obj: + MemoryInterface[]) => unknown, thisArg?: any): undefined | + MemoryInterface + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, obj: MemoryInterface[]) + => unknown + description: '' + - id: thisArg + type: any + description: '' + return: + description: '' + type: undefined | + inheritanceDescription: Inherited From Array.find + - name: >- + find((this: void, value: MemoryInterface, index: number, obj: + MemoryInterface[]) => value, any) + uid: adaptive-expressions-ie11.StackedMemory.find + package: adaptive-expressions-ie11 + summary: >- + Returns the value of the first element in the array where predicate is + true, and undefined + + otherwise. + remarks: '' + isDeprecated: false + syntax: + content: >- + function find(predicate: (this: void, value: MemoryInterface, index: + number, obj: MemoryInterface[]) => value, thisArg?: any): undefined | S + parameters: + - id: predicate + type: >- + (this: void, value: MemoryInterface, index: number, obj: + MemoryInterface[]) => value + description: >- + find calls predicate once for each element of the array, in + ascending + + order, until it finds one where predicate returns true. If such an + element is found, find + + immediately returns that element value. Otherwise, find returns + undefined. + - id: thisArg + type: any + description: >- + If provided, it will be used as the this value for each invocation + of + + predicate. If it is not provided, undefined is used instead. + return: + description: '' + type: undefined | S + inheritanceDescription: Inherited From Array.find + - name: >- + findIndex((value: MemoryInterface, index: number, obj: MemoryInterface[]) + => unknown, any) + uid: adaptive-expressions-ie11.StackedMemory.findIndex + package: adaptive-expressions-ie11 + summary: >- + Returns the index of the first element in the array where predicate is + true, and -1 + + otherwise. + remarks: '' + isDeprecated: false + syntax: + content: >- + function findIndex(predicate: (value: MemoryInterface, index: number, + obj: MemoryInterface[]) => unknown, thisArg?: any): number + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, obj: MemoryInterface[]) + => unknown + description: >- + find calls predicate once for each element of the array, in + ascending + + order, until it finds one where predicate returns true. If such an + element is found, + + findIndex immediately returns that element index. Otherwise, + findIndex returns -1. + - id: thisArg + type: any + description: >- + If provided, it will be used as the this value for each invocation + of + + predicate. If it is not provided, undefined is used instead. + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.findIndex + - name: flat(A, D) + uid: adaptive-expressions-ie11.StackedMemory.flat + package: adaptive-expressions-ie11 + summary: >- + Returns a new array with all sub-array elements concatenated into it + recursively up to the + + specified depth. + remarks: '' + isDeprecated: false + syntax: + content: 'function flat(this: A, depth?: D): FlatArray[]' + parameters: + - id: this + type: A + description: '' + - id: depth + type: D + description: The maximum recursion depth + return: + description: '' + type: FlatArray<A, D>[] + inheritanceDescription: Inherited From Array.flat + - name: >- + flatMap((this: This, value: MemoryInterface, index: number, + array: MemoryInterface[]) => U | (readonly U[]), This) + uid: adaptive-expressions-ie11.StackedMemory.flatMap + package: adaptive-expressions-ie11 + summary: >- + Calls a defined callback function on each element of an array. Then, + flattens the result into + + a new array. + + This is identical to a map followed by flat with depth 1. + remarks: '' + isDeprecated: false + syntax: + content: >- + function flatMap(callback: (this: This, value: MemoryInterface, + index: number, array: MemoryInterface[]) => U | (readonly U[]), + thisArg?: This): U[] + parameters: + - id: callback + type: >- + (this: This, value: MemoryInterface, index: number, array: + MemoryInterface[]) => U | (readonly U[]) + description: >- + A function that accepts up to three arguments. The flatMap method + calls the + + callback function one time for each element in the array. + - id: thisArg + type: This + description: >- + An object to which the this keyword can refer in the callback + function. If + + thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.flatMap + - name: >- + forEach((value: MemoryInterface, index: number, array: MemoryInterface[]) + => void, any) + uid: adaptive-expressions-ie11.StackedMemory.forEach + package: adaptive-expressions-ie11 + summary: Performs the specified action for each element in an array. + remarks: '' + isDeprecated: false + syntax: + content: >- + function forEach(callbackfn: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => void, thisArg?: any) + parameters: + - id: callbackfn + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => void + description: >- + A function that accepts up to three arguments. forEach calls the + callbackfn function one time for each element in the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the callbackfn + function. If thisArg is omitted, undefined is used as the this + value. + inheritanceDescription: Inherited From Array.forEach + - name: 'from(ArrayLike, (v: T, k: number) => U, any)' + uid: adaptive-expressions-ie11.StackedMemory.from_1 + package: adaptive-expressions-ie11 + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(arrayLike: ArrayLike, mapfn: (v: T, k: + number) => U, thisArg?: any): U[] + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: 'from(Iterable | ArrayLike, (v: T, k: number) => U, any)' + uid: adaptive-expressions-ie11.StackedMemory.from_3 + package: adaptive-expressions-ie11 + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(iterable: Iterable | ArrayLike, mapfn: + (v: T, k: number) => U, thisArg?: any): U[] + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: from(ArrayLike) + uid: adaptive-expressions-ie11.StackedMemory.from + package: adaptive-expressions-ie11 + summary: Creates an array from an array-like object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(arrayLike: ArrayLike): T[]' + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: from(Iterable | ArrayLike) + uid: adaptive-expressions-ie11.StackedMemory.from_2 + package: adaptive-expressions-ie11 + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(iterable: Iterable | ArrayLike): T[]' + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: includes(MemoryInterface, number) + uid: adaptive-expressions-ie11.StackedMemory.includes + package: adaptive-expressions-ie11 + summary: >- + Determines whether an array includes a certain element, returning true or + false as appropriate. + remarks: '' + isDeprecated: false + syntax: + content: >- + function includes(searchElement: MemoryInterface, fromIndex?: number): + boolean + parameters: + - id: searchElement + type: + description: The element to search for. + - id: fromIndex + type: number + description: >- + The position in this array at which to begin searching for + searchElement. + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Array.includes + - name: indexOf(MemoryInterface, number) + uid: adaptive-expressions-ie11.StackedMemory.indexOf + package: adaptive-expressions-ie11 + summary: >- + Returns the index of the first occurrence of a value in an array, or -1 if + it is not present. + remarks: '' + isDeprecated: false + syntax: + content: >- + function indexOf(searchElement: MemoryInterface, fromIndex?: number): + number + parameters: + - id: searchElement + type: + description: The value to locate in the array. + - id: fromIndex + type: number + description: >- + The array index at which to begin the search. If fromIndex is + omitted, the search starts at index 0. + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.indexOf + - name: isArray(any) + uid: adaptive-expressions-ie11.StackedMemory.isArray + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function isArray(arg: any): arg' + parameters: + - id: arg + type: any + description: '' + return: + description: '' + type: arg + inheritanceDescription: Inherited From Array.isArray + - name: join(string) + uid: adaptive-expressions-ie11.StackedMemory.join + package: adaptive-expressions-ie11 + summary: >- + Adds all the elements of an array into a string, separated by the + specified separator string. + remarks: '' + isDeprecated: false + syntax: + content: 'function join(separator?: string): string' + parameters: + - id: separator + type: string + description: >- + A string used to separate one element of the array from the next in + the resulting string. If omitted, the array elements are separated + with a comma. + return: + description: '' + type: string + inheritanceDescription: Inherited From Array.join + - name: keys() + uid: adaptive-expressions-ie11.StackedMemory.keys + package: adaptive-expressions-ie11 + summary: Returns an iterable of keys in the array + remarks: '' + isDeprecated: false + syntax: + content: 'function keys(): IterableIterator' + return: + description: '' + type: IterableIterator<number> + inheritanceDescription: Inherited From Array.keys + - name: lastIndexOf(MemoryInterface, number) + uid: adaptive-expressions-ie11.StackedMemory.lastIndexOf + package: adaptive-expressions-ie11 + summary: >- + Returns the index of the last occurrence of a specified value in an array, + or -1 if it is not present. + remarks: '' + isDeprecated: false + syntax: + content: >- + function lastIndexOf(searchElement: MemoryInterface, fromIndex?: + number): number + parameters: + - id: searchElement + type: + description: The value to locate in the array. + - id: fromIndex + type: number + description: >- + The array index at which to begin searching backward. If fromIndex + is omitted, the search starts at the last index in the array. + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.lastIndexOf + - name: >- + map((value: MemoryInterface, index: number, array: MemoryInterface[]) + => U, any) + uid: adaptive-expressions-ie11.StackedMemory.map + package: adaptive-expressions-ie11 + summary: >- + Calls a defined callback function on each element of an array, and returns + an array that contains the results. + remarks: '' + isDeprecated: false + syntax: + content: >- + function map(callbackfn: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => U, thisArg?: any): U[] + parameters: + - id: callbackfn + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => U + description: >- + A function that accepts up to three arguments. The map method calls + the callbackfn function one time for each element in the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the callbackfn + function. If thisArg is omitted, undefined is used as the this + value. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.map + - name: of(T[]) + uid: adaptive-expressions-ie11.StackedMemory.of + package: adaptive-expressions-ie11 + summary: Returns a new array from a set of elements. + remarks: '' + isDeprecated: false + syntax: + content: 'static function of(items: T[]): T[]' + parameters: + - id: items + type: T[] + description: A set of elements to include in the new array object. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.of + - name: pop() + uid: adaptive-expressions-ie11.StackedMemory.pop + package: adaptive-expressions-ie11 + summary: >- + Removes the last element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. + remarks: '' + isDeprecated: false + syntax: + content: 'function pop(): undefined | MemoryInterface' + return: + description: '' + type: undefined | + inheritanceDescription: Inherited From Array.pop + - name: push(MemoryInterface[]) + uid: adaptive-expressions-ie11.StackedMemory.push + package: adaptive-expressions-ie11 + summary: >- + Appends new elements to the end of an array, and returns the new length of + the array. + remarks: '' + isDeprecated: false + syntax: + content: 'function push(items: MemoryInterface[]): number' + parameters: + - id: items + type: [] + description: New elements to add to the array. + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.push + - name: >- + reduce((previousValue: MemoryInterface, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => MemoryInterface) + uid: adaptive-expressions-ie11.StackedMemory.reduce + package: adaptive-expressions-ie11 + summary: >- + Calls the specified callback function for all the elements in an array. + The return value of the callback function is the accumulated result, and + is provided as an argument in the next call to the callback function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function reduce(callbackfn: (previousValue: MemoryInterface, + currentValue: MemoryInterface, currentIndex: number, array: + MemoryInterface[]) => MemoryInterface): MemoryInterface + parameters: + - id: callbackfn + type: >- + (previousValue: MemoryInterface, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => + MemoryInterface + description: >- + A function that accepts up to four arguments. The reduce method + calls the callbackfn function one time for each element in the + array. + return: + description: '' + type: + inheritanceDescription: Inherited From Array.reduce + - name: >- + reduce((previousValue: MemoryInterface, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => MemoryInterface, + MemoryInterface) + uid: adaptive-expressions-ie11.StackedMemory.reduce_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reduce(callbackfn: (previousValue: MemoryInterface, + currentValue: MemoryInterface, currentIndex: number, array: + MemoryInterface[]) => MemoryInterface, initialValue: MemoryInterface): + MemoryInterface + parameters: + - id: callbackfn + type: >- + (previousValue: MemoryInterface, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => + MemoryInterface + description: '' + - id: initialValue + type: + description: '' + return: + description: '' + type: + inheritanceDescription: Inherited From Array.reduce + - name: >- + reduce((previousValue: U, currentValue: MemoryInterface, currentIndex: + number, array: MemoryInterface[]) => U, U) + uid: adaptive-expressions-ie11.StackedMemory.reduce_2 + package: adaptive-expressions-ie11 + summary: >- + Calls the specified callback function for all the elements in an array. + The return value of the callback function is the accumulated result, and + is provided as an argument in the next call to the callback function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function reduce(callbackfn: (previousValue: U, currentValue: + MemoryInterface, currentIndex: number, array: MemoryInterface[]) => U, + initialValue: U): U + parameters: + - id: callbackfn + type: >- + (previousValue: U, currentValue: MemoryInterface, currentIndex: + number, array: MemoryInterface[]) => U + description: >- + A function that accepts up to four arguments. The reduce method + calls the callbackfn function one time for each element in the + array. + - id: initialValue + type: U + description: >- + If initialValue is specified, it is used as the initial value to + start the accumulation. The first call to the callbackfn function + provides this value as an argument instead of an array value. + return: + description: '' + type: U + inheritanceDescription: Inherited From Array.reduce + - name: >- + reduceRight((previousValue: MemoryInterface, currentValue: + MemoryInterface, currentIndex: number, array: MemoryInterface[]) => + MemoryInterface) + uid: adaptive-expressions-ie11.StackedMemory.reduceRight + package: adaptive-expressions-ie11 + summary: >- + Calls the specified callback function for all the elements in an array, in + descending order. The return value of the callback function is the + accumulated result, and is provided as an argument in the next call to the + callback function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function reduceRight(callbackfn: (previousValue: MemoryInterface, + currentValue: MemoryInterface, currentIndex: number, array: + MemoryInterface[]) => MemoryInterface): MemoryInterface + parameters: + - id: callbackfn + type: >- + (previousValue: MemoryInterface, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => + MemoryInterface + description: >- + A function that accepts up to four arguments. The reduceRight method + calls the callbackfn function one time for each element in the + array. + return: + description: '' + type: + inheritanceDescription: Inherited From Array.reduceRight + - name: >- + reduceRight((previousValue: MemoryInterface, currentValue: + MemoryInterface, currentIndex: number, array: MemoryInterface[]) => + MemoryInterface, MemoryInterface) + uid: adaptive-expressions-ie11.StackedMemory.reduceRight_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function reduceRight(callbackfn: (previousValue: MemoryInterface, + currentValue: MemoryInterface, currentIndex: number, array: + MemoryInterface[]) => MemoryInterface, initialValue: MemoryInterface): + MemoryInterface + parameters: + - id: callbackfn + type: >- + (previousValue: MemoryInterface, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => + MemoryInterface + description: '' + - id: initialValue + type: + description: '' + return: + description: '' + type: + inheritanceDescription: Inherited From Array.reduceRight + - name: >- + reduceRight((previousValue: U, currentValue: MemoryInterface, + currentIndex: number, array: MemoryInterface[]) => U, U) + uid: adaptive-expressions-ie11.StackedMemory.reduceRight_2 + package: adaptive-expressions-ie11 + summary: >- + Calls the specified callback function for all the elements in an array, in + descending order. The return value of the callback function is the + accumulated result, and is provided as an argument in the next call to the + callback function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function reduceRight(callbackfn: (previousValue: U, currentValue: + MemoryInterface, currentIndex: number, array: MemoryInterface[]) => U, + initialValue: U): U + parameters: + - id: callbackfn + type: >- + (previousValue: U, currentValue: MemoryInterface, currentIndex: + number, array: MemoryInterface[]) => U + description: >- + A function that accepts up to four arguments. The reduceRight method + calls the callbackfn function one time for each element in the + array. + - id: initialValue + type: U + description: >- + If initialValue is specified, it is used as the initial value to + start the accumulation. The first call to the callbackfn function + provides this value as an argument instead of an array value. + return: + description: '' + type: U + inheritanceDescription: Inherited From Array.reduceRight + - name: reverse() + uid: adaptive-expressions-ie11.StackedMemory.reverse + package: adaptive-expressions-ie11 + summary: |- + Reverses the elements in an array in place. + This method mutates the array and returns a reference to the same array. + remarks: '' + isDeprecated: false + syntax: + content: 'function reverse(): MemoryInterface[]' + return: + description: '' + type: [] + inheritanceDescription: Inherited From Array.reverse + - name: shift() + uid: adaptive-expressions-ie11.StackedMemory.shift + package: adaptive-expressions-ie11 + summary: >- + Removes the first element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. + remarks: '' + isDeprecated: false + syntax: + content: 'function shift(): undefined | MemoryInterface' + return: + description: '' + type: undefined | + inheritanceDescription: Inherited From Array.shift + - name: slice(number, number) + uid: adaptive-expressions-ie11.StackedMemory.slice + package: adaptive-expressions-ie11 + summary: >- + Returns a copy of a section of an array. + + For both start and end, a negative index can be used to indicate an offset + from the end of the array. + + For example, -2 refers to the second to last element of the array. + remarks: '' + isDeprecated: false + syntax: + content: 'function slice(start?: number, end?: number): MemoryInterface[]' + parameters: + - id: start + type: number + description: |- + The beginning index of the specified portion of the array. + If start is undefined, then the slice begins at index 0. + - id: end + type: number + description: >- + The end index of the specified portion of the array. This is + exclusive of the element at the index 'end'. + + If end is undefined, then the slice extends to the end of the array. + return: + description: '' + type: [] + inheritanceDescription: Inherited From Array.slice + - name: >- + some((value: MemoryInterface, index: number, array: MemoryInterface[]) => + unknown, any) + uid: adaptive-expressions-ie11.StackedMemory.some + package: adaptive-expressions-ie11 + summary: >- + Determines whether the specified callback function returns true for any + element of an array. + remarks: '' + isDeprecated: false + syntax: + content: >- + function some(predicate: (value: MemoryInterface, index: number, array: + MemoryInterface[]) => unknown, thisArg?: any): boolean + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => unknown + description: >- + A function that accepts up to three arguments. The some method calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value true, or until the end of + the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Array.some + - name: 'sort((a: MemoryInterface, b: MemoryInterface) => number)' + uid: adaptive-expressions-ie11.StackedMemory.sort + package: adaptive-expressions-ie11 + summary: |- + Sorts an array in place. + This method mutates the array and returns a reference to the same array. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sort(compareFn?: (a: MemoryInterface, b: MemoryInterface) => + number): StackedMemory + parameters: + - id: compareFn + type: '(a: MemoryInterface, b: MemoryInterface) => number' + description: >- + Function used to determine the order of the elements. It is expected + to return + + a negative value if the first argument is less than the second + argument, zero if they're equal, and a positive + + value otherwise. If omitted, the elements are sorted in ascending, + ASCII character order. + + ```ts + + [11,2,22,1].sort((a, b) => a - b) + + ``` + return: + description: '' + type: + inheritanceDescription: Inherited From Array.sort + - name: splice(number, number) + uid: adaptive-expressions-ie11.StackedMemory.splice + package: adaptive-expressions-ie11 + summary: >- + Removes elements from an array and, if necessary, inserts new elements in + their place, returning the deleted elements. + remarks: '' + isDeprecated: false + syntax: + content: 'function splice(start: number, deleteCount?: number): MemoryInterface[]' + parameters: + - id: start + type: number + description: >- + The zero-based location in the array from which to start removing + elements. + - id: deleteCount + type: number + description: The number of elements to remove. + return: + description: An array containing the elements that were deleted. + type: [] + inheritanceDescription: Inherited From Array.splice + - name: splice(number, number, MemoryInterface[]) + uid: adaptive-expressions-ie11.StackedMemory.splice_1 + package: adaptive-expressions-ie11 + summary: >- + Removes elements from an array and, if necessary, inserts new elements in + their place, returning the deleted elements. + remarks: '' + isDeprecated: false + syntax: + content: >- + function splice(start: number, deleteCount: number, items: + MemoryInterface[]): MemoryInterface[] + parameters: + - id: start + type: number + description: >- + The zero-based location in the array from which to start removing + elements. + - id: deleteCount + type: number + description: The number of elements to remove. + - id: items + type: [] + description: Elements to insert into the array in place of the deleted elements. + return: + description: An array containing the elements that were deleted. + type: [] + inheritanceDescription: Inherited From Array.splice + - name: toLocaleString() + uid: adaptive-expressions-ie11.StackedMemory.toLocaleString + package: adaptive-expressions-ie11 + summary: >- + Returns a string representation of an array. The elements are converted to + string using their toLocaleString methods. + remarks: '' + isDeprecated: false + syntax: + content: 'function toLocaleString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Array.toLocaleString + - name: toString() + uid: adaptive-expressions-ie11.StackedMemory.toString + package: adaptive-expressions-ie11 + summary: Returns a string representation of an array. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Array.toString + - name: unshift(MemoryInterface[]) + uid: adaptive-expressions-ie11.StackedMemory.unshift + package: adaptive-expressions-ie11 + summary: >- + Inserts new elements at the start of an array, and returns the new length + of the array. + remarks: '' + isDeprecated: false + syntax: + content: 'function unshift(items: MemoryInterface[]): number' + parameters: + - id: items + type: [] + description: Elements to insert at the start of the array. + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.unshift + - name: values() + uid: adaptive-expressions-ie11.StackedMemory.values + package: adaptive-expressions-ie11 + summary: Returns an iterable of values in the array + remarks: '' + isDeprecated: false + syntax: + content: 'function values(): IterableIterator' + return: + description: '' + type: >- + IterableIterator<> + inheritanceDescription: Inherited From Array.values + - name: '[iterator]()' + uid: adaptive-expressions-ie11.StackedMemory.[iterator] + package: adaptive-expressions-ie11 + summary: Iterator + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator' + return: + description: '' + type: >- + IterableIterator<> + inheritanceDescription: Inherited From Array.__@iterator@2799 + - name: '[unscopables]()' + uid: adaptive-expressions-ie11.StackedMemory.[unscopables] + package: adaptive-expressions-ie11 + summary: |- + Returns an object whose properties have the value 'true' + when they will be absent when used in a 'with' statement. + remarks: '' + isDeprecated: false + syntax: + content: >- + function [unscopables](): { copyWithin: boolean, entries: boolean, fill: + boolean, find: boolean, findIndex: boolean, keys: boolean, values: + boolean } + return: + description: '' + type: >- + { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, + findIndex: boolean, keys: boolean, values: boolean } + inheritanceDescription: Inherited From Array.__@unscopables@2801 +methods: + - name: getValue(string) + uid: adaptive-expressions-ie11.StackedMemory.getValue + package: adaptive-expressions-ie11 + summary: Gets the value from a given path. + remarks: '' + isDeprecated: false + syntax: + content: 'function getValue(path: string): any' + parameters: + - id: path + type: string + description: Given path. + return: + description: The value from the given path if found, otherwise, undefined. + type: any + - name: setValue(string, any) + uid: adaptive-expressions-ie11.StackedMemory.setValue + package: adaptive-expressions-ie11 + summary: Sets value to a given path. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(_path: string, _value: any)' + parameters: + - id: _path + type: string + description: Memory path. + - id: _value + type: any + description: Value to set. + - name: version() + uid: adaptive-expressions-ie11.StackedMemory.version + package: adaptive-expressions-ie11 + summary: >- + Gets the version of the current + [StackedMemory](xref:adaptive-expressions.StackedMemory). + remarks: '' + isDeprecated: false + syntax: + content: 'function version(): string' + return: + description: A string value representing the version. + type: string + - name: wrap(MemoryInterface) + uid: adaptive-expressions-ie11.StackedMemory.wrap + package: adaptive-expressions-ie11 + summary: >- + Wraps an object that implements + [MemoryInterface](xref:adaptive-expressions.MemoryInterface) into a + [StackedMemory](xref:adaptive-expressions.StackedMemory) object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function wrap(memory: MemoryInterface): StackedMemory' + parameters: + - id: memory + type: + description: >- + An object that implements + [MemoryInterface](xref:adaptive-expressions.MemoryInterface). + return: + description: A [StackedMemory](xref:adaptive-expressions.StackedMemory) object. + type: +extends: Array<> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringAtomContext.yml new file mode 100644 index 00000000..a2baf6b8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringAtomContext.yml @@ -0,0 +1,906 @@ +### YamlMime:TSType +name: StringAtomContext +uid: adaptive-expressions-ie11.StringAtomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: StringAtomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: StringAtomContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.StringAtomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StringAtomContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.StringAtomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.StringAtomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.StringAtomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.StringAtomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.StringAtomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.StringAtomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.StringAtomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.StringAtomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.StringAtomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: StringAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.StringAtomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.StringAtomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.StringAtomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.StringAtomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.StringAtomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.StringAtomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.StringAtomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.StringAtomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.StringAtomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.StringAtomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.StringAtomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.StringAtomContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.StringAtomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.StringAtomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.StringAtomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringAtomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.StringAtomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringAtomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.StringAtomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.StringAtomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.StringAtomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.StringAtomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.StringAtomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.StringAtomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.StringAtomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.StringAtomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.StringAtomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.StringAtomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.StringAtomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.StringAtomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.StringAtomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.StringAtomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringAtomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringAtomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.StringAtomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.StringAtomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.StringAtomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.StringAtomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: STRING() + uid: adaptive-expressions-ie11.StringAtomContext.STRING + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function STRING(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpression.yml new file mode 100644 index 00000000..c542b375 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpression.yml @@ -0,0 +1,149 @@ +### YamlMime:TSType +name: StringExpression +uid: adaptive-expressions-ie11.StringExpression +package: adaptive-expressions-ie11 +summary: Represents a property which is either a string value or a string expression. +fullName: StringExpression +remarks: >- + If the value is + + - a string with '=' prefix then the string is treated as an expression to + resolve to a string. + + - a string without '=' then value is treated as string with string + interpolation. + + - You can escape the '=' prefix by putting a backslash. + + Examples: + prop = "Hello @{user.name}" => "Hello Joe" + prop = "=length(user.name)" => "3" + prop = "=user.name" => "Joe" + prop = "\=user" => "=user". +isDeprecated: false +type: class +constructors: + - name: StringExpression(string | Expression) + uid: adaptive-expressions-ie11.StringExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [StringExpression](xref:adaptive-expressions.StringExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new StringExpression(value?: string | Expression)' + parameters: + - id: value + type: string | + description: A `string` value or a `string` expression. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.StringExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.StringExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.StringExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): string' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.StringExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.StringExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.StringExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: string }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: string }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +methods: + - name: setValue(string | Expression) + uid: adaptive-expressions-ie11.StringExpression.setValue + package: adaptive-expressions-ie11 + summary: Set a string value. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: string | Expression)' + parameters: + - id: value + type: string | + description: Value to set. +extends: <string> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpressionConverter.yml new file mode 100644 index 00000000..6cc1e5ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringExpressionConverter.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: StringExpressionConverter +uid: adaptive-expressions-ie11.StringExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `string` to json + [StringExpression](xref:adaptive-expressions.StringExpression) converter. +fullName: StringExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(Input | StringExpression) + uid: adaptive-expressions-ie11.StringExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts a string into an + [StringExpression](xref:adaptive-expressions.StringExpression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: Input | StringExpression): StringExpression' + parameters: + - id: value + type: Input | + description: '`string` to convert.' + return: + description: The [StringExpression](xref:adaptive-expressions.StringExpression). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationAtomContext.yml new file mode 100644 index 00000000..b85d2b02 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationAtomContext.yml @@ -0,0 +1,909 @@ +### YamlMime:TSType +name: StringInterpolationAtomContext +uid: adaptive-expressions-ie11.StringInterpolationAtomContext +package: adaptive-expressions-ie11 +summary: '' +fullName: StringInterpolationAtomContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: StringInterpolationAtomContext(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StringInterpolationAtomContext(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions-ie11.PrimaryExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions-ie11.PrimaryExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions-ie11.PrimaryExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions-ie11.PrimaryExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions-ie11.PrimaryExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions-ie11.PrimaryExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions-ie11.PrimaryExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: StringInterpolationAtomContext' + return: + description: '' + type: >- + + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.PrimaryExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.PrimaryExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions-ie11.PrimaryExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions-ie11.PrimaryExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions-ie11.PrimaryExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.PrimaryExpressionContext.addErrorNode) + - name: copyFrom(PrimaryExpressionContext) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: PrimaryExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.copyFrom](xref:adaptive-expressions-ie11.PrimaryExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions-ie11.PrimaryExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions-ie11.PrimaryExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions-ie11.PrimaryExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions-ie11.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.PrimaryExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.StringInterpolationAtomContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: stringInterpolation() + uid: >- + adaptive-expressions-ie11.StringInterpolationAtomContext.stringInterpolation + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function stringInterpolation(): StringInterpolationContext' + return: + description: '' + type: +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationContext.yml new file mode 100644 index 00000000..f6a2a66e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringInterpolationContext.yml @@ -0,0 +1,929 @@ +### YamlMime:TSType +name: StringInterpolationContext +uid: adaptive-expressions-ie11.StringInterpolationContext +package: adaptive-expressions-ie11 +summary: '' +fullName: StringInterpolationContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: StringInterpolationContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.StringInterpolationContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new StringInterpolationContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.StringInterpolationContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.StringInterpolationContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.StringInterpolationContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.StringInterpolationContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.StringInterpolationContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.StringInterpolationContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.StringInterpolationContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.StringInterpolationContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.StringInterpolationContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.StringInterpolationContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: StringInterpolationContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.StringInterpolationContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.StringInterpolationContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.StringInterpolationContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.StringInterpolationContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.StringInterpolationContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.StringInterpolationContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.StringInterpolationContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.StringInterpolationContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.StringInterpolationContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.StringInterpolationContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.StringInterpolationContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.StringInterpolationContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.StringInterpolationContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.StringInterpolationContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.StringInterpolationContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.StringInterpolationContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.StringInterpolationContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.StringInterpolationContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.StringInterpolationContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.StringInterpolationContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.StringInterpolationContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.StringInterpolationContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.StringInterpolationContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.StringInterpolationContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.StringInterpolationContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.StringInterpolationContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.StringInterpolationContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.StringInterpolationContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.StringInterpolationContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: ESCAPE_CHARACTER() + uid: adaptive-expressions-ie11.StringInterpolationContext.ESCAPE_CHARACTER + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ESCAPE_CHARACTER(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: ESCAPE_CHARACTER(number) + uid: adaptive-expressions-ie11.StringInterpolationContext.ESCAPE_CHARACTER_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function ESCAPE_CHARACTER(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.StringInterpolationContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: STRING_INTERPOLATION_START() + uid: >- + adaptive-expressions-ie11.StringInterpolationContext.STRING_INTERPOLATION_START + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function STRING_INTERPOLATION_START(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: STRING_INTERPOLATION_START(number) + uid: >- + adaptive-expressions-ie11.StringInterpolationContext.STRING_INTERPOLATION_START_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function STRING_INTERPOLATION_START(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + - name: TEMPLATE() + uid: adaptive-expressions-ie11.StringInterpolationContext.TEMPLATE + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function TEMPLATE(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: TEMPLATE(number) + uid: adaptive-expressions-ie11.StringInterpolationContext.TEMPLATE_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function TEMPLATE(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + - name: textContent() + uid: adaptive-expressions-ie11.StringInterpolationContext.textContent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function textContent(): TextContentContext[]' + return: + description: '' + type: [] + - name: textContent(number) + uid: adaptive-expressions-ie11.StringInterpolationContext.textContent_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function textContent(i: number): TextContentContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringTransformEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringTransformEvaluator.yml new file mode 100644 index 00000000..bd2be237 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/StringTransformEvaluator.yml @@ -0,0 +1,118 @@ +### YamlMime:TSType +name: StringTransformEvaluator +uid: adaptive-expressions-ie11.StringTransformEvaluator +package: adaptive-expressions-ie11 +summary: Evaluator that transforms a string to another string. +fullName: StringTransformEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + StringTransformEvaluator(string, (arg0: any[], options: Options) => + string, (expr: Expression) => void) + uid: adaptive-expressions-ie11.StringTransformEvaluator.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [StringTransformEvaluator](xref:adaptive-expressions.StringTransformEvaluator) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new StringTransformEvaluator(type: string, func: (arg0: any[], options: + Options) => string, validator?: (expr: Expression) => void) + parameters: + - id: type + type: string + description: Name of the built-in function. + - id: func + type: '(arg0: any[], options: Options) => string' + description: >- + The string transformation function, it takes a list of objects and + returns an string. + - id: validator + type: '(expr: Expression) => void' + description: The validation function. +inheritedProperties: + - name: negation + uid: adaptive-expressions-ie11.StringTransformEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions-ie11.ExpressionEvaluator.negation) + - name: returnType + uid: adaptive-expressions-ie11.StringTransformEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.returnType](xref:adaptive-expressions-ie11.ExpressionEvaluator.returnType) + - name: tryEvaluate + uid: adaptive-expressions-ie11.StringTransformEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions-ie11.StringTransformEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.type](xref:adaptive-expressions-ie11.ExpressionEvaluator.type) + - name: validateExpression + uid: adaptive-expressions-ie11.StringTransformEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.validateExpression](xref:adaptive-expressions-ie11.ExpressionEvaluator.validateExpression) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TextContentContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TextContentContext.yml new file mode 100644 index 00000000..defa59d9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TextContentContext.yml @@ -0,0 +1,849 @@ +### YamlMime:TSType +name: TextContentContext +uid: adaptive-expressions-ie11.TextContentContext +package: adaptive-expressions-ie11 +summary: '' +fullName: TextContentContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TextContentContext(undefined | ParserRuleContext, number) + uid: adaptive-expressions-ie11.TextContentContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TextContentContext(parent: undefined | ParserRuleContext, + invokingState: number) + parameters: + - id: parent + type: undefined | ParserRuleContext + description: '' + - id: invokingState + type: number + description: '' +properties: + - name: ruleIndex + uid: adaptive-expressions-ie11.TextContentContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.TextContentContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.altNumber + - name: childCount + uid: adaptive-expressions-ie11.TextContentContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.childCount + - name: children + uid: adaptive-expressions-ie11.TextContentContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: Inherited From ParserRuleContext.children + - name: exception + uid: adaptive-expressions-ie11.TextContentContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: Inherited From ParserRuleContext.exception + - name: invokingState + uid: adaptive-expressions-ie11.TextContentContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.invokingState + - name: isEmpty + uid: adaptive-expressions-ie11.TextContentContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ParserRuleContext.isEmpty + - name: parent + uid: adaptive-expressions-ie11.TextContentContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.parent + - name: payload + uid: adaptive-expressions-ie11.TextContentContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.payload + - name: ruleContext + uid: adaptive-expressions-ie11.TextContentContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: TextContentContext' + return: + description: '' + type: + inheritanceDescription: Inherited From ParserRuleContext.ruleContext + - name: sourceInterval + uid: adaptive-expressions-ie11.TextContentContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + - name: start + uid: adaptive-expressions-ie11.TextContentContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: Inherited From ParserRuleContext.start + - name: stop + uid: adaptive-expressions-ie11.TextContentContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: Inherited From ParserRuleContext.stop + - name: text + uid: adaptive-expressions-ie11.TextContentContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.text +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.TextContentContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.TextContentContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.TextContentContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addChild(Token) + uid: adaptive-expressions-ie11.TextContentContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.addChild + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.TextContentContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.TextContentContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + - name: copyFrom(ParserRuleContext) + uid: adaptive-expressions-ie11.TextContentContext.copyFrom + package: adaptive-expressions-ie11 + summary: |- + COPY a ctx (I'm deliberately not using copy constructor) to avoid + confusion with creating node with parent. Does not copy children + (except error leaves). + + This is used in the generated parser code to flip a generic XContext + node for rule X to a YContext for alt label Y. In that sense, it is not + really a generic copy function. + + If we do an error sync() at start of a rule, we might add error nodes + to the generic XContext so this function must copy those nodes to the + YContext as well else they are lost! + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ParserRuleContext)' + parameters: + - id: ctx + type: ParserRuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.copyFrom + - name: depth() + uid: adaptive-expressions-ie11.TextContentContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ParserRuleContext.depth + - name: emptyContext() + uid: adaptive-expressions-ie11.TextContentContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: Inherited From ParserRuleContext.emptyContext + - name: getChild(number) + uid: adaptive-expressions-ie11.TextContentContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TextContentContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getChild + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.TextContentContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TextContentContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From ParserRuleContext.getRuleContext + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.TextContentContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts + - name: getToken(number, number) + uid: adaptive-expressions-ie11.TextContentContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.getToken + - name: getTokens(number) + uid: adaptive-expressions-ie11.TextContentContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: Inherited From ParserRuleContext.getTokens + - name: removeLastChild() + uid: adaptive-expressions-ie11.TextContentContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.TextContentContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: Inherited From ParserRuleContext.setParent + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.TextContentContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toInfoString + - name: toString() + uid: adaptive-expressions-ie11.TextContentContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.TextContentContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.TextContentContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.TextContentContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.TextContentContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toStringTree() + uid: adaptive-expressions-ie11.TextContentContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.TextContentContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.TextContentContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TextContentContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetChild + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TextContentContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.TextContentContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: Inherited From ParserRuleContext.tryGetToken +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.TextContentContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.TextContentContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.TextContentContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: TEXT_CONTENT() + uid: adaptive-expressions-ie11.TextContentContext.TEXT_CONTENT + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function TEXT_CONTENT(): TerminalNode[]' + return: + description: '' + type: TerminalNode[] + - name: TEXT_CONTENT(number) + uid: adaptive-expressions-ie11.TextContentContext.TEXT_CONTENT_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function TEXT_CONTENT(i: number): TerminalNode' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode +extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeTransformEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeTransformEvaluator.yml new file mode 100644 index 00000000..7aef0b55 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeTransformEvaluator.yml @@ -0,0 +1,115 @@ +### YamlMime:TSType +name: TimeTransformEvaluator +uid: adaptive-expressions-ie11.TimeTransformEvaluator +package: adaptive-expressions-ie11 +summary: Evaluator that transforms a datetime to another datetime. +fullName: TimeTransformEvaluator +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + TimeTransformEvaluator(string, (timestamp: Date, numOfTransformation: + number) => Date) + uid: adaptive-expressions-ie11.TimeTransformEvaluator.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [TimeTransformEvaluator](xref:adaptive-expressions.TimeTransformEvaluator) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new TimeTransformEvaluator(type: string, func: (timestamp: Date, + numOfTransformation: number) => Date) + parameters: + - id: type + type: string + description: Name of the built-in function. + - id: func + type: '(timestamp: Date, numOfTransformation: number) => Date' + description: >- + The evaluation function, it takes a timestamp and the number of + transformation, and returns a `Date`. +inheritedProperties: + - name: negation + uid: adaptive-expressions-ie11.TimeTransformEvaluator.negation + package: adaptive-expressions-ie11 + summary: Sets the evaluator that is a negation of this one. + fullName: negation + remarks: '' + isDeprecated: false + syntax: + content: 'negation: ExpressionEvaluator' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions-ie11.ExpressionEvaluator.negation) + - name: returnType + uid: adaptive-expressions-ie11.TimeTransformEvaluator.returnType + package: adaptive-expressions-ie11 + summary: Type expected by evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.returnType](xref:adaptive-expressions-ie11.ExpressionEvaluator.returnType) + - name: tryEvaluate + uid: adaptive-expressions-ie11.TimeTransformEvaluator.tryEvaluate + package: adaptive-expressions-ie11 + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions-ie11.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions-ie11.TimeTransformEvaluator.type + package: adaptive-expressions-ie11 + summary: Gets the expression type for evaluator. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.type](xref:adaptive-expressions-ie11.ExpressionEvaluator.type) + - name: validateExpression + uid: adaptive-expressions-ie11.TimeTransformEvaluator.validateExpression + package: adaptive-expressions-ie11 + summary: Validate an expression. + fullName: validateExpression + remarks: '' + isDeprecated: false + syntax: + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.validateExpression](xref:adaptive-expressions-ie11.ExpressionEvaluator.validateExpression) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeZoneConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeZoneConverter.yml new file mode 100644 index 00000000..b6d80a9d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TimeZoneConverter.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: TimeZoneConverter +uid: adaptive-expressions-ie11.TimeZoneConverter +package: adaptive-expressions-ie11 +summary: >- + Time zone converter. + + (1) From Windows (.NET) timezone to iana timezone. + + (2) From iana timezone to windows (.NET) timezone. + + windows ref: + https://support.microsoft.com/en-us/help/22803/daylight-saving-time. + + iana ref: https://www.iana.org/time-zones. +fullName: TimeZoneConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: ianaToWindows(string) + uid: adaptive-expressions-ie11.TimeZoneConverter.ianaToWindows + package: adaptive-expressions-ie11 + summary: convert IANA timezone format to windows timezone format. + remarks: '' + isDeprecated: false + syntax: + content: 'static function ianaToWindows(ianaTimeZoneId: string): string' + parameters: + - id: ianaTimeZoneId + type: string + description: IANA timezone format. + return: + description: windows timezone format. + type: string + - name: verifyTimeZoneStr(string) + uid: adaptive-expressions-ie11.TimeZoneConverter.verifyTimeZoneStr + package: adaptive-expressions-ie11 + summary: Verify the string is windows timezone or iana string + remarks: '' + isDeprecated: false + syntax: + content: 'static function verifyTimeZoneStr(timezoneStr: string): boolean' + parameters: + - id: timezoneStr + type: string + description: time zone string + return: + description: is the string is time zone string + type: boolean + - name: windowsToIana(string) + uid: adaptive-expressions-ie11.TimeZoneConverter.windowsToIana + package: adaptive-expressions-ie11 + summary: Convert windows timezone to iana timezone. + remarks: '' + isDeprecated: false + syntax: + content: 'static function windowsToIana(windowsTimeZoneId: string): string' + parameters: + - id: windowsTimeZoneId + type: string + description: Windows timezone format. + return: + description: Iana timezone format. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Trigger.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Trigger.yml new file mode 100644 index 00000000..59ff2468 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Trigger.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Trigger +uid: adaptive-expressions-ie11.Trigger +package: adaptive-expressions-ie11 +summary: >- + A trigger is a combination of a trigger expression and the corresponding + action. +fullName: Trigger +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Trigger(TriggerTree, Expression, any, Quantifier[]) + uid: adaptive-expressions-ie11.Trigger.constructor + package: adaptive-expressions-ie11 + summary: Intializes a new instance of the `Trigger` class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new Trigger(tree: TriggerTree, expression?: Expression, action?: any, + quantifiers: Quantifier[]) + parameters: + - id: tree + type: + description: Trigger tree that contains this trigger. + - id: expression + type: + description: Expression for when the trigger action is possible. + - id: action + type: any + description: Action to take when a trigger matches. + - id: quantifiers + type: [] + description: Quantifiers to dynamically expand the expression. +properties: + - name: action + uid: adaptive-expressions-ie11.Trigger.action + package: adaptive-expressions-ie11 + summary: Action to take when trigger is true. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: any' + return: + description: '' + type: any + - name: clauses + uid: adaptive-expressions-ie11.Trigger.clauses + package: adaptive-expressions-ie11 + summary: >- + Gets list of expressions converted into Disjunctive Normal Form where ! is + pushed to the leaves and + + there is an implicit || between clauses and && within a clause. + fullName: clauses + remarks: '' + isDeprecated: false + syntax: + content: 'clauses: Clause[]' + return: + description: The list of clauses. + type: [] + - name: originalExpression + uid: adaptive-expressions-ie11.Trigger.originalExpression + package: adaptive-expressions-ie11 + summary: Original trigger expression. + fullName: originalExpression + remarks: '' + isDeprecated: false + syntax: + content: 'originalExpression: Expression' + return: + description: '' + type: +methods: + - name: matches(Clause, any) + uid: adaptive-expressions-ie11.Trigger.matches + package: adaptive-expressions-ie11 + summary: >- + Determines whether there is a member in the current `Clause` that matches + the nodeClause parameter. + remarks: '' + isDeprecated: false + syntax: + content: 'function matches(nodeClause: Clause, state: any): boolean' + parameters: + - id: nodeClause + type: + description: The other Clause instance to match. + - id: state + type: any + description: The scope for looking up variables. + return: + description: A boolean value inidicating whether there is a member matches. + type: boolean + - name: relationship(Trigger, PredicateComparers) + uid: adaptive-expressions-ie11.Trigger.relationship + package: adaptive-expressions-ie11 + summary: >- + Determines the relationship between current instance and another `Trigger` + instance. + remarks: '' + isDeprecated: false + syntax: + content: >- + function relationship(other: Trigger, comparers: PredicateComparers): + RelationshipType + parameters: + - id: other + type: + description: The other Trigger instance. + - id: comparers + type: + description: The comparer dictionary. + return: + description: A `RelationshipType` value. + type: + - name: toString(string[], number) + uid: adaptive-expressions-ie11.Trigger.toString + package: adaptive-expressions-ie11 + summary: Gets a string that represents the current trigger. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(builder?: string[], indent?: number): string' + parameters: + - id: builder + type: string[] + description: An array of string to build the string of trigger. + - id: indent + type: number + description: An integer represents the number of spaces at the start of a line. + return: + description: A string that represents the current trigger. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TriggerTree.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TriggerTree.yml new file mode 100644 index 00000000..3e34a987 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TriggerTree.yml @@ -0,0 +1,160 @@ +### YamlMime:TSType +name: TriggerTree +uid: adaptive-expressions-ie11.TriggerTree +package: adaptive-expressions-ie11 +summary: >- + A trigger tree organizes evaluators according to generalization/specialization + in order to make it easier to use rules. +fullName: TriggerTree +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TriggerTree() + uid: adaptive-expressions-ie11.TriggerTree.constructor + package: adaptive-expressions-ie11 + summary: Intializes a new instance of the `TriggerTree` class. + remarks: '' + isDeprecated: false + syntax: + content: new TriggerTree() +properties: + - name: comparers + uid: adaptive-expressions-ie11.TriggerTree.comparers + package: adaptive-expressions-ie11 + summary: A dictionary of `PredicateComparer` values, with string keys. + fullName: comparers + remarks: '' + isDeprecated: false + syntax: + content: 'comparers: PredicateComparers' + return: + description: '' + type: + - name: optimizers + uid: adaptive-expressions-ie11.TriggerTree.optimizers + package: adaptive-expressions-ie11 + summary: A list of `Optimizer` for optimizing claues. + fullName: optimizers + remarks: '' + isDeprecated: false + syntax: + content: 'optimizers: Optimizer[]' + return: + description: '' + type: [] + - name: root + uid: adaptive-expressions-ie11.TriggerTree.root + package: adaptive-expressions-ie11 + summary: The root node instance. + fullName: root + remarks: '' + isDeprecated: false + syntax: + content: 'root: Node' + return: + description: '' + type: + - name: totalTriggers + uid: adaptive-expressions-ie11.TriggerTree.totalTriggers + package: adaptive-expressions-ie11 + summary: The total number of triggers. + fullName: totalTriggers + remarks: '' + isDeprecated: false + syntax: + content: 'totalTriggers: number' + return: + description: '' + type: number +methods: + - name: addTrigger(string | Expression, any, Quantifier[]) + uid: adaptive-expressions-ie11.TriggerTree.addTrigger + package: adaptive-expressions-ie11 + summary: Add a trigger expression to the tree. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addTrigger(stringOrExpression: string | Expression, action: + any, quantifiers: Quantifier[]): Trigger + parameters: + - id: stringOrExpression + type: string | + description: Trigger to add. + - id: action + type: any + description: Action when triggered. + - id: quantifiers + type: [] + description: Quantifiers to use when expanding expressions. + return: + description: New trigger. + type: + - name: matches(any) + uid: adaptive-expressions-ie11.TriggerTree.matches + package: adaptive-expressions-ie11 + summary: Return the possible matches given the current state. + remarks: '' + isDeprecated: false + syntax: + content: 'function matches(state: any): Trigger[]' + parameters: + - id: state + type: any + description: State to evaluate against. + return: + description: List of possible matches. + type: [] + - name: removeTrigger(Trigger) + uid: adaptive-expressions-ie11.TriggerTree.removeTrigger + package: adaptive-expressions-ie11 + summary: Remove trigger from tree. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeTrigger(trigger: Trigger): boolean' + parameters: + - id: trigger + type: + description: Trigger to remove. + return: + description: True if removed trigger. + type: boolean + - name: toString() + uid: adaptive-expressions-ie11.TriggerTree.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: A string the represents the current object. + type: string + - name: treeToString(number) + uid: adaptive-expressions-ie11.TriggerTree.treeToString + package: adaptive-expressions-ie11 + summary: Generates a string describing the tree. + remarks: '' + isDeprecated: false + syntax: + content: 'function treeToString(indent?: number): string' + parameters: + - id: indent + type: number + description: Current indent level. + return: + description: String describing the tree. + type: string + - name: verifyTree() + uid: adaptive-expressions-ie11.TriggerTree.verifyTree + package: adaptive-expressions-ie11 + summary: Verify the tree meets specialization/generalization invariants. + remarks: '' + isDeprecated: false + syntax: + content: 'function verifyTree(): Node' + return: + description: Bad node if found. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TripleOpExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TripleOpExpContext.yml new file mode 100644 index 00000000..1142f33e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/TripleOpExpContext.yml @@ -0,0 +1,943 @@ +### YamlMime:TSType +name: TripleOpExpContext +uid: adaptive-expressions-ie11.TripleOpExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: TripleOpExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TripleOpExpContext(ExpressionContext) + uid: adaptive-expressions-ie11.TripleOpExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new TripleOpExpContext(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.TripleOpExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions-ie11.ExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.TripleOpExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions-ie11.ExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.TripleOpExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions-ie11.ExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.TripleOpExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions-ie11.ExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.TripleOpExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions-ie11.ExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.TripleOpExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions-ie11.ExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.TripleOpExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions-ie11.ExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.TripleOpExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions-ie11.ExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.TripleOpExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: TripleOpExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions-ie11.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.TripleOpExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.ExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.TripleOpExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.ExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.TripleOpExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions-ie11.ExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.TripleOpExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions-ie11.ExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.TripleOpExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions-ie11.ExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.TripleOpExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.ExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.TripleOpExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.TripleOpExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.TripleOpExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.TripleOpExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.TripleOpExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: copyFrom(ExpressionContext) + uid: adaptive-expressions-ie11.TripleOpExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.copyFrom](xref:adaptive-expressions-ie11.ExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.TripleOpExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions-ie11.ExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.TripleOpExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions-ie11.ExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.TripleOpExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TripleOpExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.TripleOpExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions-ie11.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TripleOpExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.TripleOpExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.TripleOpExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions-ie11.ExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.TripleOpExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions-ie11.ExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.TripleOpExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.ExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.TripleOpExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions-ie11.ExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.TripleOpExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions-ie11.ExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.TripleOpExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.TripleOpExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.TripleOpExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.TripleOpExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.TripleOpExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.TripleOpExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.TripleOpExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.TripleOpExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TripleOpExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.TripleOpExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.TripleOpExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.ExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.TripleOpExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: COLON() + uid: adaptive-expressions-ie11.TripleOpExpContext.COLON + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function COLON(): TerminalNode' + return: + description: '' + type: TerminalNode + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.TripleOpExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.TripleOpExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.TripleOpExpContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext[]' + return: + description: '' + type: [] + - name: expression(number) + uid: adaptive-expressions-ie11.TripleOpExpContext.expression_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(i: number): ExpressionContext' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: + - name: QUESTION_MARK() + uid: adaptive-expressions-ie11.TripleOpExpContext.QUESTION_MARK + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function QUESTION_MARK(): TerminalNode' + return: + description: '' + type: TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/UnaryOpExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/UnaryOpExpContext.yml new file mode 100644 index 00000000..1fd99e0a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/UnaryOpExpContext.yml @@ -0,0 +1,939 @@ +### YamlMime:TSType +name: UnaryOpExpContext +uid: adaptive-expressions-ie11.UnaryOpExpContext +package: adaptive-expressions-ie11 +summary: '' +fullName: UnaryOpExpContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: UnaryOpExpContext(ExpressionContext) + uid: adaptive-expressions-ie11.UnaryOpExpContext.constructor + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new UnaryOpExpContext(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' +inheritedProperties: + - name: altNumber + uid: adaptive-expressions-ie11.UnaryOpExpContext.altNumber + package: adaptive-expressions-ie11 + summary: |- + Set the outer alternative number for this context node. Default + implementation does nothing to avoid backing field overhead for + trees that don't need it. Create + a subclass of ParserRuleContext with backing field and set + option contextSuperClass. + fullName: altNumber + remarks: '' + isDeprecated: false + syntax: + content: 'altNumber: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions-ie11.ExpressionContext.altNumber) + - name: childCount + uid: adaptive-expressions-ie11.UnaryOpExpContext.childCount + package: adaptive-expressions-ie11 + summary: '' + fullName: childCount + remarks: '' + isDeprecated: false + syntax: + content: 'childCount: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions-ie11.ExpressionContext.childCount) + - name: children + uid: adaptive-expressions-ie11.UnaryOpExpContext.children + package: adaptive-expressions-ie11 + summary: |- + If we are debugging or building a parse tree for a visitor, + we need to track all of the tokens and rule invocations associated + with this rule's context. This is empty for parsing w/o tree constr. + operation because we don't the need to track the details about + how we parse this rule. + fullName: children + remarks: '' + isDeprecated: false + syntax: + content: 'children?: ParseTree[]' + return: + description: '' + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions-ie11.ExpressionContext.children) + - name: exception + uid: adaptive-expressions-ie11.UnaryOpExpContext.exception + package: adaptive-expressions-ie11 + summary: |- + The exception that forced this rule to return. If the rule successfully + completed, this is `undefined`. + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception?: RecognitionException' + return: + description: '' + type: RecognitionException + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions-ie11.ExpressionContext.exception) + - name: invokingState + uid: adaptive-expressions-ie11.UnaryOpExpContext.invokingState + package: adaptive-expressions-ie11 + summary: '' + fullName: invokingState + remarks: '' + isDeprecated: false + syntax: + content: 'invokingState: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions-ie11.ExpressionContext.invokingState) + - name: isEmpty + uid: adaptive-expressions-ie11.UnaryOpExpContext.isEmpty + package: adaptive-expressions-ie11 + summary: |- + A context is empty if there is no invoking state; meaning nobody called + current context. + fullName: isEmpty + remarks: '' + isDeprecated: false + syntax: + content: 'isEmpty: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions-ie11.ExpressionContext.isEmpty) + - name: parent + uid: adaptive-expressions-ie11.UnaryOpExpContext.parent + package: adaptive-expressions-ie11 + summary: '' + fullName: parent + remarks: '' + isDeprecated: false + syntax: + content: 'parent: undefined | ParserRuleContext' + return: + description: '' + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions-ie11.ExpressionContext.parent) + - name: payload + uid: adaptive-expressions-ie11.UnaryOpExpContext.payload + package: adaptive-expressions-ie11 + summary: '' + fullName: payload + remarks: '' + isDeprecated: false + syntax: + content: 'payload: RuleContext' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions-ie11.ExpressionContext.payload) + - name: ruleContext + uid: adaptive-expressions-ie11.UnaryOpExpContext.ruleContext + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleContext + remarks: '' + isDeprecated: false + syntax: + content: 'ruleContext: UnaryOpExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions-ie11.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions-ie11.UnaryOpExpContext.ruleIndex + package: adaptive-expressions-ie11 + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions-ie11.ExpressionContext.ruleIndex) + - name: sourceInterval + uid: adaptive-expressions-ie11.UnaryOpExpContext.sourceInterval + package: adaptive-expressions-ie11 + summary: '' + fullName: sourceInterval + remarks: '' + isDeprecated: false + syntax: + content: 'sourceInterval: Interval' + return: + description: '' + type: Interval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions-ie11.ExpressionContext.sourceInterval) + - name: start + uid: adaptive-expressions-ie11.UnaryOpExpContext.start + package: adaptive-expressions-ie11 + summary: >- + Get the initial token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may exceed + stop. + fullName: start + remarks: '' + isDeprecated: false + syntax: + content: 'start: Token' + return: + description: '' + type: Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions-ie11.ExpressionContext.start) + - name: stop + uid: adaptive-expressions-ie11.UnaryOpExpContext.stop + package: adaptive-expressions-ie11 + summary: >- + Get the final token in this context. + + Note that the range from start to stop is inclusive, so for rules that do + not consume anything + + (for example, zero length or error productions) this token may precede + start. + fullName: stop + remarks: '' + isDeprecated: false + syntax: + content: 'stop: undefined | Token' + return: + description: '' + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions-ie11.ExpressionContext.stop) + - name: text + uid: adaptive-expressions-ie11.UnaryOpExpContext.text + package: adaptive-expressions-ie11 + summary: |- + Return the combined text of all child nodes. This method only considers + tokens which have been added to the parse tree. + + Since tokens on hidden channels (e.g. whitespace or comments) are not + added to the parse trees, they will not appear in the output of this + method. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions-ie11.ExpressionContext.text) +inheritedMethods: + - name: addAnyChild(T) + uid: adaptive-expressions-ie11.UnaryOpExpContext.addAnyChild + package: adaptive-expressions-ie11 + summary: |- + Add a parse tree node to this as a child. Works for + internal and leaf nodes. Does not set parent link; + other add methods must do that. Other addChild methods + call this. + + We cannot set the parent pointer of the incoming node + because the existing interfaces do not have a setParent() + method and I don't want to break backward compatibility for this. + remarks: '' + isDeprecated: false + syntax: + content: 'function addAnyChild(t: T): T' + parameters: + - id: t + type: T + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions-ie11.ExpressionContext.addAnyChild) + - name: addChild(RuleContext) + uid: adaptive-expressions-ie11.UnaryOpExpContext.addChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(ruleInvocation: RuleContext)' + parameters: + - id: ruleInvocation + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(TerminalNode) + uid: adaptive-expressions-ie11.UnaryOpExpContext.addChild + package: adaptive-expressions-ie11 + summary: Add a token leaf node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addChild(t: TerminalNode)' + parameters: + - id: t + type: TerminalNode + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addChild(Token) + uid: adaptive-expressions-ie11.UnaryOpExpContext.addChild_2 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon matchedToken. It + + creates a TerminalNodeImpl rather than using + + [Token)](xref:Parser%23createTerminalNode(ParserRuleContext%2C). I'm + leaving this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addChild(matchedToken: Token): TerminalNode' + parameters: + - id: matchedToken + type: Token + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions-ie11.ExpressionContext.addChild) + - name: addErrorNode(ErrorNode) + uid: adaptive-expressions-ie11.UnaryOpExpContext.addErrorNode + package: adaptive-expressions-ie11 + summary: Add an error node child and force its parent to be this node. + remarks: '' + isDeprecated: false + syntax: + content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' + parameters: + - id: errorNode + type: ErrorNode + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: addErrorNode(Token) + uid: adaptive-expressions-ie11.UnaryOpExpContext.addErrorNode_1 + package: adaptive-expressions-ie11 + summary: >- + Add a child to this node based upon badToken. It + + creates a ErrorNode rather than using + + [Token)](xref:Parser%23createErrorNode(ParserRuleContext%2C). I'm leaving + this + + in for compatibility but the parser doesn't use this anymore. + remarks: '' + isDeprecated: true + customDeprecatedMessage: Use another overload instead. + syntax: + content: 'function addErrorNode(badToken: Token): ErrorNode' + parameters: + - id: badToken + type: Token + description: '' + return: + description: '' + type: ErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions-ie11.ExpressionContext.addErrorNode) + - name: copyFrom(ExpressionContext) + uid: adaptive-expressions-ie11.UnaryOpExpContext.copyFrom + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function copyFrom(ctx: ExpressionContext)' + parameters: + - id: ctx + type: + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.copyFrom](xref:adaptive-expressions-ie11.ExpressionContext.copyFrom) + - name: depth() + uid: adaptive-expressions-ie11.UnaryOpExpContext.depth + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function depth(): number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions-ie11.ExpressionContext.depth) + - name: emptyContext() + uid: adaptive-expressions-ie11.UnaryOpExpContext.emptyContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function emptyContext(): ParserRuleContext' + return: + description: '' + type: ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions-ie11.ExpressionContext.emptyContext) + - name: getChild(number) + uid: adaptive-expressions-ie11.UnaryOpExpContext.getChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number): ParseTree' + parameters: + - id: i + type: number + description: '' + return: + description: '' + type: ParseTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.UnaryOpExpContext.getChild_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions-ie11.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) + uid: adaptive-expressions-ie11.UnaryOpExpContext.getChildContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getChildContext(parent: RuleContext, invokingState: + number): RuleContext + parameters: + - id: parent + type: RuleContext + description: '' + - id: invokingState + type: number + description: '' + return: + description: '' + type: RuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions-ie11.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.UnaryOpExpContext.getRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' + uid: adaptive-expressions-ie11.UnaryOpExpContext.getRuleContexts + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' + parameters: + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions-ie11.ExpressionContext.getRuleContexts) + - name: getToken(number, number) + uid: adaptive-expressions-ie11.UnaryOpExpContext.getToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getToken(ttype: number, i: number): TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions-ie11.ExpressionContext.getToken) + - name: getTokens(number) + uid: adaptive-expressions-ie11.UnaryOpExpContext.getTokens + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokens(ttype: number): TerminalNode[]' + parameters: + - id: ttype + type: number + description: '' + return: + description: '' + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions-ie11.ExpressionContext.getTokens) + - name: removeLastChild() + uid: adaptive-expressions-ie11.UnaryOpExpContext.removeLastChild + package: adaptive-expressions-ie11 + summary: |- + Used by enterOuterAlt to toss out a RuleContext previously added as + we entered a rule. If we have # label, we will need to remove + generic ruleContext object. + remarks: '' + isDeprecated: false + syntax: + content: function removeLastChild() + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions-ie11.ExpressionContext.removeLastChild) + - name: setParent(RuleContext) + uid: adaptive-expressions-ie11.UnaryOpExpContext.setParent + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setParent(parent: RuleContext)' + parameters: + - id: parent + type: RuleContext + description: '' + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions-ie11.ExpressionContext.setParent) + - name: toInfoString(Parser) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toInfoString + package: adaptive-expressions-ie11 + summary: >- + Used for rule context info debugging during parse-time, not so much for + ATN debugging + remarks: '' + isDeprecated: false + syntax: + content: 'function toInfoString(recognizer: Parser): string' + parameters: + - id: recognizer + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions-ie11.ExpressionContext.toInfoString) + - name: toString() + uid: adaptive-expressions-ie11.UnaryOpExpContext.toString + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toString_1 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(recog: undefined | Recognizer): string' + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toString_3 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string + parameters: + - id: recog + type: undefined | Recognizer<any, any> + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[]) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toString_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toString_4 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + - id: stop + type: undefined | RuleContext + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions-ie11.ExpressionContext.toString) + - name: toStringTree() + uid: adaptive-expressions-ie11.UnaryOpExpContext.toStringTree_2 + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(): string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(Parser) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toStringTree + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + We have to know the recognizer so we can get rule names. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(recog: Parser): string' + parameters: + - id: recog + type: Parser + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) + uid: adaptive-expressions-ie11.UnaryOpExpContext.toStringTree_1 + package: adaptive-expressions-ie11 + summary: |- + Print out a whole tree, not just a node, in LISP format + (root child1 .. childN). Print just a node if this is a leaf. + remarks: '' + isDeprecated: false + syntax: + content: 'function toStringTree(ruleNames: undefined | string[]): string' + parameters: + - id: ruleNames + type: undefined | string[] + description: '' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions-ie11.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.UnaryOpExpContext.tryGetChild + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions-ie11.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' + uid: adaptive-expressions-ie11.UnaryOpExpContext.tryGetRuleContext + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T + parameters: + - id: i + type: number + description: '' + - id: ctxType + type: '(args: any[]) => T' + description: '' + return: + description: '' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions-ie11.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) + uid: adaptive-expressions-ie11.UnaryOpExpContext.tryGetToken + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' + parameters: + - id: ttype + type: number + description: '' + - id: i + type: number + description: '' + return: + description: '' + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions-ie11.ExpressionContext.tryGetToken) +methods: + - name: accept(ExpressionAntlrParserVisitor) + uid: adaptive-expressions-ie11.UnaryOpExpContext.accept + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function accept(visitor: ExpressionAntlrParserVisitor): + Result + parameters: + - id: visitor + type: >- + <Result> + description: '' + return: + description: '' + type: Result + - name: enterRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.UnaryOpExpContext.enterRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function enterRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: exitRule(ExpressionAntlrParserListener) + uid: adaptive-expressions-ie11.UnaryOpExpContext.exitRule + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function exitRule(listener: ExpressionAntlrParserListener)' + parameters: + - id: listener + type: >- + + description: '' + - name: expression() + uid: adaptive-expressions-ie11.UnaryOpExpContext.expression + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function expression(): ExpressionContext' + return: + description: '' + type: + - name: NON() + uid: adaptive-expressions-ie11.UnaryOpExpContext.NON + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function NON(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: PLUS() + uid: adaptive-expressions-ie11.UnaryOpExpContext.PLUS + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function PLUS(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode + - name: SUBSTRACT() + uid: adaptive-expressions-ie11.UnaryOpExpContext.SUBSTRACT + package: adaptive-expressions-ie11 + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function SUBSTRACT(): undefined | TerminalNode' + return: + description: '' + type: undefined | TerminalNode +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Util.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Util.yml new file mode 100644 index 00000000..dc8e1ed2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/Util.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: Util +uid: adaptive-expressions-ie11.Util +package: adaptive-expressions-ie11 +summary: util class +fullName: Util +remarks: '' +isDeprecated: false +type: class +methods: + - name: trim(string, string) + uid: adaptive-expressions-ie11.Util.trim + package: adaptive-expressions-ie11 + summary: trim char. + remarks: '' + isDeprecated: false + syntax: + content: 'static function trim(str: string, char: string): string' + parameters: + - id: str + type: string + description: input string. + - id: char + type: string + description: trim character. + return: + description: The trimmed char. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValidateExpressionDelegate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValidateExpressionDelegate.yml new file mode 100644 index 00000000..a563b3a2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValidateExpressionDelegate.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ValidateExpressionDelegate +uid: adaptive-expressions-ie11.ValidateExpressionDelegate +package: adaptive-expressions-ie11 +summary: |- + Delegate for doing static validation on an expression. + Validators can and should throw exceptions if the expression is not valid. +fullName: ValidateExpressionDelegate +remarks: '' +isDeprecated: false +syntax: | + type ValidateExpressionDelegate = (expression: Expression) => any diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpression.yml new file mode 100644 index 00000000..e792da26 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpression.yml @@ -0,0 +1,149 @@ +### YamlMime:TSType +name: ValueExpression +uid: adaptive-expressions-ie11.ValueExpression +package: adaptive-expressions-ie11 +summary: Represents a property which is an object of any kind or a string expression. +fullName: ValueExpression +remarks: >- + If the value is + + - a string with '=' prefix then the string is treated as an expression to + resolve to a string. + + - a string without '=' then value is treated as string with string + interpolation. + + - You can escape the '=' prefix by putting a backslash. + + Examples: + prop = "Hello @{user.name}" => "Hello Joe" + prop = "=length(user.name)" => "3" + prop = "=user.name" => "Joe" + prop = "\=user" => "=user". +isDeprecated: false +type: class +constructors: + - name: ValueExpression(any) + uid: adaptive-expressions-ie11.ValueExpression.constructor + package: adaptive-expressions-ie11 + summary: >- + Initializes a new instance of the + [ValueExpression](xref:adaptive-expressions.ValueExpression) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new ValueExpression(value?: any)' + parameters: + - id: value + type: any + description: An object of `any` kind or a `string` expression. +inheritedProperties: + - name: expressionText + uid: adaptive-expressions-ie11.ValueExpression.expressionText + package: adaptive-expressions-ie11 + summary: Getes or sets the expression text to evaluate to get the value. + fullName: expressionText + remarks: '' + isDeprecated: false + syntax: + content: 'expressionText: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.expressionText](xref:adaptive-expressions-ie11.ExpressionProperty.expressionText) + - name: value + uid: adaptive-expressions-ie11.ValueExpression.value + package: adaptive-expressions-ie11 + summary: Gets or sets the raw value of the expression property. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [ExpressionProperty.value](xref:adaptive-expressions-ie11.ExpressionProperty.value) +inheritedMethods: + - name: getValue(object) + uid: adaptive-expressions-ie11.ValueExpression.getValue + package: adaptive-expressions-ie11 + summary: Get the value. + remarks: An error will be thrown if value is an invalid expression. + isDeprecated: false + syntax: + content: 'function getValue(data: object): any' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: The value. + type: any + inheritanceDescription: >- + Inherited From + [ExpressionProperty.getValue](xref:adaptive-expressions-ie11.ExpressionProperty.getValue) + - name: toExpression() + uid: adaptive-expressions-ie11.ValueExpression.toExpression + package: adaptive-expressions-ie11 + summary: This will return the existing expression if the value is non-complex type. + remarks: '' + isDeprecated: false + syntax: + content: 'function toExpression(): Expression' + return: + description: The existing expression if the value is non-complex type. + type: + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toExpression](xref:adaptive-expressions-ie11.ExpressionProperty.toExpression) + - name: toString() + uid: adaptive-expressions-ie11.ValueExpression.toString + package: adaptive-expressions-ie11 + summary: Convert an expression property to string. + remarks: '' + isDeprecated: false + syntax: + content: 'function toString(): string' + return: + description: The converted string. + type: string + inheritanceDescription: >- + Inherited From + [ExpressionProperty.toString](xref:adaptive-expressions-ie11.ExpressionProperty.toString) + - name: tryGetValue(object) + uid: adaptive-expressions-ie11.ValueExpression.tryGetValue + package: adaptive-expressions-ie11 + summary: Try to Get the value. + remarks: '' + isDeprecated: false + syntax: + content: 'function tryGetValue(data: object): { error: Error, value: any }' + parameters: + - id: data + type: object + description: Data to use for expression binding. + return: + description: the value or an error. + type: '{ error: Error, value: any }' + inheritanceDescription: >- + Inherited From + [ExpressionProperty.tryGetValue](xref:adaptive-expressions-ie11.ExpressionProperty.tryGetValue) +methods: + - name: setValue(any) + uid: adaptive-expressions-ie11.ValueExpression.setValue + package: adaptive-expressions-ie11 + summary: Set value as value expression. + remarks: '' + isDeprecated: false + syntax: + content: 'function setValue(value: any)' + parameters: + - id: value + type: any + description: Value to set. +extends: <any> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpressionConverter.yml new file mode 100644 index 00000000..3f3a3447 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueExpressionConverter.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: ValueExpressionConverter +uid: adaptive-expressions-ie11.ValueExpressionConverter +package: adaptive-expressions-ie11 +summary: >- + `any` value to json + [ValueExpression](xref:adaptive-expressions.ValueExpression) converter. +fullName: ValueExpressionConverter +remarks: '' +isDeprecated: false +type: class +methods: + - name: convert(unknown) + uid: adaptive-expressions-ie11.ValueExpressionConverter.convert + package: adaptive-expressions-ie11 + summary: >- + Converts `any` value into a + [ValueExpression](xref:adaptive-expressions.ValueExpression). + remarks: '' + isDeprecated: false + syntax: + content: 'function convert(value: unknown): ValueExpression' + parameters: + - id: value + type: unknown + description: '`any` value to convert.' + return: + description: The [ValueExpression](xref:adaptive-expressions.ValueExpression). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueWithError.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueWithError.yml new file mode 100644 index 00000000..f72ffd94 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/ValueWithError.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ValueWithError +uid: adaptive-expressions-ie11.ValueWithError +package: adaptive-expressions-ie11 +summary: Value result with error. +fullName: ValueWithError +remarks: '' +isDeprecated: false +syntax: | + type ValueWithError = { error: string; value: any } diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/VerifyExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/VerifyExpression.yml new file mode 100644 index 00000000..66029b73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/VerifyExpression.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: VerifyExpression +uid: adaptive-expressions-ie11.VerifyExpression +package: adaptive-expressions-ie11 +summary: >- + Verify the result of an expression is of the appropriate type and return a + string if not. +fullName: VerifyExpression +remarks: '' +isDeprecated: false +syntax: | + type VerifyExpression = ( + value: any, + expression: Expression, + child: number + ) => string | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/index.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/index.yml new file mode 100644 index 00000000..eff15548 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions-ie11/index.yml @@ -0,0 +1,148 @@ +### YamlMime:TSPackage +uid: adaptive-expressions-ie11 +name: adaptive-expressions-ie11 +summary: '' +type: package +enums: + - adaptive-expressions-ie11.QuantifierType + - adaptive-expressions-ie11.RelationshipType + - adaptive-expressions-ie11.ReturnType +classes: + - adaptive-expressions-ie11.Alpha_numsContext + - adaptive-expressions-ie11.AlternationContext + - adaptive-expressions-ie11.ArgsListContext + - adaptive-expressions-ie11.ArrayCreationExpContext + - adaptive-expressions-ie11.ArrayExpression + - adaptive-expressions-ie11.ArrayExpressionConverter + - adaptive-expressions-ie11.AtomContext + - adaptive-expressions-ie11.BinaryOpExpContext + - adaptive-expressions-ie11.BoolExpression + - adaptive-expressions-ie11.BoolExpressionConverter + - adaptive-expressions-ie11.CaptureContext + - adaptive-expressions-ie11.Cc_atomContext + - adaptive-expressions-ie11.Cc_literalContext + - adaptive-expressions-ie11.Character_classContext + - adaptive-expressions-ie11.Clause + - adaptive-expressions-ie11.CommonRegex + - adaptive-expressions-ie11.CommonRegexLexer + - adaptive-expressions-ie11.CommonRegexParser + - adaptive-expressions-ie11.ComparisonEvaluator + - adaptive-expressions-ie11.Constant + - adaptive-expressions-ie11.DigitContext + - adaptive-expressions-ie11.DigitsContext + - adaptive-expressions-ie11.ElementContext + - adaptive-expressions-ie11.EnumExpression + - adaptive-expressions-ie11.EnumExpressionConverter + - adaptive-expressions-ie11.ExprContext + - adaptive-expressions-ie11.Expression + - adaptive-expressions-ie11.ExpressionAntlrLexer + - adaptive-expressions-ie11.ExpressionAntlrParser + - adaptive-expressions-ie11.ExpressionContext + - adaptive-expressions-ie11.ExpressionConverter + - adaptive-expressions-ie11.ExpressionEvaluator + - adaptive-expressions-ie11.ExpressionFunctions + - adaptive-expressions-ie11.ExpressionParser + - adaptive-expressions-ie11.ExpressionProperty + - adaptive-expressions-ie11.ExpressionType + - adaptive-expressions-ie11.Extensions + - adaptive-expressions-ie11.FileContext + - adaptive-expressions-ie11.FuncInvokeExpContext + - adaptive-expressions-ie11.FunctionTable + - adaptive-expressions-ie11.FunctionUtils + - adaptive-expressions-ie11.IdAtomContext + - adaptive-expressions-ie11.IndexAccessExpContext + - adaptive-expressions-ie11.IntExpression + - adaptive-expressions-ie11.IntExpressionConverter + - adaptive-expressions-ie11.JsonCreationExpContext + - adaptive-expressions-ie11.KeyContext + - adaptive-expressions-ie11.KeyValuePairContext + - adaptive-expressions-ie11.KeyValuePairListContext + - adaptive-expressions-ie11.LambdaContext + - adaptive-expressions-ie11.LetterContext + - adaptive-expressions-ie11.LiteralContext + - adaptive-expressions-ie11.MemberAccessExpContext + - adaptive-expressions-ie11.MultivariateNumericEvaluator + - adaptive-expressions-ie11.NameContext + - adaptive-expressions-ie11.Node + - adaptive-expressions-ie11.Non_captureContext + - adaptive-expressions-ie11.Non_close_parenContext + - adaptive-expressions-ie11.Non_close_parensContext + - adaptive-expressions-ie11.NumberContext + - adaptive-expressions-ie11.NumberExpression + - adaptive-expressions-ie11.NumberExpressionConverter + - adaptive-expressions-ie11.NumberTransformEvaluator + - adaptive-expressions-ie11.NumericAtomContext + - adaptive-expressions-ie11.NumericEvaluator + - adaptive-expressions-ie11.ObjectExpression + - adaptive-expressions-ie11.ObjectExpressionConverter + - adaptive-expressions-ie11.Octal_charContext + - adaptive-expressions-ie11.Octal_digitContext + - adaptive-expressions-ie11.OptionContext + - adaptive-expressions-ie11.Option_flagContext + - adaptive-expressions-ie11.Options + - adaptive-expressions-ie11.ParenthesisExpContext + - adaptive-expressions-ie11.ParseContext + - adaptive-expressions-ie11.ParseErrorListener + - adaptive-expressions-ie11.PrimaryExpContext + - adaptive-expressions-ie11.PrimaryExpressionContext + - adaptive-expressions-ie11.Quantifier + - adaptive-expressions-ie11.QuantifierContext + - adaptive-expressions-ie11.Quantifier_typeContext + - adaptive-expressions-ie11.RegexErrorListener + - adaptive-expressions-ie11.Shared_atomContext + - adaptive-expressions-ie11.Shared_literalContext + - adaptive-expressions-ie11.SimpleObjectMemory + - adaptive-expressions-ie11.StackedMemory + - adaptive-expressions-ie11.StringAtomContext + - adaptive-expressions-ie11.StringExpression + - adaptive-expressions-ie11.StringExpressionConverter + - adaptive-expressions-ie11.StringInterpolationAtomContext + - adaptive-expressions-ie11.StringInterpolationContext + - adaptive-expressions-ie11.StringTransformEvaluator + - adaptive-expressions-ie11.TextContentContext + - adaptive-expressions-ie11.TimeTransformEvaluator + - adaptive-expressions-ie11.TimeZoneConverter + - adaptive-expressions-ie11.Trigger + - adaptive-expressions-ie11.TriggerTree + - adaptive-expressions-ie11.TripleOpExpContext + - adaptive-expressions-ie11.UnaryOpExpContext + - adaptive-expressions-ie11.Util + - adaptive-expressions-ie11.ValueExpression + - adaptive-expressions-ie11.ValueExpressionConverter +interfaces: + - adaptive-expressions-ie11.CommonRegexListener + - adaptive-expressions-ie11.CommonRegexVisitor + - adaptive-expressions-ie11.ExpressionAntlrParserListener + - adaptive-expressions-ie11.ExpressionAntlrParserVisitor + - adaptive-expressions-ie11.ExpressionParserInterface + - adaptive-expressions-ie11.MemoryInterface + - adaptive-expressions-ie11.Optimizer + - adaptive-expressions-ie11.PredicateComparer +typeAliases: + - adaptive-expressions-ie11.EvaluateExpressionDelegate + - adaptive-expressions-ie11.EvaluatorLookup + - adaptive-expressions-ie11.PredicateComparers + - adaptive-expressions-ie11.ValidateExpressionDelegate + - adaptive-expressions-ie11.ValueWithError + - adaptive-expressions-ie11.VerifyExpression +functions: + - name: convertCSharpDateTimeToDayjs(string) + uid: adaptive-expressions-ie11.convertCSharpDateTimeToDayjs + package: adaptive-expressions-ie11 + summary: >- + Convert a CSharp style datetime format string to a Day.js style datetime + format string. Ref: + https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings + remarks: '' + isDeprecated: false + syntax: + content: 'function convertCSharpDateTimeToDayjs(fmtString: string): string' + parameters: + - id: fmtString + type: string + description: >- + A CSharp style datetime format string. Ref: + https://day.js.org/docs/en/display/format + return: + description: A Momengt.js style datetime format string. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Abs.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Abs.yml deleted file mode 100644 index cd5701fa..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Abs.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Abs -uid: adaptive-expressions.Abs -package: adaptive-expressions -summary: Returns the absolute value of the specified number. -fullName: Abs -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Abs() - uid: adaptive-expressions.Abs.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Floor](xref:adaptive-expressions.Abs) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Abs() -properties: - - name: negation - uid: adaptive-expressions.Abs.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Abs.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Abs.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Abs.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Abs.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Accessor.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Accessor.yml deleted file mode 100644 index e0470d19..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Accessor.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Accessor -uid: adaptive-expressions.Accessor -package: adaptive-expressions -summary: Used to access the variable value corresponding to the path. -fullName: Accessor -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Accessor() - uid: adaptive-expressions.Accessor.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Accessor](xref:adaptive-expressions.Accessor) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Accessor() -properties: - - name: negation - uid: adaptive-expressions.Accessor.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Accessor.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Accessor.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Accessor.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Accessor.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Add.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Add.yml deleted file mode 100644 index 1862da20..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Add.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Add -uid: adaptive-expressions.Add -package: adaptive-expressions -summary: >- - Return the result from adding two or more numbers (pure number case) or - concatting two or more strings (other case). -fullName: Add -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Add() - uid: adaptive-expressions.Add.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Add](xref:adaptive-expressions.Add) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Add() -properties: - - name: negation - uid: adaptive-expressions.Add.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Add.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Add.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Add.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Add.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddDays.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddDays.yml deleted file mode 100644 index 0ad862d1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddDays.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: AddDays -uid: adaptive-expressions.AddDays -package: adaptive-expressions -summary: Add a number of days to a timestamp. -fullName: AddDays -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddDays() - uid: adaptive-expressions.AddDays.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddDays](xref:adaptive-expressions.AddDays) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddDays() -properties: - - name: negation - uid: adaptive-expressions.AddDays.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddDays.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddDays.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddDays.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddDays.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddHours.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddHours.yml deleted file mode 100644 index d7007e45..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddHours.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: AddHours -uid: adaptive-expressions.AddHours -package: adaptive-expressions -summary: Add a number of hours to a timestamp. -fullName: AddHours -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddHours() - uid: adaptive-expressions.AddHours.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddHours](xref:adaptive-expressions.AddHours) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddHours() -properties: - - name: negation - uid: adaptive-expressions.AddHours.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddHours.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddHours.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddHours.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddHours.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddMinutes.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddMinutes.yml deleted file mode 100644 index 978f6071..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddMinutes.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: AddMinutes -uid: adaptive-expressions.AddMinutes -package: adaptive-expressions -summary: Add a number of minutes to a timestamp. -fullName: AddMinutes -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddMinutes() - uid: adaptive-expressions.AddMinutes.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddMinutes](xref:adaptive-expressions.AddMinutes) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddMinutes() -properties: - - name: negation - uid: adaptive-expressions.AddMinutes.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddMinutes.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddMinutes.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddMinutes.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddMinutes.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddOrdinal.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddOrdinal.yml deleted file mode 100644 index 64c4c833..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddOrdinal.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: AddOrdinal -uid: adaptive-expressions.AddOrdinal -package: adaptive-expressions -summary: Return the ordinal number of the input number. -fullName: AddOrdinal -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddOrdinal() - uid: adaptive-expressions.AddOrdinal.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddOrdinal](xref:adaptive-expressions.AddOrdinal) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddOrdinal() -properties: - - name: negation - uid: adaptive-expressions.AddOrdinal.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddOrdinal.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddOrdinal.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddOrdinal.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddOrdinal.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddProperty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddProperty.yml deleted file mode 100644 index 92fd3525..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddProperty.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: AddProperty -uid: adaptive-expressions.AddProperty -package: adaptive-expressions -summary: >- - Add a property and its value, or name-value pair, to a JSON object, and return - the updated object. - - If the object already exists at runtime the function throws an error. -fullName: AddProperty -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddProperty() - uid: adaptive-expressions.AddProperty.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddProperty](xref:adaptive-expressions.AddProperty) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddProperty() -properties: - - name: negation - uid: adaptive-expressions.AddProperty.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddProperty.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddProperty.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddProperty.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddProperty.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddSeconds.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddSeconds.yml deleted file mode 100644 index 14bc6aab..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddSeconds.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: AddSeconds -uid: adaptive-expressions.AddSeconds -package: adaptive-expressions -summary: Add a number of seconds to a timestamp. -fullName: AddSeconds -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddSeconds() - uid: adaptive-expressions.AddSeconds.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddSeconds](xref:adaptive-expressions.AddSeconds) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddSeconds() -properties: - - name: negation - uid: adaptive-expressions.AddSeconds.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddSeconds.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddSeconds.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddSeconds.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddSeconds.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddToTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddToTime.yml deleted file mode 100644 index 2bfb004c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AddToTime.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: AddToTime -uid: adaptive-expressions.AddToTime -package: adaptive-expressions -summary: Add a number of time units to a timestamp. -fullName: AddToTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AddToTime() - uid: adaptive-expressions.AddToTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [AddToTime](xref:adaptive-expressions.AddToTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AddToTime() -properties: - - name: negation - uid: adaptive-expressions.AddToTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.AddToTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.AddToTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.AddToTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.AddToTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/All.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/All.yml deleted file mode 100644 index 38937983..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/All.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: All -uid: adaptive-expressions.All -package: adaptive-expressions -summary: Determines whether all elements of a sequence satisfy a condition. -fullName: All -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: All() - uid: adaptive-expressions.All.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [All](xref:adaptive-expressions.All) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new All() -properties: - - name: negation - uid: adaptive-expressions.All.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.All.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.All.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.All.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.All.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Alpha_numsContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Alpha_numsContext.yml index 6d4fbfb6..8fee969b 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Alpha_numsContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Alpha_numsContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Alpha_numsContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Alpha_numsContext(ParserRuleContext | undefined, number)' + - name: Alpha_numsContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Alpha_numsContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Alpha_numsContext(parent: ParserRuleContext | undefined, + new Alpha_numsContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Alpha_numsContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Alpha_numsContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Alpha_numsContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Alpha_numsContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Alpha_numsContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Alpha_numsContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Alpha_numsContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Alpha_numsContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Alpha_numsContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Alpha_numsContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Alpha_numsContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Alpha_numsContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Alpha_numsContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Alpha_numsContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Alpha_numsContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Alpha_numsContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Alpha_numsContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Alpha_numsContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Alpha_numsContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Alpha_numsContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Alpha_numsContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Alpha_numsContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Alpha_numsContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Alpha_numsContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Alpha_numsContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Alpha_numsContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Alpha_numsContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Alpha_numsContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Alpha_numsContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Alpha_numsContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,19 +793,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digit(): DigitContext[]' return: description: '' - type: '[]' + type: [] - name: digit(number) uid: adaptive-expressions.Alpha_numsContext.digit_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digit(i: number): DigitContext' @@ -864,7 +819,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -877,7 +831,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -890,19 +843,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function letter(): LetterContext[]' return: description: '' - type: '[]' + type: [] - name: letter(number) uid: adaptive-expressions.Alpha_numsContext.letter_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function letter(i: number): LetterContext' @@ -918,19 +869,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function Underscore(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: Underscore(number) uid: adaptive-expressions.Alpha_numsContext.Underscore_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function Underscore(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AlternationContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AlternationContext.yml index d39bf21a..81ceb04a 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AlternationContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AlternationContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: AlternationContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AlternationContext(ParserRuleContext | undefined, number)' + - name: AlternationContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.AlternationContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new AlternationContext(parent: ParserRuleContext | undefined, + new AlternationContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.AlternationContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.AlternationContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.AlternationContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.AlternationContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.AlternationContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.AlternationContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.AlternationContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: AlternationContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.AlternationContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.AlternationContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.AlternationContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.AlternationContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.AlternationContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.AlternationContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.AlternationContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.AlternationContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.AlternationContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.AlternationContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.AlternationContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.AlternationContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.AlternationContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.AlternationContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.AlternationContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.AlternationContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.AlternationContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.AlternationContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.AlternationContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.AlternationContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.AlternationContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.AlternationContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -849,7 +805,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -862,19 +817,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expr(): ExprContext[]' return: description: '' - type: '[]' + type: [] - name: expr(number) uid: adaptive-expressions.AlternationContext.expr_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expr(i: number): ExprContext' @@ -890,19 +843,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function Pipe(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: Pipe(number) uid: adaptive-expressions.AlternationContext.Pipe_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function Pipe(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/And.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/And.yml deleted file mode 100644 index 81bfd5dd..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/And.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: And -uid: adaptive-expressions.And -package: adaptive-expressions -summary: >- - Return true if all expressions are true or return false if at least one - expression is false. -fullName: And -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: And() - uid: adaptive-expressions.And.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [And](xref:adaptive-expressions.And) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new And() -properties: - - name: negation - uid: adaptive-expressions.And.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.And.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.And.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.And.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.And.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Any.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Any.yml deleted file mode 100644 index 0e8897f7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Any.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Any -uid: adaptive-expressions.Any -package: adaptive-expressions -summary: Determines whether any element of a sequence satisfies a condition. -fullName: Any -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Any() - uid: adaptive-expressions.Any.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Any](xref:adaptive-expressions.Any) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Any() -properties: - - name: negation - uid: adaptive-expressions.Any.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Any.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Any.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Any.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Any.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArgsListContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArgsListContext.yml index 1fbd5ec4..dd2f1266 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArgsListContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArgsListContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: ArgsListContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ArgsListContext(ParserRuleContext | undefined, number)' + - name: ArgsListContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.ArgsListContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ArgsListContext(parent: ParserRuleContext | undefined, + new ArgsListContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.ArgsListContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.ArgsListContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.ArgsListContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.ArgsListContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.ArgsListContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.ArgsListContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.ArgsListContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ArgsListContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.ArgsListContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.ArgsListContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.ArgsListContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.ArgsListContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.ArgsListContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ArgsListContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ArgsListContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ArgsListContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ArgsListContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.ArgsListContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.ArgsListContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.ArgsListContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ArgsListContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ArgsListContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.ArgsListContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ArgsListContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.ArgsListContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.ArgsListContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ArgsListContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ArgsListContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ArgsListContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.ArgsListContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,19 +797,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COMMA(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: COMMA(number) uid: adaptive-expressions.ArgsListContext.COMMA_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COMMA(i: number): TerminalNode' @@ -868,7 +823,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -881,7 +835,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -894,19 +847,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext[]' return: description: '' - type: '[]' + type: [] - name: expression(number) uid: adaptive-expressions.ArgsListContext.expression_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(i: number): ExpressionContext' @@ -922,19 +873,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function lambda(): LambdaContext[]' return: description: '' - type: '[]' + type: [] - name: lambda(number) uid: adaptive-expressions.ArgsListContext.lambda_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function lambda(i: number): LambdaContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayCreationExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayCreationExpContext.yml index 3e638773..6136700a 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayCreationExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayCreationExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: ArrayCreationExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ArrayCreationExpContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.ArrayCreationExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.ArrayCreationExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.ArrayCreationExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.ArrayCreationExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.ArrayCreationExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.ArrayCreationExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.ArrayCreationExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.ArrayCreationExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.ArrayCreationExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.ArrayCreationExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ArrayCreationExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.ArrayCreationExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.ArrayCreationExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.ArrayCreationExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.ArrayCreationExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.ArrayCreationExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.ArrayCreationExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.ArrayCreationExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.ArrayCreationExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.ArrayCreationExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.ArrayCreationExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.ArrayCreationExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.ArrayCreationExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.ArrayCreationExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.ArrayCreationExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ArrayCreationExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ArrayCreationExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ArrayCreationExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ArrayCreationExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.ArrayCreationExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.ArrayCreationExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.ArrayCreationExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.ArrayCreationExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.ArrayCreationExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.ArrayCreationExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ArrayCreationExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ArrayCreationExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.ArrayCreationExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ArrayCreationExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.ArrayCreationExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.ArrayCreationExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ArrayCreationExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ArrayCreationExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ArrayCreationExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.ArrayCreationExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.ArrayCreationExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,19 +869,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function argsList(): ArgsListContext | undefined' + content: 'function argsList(): undefined | ArgsListContext' return: description: '' - type: | undefined + type: undefined | - name: CLOSE_SQUARE_BRACKET() uid: adaptive-expressions.ArrayCreationExpContext.CLOSE_SQUARE_BRACKET package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CLOSE_SQUARE_BRACKET(): TerminalNode' @@ -851,7 +891,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -864,7 +903,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -877,7 +915,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OPEN_SQUARE_BRACKET(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpression.yml index 119a4410..aa11e0c8 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpression.yml @@ -11,26 +11,23 @@ fullName: ArrayExpression remarks: >- String values are always interpreted as an expression, whether it has '=' prefix or not. -isPreview: false isDeprecated: false type: class constructors: - - name: 'ArrayExpression(T[] | string | Expression)' + - name: ArrayExpression(string | Expression | T[]) uid: adaptive-expressions.ArrayExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [ArrayExpression](xref:adaptive-expressions.ArrayExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ArrayExpression(value?: T[] | string | Expression)' + content: 'new ArrayExpression(value?: string | Expression | T[])' parameters: - id: value - type: 'T[] | string | ' - description: | - Value of `T[]` or a `string` expression to bind to a `T[]`. + type: string | | T[] + description: Value of `T[]` or a `string` expression to bind to a `T[]`. inheritedProperties: - name: expressionText uid: adaptive-expressions.ArrayExpression.expressionText @@ -38,7 +35,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -54,13 +50,12 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: T[]' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: >- Inherited From [ExpressionProperty.value](xref:adaptive-expressions.ExpressionProperty.value) @@ -70,7 +65,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): T[]' @@ -80,7 +74,7 @@ inheritedMethods: description: Data to use for expression binding. return: description: The value. - type: 'T[]' + type: T[] inheritanceDescription: >- Inherited From [ExpressionProperty.getValue](xref:adaptive-expressions.ExpressionProperty.getValue) @@ -89,7 +83,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -104,7 +97,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -119,7 +111,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: T[] }' @@ -134,18 +125,16 @@ inheritedMethods: Inherited From [ExpressionProperty.tryGetValue](xref:adaptive-expressions.ExpressionProperty.tryGetValue) methods: - - name: 'setValue(T[] | string | Expression)' + - name: setValue(string | Expression | T[]) uid: adaptive-expressions.ArrayExpression.setValue package: adaptive-expressions summary: Set an array value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: T[] | string | Expression)' + content: 'function setValue(value: string | Expression | T[])' parameters: - id: value - type: 'T[] | string | ' - description: | - Value to set. -extends: '<T[]>' + type: string | | T[] + description: Value to set. +extends: <T[]> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpressionConverter.yml index 0d00adb8..80835777 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ArrayExpressionConverter.yml @@ -7,7 +7,6 @@ summary: >- converter. fullName: ArrayExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -18,7 +17,6 @@ methods: Converts an array into an [ArrayExpression](xref:adaptive-expressions.ArrayExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,5 +29,5 @@ methods: /><T> description: '`array` to convert.' return: - description: 'The [ArrayExpression](xref:adaptive-expressions.ArrayExpression).' + description: The [ArrayExpression](xref:adaptive-expressions.ArrayExpression). type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AtomContext.yml index 745f83bc..872d1911 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AtomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/AtomContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: AtomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AtomContext(ParserRuleContext | undefined, number)' + - name: AtomContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.AtomContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new AtomContext(parent: ParserRuleContext | undefined, invokingState: + new AtomContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.AtomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.AtomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.AtomContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.AtomContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.AtomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.AtomContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.AtomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: AtomContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.AtomContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.AtomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.AtomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.AtomContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.AtomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.AtomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.AtomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.AtomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.AtomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.AtomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.AtomContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.AtomContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.AtomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.AtomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.AtomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.AtomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.AtomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.AtomContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.AtomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.AtomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.AtomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.AtomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,67 +793,61 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function capture(): CaptureContext | undefined' + content: 'function capture(): undefined | CaptureContext' return: description: '' - type: | undefined + type: undefined | - name: Caret() uid: adaptive-expressions.AtomContext.Caret package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Caret(): TerminalNode | undefined' + content: 'function Caret(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: character_class() uid: adaptive-expressions.AtomContext.character_class package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function character_class(): Character_classContext | undefined' + content: 'function character_class(): undefined | Character_classContext' return: description: '' - type: | undefined + type: undefined | - name: Dot() uid: adaptive-expressions.AtomContext.Dot package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Dot(): TerminalNode | undefined' + content: 'function Dot(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: EndOfSubject() uid: adaptive-expressions.AtomContext.EndOfSubject package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function EndOfSubject(): TerminalNode | undefined' + content: 'function EndOfSubject(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.AtomContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -909,7 +860,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -922,47 +872,43 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function literal(): LiteralContext | undefined' + content: 'function literal(): undefined | LiteralContext' return: description: '' - type: | undefined + type: undefined | - name: non_capture() uid: adaptive-expressions.AtomContext.non_capture package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function non_capture(): Non_captureContext | undefined' + content: 'function non_capture(): undefined | Non_captureContext' return: description: '' - type: | undefined + type: undefined | - name: option() uid: adaptive-expressions.AtomContext.option package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function option(): OptionContext | undefined' + content: 'function option(): undefined | OptionContext' return: description: '' - type: | undefined + type: undefined | - name: shared_atom() uid: adaptive-expressions.AtomContext.shared_atom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shared_atom(): Shared_atomContext | undefined' + content: 'function shared_atom(): undefined | Shared_atomContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Average.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Average.yml deleted file mode 100644 index 672c4caf..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Average.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Average -uid: adaptive-expressions.Average -package: adaptive-expressions -summary: Return the average of a numeric array. -fullName: Average -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Average() - uid: adaptive-expressions.Average.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Average](xref:adaptive-expressions.Average) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Average() -properties: - - name: negation - uid: adaptive-expressions.Average.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Average.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Average.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Average.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Average.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64.yml deleted file mode 100644 index 380c3f8e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Base64 -uid: adaptive-expressions.Base64 -package: adaptive-expressions -summary: Return the base64-encoded version of a string or byte array. -fullName: Base64 -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Base64() - uid: adaptive-expressions.Base64.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Base64](xref:adaptive-expressions.Base64) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Base64() -properties: - - name: negation - uid: adaptive-expressions.Base64.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Base64.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Base64.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Base64.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Base64.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToBinary.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToBinary.yml deleted file mode 100644 index 61b3a3c0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToBinary.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Base64ToBinary -uid: adaptive-expressions.Base64ToBinary -package: adaptive-expressions -summary: Return the binary array of a base64-encoded string. -fullName: Base64ToBinary -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Base64ToBinary() - uid: adaptive-expressions.Base64ToBinary.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Base64ToBinary](xref:adaptive-expressions.Base64ToBinary) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Base64ToBinary() -properties: - - name: negation - uid: adaptive-expressions.Base64ToBinary.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Base64ToBinary.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Base64ToBinary.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Base64ToBinary.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Base64ToBinary.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToString.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToString.yml deleted file mode 100644 index a97d4507..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Base64ToString.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Base64ToString -uid: adaptive-expressions.Base64ToString -package: adaptive-expressions -summary: >- - Return the string version of a base64-encoded string, effectively decoding the - base64 string. -fullName: Base64ToString -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Base64ToString() - uid: adaptive-expressions.Base64ToString.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Base64ToString](xref:adaptive-expressions.Base64ToString) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Base64ToString() -properties: - - name: negation - uid: adaptive-expressions.Base64ToString.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Base64ToString.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Base64ToString.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Base64ToString.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Base64ToString.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Binary.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Binary.yml deleted file mode 100644 index 3eb18d11..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Binary.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Binary -uid: adaptive-expressions.Binary -package: adaptive-expressions -summary: Return the binary version of a string. -fullName: Binary -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Binary() - uid: adaptive-expressions.Binary.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Binary](xref:adaptive-expressions.Binary) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Binary() -properties: - - name: negation - uid: adaptive-expressions.Binary.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Binary.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Binary.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Binary.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Binary.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BinaryOpExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BinaryOpExpContext.yml index 6ce60fbd..49154e33 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BinaryOpExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BinaryOpExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: BinaryOpExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BinaryOpExpContext(ctx: ExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.BinaryOpExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.BinaryOpExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions.ExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.BinaryOpExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions.ExpressionContext.childCount) - name: children uid: adaptive-expressions.BinaryOpExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions.ExpressionContext.children) - name: exception uid: adaptive-expressions.BinaryOpExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions.ExpressionContext.exception) - name: invokingState uid: adaptive-expressions.BinaryOpExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions.ExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.BinaryOpExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions.ExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.BinaryOpExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions.ExpressionContext.parent) - name: payload uid: adaptive-expressions.BinaryOpExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions.ExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.BinaryOpExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: BinaryOpExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.BinaryOpExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions.ExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.BinaryOpExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions.ExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.BinaryOpExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions.ExpressionContext.start) - name: stop uid: adaptive-expressions.BinaryOpExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions.ExpressionContext.stop) - name: text uid: adaptive-expressions.BinaryOpExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions.ExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.BinaryOpExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions.ExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.BinaryOpExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.BinaryOpExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.BinaryOpExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.BinaryOpExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.BinaryOpExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: copyFrom(ExpressionContext) uid: adaptive-expressions.BinaryOpExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions.ExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.BinaryOpExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions.ExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.BinaryOpExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.BinaryOpExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.BinaryOpExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.BinaryOpExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.BinaryOpExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions.ExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.BinaryOpExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions.ExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.BinaryOpExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions.ExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.BinaryOpExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions.ExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.BinaryOpExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions.ExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.BinaryOpExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions.ExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.BinaryOpExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.BinaryOpExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.BinaryOpExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.BinaryOpExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.BinaryOpExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.BinaryOpExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.BinaryOpExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.BinaryOpExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.BinaryOpExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.BinaryOpExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.BinaryOpExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions.ExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.BinaryOpExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,55 +869,50 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ASTERISK(): TerminalNode | undefined' + content: 'function ASTERISK(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DOUBLE_AND() uid: adaptive-expressions.BinaryOpExpContext.DOUBLE_AND package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DOUBLE_AND(): TerminalNode | undefined' + content: 'function DOUBLE_AND(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DOUBLE_EQUAL() uid: adaptive-expressions.BinaryOpExpContext.DOUBLE_EQUAL package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DOUBLE_EQUAL(): TerminalNode | undefined' + content: 'function DOUBLE_EQUAL(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DOUBLE_VERTICAL_CYLINDER() uid: adaptive-expressions.BinaryOpExpContext.DOUBLE_VERTICAL_CYLINDER package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DOUBLE_VERTICAL_CYLINDER(): TerminalNode | undefined' + content: 'function DOUBLE_VERTICAL_CYLINDER(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(ExpressionAntlrParserListener) uid: adaptive-expressions.BinaryOpExpContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -888,7 +925,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -901,19 +937,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext[]' return: description: '' - type: '[]' + type: [] - name: expression(number) uid: adaptive-expressions.BinaryOpExpContext.expression_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(i: number): ExpressionContext' @@ -929,143 +963,131 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function LESS_OR_EQUAl(): TerminalNode | undefined' + content: 'function LESS_OR_EQUAl(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: LESS_THAN() uid: adaptive-expressions.BinaryOpExpContext.LESS_THAN package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function LESS_THAN(): TerminalNode | undefined' + content: 'function LESS_THAN(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MORE_OR_EQUAL() uid: adaptive-expressions.BinaryOpExpContext.MORE_OR_EQUAL package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MORE_OR_EQUAL(): TerminalNode | undefined' + content: 'function MORE_OR_EQUAL(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MORE_THAN() uid: adaptive-expressions.BinaryOpExpContext.MORE_THAN package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MORE_THAN(): TerminalNode | undefined' + content: 'function MORE_THAN(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: NOT_EQUAL() uid: adaptive-expressions.BinaryOpExpContext.NOT_EQUAL package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NOT_EQUAL(): TerminalNode | undefined' + content: 'function NOT_EQUAL(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: NULL_COALESCE() uid: adaptive-expressions.BinaryOpExpContext.NULL_COALESCE package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NULL_COALESCE(): TerminalNode | undefined' + content: 'function NULL_COALESCE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: PERCENT() uid: adaptive-expressions.BinaryOpExpContext.PERCENT package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function PERCENT(): TerminalNode | undefined' + content: 'function PERCENT(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: PLUS() uid: adaptive-expressions.BinaryOpExpContext.PLUS package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function PLUS(): TerminalNode | undefined' + content: 'function PLUS(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SINGLE_AND() uid: adaptive-expressions.BinaryOpExpContext.SINGLE_AND package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SINGLE_AND(): TerminalNode | undefined' + content: 'function SINGLE_AND(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SLASH() uid: adaptive-expressions.BinaryOpExpContext.SLASH package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SLASH(): TerminalNode | undefined' + content: 'function SLASH(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SUBSTRACT() uid: adaptive-expressions.BinaryOpExpContext.SUBSTRACT package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SUBSTRACT(): TerminalNode | undefined' + content: 'function SUBSTRACT(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: XOR() uid: adaptive-expressions.BinaryOpExpContext.XOR package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function XOR(): TerminalNode | undefined' + content: 'function XOR(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Bool.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Bool.yml deleted file mode 100644 index dc302d15..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Bool.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Bool -uid: adaptive-expressions.Bool -package: adaptive-expressions -summary: Return the Boolean version of a value. -fullName: Bool -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Bool() - uid: adaptive-expressions.Bool.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Bool](xref:adaptive-expressions.Bool) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Bool() -properties: - - name: negation - uid: adaptive-expressions.Bool.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Bool.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Bool.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Bool.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Bool.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpression.yml index 193b3734..932af958 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpression.yml @@ -9,26 +9,23 @@ fullName: BoolExpression remarks: >- String values are always interpreted as an expression, whether it has '=' prefix or not. -isPreview: false isDeprecated: false type: class constructors: - - name: BoolExpression(boolean | string | Expression) + - name: BoolExpression(string | boolean | Expression) uid: adaptive-expressions.BoolExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [BoolExpression](xref:adaptive-expressions.BoolExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new BoolExpression(value?: boolean | string | Expression)' + content: 'new BoolExpression(value?: string | boolean | Expression)' parameters: - id: value - type: boolean | string | - description: | - A `boolean` or a `string` expression which resolves to a `boolean`. + type: string | boolean | + description: A `boolean` or a `string` expression which resolves to a `boolean`. inheritedProperties: - name: expressionText uid: adaptive-expressions.BoolExpression.expressionText @@ -36,7 +33,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -52,7 +48,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: boolean' @@ -68,7 +63,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): boolean' @@ -87,7 +81,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -102,7 +95,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -117,7 +109,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: boolean }' @@ -132,18 +123,16 @@ inheritedMethods: Inherited From [ExpressionProperty.tryGetValue](xref:adaptive-expressions.ExpressionProperty.tryGetValue) methods: - - name: setValue(boolean | string | Expression) + - name: setValue(string | boolean | Expression) uid: adaptive-expressions.BoolExpression.setValue package: adaptive-expressions summary: Set a boolean value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: boolean | string | Expression)' + content: 'function setValue(value: string | boolean | Expression)' parameters: - id: value - type: boolean | string | - description: | - Value to set. + type: string | boolean | + description: Value to set. extends: <boolean> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpressionConverter.yml index c43127fe..1749f44e 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/BoolExpressionConverter.yml @@ -7,7 +7,6 @@ summary: >- converter. fullName: BoolExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -18,7 +17,6 @@ methods: Converts `any` value into a [BoolExpression](xref:adaptive-expressions.BoolExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: Input | BoolExpression): BoolExpression' @@ -27,5 +25,5 @@ methods: type: Input | description: '`any` value to convert.' return: - description: 'The [BoolExpression](xref:adaptive-expressions.BoolExpression).' + description: The [BoolExpression](xref:adaptive-expressions.BoolExpression). type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CaptureContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CaptureContext.yml index c8acd5cb..6462fc0f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CaptureContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CaptureContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: CaptureContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'CaptureContext(ParserRuleContext | undefined, number)' + - name: CaptureContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.CaptureContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new CaptureContext(parent: ParserRuleContext | undefined, invokingState: + new CaptureContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.CaptureContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.CaptureContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.CaptureContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.CaptureContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.CaptureContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.CaptureContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.CaptureContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: CaptureContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.CaptureContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.CaptureContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.CaptureContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.CaptureContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.CaptureContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.CaptureContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.CaptureContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.CaptureContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.CaptureContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.CaptureContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.CaptureContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.CaptureContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.CaptureContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.CaptureContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.CaptureContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.CaptureContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.CaptureContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.CaptureContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.CaptureContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.CaptureContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.CaptureContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.CaptureContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function alternation(): AlternationContext' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CloseParen(): TerminalNode' @@ -860,7 +815,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -873,7 +827,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -886,43 +839,39 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function GreaterThan(): TerminalNode | undefined' + content: 'function GreaterThan(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: LessThan() uid: adaptive-expressions.CaptureContext.LessThan package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function LessThan(): TerminalNode | undefined' + content: 'function LessThan(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: name() uid: adaptive-expressions.CaptureContext.name package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function name(): NameContext | undefined' + content: 'function name(): undefined | NameContext' return: description: '' - type: | undefined + type: undefined | - name: OpenParen() uid: adaptive-expressions.CaptureContext.OpenParen package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OpenParen(): TerminalNode' @@ -934,11 +883,10 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function QuestionMark(): TerminalNode | undefined' + content: 'function QuestionMark(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_atomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_atomContext.yml index 43917391..736abb73 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_atomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_atomContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Cc_atomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Cc_atomContext(ParserRuleContext | undefined, number)' + - name: Cc_atomContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Cc_atomContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Cc_atomContext(parent: ParserRuleContext | undefined, invokingState: + new Cc_atomContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Cc_atomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Cc_atomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Cc_atomContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Cc_atomContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Cc_atomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Cc_atomContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Cc_atomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Cc_atomContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Cc_atomContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Cc_atomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Cc_atomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Cc_atomContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Cc_atomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_atomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Cc_atomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_atomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Cc_atomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Cc_atomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Cc_atomContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Cc_atomContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Cc_atomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Cc_atomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Cc_atomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Cc_atomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Cc_atomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Cc_atomContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Cc_atomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_atomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_atomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Cc_atomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,19 +793,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cc_literal(): Cc_literalContext[]' return: description: '' - type: '[]' + type: [] - name: cc_literal(number) uid: adaptive-expressions.Cc_atomContext.cc_literal_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cc_literal(i: number): Cc_literalContext' @@ -864,7 +819,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -877,7 +831,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -890,23 +843,21 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Hyphen(): TerminalNode | undefined' + content: 'function Hyphen(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: shared_atom() uid: adaptive-expressions.Cc_atomContext.shared_atom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shared_atom(): Shared_atomContext | undefined' + content: 'function shared_atom(): undefined | Shared_atomContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_literalContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_literalContext.yml index 4ba6c5f6..c312a8d9 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_literalContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Cc_literalContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Cc_literalContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Cc_literalContext(ParserRuleContext | undefined, number)' + - name: Cc_literalContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Cc_literalContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Cc_literalContext(parent: ParserRuleContext | undefined, + new Cc_literalContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Cc_literalContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Cc_literalContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Cc_literalContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Cc_literalContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Cc_literalContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Cc_literalContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Cc_literalContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Cc_literalContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Cc_literalContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Cc_literalContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Cc_literalContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Cc_literalContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Cc_literalContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_literalContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Cc_literalContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_literalContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Cc_literalContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Cc_literalContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Cc_literalContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Cc_literalContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Cc_literalContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Cc_literalContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Cc_literalContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Cc_literalContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Cc_literalContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Cc_literalContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Cc_literalContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_literalContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Cc_literalContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Cc_literalContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,67 +793,61 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Caret(): TerminalNode | undefined' + content: 'function Caret(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CharacterClassStart() uid: adaptive-expressions.Cc_literalContext.CharacterClassStart package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CharacterClassStart(): TerminalNode | undefined' + content: 'function CharacterClassStart(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CloseParen() uid: adaptive-expressions.Cc_literalContext.CloseParen package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CloseParen(): TerminalNode | undefined' + content: 'function CloseParen(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Dot() uid: adaptive-expressions.Cc_literalContext.Dot package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Dot(): TerminalNode | undefined' + content: 'function Dot(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: EndOfSubject() uid: adaptive-expressions.Cc_literalContext.EndOfSubject package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function EndOfSubject(): TerminalNode | undefined' + content: 'function EndOfSubject(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.Cc_literalContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -909,7 +860,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -922,71 +872,65 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function OpenParen(): TerminalNode | undefined' + content: 'function OpenParen(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Pipe() uid: adaptive-expressions.Cc_literalContext.Pipe package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Pipe(): TerminalNode | undefined' + content: 'function Pipe(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Plus() uid: adaptive-expressions.Cc_literalContext.Plus package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Plus(): TerminalNode | undefined' + content: 'function Plus(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: QuestionMark() uid: adaptive-expressions.Cc_literalContext.QuestionMark package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function QuestionMark(): TerminalNode | undefined' + content: 'function QuestionMark(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: shared_literal() uid: adaptive-expressions.Cc_literalContext.shared_literal package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shared_literal(): Shared_literalContext | undefined' + content: 'function shared_literal(): undefined | Shared_literalContext' return: description: '' - type: | undefined + type: undefined | - name: Star() uid: adaptive-expressions.Cc_literalContext.Star package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Star(): TerminalNode | undefined' + content: 'function Star(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ceiling.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ceiling.yml deleted file mode 100644 index d48a0afa..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ceiling.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Ceiling -uid: adaptive-expressions.Ceiling -package: adaptive-expressions -summary: >- - Returns the smallest integral value that is greater than or equal to the - specified number. -fullName: Ceiling -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Ceiling() - uid: adaptive-expressions.Ceiling.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Ceiling](xref:adaptive-expressions.Ceiling) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Ceiling() -properties: - - name: negation - uid: adaptive-expressions.Ceiling.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Ceiling.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Ceiling.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Ceiling.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Ceiling.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Character_classContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Character_classContext.yml index 6d0fe8ea..519b7349 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Character_classContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Character_classContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Character_classContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Character_classContext(ParserRuleContext | undefined, number)' + - name: Character_classContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Character_classContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Character_classContext(parent: ParserRuleContext | undefined, + new Character_classContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Character_classContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Character_classContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Character_classContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Character_classContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Character_classContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Character_classContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Character_classContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Character_classContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Character_classContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Character_classContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Character_classContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Character_classContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Character_classContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Character_classContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Character_classContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Character_classContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Character_classContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Character_classContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Character_classContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Character_classContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Character_classContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Character_classContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Character_classContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Character_classContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Character_classContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Character_classContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Character_classContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Character_classContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Character_classContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Character_classContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,31 +793,28 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Caret(): TerminalNode | undefined' + content: 'function Caret(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: cc_atom() uid: adaptive-expressions.Character_classContext.cc_atom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cc_atom(): Cc_atomContext[]' return: description: '' - type: '[]' + type: [] - name: cc_atom(number) uid: adaptive-expressions.Character_classContext.cc_atom_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cc_atom(i: number): Cc_atomContext' @@ -876,7 +830,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CharacterClassEnd(): TerminalNode' @@ -888,7 +841,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CharacterClassStart(): TerminalNode' @@ -900,7 +852,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -913,7 +864,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Clause.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Clause.yml index ab4ddbdc..cbfdb5af 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Clause.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Clause.yml @@ -5,26 +5,24 @@ package: adaptive-expressions summary: A canonical normal form expression. fullName: Clause remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Clause(Clause | Expression | Expression[])' + - name: Clause(Expression | Expression[] | Clause) uid: adaptive-expressions.Clause.constructor package: adaptive-expressions summary: Initializes a new instance of the `Clause` class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new Clause(clauseOrExpression?: Clause | Expression | Expression[])' + content: 'new Clause(clauseOrExpression?: Expression | Expression[] | Clause)' parameters: - id: clauseOrExpression type: >- - | | [] - description: > + | [] | + description: >- A clause, expression or an array of expressions to initialize a `Clause`. properties: @@ -34,52 +32,24 @@ properties: summary: Gets or sets the anyBinding dictionary. fullName: anyBindings remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'anyBindings: Map = new Map()' + content: 'anyBindings: Map' return: description: '' - type: 'Map<string, string>' - - name: returnType - uid: adaptive-expressions.Clause.returnType - package: adaptive-expressions - summary: Expected result of evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ReturnType returnType - return: - description: The expected result of evaluating the expression. - type: + type: Map<string, string> - name: subsumed uid: adaptive-expressions.Clause.subsumed package: adaptive-expressions summary: Gets or sets whether the clause is subsumed. fullName: subsumed remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'subsumed: boolean = false' + content: 'subsumed: boolean' return: description: '' type: boolean - - name: type - uid: adaptive-expressions.Clause.type - package: adaptive-expressions - summary: Type of expression. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string type - return: - description: The type of the expression. - type: string inheritedProperties: - name: children uid: adaptive-expressions.Clause.children @@ -87,13 +57,12 @@ inheritedProperties: summary: Children expressions. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children: Expression[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Expression.children](xref:adaptive-expressions.Expression.children) @@ -103,7 +72,6 @@ inheritedProperties: summary: Evaluator of expression. fullName: evaluator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'evaluator: ExpressionEvaluator' @@ -126,29 +94,72 @@ inheritedProperties: to the built in functions. fullName: functions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static functions: FunctionTable = new FunctionTable()' + content: 'static functions: FunctionTable' return: description: '' type: inheritanceDescription: >- Inherited From [Expression.functions](xref:adaptive-expressions.Expression.functions) + - name: returnType + uid: adaptive-expressions.Clause.returnType + package: adaptive-expressions + summary: Expected result of evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: The expected result of evaluating the expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.returnType](xref:adaptive-expressions.Expression.returnType) + - name: type + uid: adaptive-expressions.Clause.type + package: adaptive-expressions + summary: Type of expression. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: The type of the expression. + type: string + inheritanceDescription: >- + Inherited From + [Expression.type](xref:adaptive-expressions.Expression.type) + - name: validate + uid: adaptive-expressions.Clause.validate + package: adaptive-expressions + summary: Validate immediate expression. + fullName: validate + remarks: '' + isDeprecated: false + syntax: + content: 'validate: () => void' + return: + description: '' + type: () => void + inheritanceDescription: >- + Inherited From + [Expression.validate](xref:adaptive-expressions.Expression.validate) inheritedMethods: - - name: 'andExpression(Expression[])' + - name: andExpression(Expression[]) uid: adaptive-expressions.Clause.andExpression package: adaptive-expressions summary: Construct and validate an And expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function andExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -161,7 +172,6 @@ inheritedMethods: package: adaptive-expressions summary: Do a deep equality between expressions. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deepEquals(other: Expression): boolean' @@ -175,18 +185,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.deepEquals](xref:adaptive-expressions.Expression.deepEquals) - - name: 'equalsExpression(Expression[])' + - name: equalsExpression(Expression[]) uid: adaptive-expressions.Clause.equalsExpression package: adaptive-expressions summary: Construct and validate an Equals expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function equalsExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -199,7 +208,6 @@ inheritedMethods: package: adaptive-expressions summary: Construct an expression from a EvaluateExpressionDelegate remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,7 +230,6 @@ inheritedMethods: Construct an expression from a lamba expression over the state. Exceptions will be caught and surfaced as an error string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function lambda(func: (arg0: any) => any): Expression' @@ -244,7 +251,6 @@ inheritedMethods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) function by name. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function lookup(functionName: string): ExpressionEvaluator' @@ -261,12 +267,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.lookup](xref:adaptive-expressions.Expression.lookup) - - name: 'makeExpression(string, ExpressionEvaluator, Expression[])' + - name: makeExpression(string, ExpressionEvaluator, Expression[]) uid: adaptive-expressions.Clause.makeExpression package: adaptive-expressions summary: Make an expression and validate it. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -280,7 +285,7 @@ inheritedMethods: type: description: Information about how to validate and evaluate expression. - id: children - type: '[]' + type: [] description: Child expressions. return: description: The new expression. @@ -293,7 +298,6 @@ inheritedMethods: package: adaptive-expressions summary: Construct and validate an Not expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function notExpression(child: Expression): Expression' @@ -307,18 +311,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.notExpression](xref:adaptive-expressions.Expression.notExpression) - - name: 'orExpression(Expression[])' + - name: orExpression(Expression[]) uid: adaptive-expressions.Clause.orExpression package: adaptive-expressions summary: Construct and validate an Or expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function orExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -326,14 +329,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.orExpression](xref:adaptive-expressions.Expression.orExpression) - - name: 'parse(string, EvaluatorLookup)' + - name: parse(string, EvaluatorLookup) uid: adaptive-expressions.Clause.parse package: adaptive-expressions summary: >- Parse an expression string into an [Expression](xref:adaptive-expressions.Expression) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -344,7 +346,7 @@ inheritedMethods: type: string description: Expression string. - id: lookup - type: + type: description: >- Optional. [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) @@ -370,13 +372,12 @@ inheritedMethods: but you might get other paths from the computed part as well. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function references(): string[]' return: description: List of the static reference paths. - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [Expression.references](xref:adaptive-expressions.Expression.references) @@ -387,7 +388,6 @@ inheritedMethods: Walking function for identifying static memory references in an expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -408,12 +408,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.referenceWalk](xref:adaptive-expressions.Expression.referenceWalk) - - name: 'setPathToValue(Expression, any)' + - name: setPathToValue(Expression, any) uid: adaptive-expressions.Clause.setPathToValue package: adaptive-expressions summary: Construct and validate an Set a property expression to a value expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -432,20 +431,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.setPathToValue](xref:adaptive-expressions.Expression.setPathToValue) - - name: 'tryEvaluate(MemoryInterface | any, Options)' + - name: tryEvaluate(any, Options) uid: adaptive-expressions.Clause.tryEvaluate package: adaptive-expressions summary: Evaluate the expression. remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(state: MemoryInterface | any, options: Options): - ValueWithError + content: 'function tryEvaluate(state: any, options?: Options): ValueWithError' parameters: - id: state - type: | any + type: any description: >- Global state to evaluate accessor expressions against. Can be Dictionary, otherwise reflection is used to access property and then @@ -461,24 +457,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.tryEvaluate](xref:adaptive-expressions.Expression.tryEvaluate) - - name: validate() - uid: adaptive-expressions.Clause.validate - package: adaptive-expressions - summary: Validate immediate expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function validate() - inheritanceDescription: >- - Inherited From - [Expression.validate](xref:adaptive-expressions.Expression.validate) - name: validateTree() uid: adaptive-expressions.Clause.validateTree package: adaptive-expressions summary: Recursively validate the expression tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: function validateTree() @@ -486,31 +469,29 @@ inheritedMethods: Inherited From [Expression.validateTree](xref:adaptive-expressions.Expression.validateTree) methods: - - name: 'matches(Clause, MemoryInterface | any)' + - name: matches(Clause, any) uid: adaptive-expressions.Clause.matches package: adaptive-expressions summary: Determines whether the current `Clause` matches with another `Clause`. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function matches(clause: Clause, memory: MemoryInterface | any): boolean' + content: 'function matches(clause: Clause, memory: any): boolean' parameters: - id: clause type: description: The other `Clause` instance to compare with. - id: memory - type: | any + type: any description: The scope for looking up variables. return: description: A boolean value indicating whether the two clauses are matches. type: boolean - - name: 'relationship(Clause, PredicateComparers)' + - name: relationship(Clause, PredicateComparers) uid: adaptive-expressions.Clause.relationship package: adaptive-expressions summary: Compares the current `Clause` with another `Clause`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -533,22 +514,20 @@ methods: package: adaptive-expressions summary: Splits ignored child expressions. remarks: '' - isPreview: false isDeprecated: false syntax: content: function splitIgnores() - - name: 'toString(string[], number)' + - name: toString(string[], number) uid: adaptive-expressions.Clause.toString package: adaptive-expressions summary: Gets a string that represents the current clause. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(builder: string[], indent: number): string' + content: 'function toString(builder?: string[], indent?: number): string' parameters: - id: builder - type: 'string[]' + type: string[] description: An array of string to build the string of clause. - id: indent type: number diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Coalesce.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Coalesce.yml deleted file mode 100644 index 3e22c9b2..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Coalesce.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Coalesce -uid: adaptive-expressions.Coalesce -package: adaptive-expressions -summary: |- - Return the first non-null value from one or more parameters. - Empty strings, empty arrays, and empty objects are not null. -fullName: Coalesce -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Coalesce() - uid: adaptive-expressions.Coalesce.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Coalesce](xref:adaptive-expressions.Coalesce) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Coalesce() -properties: - - name: negation - uid: adaptive-expressions.Coalesce.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Coalesce.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Coalesce.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Coalesce.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Coalesce.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegex.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegex.yml index c362b728..d230333e 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegex.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegex.yml @@ -8,7 +8,6 @@ summary: |- PCRE antlr g4 file: CommonRegex.g4. fullName: CommonRegex remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -17,7 +16,6 @@ methods: package: adaptive-expressions summary: Create RegExp object from PCRE pattern string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function CreateRegex(pattern: string): RegExp' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexLexer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexLexer.yml index 76205fb9..66be9a83 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexLexer.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexLexer.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: CommonRegexLexer remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CommonRegexLexer(input: CharStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: ALC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ALC: 44 = 44' + content: 'static ALC: 44 = 44' return: description: '' type: '44' @@ -42,10 +39,9 @@ properties: summary: '' fullName: Ampersand remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Ampersand: 43 = 43' + content: 'static Ampersand: 43 = 43' return: description: '' type: '43' @@ -55,10 +51,9 @@ properties: summary: '' fullName: AUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static AUC: 70 = 70' + content: 'static AUC: 70 = 70' return: description: '' type: '70' @@ -68,10 +63,9 @@ properties: summary: '' fullName: Backslash remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Backslash: 10 = 10' + content: 'static Backslash: 10 = 10' return: description: '' type: '10' @@ -81,10 +75,9 @@ properties: summary: '' fullName: BellChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BellChar: 3 = 3' + content: 'static BellChar: 3 = 3' return: description: '' type: '3' @@ -94,10 +87,9 @@ properties: summary: '' fullName: BLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BLC: 45 = 45' + content: 'static BLC: 45 = 45' return: description: '' type: '45' @@ -107,10 +99,9 @@ properties: summary: '' fullName: BlockQuoted remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BlockQuoted: 2 = 2' + content: 'static BlockQuoted: 2 = 2' return: description: '' type: '2' @@ -120,10 +111,9 @@ properties: summary: '' fullName: BUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BUC: 71 = 71' + content: 'static BUC: 71 = 71' return: description: '' type: '71' @@ -133,10 +123,9 @@ properties: summary: '' fullName: Caret remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Caret: 23 = 23' + content: 'static Caret: 23 = 23' return: description: '' type: '23' @@ -146,10 +135,9 @@ properties: summary: '' fullName: CarriageReturn remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CarriageReturn: 8 = 8' + content: 'static CarriageReturn: 8 = 8' return: description: '' type: '8' @@ -159,36 +147,33 @@ properties: summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static channelNames: string[] = [\n\t\t\"DEFAULT_TOKEN_CHANNEL\", \"HIDDEN\",\n\t]" + content: 'channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: channelNames uid: adaptive-expressions.CommonRegexLexer.channelNames package: adaptive-expressions summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] channelNames' + content: 'static channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: CharacterClassEnd uid: adaptive-expressions.CommonRegexLexer.CharacterClassEnd package: adaptive-expressions summary: '' fullName: CharacterClassEnd remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharacterClassEnd: 22 = 22' + content: 'static CharacterClassEnd: 22 = 22' return: description: '' type: '22' @@ -198,10 +183,9 @@ properties: summary: '' fullName: CharacterClassStart remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharacterClassStart: 21 = 21' + content: 'static CharacterClassStart: 21 = 21' return: description: '' type: '21' @@ -211,10 +195,9 @@ properties: summary: '' fullName: CharWithoutProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharWithoutProperty: 16 = 16' + content: 'static CharWithoutProperty: 16 = 16' return: description: '' type: '16' @@ -224,10 +207,9 @@ properties: summary: '' fullName: CharWithProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharWithProperty: 15 = 15' + content: 'static CharWithProperty: 15 = 15' return: description: '' type: '15' @@ -237,10 +219,9 @@ properties: summary: '' fullName: CLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLC: 46 = 46' + content: 'static CLC: 46 = 46' return: description: '' type: '46' @@ -250,10 +231,9 @@ properties: summary: '' fullName: CloseBrace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CloseBrace: 29 = 29' + content: 'static CloseBrace: 29 = 29' return: description: '' type: '29' @@ -263,10 +243,9 @@ properties: summary: '' fullName: CloseParen remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CloseParen: 34 = 34' + content: 'static CloseParen: 34 = 34' return: description: '' type: '34' @@ -276,10 +255,9 @@ properties: summary: '' fullName: Colon remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Colon: 39 = 39' + content: 'static Colon: 39 = 39' return: description: '' type: '39' @@ -289,10 +267,9 @@ properties: summary: '' fullName: Comma remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Comma: 30 = 30' + content: 'static Comma: 30 = 30' return: description: '' type: '30' @@ -302,10 +279,9 @@ properties: summary: '' fullName: ControlChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ControlChar: 4 = 4' + content: 'static ControlChar: 4 = 4' return: description: '' type: '4' @@ -315,10 +291,9 @@ properties: summary: '' fullName: CUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CUC: 72 = 72' + content: 'static CUC: 72 = 72' return: description: '' type: '72' @@ -328,10 +303,9 @@ properties: summary: '' fullName: D0 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D0: 105 = 105' + content: 'static D0: 105 = 105' return: description: '' type: '105' @@ -341,10 +315,9 @@ properties: summary: '' fullName: D1 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D1: 96 = 96' + content: 'static D1: 96 = 96' return: description: '' type: '96' @@ -354,10 +327,9 @@ properties: summary: '' fullName: D2 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D2: 97 = 97' + content: 'static D2: 97 = 97' return: description: '' type: '97' @@ -367,10 +339,9 @@ properties: summary: '' fullName: D3 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D3: 98 = 98' + content: 'static D3: 98 = 98' return: description: '' type: '98' @@ -380,10 +351,9 @@ properties: summary: '' fullName: D4 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D4: 99 = 99' + content: 'static D4: 99 = 99' return: description: '' type: '99' @@ -393,10 +363,9 @@ properties: summary: '' fullName: D5 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D5: 100 = 100' + content: 'static D5: 100 = 100' return: description: '' type: '100' @@ -406,10 +375,9 @@ properties: summary: '' fullName: D6 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D6: 101 = 101' + content: 'static D6: 101 = 101' return: description: '' type: '101' @@ -419,10 +387,9 @@ properties: summary: '' fullName: D7 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D7: 102 = 102' + content: 'static D7: 102 = 102' return: description: '' type: '102' @@ -432,10 +399,9 @@ properties: summary: '' fullName: D8 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D8: 103 = 103' + content: 'static D8: 103 = 103' return: description: '' type: '103' @@ -445,10 +411,9 @@ properties: summary: '' fullName: D9 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D9: 104 = 104' + content: 'static D9: 104 = 104' return: description: '' type: '104' @@ -458,10 +423,9 @@ properties: summary: '' fullName: DecimalDigit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DecimalDigit: 13 = 13' + content: 'static DecimalDigit: 13 = 13' return: description: '' type: '13' @@ -471,10 +435,9 @@ properties: summary: '' fullName: DLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DLC: 47 = 47' + content: 'static DLC: 47 = 47' return: description: '' type: '47' @@ -484,10 +447,9 @@ properties: summary: '' fullName: Dot remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Dot: 12 = 12' + content: 'static Dot: 12 = 12' return: description: '' type: '12' @@ -497,10 +459,9 @@ properties: summary: '' fullName: DUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DUC: 73 = 73' + content: 'static DUC: 73 = 73' return: description: '' type: '73' @@ -510,10 +471,9 @@ properties: summary: '' fullName: ELC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ELC: 48 = 48' + content: 'static ELC: 48 = 48' return: description: '' type: '48' @@ -523,10 +483,9 @@ properties: summary: '' fullName: EndOfSubject remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EndOfSubject: 31 = 31' + content: 'static EndOfSubject: 31 = 31' return: description: '' type: '31' @@ -536,10 +495,9 @@ properties: summary: '' fullName: Equals remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Equals: 41 = 41' + content: 'static Equals: 41 = 41' return: description: '' type: '41' @@ -549,10 +507,9 @@ properties: summary: '' fullName: EscapeChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EscapeChar: 5 = 5' + content: 'static EscapeChar: 5 = 5' return: description: '' type: '5' @@ -562,10 +519,9 @@ properties: summary: '' fullName: EUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EUC: 74 = 74' + content: 'static EUC: 74 = 74' return: description: '' type: '74' @@ -575,10 +531,9 @@ properties: summary: '' fullName: Exclamation remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Exclamation: 42 = 42' + content: 'static Exclamation: 42 = 42' return: description: '' type: '42' @@ -588,10 +543,9 @@ properties: summary: '' fullName: FLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static FLC: 49 = 49' + content: 'static FLC: 49 = 49' return: description: '' type: '49' @@ -601,10 +555,9 @@ properties: summary: '' fullName: FormFeed remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static FormFeed: 6 = 6' + content: 'static FormFeed: 6 = 6' return: description: '' type: '6' @@ -614,10 +567,9 @@ properties: summary: '' fullName: FUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static FUC: 75 = 75' + content: 'static FUC: 75 = 75' return: description: '' type: '75' @@ -627,10 +579,9 @@ properties: summary: '' fullName: GLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static GLC: 50 = 50' + content: 'static GLC: 50 = 50' return: description: '' type: '50' @@ -640,10 +591,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -653,10 +603,9 @@ properties: summary: '' fullName: GreaterThan remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static GreaterThan: 36 = 36' + content: 'static GreaterThan: 36 = 36' return: description: '' type: '36' @@ -666,10 +615,9 @@ properties: summary: '' fullName: GUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static GUC: 76 = 76' + content: 'static GUC: 76 = 76' return: description: '' type: '76' @@ -679,10 +627,9 @@ properties: summary: '' fullName: Hash remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Hash: 40 = 40' + content: 'static Hash: 40 = 40' return: description: '' type: '40' @@ -692,10 +639,9 @@ properties: summary: '' fullName: HexChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static HexChar: 11 = 11' + content: 'static HexChar: 11 = 11' return: description: '' type: '11' @@ -705,10 +651,9 @@ properties: summary: '' fullName: HLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static HLC: 51 = 51' + content: 'static HLC: 51 = 51' return: description: '' type: '51' @@ -718,10 +663,9 @@ properties: summary: '' fullName: HUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static HUC: 77 = 77' + content: 'static HUC: 77 = 77' return: description: '' type: '77' @@ -731,10 +675,9 @@ properties: summary: '' fullName: Hyphen remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Hyphen: 24 = 24' + content: 'static Hyphen: 24 = 24' return: description: '' type: '24' @@ -744,10 +687,9 @@ properties: summary: '' fullName: ILC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ILC: 52 = 52' + content: 'static ILC: 52 = 52' return: description: '' type: '52' @@ -757,10 +699,9 @@ properties: summary: '' fullName: IUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IUC: 78 = 78' + content: 'static IUC: 78 = 78' return: description: '' type: '78' @@ -770,10 +711,9 @@ properties: summary: '' fullName: JLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static JLC: 53 = 53' + content: 'static JLC: 53 = 53' return: description: '' type: '53' @@ -783,10 +723,9 @@ properties: summary: '' fullName: JUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static JUC: 79 = 79' + content: 'static JUC: 79 = 79' return: description: '' type: '79' @@ -796,10 +735,9 @@ properties: summary: '' fullName: KLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static KLC: 54 = 54' + content: 'static KLC: 54 = 54' return: description: '' type: '54' @@ -809,10 +747,9 @@ properties: summary: '' fullName: KUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static KUC: 80 = 80' + content: 'static KUC: 80 = 80' return: description: '' type: '80' @@ -822,10 +759,9 @@ properties: summary: '' fullName: LessThan remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LessThan: 35 = 35' + content: 'static LessThan: 35 = 35' return: description: '' type: '35' @@ -835,10 +771,9 @@ properties: summary: '' fullName: LLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LLC: 55 = 55' + content: 'static LLC: 55 = 55' return: description: '' type: '55' @@ -848,10 +783,9 @@ properties: summary: '' fullName: LUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LUC: 81 = 81' + content: 'static LUC: 81 = 81' return: description: '' type: '81' @@ -861,10 +795,9 @@ properties: summary: '' fullName: MLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MLC: 56 = 56' + content: 'static MLC: 56 = 56' return: description: '' type: '56' @@ -874,36 +807,33 @@ properties: summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static modeNames: string[] = [\n\t\t\"DEFAULT_MODE\",\n\t]" + content: 'modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: modeNames uid: adaptive-expressions.CommonRegexLexer.modeNames package: adaptive-expressions summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] modeNames' + content: 'static modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: MUC uid: adaptive-expressions.CommonRegexLexer.MUC package: adaptive-expressions summary: '' fullName: MUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MUC: 82 = 82' + content: 'static MUC: 82 = 82' return: description: '' type: '82' @@ -913,10 +843,9 @@ properties: summary: '' fullName: NewLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NewLine: 7 = 7' + content: 'static NewLine: 7 = 7' return: description: '' type: '7' @@ -926,10 +855,9 @@ properties: summary: '' fullName: NLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NLC: 57 = 57' + content: 'static NLC: 57 = 57' return: description: '' type: '57' @@ -939,10 +867,9 @@ properties: summary: '' fullName: NotDecimalDigit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NotDecimalDigit: 14 = 14' + content: 'static NotDecimalDigit: 14 = 14' return: description: '' type: '14' @@ -952,10 +879,9 @@ properties: summary: '' fullName: NotWhiteSpace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NotWhiteSpace: 18 = 18' + content: 'static NotWhiteSpace: 18 = 18' return: description: '' type: '18' @@ -965,10 +891,9 @@ properties: summary: '' fullName: NotWordChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NotWordChar: 20 = 20' + content: 'static NotWordChar: 20 = 20' return: description: '' type: '20' @@ -978,10 +903,9 @@ properties: summary: '' fullName: NUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NUC: 83 = 83' + content: 'static NUC: 83 = 83' return: description: '' type: '83' @@ -991,10 +915,9 @@ properties: summary: '' fullName: OLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OLC: 58 = 58' + content: 'static OLC: 58 = 58' return: description: '' type: '58' @@ -1004,10 +927,9 @@ properties: summary: '' fullName: OpenBrace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OpenBrace: 28 = 28' + content: 'static OpenBrace: 28 = 28' return: description: '' type: '28' @@ -1017,10 +939,9 @@ properties: summary: '' fullName: OpenParen remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OpenParen: 33 = 33' + content: 'static OpenParen: 33 = 33' return: description: '' type: '33' @@ -1030,10 +951,9 @@ properties: summary: '' fullName: OtherChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OtherChar: 106 = 106' + content: 'static OtherChar: 106 = 106' return: description: '' type: '106' @@ -1043,10 +963,9 @@ properties: summary: '' fullName: OUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OUC: 84 = 84' + content: 'static OUC: 84 = 84' return: description: '' type: '84' @@ -1056,10 +975,9 @@ properties: summary: '' fullName: Pipe remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Pipe: 32 = 32' + content: 'static Pipe: 32 = 32' return: description: '' type: '32' @@ -1069,10 +987,9 @@ properties: summary: '' fullName: PLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PLC: 59 = 59' + content: 'static PLC: 59 = 59' return: description: '' type: '59' @@ -1082,10 +999,9 @@ properties: summary: '' fullName: Plus remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Plus: 26 = 26' + content: 'static Plus: 26 = 26' return: description: '' type: '26' @@ -1095,10 +1011,9 @@ properties: summary: '' fullName: PUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PUC: 85 = 85' + content: 'static PUC: 85 = 85' return: description: '' type: '85' @@ -1108,10 +1023,9 @@ properties: summary: '' fullName: QLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QLC: 60 = 60' + content: 'static QLC: 60 = 60' return: description: '' type: '60' @@ -1121,10 +1035,9 @@ properties: summary: '' fullName: QUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QUC: 86 = 86' + content: 'static QUC: 86 = 86' return: description: '' type: '86' @@ -1134,10 +1047,9 @@ properties: summary: '' fullName: QuestionMark remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QuestionMark: 25 = 25' + content: 'static QuestionMark: 25 = 25' return: description: '' type: '25' @@ -1147,10 +1059,9 @@ properties: summary: '' fullName: Quoted remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Quoted: 1 = 1' + content: 'static Quoted: 1 = 1' return: description: '' type: '1' @@ -1160,10 +1071,9 @@ properties: summary: '' fullName: RLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RLC: 61 = 61' + content: 'static RLC: 61 = 61' return: description: '' type: '61' @@ -1173,10 +1083,9 @@ properties: summary: '' fullName: RUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RUC: 87 = 87' + content: 'static RUC: 87 = 87' return: description: '' type: '87' @@ -1186,36 +1095,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\n\t\t\"Quoted\", \"BlockQuoted\", \"BellChar\", \"ControlChar\", \"EscapeChar\", \"FormFeed\", \n\t\t\"NewLine\", \"CarriageReturn\", \"Tab\", \"Backslash\", \"HexChar\", \"Dot\", \"DecimalDigit\", \n\t\t\"NotDecimalDigit\", \"CharWithProperty\", \"CharWithoutProperty\", \"WhiteSpace\", \n\t\t\"NotWhiteSpace\", \"WordChar\", \"NotWordChar\", \"CharacterClassStart\", \"CharacterClassEnd\", \n\t\t\"Caret\", \"Hyphen\", \"QuestionMark\", \"Plus\", \"Star\", \"OpenBrace\", \"CloseBrace\", \n\t\t\"Comma\", \"EndOfSubject\", \"Pipe\", \"OpenParen\", \"CloseParen\", \"LessThan\", \n\t\t\"GreaterThan\", \"SingleQuote\", \"Underscore\", \"Colon\", \"Hash\", \"Equals\", \n\t\t\"Exclamation\", \"Ampersand\", \"ALC\", \"BLC\", \"CLC\", \"DLC\", \"ELC\", \"FLC\", \n\t\t\"GLC\", \"HLC\", \"ILC\", \"JLC\", \"KLC\", \"LLC\", \"MLC\", \"NLC\", \"OLC\", \"PLC\", \n\t\t\"QLC\", \"RLC\", \"SLC\", \"TLC\", \"ULC\", \"VLC\", \"WLC\", \"XLC\", \"YLC\", \"ZLC\", \n\t\t\"AUC\", \"BUC\", \"CUC\", \"DUC\", \"EUC\", \"FUC\", \"GUC\", \"HUC\", \"IUC\", \"JUC\", \n\t\t\"KUC\", \"LUC\", \"MUC\", \"NUC\", \"OUC\", \"PUC\", \"QUC\", \"RUC\", \"SUC\", \"TUC\", \n\t\t\"UUC\", \"VUC\", \"WUC\", \"XUC\", \"YUC\", \"ZUC\", \"D1\", \"D2\", \"D3\", \"D4\", \"D5\", \n\t\t\"D6\", \"D7\", \"D8\", \"D9\", \"D0\", \"OtherChar\", \"UnderscoreAlphaNumerics\", \n\t\t\"AlphaNumerics\", \"AlphaNumeric\", \"NonAlphaNumeric\", \"HexDigit\", \"ASCII\",\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: adaptive-expressions.CommonRegexLexer.ruleNames package: adaptive-expressions summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: serializedATN uid: adaptive-expressions.CommonRegexLexer.serializedATN package: adaptive-expressions summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -1225,10 +1131,9 @@ properties: summary: '' fullName: SingleQuote remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SingleQuote: 37 = 37' + content: 'static SingleQuote: 37 = 37' return: description: '' type: '37' @@ -1238,10 +1143,9 @@ properties: summary: '' fullName: SLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SLC: 62 = 62' + content: 'static SLC: 62 = 62' return: description: '' type: '62' @@ -1251,10 +1155,9 @@ properties: summary: '' fullName: Star remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Star: 27 = 27' + content: 'static Star: 27 = 27' return: description: '' type: '27' @@ -1264,10 +1167,9 @@ properties: summary: '' fullName: SUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SUC: 88 = 88' + content: 'static SUC: 88 = 88' return: description: '' type: '88' @@ -1277,10 +1179,9 @@ properties: summary: '' fullName: Tab remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Tab: 9 = 9' + content: 'static Tab: 9 = 9' return: description: '' type: '9' @@ -1290,10 +1191,9 @@ properties: summary: '' fullName: TLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TLC: 63 = 63' + content: 'static TLC: 63 = 63' return: description: '' type: '63' @@ -1303,10 +1203,9 @@ properties: summary: '' fullName: TUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TUC: 89 = 89' + content: 'static TUC: 89 = 89' return: description: '' type: '89' @@ -1316,10 +1215,9 @@ properties: summary: '' fullName: ULC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ULC: 64 = 64' + content: 'static ULC: 64 = 64' return: description: '' type: '64' @@ -1329,10 +1227,9 @@ properties: summary: '' fullName: Underscore remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Underscore: 38 = 38' + content: 'static Underscore: 38 = 38' return: description: '' type: '38' @@ -1342,10 +1239,9 @@ properties: summary: '' fullName: UUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static UUC: 90 = 90' + content: 'static UUC: 90 = 90' return: description: '' type: '90' @@ -1355,39 +1251,33 @@ properties: summary: '' fullName: VLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static VLC: 65 = 65' + content: 'static VLC: 65 = 65' return: description: '' type: '65' - - name: VOCABULARY - uid: adaptive-expressions.CommonRegexLexer.VOCABULARY + - name: vocabulary + uid: adaptive-expressions.CommonRegexLexer.vocabulary package: adaptive-expressions summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(CommonRegexLexer._LITERAL_NAMES, - CommonRegexLexer._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: adaptive-expressions.CommonRegexLexer.vocabulary + - name: VOCABULARY + uid: adaptive-expressions.CommonRegexLexer.VOCABULARY package: adaptive-expressions summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -1397,10 +1287,9 @@ properties: summary: '' fullName: VUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static VUC: 91 = 91' + content: 'static VUC: 91 = 91' return: description: '' type: '91' @@ -1410,10 +1299,9 @@ properties: summary: '' fullName: WhiteSpace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WhiteSpace: 17 = 17' + content: 'static WhiteSpace: 17 = 17' return: description: '' type: '17' @@ -1423,10 +1311,9 @@ properties: summary: '' fullName: WLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WLC: 66 = 66' + content: 'static WLC: 66 = 66' return: description: '' type: '66' @@ -1436,10 +1323,9 @@ properties: summary: '' fullName: WordChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WordChar: 19 = 19' + content: 'static WordChar: 19 = 19' return: description: '' type: '19' @@ -1449,10 +1335,9 @@ properties: summary: '' fullName: WUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WUC: 92 = 92' + content: 'static WUC: 92 = 92' return: description: '' type: '92' @@ -1462,10 +1347,9 @@ properties: summary: '' fullName: XLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static XLC: 67 = 67' + content: 'static XLC: 67 = 67' return: description: '' type: '67' @@ -1475,10 +1359,9 @@ properties: summary: '' fullName: XUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static XUC: 93 = 93' + content: 'static XUC: 93 = 93' return: description: '' type: '93' @@ -1488,10 +1371,9 @@ properties: summary: '' fullName: YLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static YLC: 68 = 68' + content: 'static YLC: 68 = 68' return: description: '' type: '68' @@ -1501,10 +1383,9 @@ properties: summary: '' fullName: YUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static YUC: 94 = 94' + content: 'static YUC: 94 = 94' return: description: '' type: '94' @@ -1514,10 +1395,9 @@ properties: summary: '' fullName: ZLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ZLC: 69 = 69' + content: 'static ZLC: 69 = 69' return: description: '' type: '69' @@ -1527,10 +1407,9 @@ properties: summary: '' fullName: ZUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ZUC: 95 = 95' + content: 'static ZUC: 95 = 95' return: description: '' type: '95' @@ -1543,21 +1422,21 @@ inheritedProperties: the recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by + the recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Lexer.atn - name: channel uid: adaptive-expressions.CommonRegexLexer.channel package: adaptive-expressions summary: '' fullName: channel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channel: number' @@ -1571,7 +1450,6 @@ inheritedProperties: summary: What is the index of the current character of lookahead? fullName: charIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charIndex: number' @@ -1585,7 +1463,6 @@ inheritedProperties: summary: '' fullName: charPositionInLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charPositionInLine: number' @@ -1599,7 +1476,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_MODE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_MODE: number' @@ -1613,7 +1489,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_TOKEN_CHANNEL remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_TOKEN_CHANNEL: number' @@ -1627,21 +1502,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Lexer.EOF - name: HIDDEN uid: adaptive-expressions.CommonRegexLexer.HIDDEN package: adaptive-expressions summary: '' fullName: HIDDEN remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static HIDDEN: number' @@ -1655,7 +1528,6 @@ inheritedProperties: summary: Set the char stream and reset the lexer fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: CharStream' @@ -1669,21 +1541,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: LexerATNSimulator' return: description: '' type: LexerATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Lexer.interpreter - name: line uid: adaptive-expressions.CommonRegexLexer.line package: adaptive-expressions summary: '' fullName: line remarks: '' - isPreview: false isDeprecated: false syntax: content: 'line: number' @@ -1697,7 +1567,6 @@ inheritedProperties: summary: '' fullName: MAX_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MAX_CHAR_VALUE: number' @@ -1711,7 +1580,6 @@ inheritedProperties: summary: '' fullName: MIN_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MIN_CHAR_VALUE: number' @@ -1725,7 +1593,6 @@ inheritedProperties: summary: '' fullName: MORE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MORE: number' @@ -1741,21 +1608,19 @@ inheritedProperties: for each decision in recognizer in a ParseInfo object. fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> - inheritanceDescription: Inherited From Recognizer.parseInfo + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Lexer.parseInfo - name: SKIP uid: adaptive-expressions.CommonRegexLexer.SKIP package: adaptive-expressions summary: '' fullName: SKIP remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static SKIP: number' @@ -1769,7 +1634,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -1789,14 +1653,13 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Lexer.state - name: text uid: adaptive-expressions.CommonRegexLexer.text package: adaptive-expressions @@ -1805,7 +1668,6 @@ inheritedProperties: changes to the text. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -1819,13 +1681,12 @@ inheritedProperties: summary: Override if emitting multiple tokens. fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'token: Token | undefined' + content: 'token: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From Lexer.token - name: tokenFactory uid: adaptive-expressions.CommonRegexLexer.tokenFactory @@ -1833,7 +1694,6 @@ inheritedProperties: summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -1847,7 +1707,6 @@ inheritedProperties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: number' @@ -1856,20 +1715,19 @@ inheritedProperties: type: number inheritanceDescription: Inherited From Lexer.type inheritedMethods: - - name: 'action(RuleContext | undefined, number, number)' + - name: action(undefined | RuleContext, number, number) uid: adaptive-expressions.CommonRegexLexer.action package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function action(_localctx: RuleContext | undefined, ruleIndex: number, + function action(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number) parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -1877,13 +1735,12 @@ inheritedMethods: - id: actionIndex type: number description: '' - inheritanceDescription: Inherited From Recognizer.action + inheritanceDescription: Inherited From Lexer.action - name: addErrorListener(ANTLRErrorListener) uid: adaptive-expressions.CommonRegexLexer.addErrorListener package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -1891,7 +1748,7 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Lexer.addErrorListener - name: emit() uid: adaptive-expressions.CommonRegexLexer.emit_1 package: adaptive-expressions @@ -1901,7 +1758,6 @@ inheritedMethods: and getToken (to push tokens into a list and pull from that list rather than a single variable as this implementation does). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(): Token' @@ -1919,7 +1775,6 @@ inheritedMethods: use that to set the token's text. Override this method to emit custom Token objects or provide a new factory. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(token: Token): Token' @@ -1936,7 +1791,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEOF(): Token' @@ -1951,20 +1805,18 @@ inheritedMethods: Return a list of all Token objects in input char stream. Forces load of all tokens. Does not include EOF token. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllTokens(): Token[]' return: description: '' - type: 'Token[]' + type: Token[] inheritanceDescription: Inherited From Lexer.getAllTokens - name: getCharErrorDisplay(number) uid: adaptive-expressions.CommonRegexLexer.getCharErrorDisplay package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCharErrorDisplay(c: number): string' @@ -1981,7 +1833,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorDisplay(s: string | number): string' @@ -1996,9 +1847,8 @@ inheritedMethods: - name: getErrorHeader(RecognitionException) uid: adaptive-expressions.CommonRegexLexer.getErrorHeader package: adaptive-expressions - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -2009,54 +1859,51 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Lexer.getErrorHeader - name: getErrorListenerDispatch() uid: adaptive-expressions.CommonRegexLexer.getErrorListenerDispatch package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ANTLRErrorListener' return: description: '' type: ANTLRErrorListener<number> - inheritanceDescription: Inherited From Recognizer.getErrorListenerDispatch + inheritanceDescription: Inherited From Lexer.getErrorListenerDispatch - name: getErrorListeners() uid: adaptive-expressions.CommonRegexLexer.getErrorListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<number>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<number>[] + inheritanceDescription: Inherited From Lexer.getErrorListeners - name: getRuleIndexMap() uid: adaptive-expressions.CommonRegexLexer.getRuleIndexMap package: adaptive-expressions - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getRuleIndexMap - name: getTokenType(string) uid: adaptive-expressions.CommonRegexLexer.getTokenType package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -2067,28 +1914,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Lexer.getTokenType - name: getTokenTypeMap() uid: adaptive-expressions.CommonRegexLexer.getTokenTypeMap package: adaptive-expressions - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getTokenTypeMap - name: mode(number) uid: adaptive-expressions.CommonRegexLexer.mode package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function mode(m: number)' @@ -2102,7 +1948,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function more() @@ -2114,7 +1959,6 @@ inheritedMethods: Return a token from this source; i.e., match a token on the char stream. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function nextToken(): Token' @@ -2127,7 +1971,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyListeners(e: LexerNoViableAltException)' @@ -2141,7 +1984,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function popMode(): number' @@ -2149,20 +1991,19 @@ inheritedMethods: description: '' type: number inheritanceDescription: Inherited From Lexer.popMode - - name: 'precpred(RuleContext | undefined, number)' + - name: precpred(undefined | RuleContext, number) uid: adaptive-expressions.CommonRegexLexer.precpred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function precpred(localctx: RuleContext | undefined, precedence: + function precpred(localctx: undefined | RuleContext, precedence: number): boolean parameters: - id: localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: precedence type: number @@ -2170,13 +2011,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.precpred + inheritanceDescription: Inherited From Lexer.precpred - name: pushMode(number) uid: adaptive-expressions.CommonRegexLexer.pushMode package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function pushMode(m: number)' @@ -2190,7 +2030,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: LexerNoViableAltException)' @@ -2208,7 +2047,6 @@ inheritedMethods: it all works out. You can instead use the rule invocation stack to do sophisticated error recovery if you are in a fragment rule. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: RecognitionException)' @@ -2222,7 +2060,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -2230,23 +2067,21 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Lexer.removeErrorListener - name: removeErrorListeners() uid: adaptive-expressions.CommonRegexLexer.removeErrorListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Lexer.removeErrorListeners - name: reset() uid: adaptive-expressions.CommonRegexLexer.reset package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -2256,7 +2091,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -2265,20 +2099,19 @@ inheritedMethods: type: boolean description: '' inheritanceDescription: Inherited From Lexer.reset - - name: 'sempred(RuleContext | undefined, number, number)' + - name: sempred(undefined | RuleContext, number, number) uid: adaptive-expressions.CommonRegexLexer.sempred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function sempred(_localctx: RuleContext | undefined, ruleIndex: number, + function sempred(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number): boolean parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -2289,7 +2122,7 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.sempred + inheritanceDescription: Inherited From Lexer.sempred - name: skip() uid: adaptive-expressions.CommonRegexLexer.skip package: adaptive-expressions @@ -2300,7 +2133,6 @@ inheritedMethods: if token==undefined at end of any token rule, it creates one for you and emits it. remarks: '' - isPreview: false isDeprecated: false syntax: content: function skip() diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexListener.yml index ff99f439..f6c4acd0 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexListener.yml @@ -7,7 +7,6 @@ summary: |- `CommonRegexParser`. fullName: CommonRegexListener remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.alpha_nums`. fullName: enterAlpha_nums remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterAlpha_nums?: (ctx: Alpha_numsContext) => void' @@ -30,7 +28,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.alternation`. fullName: enterAlternation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterAlternation?: (ctx: AlternationContext) => void' @@ -43,7 +40,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.atom`. fullName: enterAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterAtom?: (ctx: AtomContext) => void' @@ -56,7 +52,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.capture`. fullName: enterCapture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterCapture?: (ctx: CaptureContext) => void' @@ -69,7 +64,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.cc_atom`. fullName: enterCc_atom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterCc_atom?: (ctx: Cc_atomContext) => void' @@ -82,7 +76,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.cc_literal`. fullName: enterCc_literal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterCc_literal?: (ctx: Cc_literalContext) => void' @@ -95,7 +88,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.character_class`. fullName: enterCharacter_class remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterCharacter_class?: (ctx: Character_classContext) => void' @@ -108,7 +100,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.digit`. fullName: enterDigit remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterDigit?: (ctx: DigitContext) => void' @@ -121,7 +112,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.digits`. fullName: enterDigits remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterDigits?: (ctx: DigitsContext) => void' @@ -134,7 +124,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.element`. fullName: enterElement remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterElement?: (ctx: ElementContext) => void' @@ -147,7 +136,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.expr`. fullName: enterExpr remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterExpr?: (ctx: ExprContext) => void' @@ -160,7 +148,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.letter`. fullName: enterLetter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterLetter?: (ctx: LetterContext) => void' @@ -173,7 +160,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.literal`. fullName: enterLiteral remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterLiteral?: (ctx: LiteralContext) => void' @@ -186,7 +172,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.name`. fullName: enterName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterName?: (ctx: NameContext) => void' @@ -199,7 +184,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.non_capture`. fullName: enterNon_capture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNon_capture?: (ctx: Non_captureContext) => void' @@ -212,7 +196,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.non_close_paren`. fullName: enterNon_close_paren remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNon_close_paren?: (ctx: Non_close_parenContext) => void' @@ -225,7 +208,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.non_close_parens`. fullName: enterNon_close_parens remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNon_close_parens?: (ctx: Non_close_parensContext) => void' @@ -238,7 +220,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.number`. fullName: enterNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNumber?: (ctx: NumberContext) => void' @@ -251,7 +232,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.octal_char`. fullName: enterOctal_char remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterOctal_char?: (ctx: Octal_charContext) => void' @@ -264,7 +244,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.octal_digit`. fullName: enterOctal_digit remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterOctal_digit?: (ctx: Octal_digitContext) => void' @@ -277,7 +256,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.option`. fullName: enterOption remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterOption?: (ctx: OptionContext) => void' @@ -290,7 +268,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.option_flag`. fullName: enterOption_flag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterOption_flag?: (ctx: Option_flagContext) => void' @@ -303,7 +280,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.parse`. fullName: enterParse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterParse?: (ctx: ParseContext) => void' @@ -316,7 +292,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.quantifier`. fullName: enterQuantifier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterQuantifier?: (ctx: QuantifierContext) => void' @@ -329,7 +304,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.quantifier_type`. fullName: enterQuantifier_type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterQuantifier_type?: (ctx: Quantifier_typeContext) => void' @@ -342,7 +316,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.shared_atom`. fullName: enterShared_atom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterShared_atom?: (ctx: Shared_atomContext) => void' @@ -355,7 +328,6 @@ properties: summary: Enter a parse tree produced by `CommonRegexParser.shared_literal`. fullName: enterShared_literal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterShared_literal?: (ctx: Shared_literalContext) => void' @@ -368,7 +340,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.alpha_nums`. fullName: exitAlpha_nums remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitAlpha_nums?: (ctx: Alpha_numsContext) => void' @@ -381,7 +352,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.alternation`. fullName: exitAlternation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitAlternation?: (ctx: AlternationContext) => void' @@ -394,7 +364,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.atom`. fullName: exitAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitAtom?: (ctx: AtomContext) => void' @@ -407,7 +376,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.capture`. fullName: exitCapture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitCapture?: (ctx: CaptureContext) => void' @@ -420,7 +388,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.cc_atom`. fullName: exitCc_atom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitCc_atom?: (ctx: Cc_atomContext) => void' @@ -433,7 +400,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.cc_literal`. fullName: exitCc_literal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitCc_literal?: (ctx: Cc_literalContext) => void' @@ -446,7 +412,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.character_class`. fullName: exitCharacter_class remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitCharacter_class?: (ctx: Character_classContext) => void' @@ -459,7 +424,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.digit`. fullName: exitDigit remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitDigit?: (ctx: DigitContext) => void' @@ -472,7 +436,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.digits`. fullName: exitDigits remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitDigits?: (ctx: DigitsContext) => void' @@ -485,7 +448,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.element`. fullName: exitElement remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitElement?: (ctx: ElementContext) => void' @@ -498,7 +460,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.expr`. fullName: exitExpr remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitExpr?: (ctx: ExprContext) => void' @@ -511,7 +472,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.letter`. fullName: exitLetter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitLetter?: (ctx: LetterContext) => void' @@ -524,7 +484,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.literal`. fullName: exitLiteral remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitLiteral?: (ctx: LiteralContext) => void' @@ -537,7 +496,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.name`. fullName: exitName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitName?: (ctx: NameContext) => void' @@ -550,7 +508,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.non_capture`. fullName: exitNon_capture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNon_capture?: (ctx: Non_captureContext) => void' @@ -563,7 +520,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.non_close_paren`. fullName: exitNon_close_paren remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNon_close_paren?: (ctx: Non_close_parenContext) => void' @@ -576,7 +532,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.non_close_parens`. fullName: exitNon_close_parens remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNon_close_parens?: (ctx: Non_close_parensContext) => void' @@ -589,7 +544,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.number`. fullName: exitNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNumber?: (ctx: NumberContext) => void' @@ -602,7 +556,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.octal_char`. fullName: exitOctal_char remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitOctal_char?: (ctx: Octal_charContext) => void' @@ -615,7 +568,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.octal_digit`. fullName: exitOctal_digit remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitOctal_digit?: (ctx: Octal_digitContext) => void' @@ -628,7 +580,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.option`. fullName: exitOption remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitOption?: (ctx: OptionContext) => void' @@ -641,7 +592,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.option_flag`. fullName: exitOption_flag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitOption_flag?: (ctx: Option_flagContext) => void' @@ -654,7 +604,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.parse`. fullName: exitParse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitParse?: (ctx: ParseContext) => void' @@ -667,7 +616,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.quantifier`. fullName: exitQuantifier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitQuantifier?: (ctx: QuantifierContext) => void' @@ -680,7 +628,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.quantifier_type`. fullName: exitQuantifier_type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitQuantifier_type?: (ctx: Quantifier_typeContext) => void' @@ -693,7 +640,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.shared_atom`. fullName: exitShared_atom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitShared_atom?: (ctx: Shared_atomContext) => void' @@ -706,7 +652,6 @@ properties: summary: Exit a parse tree produced by `CommonRegexParser.shared_literal`. fullName: exitShared_literal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitShared_literal?: (ctx: Shared_literalContext) => void' @@ -720,7 +665,6 @@ inheritedProperties: summary: '' fullName: enterEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterEveryRule?: (ctx: ParserRuleContext) => void' @@ -734,7 +678,6 @@ inheritedProperties: summary: '' fullName: exitEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitEveryRule?: (ctx: ParserRuleContext) => void' @@ -748,7 +691,6 @@ inheritedProperties: summary: '' fullName: visitErrorNode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorNode?: (node: ErrorNode) => void' @@ -762,7 +704,6 @@ inheritedProperties: summary: '' fullName: visitTerminal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTerminal?: (node: TerminalNode) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexParser.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexParser.yml index 9454ce66..f20fb78d 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexParser.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexParser.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: CommonRegexParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CommonRegexParser(input: TokenStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: ALC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ALC: 44 = 44' + content: 'static ALC: 44 = 44' return: description: '' type: '44' @@ -42,10 +39,9 @@ properties: summary: '' fullName: Ampersand remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Ampersand: 43 = 43' + content: 'static Ampersand: 43 = 43' return: description: '' type: '43' @@ -55,10 +51,9 @@ properties: summary: '' fullName: AUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static AUC: 70 = 70' + content: 'static AUC: 70 = 70' return: description: '' type: '70' @@ -68,10 +63,9 @@ properties: summary: '' fullName: Backslash remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Backslash: 10 = 10' + content: 'static Backslash: 10 = 10' return: description: '' type: '10' @@ -81,10 +75,9 @@ properties: summary: '' fullName: BellChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BellChar: 3 = 3' + content: 'static BellChar: 3 = 3' return: description: '' type: '3' @@ -94,10 +87,9 @@ properties: summary: '' fullName: BLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BLC: 45 = 45' + content: 'static BLC: 45 = 45' return: description: '' type: '45' @@ -107,10 +99,9 @@ properties: summary: '' fullName: BlockQuoted remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BlockQuoted: 2 = 2' + content: 'static BlockQuoted: 2 = 2' return: description: '' type: '2' @@ -120,10 +111,9 @@ properties: summary: '' fullName: BUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static BUC: 71 = 71' + content: 'static BUC: 71 = 71' return: description: '' type: '71' @@ -133,10 +123,9 @@ properties: summary: '' fullName: Caret remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Caret: 23 = 23' + content: 'static Caret: 23 = 23' return: description: '' type: '23' @@ -146,10 +135,9 @@ properties: summary: '' fullName: CarriageReturn remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CarriageReturn: 8 = 8' + content: 'static CarriageReturn: 8 = 8' return: description: '' type: '8' @@ -159,10 +147,9 @@ properties: summary: '' fullName: CharacterClassEnd remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharacterClassEnd: 22 = 22' + content: 'static CharacterClassEnd: 22 = 22' return: description: '' type: '22' @@ -172,10 +159,9 @@ properties: summary: '' fullName: CharacterClassStart remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharacterClassStart: 21 = 21' + content: 'static CharacterClassStart: 21 = 21' return: description: '' type: '21' @@ -185,10 +171,9 @@ properties: summary: '' fullName: CharWithoutProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharWithoutProperty: 16 = 16' + content: 'static CharWithoutProperty: 16 = 16' return: description: '' type: '16' @@ -198,10 +183,9 @@ properties: summary: '' fullName: CharWithProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CharWithProperty: 15 = 15' + content: 'static CharWithProperty: 15 = 15' return: description: '' type: '15' @@ -211,10 +195,9 @@ properties: summary: '' fullName: CLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLC: 46 = 46' + content: 'static CLC: 46 = 46' return: description: '' type: '46' @@ -224,10 +207,9 @@ properties: summary: '' fullName: CloseBrace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CloseBrace: 29 = 29' + content: 'static CloseBrace: 29 = 29' return: description: '' type: '29' @@ -237,10 +219,9 @@ properties: summary: '' fullName: CloseParen remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CloseParen: 34 = 34' + content: 'static CloseParen: 34 = 34' return: description: '' type: '34' @@ -250,10 +231,9 @@ properties: summary: '' fullName: Colon remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Colon: 39 = 39' + content: 'static Colon: 39 = 39' return: description: '' type: '39' @@ -263,10 +243,9 @@ properties: summary: '' fullName: Comma remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Comma: 30 = 30' + content: 'static Comma: 30 = 30' return: description: '' type: '30' @@ -276,10 +255,9 @@ properties: summary: '' fullName: ControlChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ControlChar: 4 = 4' + content: 'static ControlChar: 4 = 4' return: description: '' type: '4' @@ -289,10 +267,9 @@ properties: summary: '' fullName: CUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CUC: 72 = 72' + content: 'static CUC: 72 = 72' return: description: '' type: '72' @@ -302,10 +279,9 @@ properties: summary: '' fullName: D0 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D0: 105 = 105' + content: 'static D0: 105 = 105' return: description: '' type: '105' @@ -315,10 +291,9 @@ properties: summary: '' fullName: D1 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D1: 96 = 96' + content: 'static D1: 96 = 96' return: description: '' type: '96' @@ -328,10 +303,9 @@ properties: summary: '' fullName: D2 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D2: 97 = 97' + content: 'static D2: 97 = 97' return: description: '' type: '97' @@ -341,10 +315,9 @@ properties: summary: '' fullName: D3 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D3: 98 = 98' + content: 'static D3: 98 = 98' return: description: '' type: '98' @@ -354,10 +327,9 @@ properties: summary: '' fullName: D4 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D4: 99 = 99' + content: 'static D4: 99 = 99' return: description: '' type: '99' @@ -367,10 +339,9 @@ properties: summary: '' fullName: D5 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D5: 100 = 100' + content: 'static D5: 100 = 100' return: description: '' type: '100' @@ -380,10 +351,9 @@ properties: summary: '' fullName: D6 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D6: 101 = 101' + content: 'static D6: 101 = 101' return: description: '' type: '101' @@ -393,10 +363,9 @@ properties: summary: '' fullName: D7 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D7: 102 = 102' + content: 'static D7: 102 = 102' return: description: '' type: '102' @@ -406,10 +375,9 @@ properties: summary: '' fullName: D8 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D8: 103 = 103' + content: 'static D8: 103 = 103' return: description: '' type: '103' @@ -419,10 +387,9 @@ properties: summary: '' fullName: D9 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static D9: 104 = 104' + content: 'static D9: 104 = 104' return: description: '' type: '104' @@ -432,10 +399,9 @@ properties: summary: '' fullName: DecimalDigit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DecimalDigit: 13 = 13' + content: 'static DecimalDigit: 13 = 13' return: description: '' type: '13' @@ -445,10 +411,9 @@ properties: summary: '' fullName: DLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DLC: 47 = 47' + content: 'static DLC: 47 = 47' return: description: '' type: '47' @@ -458,10 +423,9 @@ properties: summary: '' fullName: Dot remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Dot: 12 = 12' + content: 'static Dot: 12 = 12' return: description: '' type: '12' @@ -471,10 +435,9 @@ properties: summary: '' fullName: DUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DUC: 73 = 73' + content: 'static DUC: 73 = 73' return: description: '' type: '73' @@ -484,10 +447,9 @@ properties: summary: '' fullName: ELC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ELC: 48 = 48' + content: 'static ELC: 48 = 48' return: description: '' type: '48' @@ -497,10 +459,9 @@ properties: summary: '' fullName: EndOfSubject remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EndOfSubject: 31 = 31' + content: 'static EndOfSubject: 31 = 31' return: description: '' type: '31' @@ -510,10 +471,9 @@ properties: summary: '' fullName: Equals remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Equals: 41 = 41' + content: 'static Equals: 41 = 41' return: description: '' type: '41' @@ -523,10 +483,9 @@ properties: summary: '' fullName: EscapeChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EscapeChar: 5 = 5' + content: 'static EscapeChar: 5 = 5' return: description: '' type: '5' @@ -536,10 +495,9 @@ properties: summary: '' fullName: EUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EUC: 74 = 74' + content: 'static EUC: 74 = 74' return: description: '' type: '74' @@ -549,10 +507,9 @@ properties: summary: '' fullName: Exclamation remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Exclamation: 42 = 42' + content: 'static Exclamation: 42 = 42' return: description: '' type: '42' @@ -562,10 +519,9 @@ properties: summary: '' fullName: FLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static FLC: 49 = 49' + content: 'static FLC: 49 = 49' return: description: '' type: '49' @@ -575,10 +531,9 @@ properties: summary: '' fullName: FormFeed remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static FormFeed: 6 = 6' + content: 'static FormFeed: 6 = 6' return: description: '' type: '6' @@ -588,10 +543,9 @@ properties: summary: '' fullName: FUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static FUC: 75 = 75' + content: 'static FUC: 75 = 75' return: description: '' type: '75' @@ -601,10 +555,9 @@ properties: summary: '' fullName: GLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static GLC: 50 = 50' + content: 'static GLC: 50 = 50' return: description: '' type: '50' @@ -614,10 +567,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -627,10 +579,9 @@ properties: summary: '' fullName: GreaterThan remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static GreaterThan: 36 = 36' + content: 'static GreaterThan: 36 = 36' return: description: '' type: '36' @@ -640,10 +591,9 @@ properties: summary: '' fullName: GUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static GUC: 76 = 76' + content: 'static GUC: 76 = 76' return: description: '' type: '76' @@ -653,10 +603,9 @@ properties: summary: '' fullName: Hash remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Hash: 40 = 40' + content: 'static Hash: 40 = 40' return: description: '' type: '40' @@ -666,10 +615,9 @@ properties: summary: '' fullName: HexChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static HexChar: 11 = 11' + content: 'static HexChar: 11 = 11' return: description: '' type: '11' @@ -679,10 +627,9 @@ properties: summary: '' fullName: HLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static HLC: 51 = 51' + content: 'static HLC: 51 = 51' return: description: '' type: '51' @@ -692,10 +639,9 @@ properties: summary: '' fullName: HUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static HUC: 77 = 77' + content: 'static HUC: 77 = 77' return: description: '' type: '77' @@ -705,10 +651,9 @@ properties: summary: '' fullName: Hyphen remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Hyphen: 24 = 24' + content: 'static Hyphen: 24 = 24' return: description: '' type: '24' @@ -718,10 +663,9 @@ properties: summary: '' fullName: ILC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ILC: 52 = 52' + content: 'static ILC: 52 = 52' return: description: '' type: '52' @@ -731,10 +675,9 @@ properties: summary: '' fullName: IUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IUC: 78 = 78' + content: 'static IUC: 78 = 78' return: description: '' type: '78' @@ -744,10 +687,9 @@ properties: summary: '' fullName: JLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static JLC: 53 = 53' + content: 'static JLC: 53 = 53' return: description: '' type: '53' @@ -757,10 +699,9 @@ properties: summary: '' fullName: JUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static JUC: 79 = 79' + content: 'static JUC: 79 = 79' return: description: '' type: '79' @@ -770,10 +711,9 @@ properties: summary: '' fullName: KLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static KLC: 54 = 54' + content: 'static KLC: 54 = 54' return: description: '' type: '54' @@ -783,10 +723,9 @@ properties: summary: '' fullName: KUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static KUC: 80 = 80' + content: 'static KUC: 80 = 80' return: description: '' type: '80' @@ -796,10 +735,9 @@ properties: summary: '' fullName: LessThan remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LessThan: 35 = 35' + content: 'static LessThan: 35 = 35' return: description: '' type: '35' @@ -809,10 +747,9 @@ properties: summary: '' fullName: LLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LLC: 55 = 55' + content: 'static LLC: 55 = 55' return: description: '' type: '55' @@ -822,10 +759,9 @@ properties: summary: '' fullName: LUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LUC: 81 = 81' + content: 'static LUC: 81 = 81' return: description: '' type: '81' @@ -835,10 +771,9 @@ properties: summary: '' fullName: MLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MLC: 56 = 56' + content: 'static MLC: 56 = 56' return: description: '' type: '56' @@ -848,10 +783,9 @@ properties: summary: '' fullName: MUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MUC: 82 = 82' + content: 'static MUC: 82 = 82' return: description: '' type: '82' @@ -861,10 +795,9 @@ properties: summary: '' fullName: NewLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NewLine: 7 = 7' + content: 'static NewLine: 7 = 7' return: description: '' type: '7' @@ -874,10 +807,9 @@ properties: summary: '' fullName: NLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NLC: 57 = 57' + content: 'static NLC: 57 = 57' return: description: '' type: '57' @@ -887,10 +819,9 @@ properties: summary: '' fullName: NotDecimalDigit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NotDecimalDigit: 14 = 14' + content: 'static NotDecimalDigit: 14 = 14' return: description: '' type: '14' @@ -900,10 +831,9 @@ properties: summary: '' fullName: NotWhiteSpace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NotWhiteSpace: 18 = 18' + content: 'static NotWhiteSpace: 18 = 18' return: description: '' type: '18' @@ -913,10 +843,9 @@ properties: summary: '' fullName: NotWordChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NotWordChar: 20 = 20' + content: 'static NotWordChar: 20 = 20' return: description: '' type: '20' @@ -926,10 +855,9 @@ properties: summary: '' fullName: NUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NUC: 83 = 83' + content: 'static NUC: 83 = 83' return: description: '' type: '83' @@ -939,10 +867,9 @@ properties: summary: '' fullName: OLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OLC: 58 = 58' + content: 'static OLC: 58 = 58' return: description: '' type: '58' @@ -952,10 +879,9 @@ properties: summary: '' fullName: OpenBrace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OpenBrace: 28 = 28' + content: 'static OpenBrace: 28 = 28' return: description: '' type: '28' @@ -965,10 +891,9 @@ properties: summary: '' fullName: OpenParen remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OpenParen: 33 = 33' + content: 'static OpenParen: 33 = 33' return: description: '' type: '33' @@ -978,10 +903,9 @@ properties: summary: '' fullName: OtherChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OtherChar: 106 = 106' + content: 'static OtherChar: 106 = 106' return: description: '' type: '106' @@ -991,10 +915,9 @@ properties: summary: '' fullName: OUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OUC: 84 = 84' + content: 'static OUC: 84 = 84' return: description: '' type: '84' @@ -1004,10 +927,9 @@ properties: summary: '' fullName: Pipe remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Pipe: 32 = 32' + content: 'static Pipe: 32 = 32' return: description: '' type: '32' @@ -1017,10 +939,9 @@ properties: summary: '' fullName: PLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PLC: 59 = 59' + content: 'static PLC: 59 = 59' return: description: '' type: '59' @@ -1030,10 +951,9 @@ properties: summary: '' fullName: Plus remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Plus: 26 = 26' + content: 'static Plus: 26 = 26' return: description: '' type: '26' @@ -1043,10 +963,9 @@ properties: summary: '' fullName: PUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PUC: 85 = 85' + content: 'static PUC: 85 = 85' return: description: '' type: '85' @@ -1056,10 +975,9 @@ properties: summary: '' fullName: QLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QLC: 60 = 60' + content: 'static QLC: 60 = 60' return: description: '' type: '60' @@ -1069,10 +987,9 @@ properties: summary: '' fullName: QUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QUC: 86 = 86' + content: 'static QUC: 86 = 86' return: description: '' type: '86' @@ -1082,10 +999,9 @@ properties: summary: '' fullName: QuestionMark remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QuestionMark: 25 = 25' + content: 'static QuestionMark: 25 = 25' return: description: '' type: '25' @@ -1095,10 +1011,9 @@ properties: summary: '' fullName: Quoted remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Quoted: 1 = 1' + content: 'static Quoted: 1 = 1' return: description: '' type: '1' @@ -1108,10 +1023,9 @@ properties: summary: '' fullName: RLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RLC: 61 = 61' + content: 'static RLC: 61 = 61' return: description: '' type: '61' @@ -1121,10 +1035,9 @@ properties: summary: '' fullName: RUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RUC: 87 = 87' + content: 'static RUC: 87 = 87' return: description: '' type: '87' @@ -1134,36 +1047,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\n\t\t\"parse\", \"alternation\", \"expr\", \"element\", \"quantifier\", \"quantifier_type\", \n\t\t\"character_class\", \"capture\", \"non_capture\", \"option\", \"option_flag\", \n\t\t\"atom\", \"cc_atom\", \"shared_atom\", \"literal\", \"cc_literal\", \"shared_literal\", \n\t\t\"number\", \"octal_char\", \"octal_digit\", \"digits\", \"digit\", \"name\", \"alpha_nums\", \n\t\t\"non_close_parens\", \"non_close_paren\", \"letter\",\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: adaptive-expressions.CommonRegexParser.ruleNames package: adaptive-expressions summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: RULE_alpha_nums uid: adaptive-expressions.CommonRegexParser.RULE_alpha_nums package: adaptive-expressions summary: '' fullName: RULE_alpha_nums remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_alpha_nums: 23 = 23' + content: 'static RULE_alpha_nums: 23 = 23' return: description: '' type: '23' @@ -1173,10 +1083,9 @@ properties: summary: '' fullName: RULE_alternation remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_alternation: 1 = 1' + content: 'static RULE_alternation: 1 = 1' return: description: '' type: '1' @@ -1186,10 +1095,9 @@ properties: summary: '' fullName: RULE_atom remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_atom: 11 = 11' + content: 'static RULE_atom: 11 = 11' return: description: '' type: '11' @@ -1199,10 +1107,9 @@ properties: summary: '' fullName: RULE_capture remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_capture: 7 = 7' + content: 'static RULE_capture: 7 = 7' return: description: '' type: '7' @@ -1212,10 +1119,9 @@ properties: summary: '' fullName: RULE_cc_atom remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_cc_atom: 12 = 12' + content: 'static RULE_cc_atom: 12 = 12' return: description: '' type: '12' @@ -1225,10 +1131,9 @@ properties: summary: '' fullName: RULE_cc_literal remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_cc_literal: 15 = 15' + content: 'static RULE_cc_literal: 15 = 15' return: description: '' type: '15' @@ -1238,10 +1143,9 @@ properties: summary: '' fullName: RULE_character_class remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_character_class: 6 = 6' + content: 'static RULE_character_class: 6 = 6' return: description: '' type: '6' @@ -1251,10 +1155,9 @@ properties: summary: '' fullName: RULE_digit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_digit: 21 = 21' + content: 'static RULE_digit: 21 = 21' return: description: '' type: '21' @@ -1264,10 +1167,9 @@ properties: summary: '' fullName: RULE_digits remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_digits: 20 = 20' + content: 'static RULE_digits: 20 = 20' return: description: '' type: '20' @@ -1277,10 +1179,9 @@ properties: summary: '' fullName: RULE_element remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_element: 3 = 3' + content: 'static RULE_element: 3 = 3' return: description: '' type: '3' @@ -1290,10 +1191,9 @@ properties: summary: '' fullName: RULE_expr remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_expr: 2 = 2' + content: 'static RULE_expr: 2 = 2' return: description: '' type: '2' @@ -1303,10 +1203,9 @@ properties: summary: '' fullName: RULE_letter remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_letter: 26 = 26' + content: 'static RULE_letter: 26 = 26' return: description: '' type: '26' @@ -1316,10 +1215,9 @@ properties: summary: '' fullName: RULE_literal remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_literal: 14 = 14' + content: 'static RULE_literal: 14 = 14' return: description: '' type: '14' @@ -1329,10 +1227,9 @@ properties: summary: '' fullName: RULE_name remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_name: 22 = 22' + content: 'static RULE_name: 22 = 22' return: description: '' type: '22' @@ -1342,10 +1239,9 @@ properties: summary: '' fullName: RULE_non_capture remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_non_capture: 8 = 8' + content: 'static RULE_non_capture: 8 = 8' return: description: '' type: '8' @@ -1355,10 +1251,9 @@ properties: summary: '' fullName: RULE_non_close_paren remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_non_close_paren: 25 = 25' + content: 'static RULE_non_close_paren: 25 = 25' return: description: '' type: '25' @@ -1368,10 +1263,9 @@ properties: summary: '' fullName: RULE_non_close_parens remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_non_close_parens: 24 = 24' + content: 'static RULE_non_close_parens: 24 = 24' return: description: '' type: '24' @@ -1381,10 +1275,9 @@ properties: summary: '' fullName: RULE_number remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_number: 17 = 17' + content: 'static RULE_number: 17 = 17' return: description: '' type: '17' @@ -1394,10 +1287,9 @@ properties: summary: '' fullName: RULE_octal_char remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_octal_char: 18 = 18' + content: 'static RULE_octal_char: 18 = 18' return: description: '' type: '18' @@ -1407,10 +1299,9 @@ properties: summary: '' fullName: RULE_octal_digit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_octal_digit: 19 = 19' + content: 'static RULE_octal_digit: 19 = 19' return: description: '' type: '19' @@ -1420,10 +1311,9 @@ properties: summary: '' fullName: RULE_option remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_option: 9 = 9' + content: 'static RULE_option: 9 = 9' return: description: '' type: '9' @@ -1433,10 +1323,9 @@ properties: summary: '' fullName: RULE_option_flag remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_option_flag: 10 = 10' + content: 'static RULE_option_flag: 10 = 10' return: description: '' type: '10' @@ -1446,10 +1335,9 @@ properties: summary: '' fullName: RULE_parse remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_parse: 0 = 0' + content: 'static RULE_parse: 0 = 0' return: description: '' type: '0' @@ -1459,10 +1347,9 @@ properties: summary: '' fullName: RULE_quantifier remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_quantifier: 4 = 4' + content: 'static RULE_quantifier: 4 = 4' return: description: '' type: '4' @@ -1472,10 +1359,9 @@ properties: summary: '' fullName: RULE_quantifier_type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_quantifier_type: 5 = 5' + content: 'static RULE_quantifier_type: 5 = 5' return: description: '' type: '5' @@ -1485,10 +1371,9 @@ properties: summary: '' fullName: RULE_shared_atom remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_shared_atom: 13 = 13' + content: 'static RULE_shared_atom: 13 = 13' return: description: '' type: '13' @@ -1498,10 +1383,9 @@ properties: summary: '' fullName: RULE_shared_literal remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_shared_literal: 16 = 16' + content: 'static RULE_shared_literal: 16 = 16' return: description: '' type: '16' @@ -1511,10 +1395,9 @@ properties: summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -1524,10 +1407,9 @@ properties: summary: '' fullName: SingleQuote remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SingleQuote: 37 = 37' + content: 'static SingleQuote: 37 = 37' return: description: '' type: '37' @@ -1537,10 +1419,9 @@ properties: summary: '' fullName: SLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SLC: 62 = 62' + content: 'static SLC: 62 = 62' return: description: '' type: '62' @@ -1550,10 +1431,9 @@ properties: summary: '' fullName: Star remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Star: 27 = 27' + content: 'static Star: 27 = 27' return: description: '' type: '27' @@ -1563,10 +1443,9 @@ properties: summary: '' fullName: SUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SUC: 88 = 88' + content: 'static SUC: 88 = 88' return: description: '' type: '88' @@ -1576,10 +1455,9 @@ properties: summary: '' fullName: Tab remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Tab: 9 = 9' + content: 'static Tab: 9 = 9' return: description: '' type: '9' @@ -1589,10 +1467,9 @@ properties: summary: '' fullName: TLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TLC: 63 = 63' + content: 'static TLC: 63 = 63' return: description: '' type: '63' @@ -1602,10 +1479,9 @@ properties: summary: '' fullName: TUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TUC: 89 = 89' + content: 'static TUC: 89 = 89' return: description: '' type: '89' @@ -1615,10 +1491,9 @@ properties: summary: '' fullName: ULC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ULC: 64 = 64' + content: 'static ULC: 64 = 64' return: description: '' type: '64' @@ -1628,10 +1503,9 @@ properties: summary: '' fullName: Underscore remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static Underscore: 38 = 38' + content: 'static Underscore: 38 = 38' return: description: '' type: '38' @@ -1641,10 +1515,9 @@ properties: summary: '' fullName: UUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static UUC: 90 = 90' + content: 'static UUC: 90 = 90' return: description: '' type: '90' @@ -1654,39 +1527,33 @@ properties: summary: '' fullName: VLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static VLC: 65 = 65' + content: 'static VLC: 65 = 65' return: description: '' type: '65' - - name: VOCABULARY - uid: adaptive-expressions.CommonRegexParser.VOCABULARY + - name: vocabulary + uid: adaptive-expressions.CommonRegexParser.vocabulary package: adaptive-expressions summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(CommonRegexParser._LITERAL_NAMES, - CommonRegexParser._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: adaptive-expressions.CommonRegexParser.vocabulary + - name: VOCABULARY + uid: adaptive-expressions.CommonRegexParser.VOCABULARY package: adaptive-expressions summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -1696,10 +1563,9 @@ properties: summary: '' fullName: VUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static VUC: 91 = 91' + content: 'static VUC: 91 = 91' return: description: '' type: '91' @@ -1709,10 +1575,9 @@ properties: summary: '' fullName: WhiteSpace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WhiteSpace: 17 = 17' + content: 'static WhiteSpace: 17 = 17' return: description: '' type: '17' @@ -1722,10 +1587,9 @@ properties: summary: '' fullName: WLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WLC: 66 = 66' + content: 'static WLC: 66 = 66' return: description: '' type: '66' @@ -1735,10 +1599,9 @@ properties: summary: '' fullName: WordChar remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WordChar: 19 = 19' + content: 'static WordChar: 19 = 19' return: description: '' type: '19' @@ -1748,10 +1611,9 @@ properties: summary: '' fullName: WUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WUC: 92 = 92' + content: 'static WUC: 92 = 92' return: description: '' type: '92' @@ -1761,10 +1623,9 @@ properties: summary: '' fullName: XLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static XLC: 67 = 67' + content: 'static XLC: 67 = 67' return: description: '' type: '67' @@ -1774,10 +1635,9 @@ properties: summary: '' fullName: XUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static XUC: 93 = 93' + content: 'static XUC: 93 = 93' return: description: '' type: '93' @@ -1787,10 +1647,9 @@ properties: summary: '' fullName: YLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static YLC: 68 = 68' + content: 'static YLC: 68 = 68' return: description: '' type: '68' @@ -1800,10 +1659,9 @@ properties: summary: '' fullName: YUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static YUC: 94 = 94' + content: 'static YUC: 94 = 94' return: description: '' type: '94' @@ -1813,10 +1671,9 @@ properties: summary: '' fullName: ZLC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ZLC: 69 = 69' + content: 'static ZLC: 69 = 69' return: description: '' type: '69' @@ -1826,10 +1683,9 @@ properties: summary: '' fullName: ZUC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ZUC: 95 = 95' + content: 'static ZUC: 95 = 95' return: description: '' type: '95' @@ -1842,22 +1698,24 @@ inheritedProperties: the recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by + the recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Parser.atn - name: buildParseTree uid: adaptive-expressions.CommonRegexParser.buildParseTree package: adaptive-expressions - summary: | + summary: |- Track the objects during the parse and hook them up using the list so that it forms a parse tree. The returned from the start rule represents the root of the parse tree. + Note that if we are not building parse trees, rule contexts only point upwards. When a rule exits, it returns the context but that gets garbage collected if nobody holds a reference. It points upwards but nobody @@ -1868,7 +1726,6 @@ inheritedProperties: for garbage collection. fullName: buildParseTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buildParseTree: boolean' @@ -1882,7 +1739,6 @@ inheritedProperties: summary: '' fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: ParserRuleContext' @@ -1898,7 +1754,6 @@ inheritedProperties: into the label for the associated token ref; e.g., x=ID. fullName: currentToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'currentToken: Token' @@ -1912,21 +1767,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Parser.EOF - name: errorHandler uid: adaptive-expressions.CommonRegexParser.errorHandler package: adaptive-expressions summary: '' fullName: errorHandler remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorHandler: ANTLRErrorStrategy' @@ -1940,7 +1793,6 @@ inheritedProperties: summary: Set the token stream and reset the parser. fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: TokenStream' @@ -1954,21 +1806,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: ParserATNSimulator' return: description: '' type: ParserATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Parser.interpreter - name: isMatchedEOF uid: adaptive-expressions.CommonRegexParser.isMatchedEOF package: adaptive-expressions summary: '' fullName: isMatchedEOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isMatchedEOF: boolean' @@ -1984,7 +1834,6 @@ inheritedProperties: events as well as token matches. This is for quick and dirty debugging. fullName: isTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTrace: boolean' @@ -2002,7 +1851,6 @@ inheritedProperties: See #notifyErrorListeners fullName: numberOfSyntaxErrors remarks: '' - isPreview: false isDeprecated: false syntax: content: 'numberOfSyntaxErrors: number' @@ -2016,13 +1864,12 @@ inheritedProperties: summary: '' fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> + type: Promise<undefined | ParseInfo> inheritanceDescription: Inherited From Parser.parseInfo - name: precedence uid: adaptive-expressions.CommonRegexParser.precedence @@ -2030,12 +1877,13 @@ inheritedProperties: summary: Get the precedence level for the top-most precedence rule. fullName: precedence remarks: '' - isPreview: false isDeprecated: false syntax: content: 'precedence: number' return: - description: '' + description: |- + The precedence level for the top-most precedence rule, or -1 if + the parser context is not nested within a precedence rule. type: number inheritanceDescription: Inherited From Parser.precedence - name: ruleContext @@ -2044,7 +1892,6 @@ inheritedProperties: summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ruleContext: ParserRuleContext' @@ -2058,7 +1905,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -2078,21 +1924,19 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Parser.state - name: tokenFactory uid: adaptive-expressions.CommonRegexParser.tokenFactory package: adaptive-expressions summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -2101,20 +1945,19 @@ inheritedProperties: type: TokenFactory inheritanceDescription: Inherited From Parser.tokenFactory inheritedMethods: - - name: 'action(RuleContext | undefined, number, number)' + - name: action(undefined | RuleContext, number, number) uid: adaptive-expressions.CommonRegexParser.action package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function action(_localctx: RuleContext | undefined, ruleIndex: number, + function action(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number) parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -2122,13 +1965,12 @@ inheritedMethods: - id: actionIndex type: number description: '' - inheritanceDescription: Inherited From Recognizer.action + inheritanceDescription: Inherited From Parser.action - name: addErrorListener(ANTLRErrorListener) uid: adaptive-expressions.CommonRegexParser.addErrorListener package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -2136,12 +1978,13 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Parser.addErrorListener - name: addParseListener(ParseTreeListener) uid: adaptive-expressions.CommonRegexParser.addParseListener package: adaptive-expressions - summary: | + summary: |- Registers `listener` to receive events during the parsing process. + To support output-preserving grammar transformations (including but not limited to left-recursion removal, automated left-factoring, and optimized code generation), calls to listener methods during the parse @@ -2162,24 +2005,23 @@ inheritedMethods: * Changing the version of the ANTLR Tool used to generate the parser may change the behavior of the listener calls. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to add + description: the listener to add inheritanceDescription: Inherited From Parser.addParseListener - - name: 'compileParseTreePattern(string, number)' + - name: compileParseTreePattern(string, number) uid: adaptive-expressions.CommonRegexParser.compileParseTreePattern package: adaptive-expressions - summary: > + summary: >- The preferred method of getting a tree pattern. For example, here's a sample use: + ``` let t: ParseTree = parser.expr(); @@ -2193,7 +2035,6 @@ inheritedMethods: ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2210,7 +2051,7 @@ inheritedMethods: description: '' type: Promise<ParseTreePattern> inheritanceDescription: Inherited From Parser.compileParseTreePattern - - name: 'compileParseTreePattern(string, number, Lexer)' + - name: compileParseTreePattern(string, number, Lexer) uid: adaptive-expressions.CommonRegexParser.compileParseTreePattern_1 package: adaptive-expressions summary: >- @@ -2220,7 +2061,6 @@ inheritedMethods: rather than trying to deduce it from this parser. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2243,9 +2083,10 @@ inheritedMethods: - name: consume() uid: adaptive-expressions.CommonRegexParser.consume package: adaptive-expressions - summary: > + summary: >- Consume and return the [current symbol](`currentToken`). + E.g., given the following input with `A` being the current lookahead symbol, this function moves the cursor to `B` and returns @@ -2280,7 +2121,6 @@ inheritedMethods: listeners. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function consume(): Token' @@ -2288,14 +2128,13 @@ inheritedMethods: description: '' type: Token inheritanceDescription: Inherited From Parser.consume - - name: 'createErrorNode(ParserRuleContext, Token)' + - name: createErrorNode(ParserRuleContext, Token) uid: adaptive-expressions.CommonRegexParser.createErrorNode package: adaptive-expressions summary: |- How to create an error node, given a token, associated with a parent. Typically, the error node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createErrorNode(parent: ParserRuleContext, t: Token): ErrorNode' @@ -2310,14 +2149,13 @@ inheritedMethods: description: '' type: ErrorNode inheritanceDescription: Inherited From Parser.createErrorNode - - name: 'createTerminalNode(ParserRuleContext, Token)' + - name: createTerminalNode(ParserRuleContext, Token) uid: adaptive-expressions.CommonRegexParser.createTerminalNode package: adaptive-expressions summary: |- How to create a token leaf node associated with a parent. Typically, the terminal node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2339,17 +2177,15 @@ inheritedMethods: package: adaptive-expressions summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: function dumpDFA() inheritanceDescription: Inherited From Parser.dumpDFA - - name: 'enterLeftFactoredRule(ParserRuleContext, number, number)' + - name: enterLeftFactoredRule(ParserRuleContext, number, number) uid: adaptive-expressions.CommonRegexParser.enterLeftFactoredRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2366,12 +2202,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterLeftFactoredRule - - name: 'enterOuterAlt(ParserRuleContext, number)' + - name: enterOuterAlt(ParserRuleContext, number) uid: adaptive-expressions.CommonRegexParser.enterOuterAlt package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterOuterAlt(localctx: ParserRuleContext, altNum: number)' @@ -2383,12 +2218,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterOuterAlt - - name: 'enterRecursionRule(ParserRuleContext, number, number, number)' + - name: enterRecursionRule(ParserRuleContext, number, number, number) uid: adaptive-expressions.CommonRegexParser.enterRecursionRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2408,14 +2242,13 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterRecursionRule - - name: 'enterRule(ParserRuleContext, number, number)' + - name: enterRule(ParserRuleContext, number, number) uid: adaptive-expressions.CommonRegexParser.enterRule package: adaptive-expressions summary: |- Always called by generated parsers upon entry to a rule. Access field get the current context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2437,7 +2270,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function exitRule() @@ -2445,13 +2277,13 @@ inheritedMethods: - name: getATNWithBypassAlts() uid: adaptive-expressions.CommonRegexParser.getATNWithBypassAlts package: adaptive-expressions - summary: | + summary: |- The ATN with bypass alternatives is expensive to create so we create it lazily. + @ if the current parser does not implement the `serializedATN` property. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getATNWithBypassAlts(): ATN' @@ -2464,20 +2296,18 @@ inheritedMethods: package: adaptive-expressions summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getDFAStrings(): string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getDFAStrings - name: getErrorHeader(RecognitionException) uid: adaptive-expressions.CommonRegexParser.getErrorHeader package: adaptive-expressions - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -2488,13 +2318,12 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Parser.getErrorHeader - name: getErrorListenerDispatch() uid: adaptive-expressions.CommonRegexParser.getErrorListenerDispatch package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ParserErrorListener' @@ -2507,14 +2336,13 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<Token>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<Token>[] + inheritanceDescription: Inherited From Parser.getErrorListeners - name: getExpectedTokens() uid: adaptive-expressions.CommonRegexParser.getExpectedTokens package: adaptive-expressions @@ -2529,7 +2357,6 @@ inheritedMethods: See ATN#getExpectedTokens(int, RuleContext) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokens(): IntervalSet' @@ -2542,7 +2369,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokensWithinCurrentRule(): IntervalSet' @@ -2555,39 +2381,36 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function getInvokingContext(ruleIndex: number): ParserRuleContext | - undefined + function getInvokingContext(ruleIndex: number): undefined | + ParserRuleContext parameters: - id: ruleIndex type: number description: '' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From Parser.getInvokingContext - name: getParseListeners() uid: adaptive-expressions.CommonRegexParser.getParseListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getParseListeners(): ParseTreeListener[]' return: description: '' - type: 'ParseTreeListener[]' + type: ParseTreeListener[] inheritanceDescription: Inherited From Parser.getParseListeners - name: getRuleIndex(string) uid: adaptive-expressions.CommonRegexParser.getRuleIndex package: adaptive-expressions - summary: 'Get a rule''s index (i.e., `RULE_ruleName` field) or -1 if not found.' + summary: Get a rule's index (i.e., `RULE_ruleName` field) or -1 if not found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndex(ruleName: string): number' @@ -2602,29 +2425,29 @@ inheritedMethods: - name: getRuleIndexMap() uid: adaptive-expressions.CommonRegexParser.getRuleIndexMap package: adaptive-expressions - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getRuleIndexMap - name: getRuleInvocationStack(RuleContext) uid: adaptive-expressions.CommonRegexParser.getRuleInvocationStack package: adaptive-expressions - summary: | + summary: |- Return List<String> of the rule names in your parser instance leading up to a call to the current rule. You could override if you want more details such as the file/line info of where in the ATN a rule is invoked. + This is very useful for error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleInvocationStack(ctx?: RuleContext): string[]' @@ -2634,14 +2457,13 @@ inheritedMethods: description: '' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getRuleInvocationStack - name: getTokenType(string) uid: adaptive-expressions.CommonRegexParser.getTokenType package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -2652,28 +2474,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Parser.getTokenType - name: getTokenTypeMap() uid: adaptive-expressions.CommonRegexParser.getTokenTypeMap package: adaptive-expressions - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getTokenTypeMap - name: inContext(string) uid: adaptive-expressions.CommonRegexParser.inContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function inContext(context: string): boolean' @@ -2688,16 +2509,16 @@ inheritedMethods: - name: isExpectedToken(number) uid: adaptive-expressions.CommonRegexParser.isExpectedToken package: adaptive-expressions - summary: | + summary: |- Checks whether or not `symbol` can follow the current state in the ATN. The behavior of this method is equivalent to the following, but is implemented such that the complete context-sensitive follow set does not need to be explicitly constructed. + ``` return getExpectedTokens().contains(symbol); ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isExpectedToken(symbol: number): boolean' @@ -2714,13 +2535,14 @@ inheritedMethods: - name: match(number) uid: adaptive-expressions.CommonRegexParser.match package: adaptive-expressions - summary: > + summary: >- Match current input symbol against `ttype`. If the symbol type matches, and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -2736,7 +2558,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function match(ttype: number): Token' @@ -2755,13 +2576,14 @@ inheritedMethods: - name: matchWildcard() uid: adaptive-expressions.CommonRegexParser.matchWildcard package: adaptive-expressions - summary: > + summary: >- Match current input symbol as a wildcard. If the symbol type matches (i.e. has a value greater than 0), and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -2777,7 +2599,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function matchWildcard(): Token' @@ -2798,7 +2619,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyErrorListeners(msg: string)' @@ -2808,35 +2628,33 @@ inheritedMethods: description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - name: >- - notifyErrorListeners(string, Token | null, RecognitionException | - undefined) + notifyErrorListeners(string, null | Token, undefined | + RecognitionException) uid: adaptive-expressions.CommonRegexParser.notifyErrorListeners_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function notifyErrorListeners(msg: string, offendingToken: Token | null, - e: RecognitionException | undefined) + function notifyErrorListeners(msg: string, offendingToken: null | Token, + e: undefined | RecognitionException) parameters: - id: msg type: string description: '' - id: offendingToken - type: Token | null + type: null | Token description: '' - id: e - type: RecognitionException | undefined + type: undefined | RecognitionException description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - - name: 'precpred(RuleContext, number)' + - name: precpred(RuleContext, number) uid: adaptive-expressions.CommonRegexParser.precpred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function precpred(localctx: RuleContext, precedence: number): boolean' @@ -2851,14 +2669,13 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From Parser.precpred - - name: 'pushNewRecursionContext(ParserRuleContext, number, number)' + - name: pushNewRecursionContext(ParserRuleContext, number, number) uid: adaptive-expressions.CommonRegexParser.pushNewRecursionContext package: adaptive-expressions summary: |- Like but for recursive rules. Make the current context the child of the incoming localctx. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2880,7 +2697,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -2888,37 +2704,34 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Parser.removeErrorListener - name: removeErrorListeners() uid: adaptive-expressions.CommonRegexParser.removeErrorListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Parser.removeErrorListeners - name: removeParseListener(ParseTreeListener) uid: adaptive-expressions.CommonRegexParser.removeParseListener package: adaptive-expressions summary: |- Remove `listener` from the list of parse listeners. + If `listener` is `undefined` or has not been added as a parse listener, this method does nothing. - See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to remove + description: the listener to remove inheritanceDescription: Inherited From Parser.removeParseListener - name: removeParseListeners() uid: adaptive-expressions.CommonRegexParser.removeParseListeners @@ -2928,7 +2741,6 @@ inheritedMethods: See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeParseListeners() @@ -2938,7 +2750,6 @@ inheritedMethods: package: adaptive-expressions summary: reset the parser's state remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -2948,7 +2759,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -2957,20 +2767,19 @@ inheritedMethods: type: boolean description: '' inheritanceDescription: Inherited From Parser.reset - - name: 'sempred(RuleContext | undefined, number, number)' + - name: sempred(undefined | RuleContext, number, number) uid: adaptive-expressions.CommonRegexParser.sempred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function sempred(_localctx: RuleContext | undefined, ruleIndex: number, + function sempred(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number): boolean parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -2981,13 +2790,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.sempred + inheritanceDescription: Inherited From Parser.sempred - name: setProfile(boolean) uid: adaptive-expressions.CommonRegexParser.setProfile package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setProfile(profile: boolean): Promise' @@ -3004,7 +2812,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unrollRecursionContexts(_parentctx: ParserRuleContext)' @@ -3019,7 +2826,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function alpha_nums(): Alpha_numsContext' @@ -3031,7 +2837,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function alternation(): AlternationContext' @@ -3043,7 +2848,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function atom(): AtomContext' @@ -3055,7 +2859,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function capture(): CaptureContext' @@ -3067,7 +2870,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cc_atom(): Cc_atomContext' @@ -3079,7 +2881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cc_literal(): Cc_literalContext' @@ -3091,7 +2892,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function character_class(): Character_classContext' @@ -3103,7 +2903,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digit(): DigitContext' @@ -3115,7 +2914,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digits(): DigitsContext' @@ -3127,7 +2925,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function element(): ElementContext' @@ -3139,7 +2936,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expr(): ExprContext' @@ -3151,7 +2947,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function letter(): LetterContext' @@ -3163,7 +2958,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function literal(): LiteralContext' @@ -3175,7 +2969,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function name(): NameContext' @@ -3187,7 +2980,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function non_capture(): Non_captureContext' @@ -3199,7 +2991,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function non_close_paren(): Non_close_parenContext' @@ -3211,7 +3002,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function non_close_parens(): Non_close_parensContext' @@ -3223,7 +3013,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function number(): NumberContext' @@ -3235,7 +3024,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function octal_char(): Octal_charContext' @@ -3247,7 +3035,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function octal_digit(): Octal_digitContext' @@ -3259,7 +3046,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function option(): OptionContext' @@ -3271,7 +3057,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function option_flag(): Option_flagContext' @@ -3283,7 +3068,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function parse(): ParseContext' @@ -3295,7 +3079,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function quantifier(): QuantifierContext' @@ -3307,7 +3090,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function quantifier_type(): Quantifier_typeContext' @@ -3319,7 +3101,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function shared_atom(): Shared_atomContext' @@ -3331,7 +3112,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function shared_literal(): Shared_literalContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexVisitor.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexVisitor.yml index 4c7d45b5..1121ef11 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexVisitor.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CommonRegexVisitor.yml @@ -7,7 +7,6 @@ summary: |- by `CommonRegexParser`. fullName: CommonRegexVisitor remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.alpha_nums`. fullName: visitAlpha_nums remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitAlpha_nums?: (ctx: Alpha_numsContext) => Result' @@ -30,7 +28,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.alternation`. fullName: visitAlternation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitAlternation?: (ctx: AlternationContext) => Result' @@ -43,7 +40,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.atom`. fullName: visitAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitAtom?: (ctx: AtomContext) => Result' @@ -56,7 +52,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.capture`. fullName: visitCapture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitCapture?: (ctx: CaptureContext) => Result' @@ -69,7 +64,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.cc_atom`. fullName: visitCc_atom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitCc_atom?: (ctx: Cc_atomContext) => Result' @@ -82,7 +76,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.cc_literal`. fullName: visitCc_literal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitCc_literal?: (ctx: Cc_literalContext) => Result' @@ -95,7 +88,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.character_class`. fullName: visitCharacter_class remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitCharacter_class?: (ctx: Character_classContext) => Result' @@ -108,7 +100,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.digit`. fullName: visitDigit remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitDigit?: (ctx: DigitContext) => Result' @@ -121,7 +112,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.digits`. fullName: visitDigits remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitDigits?: (ctx: DigitsContext) => Result' @@ -134,7 +124,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.element`. fullName: visitElement remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitElement?: (ctx: ElementContext) => Result' @@ -147,7 +136,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.expr`. fullName: visitExpr remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitExpr?: (ctx: ExprContext) => Result' @@ -160,7 +148,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.letter`. fullName: visitLetter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitLetter?: (ctx: LetterContext) => Result' @@ -173,7 +160,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.literal`. fullName: visitLiteral remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitLiteral?: (ctx: LiteralContext) => Result' @@ -186,7 +172,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.name`. fullName: visitName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitName?: (ctx: NameContext) => Result' @@ -199,7 +184,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.non_capture`. fullName: visitNon_capture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNon_capture?: (ctx: Non_captureContext) => Result' @@ -212,7 +196,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.non_close_paren`. fullName: visitNon_close_paren remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNon_close_paren?: (ctx: Non_close_parenContext) => Result' @@ -225,7 +208,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.non_close_parens`. fullName: visitNon_close_parens remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNon_close_parens?: (ctx: Non_close_parensContext) => Result' @@ -238,7 +220,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.number`. fullName: visitNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNumber?: (ctx: NumberContext) => Result' @@ -251,7 +232,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.octal_char`. fullName: visitOctal_char remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitOctal_char?: (ctx: Octal_charContext) => Result' @@ -264,7 +244,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.octal_digit`. fullName: visitOctal_digit remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitOctal_digit?: (ctx: Octal_digitContext) => Result' @@ -277,7 +256,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.option`. fullName: visitOption remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitOption?: (ctx: OptionContext) => Result' @@ -290,7 +268,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.option_flag`. fullName: visitOption_flag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitOption_flag?: (ctx: Option_flagContext) => Result' @@ -303,7 +280,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.parse`. fullName: visitParse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitParse?: (ctx: ParseContext) => Result' @@ -316,7 +292,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.quantifier`. fullName: visitQuantifier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitQuantifier?: (ctx: QuantifierContext) => Result' @@ -329,7 +304,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.quantifier_type`. fullName: visitQuantifier_type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitQuantifier_type?: (ctx: Quantifier_typeContext) => Result' @@ -342,7 +316,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.shared_atom`. fullName: visitShared_atom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitShared_atom?: (ctx: Shared_atomContext) => Result' @@ -355,7 +328,6 @@ properties: summary: Visit a parse tree produced by `CommonRegexParser.shared_literal`. fullName: visitShared_literal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitShared_literal?: (ctx: Shared_literalContext) => Result' @@ -366,9 +338,8 @@ inheritedMethods: - name: visit(ParseTree) uid: adaptive-expressions.CommonRegexVisitor.visit package: adaptive-expressions - summary: 'Visit a parse tree, and return a user-defined result of the operation.' + summary: Visit a parse tree, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): Result' @@ -389,14 +360,13 @@ inheritedMethods: Visit the children of a node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): Result' parameters: - id: node type: RuleNode - description: 'The whose children should be visited.' + description: The whose children should be visited. return: description: The result of visiting the children of the node. type: Result @@ -404,16 +374,15 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: adaptive-expressions.CommonRegexVisitor.visitErrorNode package: adaptive-expressions - summary: 'Visit an error node, and return a user-defined result of the operation.' + summary: Visit an error node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): Result' parameters: - id: node type: ErrorNode - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the node. type: Result @@ -421,9 +390,8 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: adaptive-expressions.CommonRegexVisitor.visitTerminal package: adaptive-expressions - summary: 'Visit a terminal node, and return a user-defined result of the operation.' + summary: Visit a terminal node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): Result' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ComparisonEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ComparisonEvaluator.yml index 5e5b57fc..aea2502f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ComparisonEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ComparisonEvaluator.yml @@ -9,7 +9,6 @@ summary: >- error. This prevents errors from short-circuiting boolean expressions. fullName: ComparisonEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -23,7 +22,6 @@ constructors: [ComparisonEvaluator](xref:adaptive-expressions.ComparisonEvaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,38 +39,36 @@ constructors: - id: validator type: description: >- - (xref:adaptive-expressions.ValidateExpressionDelegate) for input - arguments. + [ValidateExpressionDelegate](xref:adaptive-expressions.ValidateExpressionDelegate) + for input arguments. - id: verify type: - description: > + description: >- Optional. [VerifyExpression](xref:adaptive-expressions.VerifyExpression) function to verify each child's result. -properties: +inheritedProperties: - name: negation uid: adaptive-expressions.ComparisonEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: -inheritedProperties: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions.ExpressionEvaluator.negation) - name: returnType uid: adaptive-expressions.ComparisonEvaluator.returnType package: adaptive-expressions summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -82,63 +78,52 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.ComparisonEvaluator.type + - name: tryEvaluate + uid: adaptive-expressions.ComparisonEvaluator.tryEvaluate package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type + summary: Evaluate an expression. + fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: string' + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError return: description: '' - type: string + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError inheritanceDescription: >- Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ComparisonEvaluator.tryEvaluate + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions.ComparisonEvaluator.type package: adaptive-expressions - summary: Evaluate an expression. + summary: Gets the expression type for evaluator. + fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. + content: 'type: string' return: - description: The value and error string that is non-null if there is an error. - type: + description: '' + type: string inheritanceDescription: >- Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) + [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) + - name: validateExpression uid: adaptive-expressions.ComparisonEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' inheritanceDescription: >- Inherited From [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Concat.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Concat.yml deleted file mode 100644 index ab408b1b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Concat.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Concat -uid: adaptive-expressions.Concat -package: adaptive-expressions -summary: 'Combine two or more strings, and return the combined string.' -fullName: Concat -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Concat() - uid: adaptive-expressions.Concat.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Concat](xref:adaptive-expressions.Concat) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Concat() -properties: - - name: negation - uid: adaptive-expressions.Concat.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Concat.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Concat.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Concat.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Concat.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Constant.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Constant.yml index ef40812a..a2dadc61 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Constant.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Constant.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Construct an expression constant. fullName: Constant remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,56 +17,25 @@ constructors: Constructs an expression constant. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Constant(value: any)' parameters: - id: value type: any - description: | - Constant value. + description: Constant value. properties: - - name: returnType - uid: adaptive-expressions.Constant.returnType - package: adaptive-expressions - summary: Expected result of evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ReturnType returnType - return: - description: The expected result of evaluating the expression. - type: - - name: type - uid: adaptive-expressions.Constant.type - package: adaptive-expressions - summary: Type of expression. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string type - return: - description: The type of the expression. - type: string - name: value uid: adaptive-expressions.Constant.value package: adaptive-expressions - summary: |- - Constant value. - Sets constant value. + summary: Sets constant value. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: any value + content: 'value: any' return: - description: The value. + description: '' type: any inheritedProperties: - name: children @@ -76,13 +44,12 @@ inheritedProperties: summary: Children expressions. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children: Expression[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Expression.children](xref:adaptive-expressions.Expression.children) @@ -92,7 +59,6 @@ inheritedProperties: summary: Evaluator of expression. fullName: evaluator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'evaluator: ExpressionEvaluator' @@ -115,29 +81,72 @@ inheritedProperties: to the built in functions. fullName: functions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static functions: FunctionTable = new FunctionTable()' + content: 'static functions: FunctionTable' return: description: '' type: inheritanceDescription: >- Inherited From [Expression.functions](xref:adaptive-expressions.Expression.functions) + - name: returnType + uid: adaptive-expressions.Constant.returnType + package: adaptive-expressions + summary: Expected result of evaluating the expression. + fullName: returnType + remarks: '' + isDeprecated: false + syntax: + content: 'returnType: ReturnType' + return: + description: The expected result of evaluating the expression. + type: + inheritanceDescription: >- + Inherited From + [Expression.returnType](xref:adaptive-expressions.Expression.returnType) + - name: type + uid: adaptive-expressions.Constant.type + package: adaptive-expressions + summary: Type of expression. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: The type of the expression. + type: string + inheritanceDescription: >- + Inherited From + [Expression.type](xref:adaptive-expressions.Expression.type) + - name: validate + uid: adaptive-expressions.Constant.validate + package: adaptive-expressions + summary: Validate immediate expression. + fullName: validate + remarks: '' + isDeprecated: false + syntax: + content: 'validate: () => void' + return: + description: '' + type: () => void + inheritanceDescription: >- + Inherited From + [Expression.validate](xref:adaptive-expressions.Expression.validate) inheritedMethods: - - name: 'andExpression(Expression[])' + - name: andExpression(Expression[]) uid: adaptive-expressions.Constant.andExpression package: adaptive-expressions summary: Construct and validate an And expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function andExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -145,18 +154,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.andExpression](xref:adaptive-expressions.Expression.andExpression) - - name: 'equalsExpression(Expression[])' + - name: equalsExpression(Expression[]) uid: adaptive-expressions.Constant.equalsExpression package: adaptive-expressions summary: Construct and validate an Equals expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function equalsExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -169,7 +177,6 @@ inheritedMethods: package: adaptive-expressions summary: Construct an expression from a EvaluateExpressionDelegate remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -192,7 +199,6 @@ inheritedMethods: Construct an expression from a lamba expression over the state. Exceptions will be caught and surfaced as an error string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function lambda(func: (arg0: any) => any): Expression' @@ -214,7 +220,6 @@ inheritedMethods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) function by name. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function lookup(functionName: string): ExpressionEvaluator' @@ -231,12 +236,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.lookup](xref:adaptive-expressions.Expression.lookup) - - name: 'makeExpression(string, ExpressionEvaluator, Expression[])' + - name: makeExpression(string, ExpressionEvaluator, Expression[]) uid: adaptive-expressions.Constant.makeExpression package: adaptive-expressions summary: Make an expression and validate it. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -250,7 +254,7 @@ inheritedMethods: type: description: Information about how to validate and evaluate expression. - id: children - type: '[]' + type: [] description: Child expressions. return: description: The new expression. @@ -263,7 +267,6 @@ inheritedMethods: package: adaptive-expressions summary: Construct and validate an Not expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function notExpression(child: Expression): Expression' @@ -277,18 +280,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.notExpression](xref:adaptive-expressions.Expression.notExpression) - - name: 'orExpression(Expression[])' + - name: orExpression(Expression[]) uid: adaptive-expressions.Constant.orExpression package: adaptive-expressions summary: Construct and validate an Or expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function orExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -296,14 +298,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.orExpression](xref:adaptive-expressions.Expression.orExpression) - - name: 'parse(string, EvaluatorLookup)' + - name: parse(string, EvaluatorLookup) uid: adaptive-expressions.Constant.parse package: adaptive-expressions summary: >- Parse an expression string into an [Expression](xref:adaptive-expressions.Expression) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -314,7 +315,7 @@ inheritedMethods: type: string description: Expression string. - id: lookup - type: + type: description: >- Optional. [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) @@ -340,13 +341,12 @@ inheritedMethods: but you might get other paths from the computed part as well. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function references(): string[]' return: description: List of the static reference paths. - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [Expression.references](xref:adaptive-expressions.Expression.references) @@ -357,7 +357,6 @@ inheritedMethods: Walking function for identifying static memory references in an expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -378,12 +377,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.referenceWalk](xref:adaptive-expressions.Expression.referenceWalk) - - name: 'setPathToValue(Expression, any)' + - name: setPathToValue(Expression, any) uid: adaptive-expressions.Constant.setPathToValue package: adaptive-expressions summary: Construct and validate an Set a property expression to a value expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -402,20 +400,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.setPathToValue](xref:adaptive-expressions.Expression.setPathToValue) - - name: 'tryEvaluate(MemoryInterface | any, Options)' + - name: tryEvaluate(any, Options) uid: adaptive-expressions.Constant.tryEvaluate package: adaptive-expressions summary: Evaluate the expression. remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(state: MemoryInterface | any, options: Options): - ValueWithError + content: 'function tryEvaluate(state: any, options?: Options): ValueWithError' parameters: - id: state - type: | any + type: any description: >- Global state to evaluate accessor expressions against. Can be Dictionary, otherwise reflection is used to access property and then @@ -431,24 +426,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Expression.tryEvaluate](xref:adaptive-expressions.Expression.tryEvaluate) - - name: validate() - uid: adaptive-expressions.Constant.validate - package: adaptive-expressions - summary: Validate immediate expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function validate() - inheritanceDescription: >- - Inherited From - [Expression.validate](xref:adaptive-expressions.Expression.validate) - name: validateTree() uid: adaptive-expressions.Constant.validateTree package: adaptive-expressions summary: Recursively validate the expression tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: function validateTree() @@ -464,7 +446,6 @@ methods: [Expression](xref:adaptive-expressions.Expression) instance is deep equal to another one. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deepEquals(other: Expression): boolean' @@ -484,7 +465,6 @@ methods: package: adaptive-expressions summary: Returns a string that represents the current constant object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Contains.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Contains.yml deleted file mode 100644 index 419f840f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Contains.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: Contains -uid: adaptive-expressions.Contains -package: adaptive-expressions -summary: >- - Check whether a collection has a specific item. Return true if the item is - found, or return false if not found. - - This function is case-sensitive. -fullName: Contains -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Contains() - uid: adaptive-expressions.Contains.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Contains](xref:adaptive-expressions.Contains) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Contains() -properties: - - name: negation - uid: adaptive-expressions.Contains.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Contains.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Contains.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Contains.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Contains.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertFromUTC.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertFromUTC.yml deleted file mode 100644 index df9ebb5d..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertFromUTC.yml +++ /dev/null @@ -1,133 +0,0 @@ -### YamlMime:TSType -name: ConvertFromUTC -uid: adaptive-expressions.ConvertFromUTC -package: adaptive-expressions -summary: >- - Convert a timestamp from Universal Time Coordinated (UTC) to a target time - zone. -fullName: ConvertFromUTC -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: ConvertFromUTC() - uid: adaptive-expressions.ConvertFromUTC.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [ConvertFromUTC](xref:adaptive-expressions.ConvertFromUTC) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ConvertFromUTC() -properties: - - name: negation - uid: adaptive-expressions.ConvertFromUTC.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: - - name: NoneUtcDefaultDateTimeFormat - uid: adaptive-expressions.ConvertFromUTC.NoneUtcDefaultDateTimeFormat - package: adaptive-expressions - summary: '' - fullName: NoneUtcDefaultDateTimeFormat - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static NoneUtcDefaultDateTimeFormat: string = - "YYYY-MM-DDTHH:mm:ss.SSS0000" - return: - description: '' - type: string -inheritedProperties: - - name: returnType - uid: adaptive-expressions.ConvertFromUTC.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.ConvertFromUTC.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ConvertFromUTC.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.ConvertFromUTC.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertToUTC.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertToUTC.yml deleted file mode 100644 index 2976f0e6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ConvertToUTC.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: ConvertToUTC -uid: adaptive-expressions.ConvertToUTC -package: adaptive-expressions -summary: >- - Convert a timestamp to Universal Time Coordinated (UTC) from the source time - zone. -fullName: ConvertToUTC -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: ConvertToUTC() - uid: adaptive-expressions.ConvertToUTC.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [ConvertToUTC](xref:adaptive-expressions.ConvertToUTC) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ConvertToUTC() -properties: - - name: negation - uid: adaptive-expressions.ConvertToUTC.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.ConvertToUTC.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.ConvertToUTC.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ConvertToUTC.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.ConvertToUTC.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Count.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Count.yml deleted file mode 100644 index 2c6b06aa..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Count.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Count -uid: adaptive-expressions.Count -package: adaptive-expressions -summary: Return the number of items in a collection. -fullName: Count -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Count() - uid: adaptive-expressions.Count.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Count](xref:adaptive-expressions.Count) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Count() -properties: - - name: negation - uid: adaptive-expressions.Count.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Count.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Count.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Count.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Count.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CountWord.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CountWord.yml deleted file mode 100644 index 6474ac8e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CountWord.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: CountWord -uid: adaptive-expressions.CountWord -package: adaptive-expressions -summary: Return the number of words in a string. -fullName: CountWord -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: CountWord() - uid: adaptive-expressions.CountWord.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [CountWord](xref:adaptive-expressions.CountWord) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new CountWord() -properties: - - name: negation - uid: adaptive-expressions.CountWord.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.CountWord.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.CountWord.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.CountWord.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.CountWord.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CreateArray.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CreateArray.yml deleted file mode 100644 index be6d6d5f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/CreateArray.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: CreateArray -uid: adaptive-expressions.CreateArray -package: adaptive-expressions -summary: Return an array from multiple inputs. -fullName: CreateArray -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: CreateArray() - uid: adaptive-expressions.CreateArray.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [CreateArray](xref:adaptive-expressions.CreateArray) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new CreateArray() -properties: - - name: negation - uid: adaptive-expressions.CreateArray.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.CreateArray.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.CreateArray.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.CreateArray.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.CreateArray.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUri.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUri.yml deleted file mode 100644 index 659cb797..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUri.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DataUri -uid: adaptive-expressions.DataUri -package: adaptive-expressions -summary: Return a data uniform resource identifier (URI) of a string. -fullName: DataUri -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DataUri() - uid: adaptive-expressions.DataUri.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DataUri](xref:adaptive-expressions.DataUri) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DataUri() -properties: - - name: negation - uid: adaptive-expressions.DataUri.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DataUri.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DataUri.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DataUri.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DataUri.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToBinary.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToBinary.yml deleted file mode 100644 index 4e66701a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToBinary.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DataUriToBinary -uid: adaptive-expressions.DataUriToBinary -package: adaptive-expressions -summary: Return the binary version of a data uniform resource identifier (URI). -fullName: DataUriToBinary -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DataUriToBinary() - uid: adaptive-expressions.DataUriToBinary.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DataUriToBinary](xref:adaptive-expressions.DataUriToBinary) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DataUriToBinary() -properties: - - name: negation - uid: adaptive-expressions.DataUriToBinary.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DataUriToBinary.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DataUriToBinary.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DataUriToBinary.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DataUriToBinary.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToString.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToString.yml deleted file mode 100644 index 1ec601c1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DataUriToString.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DataUriToString -uid: adaptive-expressions.DataUriToString -package: adaptive-expressions -summary: Return the string version of a data uniform resource identifier (URI). -fullName: DataUriToString -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DataUriToString() - uid: adaptive-expressions.DataUriToString.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DataUriToString](xref:adaptive-expressions.DataUriToString) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DataUriToString() -properties: - - name: negation - uid: adaptive-expressions.DataUriToString.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DataUriToString.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DataUriToString.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DataUriToString.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DataUriToString.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateFunc.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateFunc.yml deleted file mode 100644 index 2065b0dd..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateFunc.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DateFunc -uid: adaptive-expressions.DateFunc -package: adaptive-expressions -summary: Return the date of a specified timestamp in m/dd/yyyy format. -fullName: DateFunc -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DateFunc() - uid: adaptive-expressions.DateFunc.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DateFunc](xref:adaptive-expressions.DateFunc) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DateFunc() -properties: - - name: negation - uid: adaptive-expressions.DateFunc.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DateFunc.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DateFunc.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DateFunc.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DateFunc.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateReadBack.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateReadBack.yml deleted file mode 100644 index 3d929334..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateReadBack.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DateReadBack -uid: adaptive-expressions.DateReadBack -package: adaptive-expressions -summary: Uses the date-time library to provide a date readback. -fullName: DateReadBack -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DateReadBack() - uid: adaptive-expressions.DateReadBack.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DateReadBack](xref:adaptive-expressions.DateReadBack) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DateReadBack() -properties: - - name: negation - uid: adaptive-expressions.DateReadBack.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DateReadBack.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DateReadBack.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DateReadBack.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DateReadBack.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateTimeDiff.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateTimeDiff.yml deleted file mode 100644 index 8cacdd06..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DateTimeDiff.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DateTimeDiff -uid: adaptive-expressions.DateTimeDiff -package: adaptive-expressions -summary: Return a number of ticks that the two timestamps differ. -fullName: DateTimeDiff -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DateTimeDiff() - uid: adaptive-expressions.DateTimeDiff.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DateTimeDiff](xref:adaptive-expressions.DateTimeDiff) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DateTimeDiff() -properties: - - name: negation - uid: adaptive-expressions.DateTimeDiff.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DateTimeDiff.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DateTimeDiff.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DateTimeDiff.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DateTimeDiff.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfMonth.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfMonth.yml deleted file mode 100644 index a72350b1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfMonth.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DayOfMonth -uid: adaptive-expressions.DayOfMonth -package: adaptive-expressions -summary: Return the day of the month from a timestamp. -fullName: DayOfMonth -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DayOfMonth() - uid: adaptive-expressions.DayOfMonth.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DayOfMonth](xref:adaptive-expressions.DayOfMonth) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DayOfMonth() -properties: - - name: negation - uid: adaptive-expressions.DayOfMonth.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DayOfMonth.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DayOfMonth.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DayOfMonth.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DayOfMonth.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfWeek.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfWeek.yml deleted file mode 100644 index fe40b90b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfWeek.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DayOfWeek -uid: adaptive-expressions.DayOfWeek -package: adaptive-expressions -summary: Return the day of the week from a timestamp. -fullName: DayOfWeek -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DayOfWeek() - uid: adaptive-expressions.DayOfWeek.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DayOfWeek](xref:adaptive-expressions.DayOfWeek) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DayOfWeek() -properties: - - name: negation - uid: adaptive-expressions.DayOfWeek.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DayOfWeek.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DayOfWeek.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DayOfWeek.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DayOfWeek.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfYear.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfYear.yml deleted file mode 100644 index 2d6bd120..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DayOfYear.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: DayOfYear -uid: adaptive-expressions.DayOfYear -package: adaptive-expressions -summary: Return the day of the year from a timestamp. -fullName: DayOfYear -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DayOfYear() - uid: adaptive-expressions.DayOfYear.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [DayOfYear](xref:adaptive-expressions.DayOfYear) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DayOfYear() -properties: - - name: negation - uid: adaptive-expressions.DayOfYear.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.DayOfYear.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.DayOfYear.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.DayOfYear.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.DayOfYear.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitContext.yml index 925a8e85..802b611a 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: DigitContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DigitContext(ParserRuleContext | undefined, number)' + - name: DigitContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.DigitContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new DigitContext(parent: ParserRuleContext | undefined, invokingState: + new DigitContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.DigitContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.DigitContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.DigitContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.DigitContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.DigitContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.DigitContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.DigitContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: DigitContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.DigitContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.DigitContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.DigitContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.DigitContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.DigitContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.DigitContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.DigitContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.DigitContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.DigitContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.DigitContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.DigitContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.DigitContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.DigitContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.DigitContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.DigitContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.DigitContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.DigitContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.DigitContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.DigitContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.DigitContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.DigitContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.DigitContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,127 +793,116 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D0(): TerminalNode | undefined' + content: 'function D0(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D1() uid: adaptive-expressions.DigitContext.D1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D1(): TerminalNode | undefined' + content: 'function D1(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D2() uid: adaptive-expressions.DigitContext.D2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D2(): TerminalNode | undefined' + content: 'function D2(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D3() uid: adaptive-expressions.DigitContext.D3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D3(): TerminalNode | undefined' + content: 'function D3(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D4() uid: adaptive-expressions.DigitContext.D4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D4(): TerminalNode | undefined' + content: 'function D4(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D5() uid: adaptive-expressions.DigitContext.D5 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D5(): TerminalNode | undefined' + content: 'function D5(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D6() uid: adaptive-expressions.DigitContext.D6 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D6(): TerminalNode | undefined' + content: 'function D6(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D7() uid: adaptive-expressions.DigitContext.D7 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D7(): TerminalNode | undefined' + content: 'function D7(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D8() uid: adaptive-expressions.DigitContext.D8 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D8(): TerminalNode | undefined' + content: 'function D8(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D9() uid: adaptive-expressions.DigitContext.D9 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D9(): TerminalNode | undefined' + content: 'function D9(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.DigitContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -969,7 +915,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitsContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitsContext.yml index e3d24d74..2fb5be18 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitsContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/DigitsContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: DigitsContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DigitsContext(ParserRuleContext | undefined, number)' + - name: DigitsContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.DigitsContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new DigitsContext(parent: ParserRuleContext | undefined, invokingState: + new DigitsContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.DigitsContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.DigitsContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.DigitsContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.DigitsContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.DigitsContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.DigitsContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.DigitsContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: DigitsContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.DigitsContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.DigitsContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.DigitsContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.DigitsContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.DigitsContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.DigitsContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.DigitsContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.DigitsContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.DigitsContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.DigitsContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.DigitsContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.DigitsContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.DigitsContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.DigitsContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.DigitsContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.DigitsContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.DigitsContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.DigitsContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.DigitsContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.DigitsContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.DigitsContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.DigitsContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,19 +793,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digit(): DigitContext[]' return: description: '' - type: '[]' + type: [] - name: digit(number) uid: adaptive-expressions.DigitsContext.digit_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digit(i: number): DigitContext' @@ -864,7 +819,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -877,7 +831,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Divide.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Divide.yml deleted file mode 100644 index e356725f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Divide.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Divide -uid: adaptive-expressions.Divide -package: adaptive-expressions -summary: Return the integer result from dividing two numbers. -fullName: Divide -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Divide() - uid: adaptive-expressions.Divide.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Divide](xref:adaptive-expressions.Divide) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Divide() -properties: - - name: negation - uid: adaptive-expressions.Divide.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Divide.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Divide.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Divide.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Divide.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EOL.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EOL.yml deleted file mode 100644 index 3f511287..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EOL.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: EOL -uid: adaptive-expressions.EOL -package: adaptive-expressions -summary: Return the newline string according to the environment. -fullName: EOL -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: EOL() - uid: adaptive-expressions.EOL.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [EOL](xref:adaptive-expressions.EOL) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new EOL() -properties: - - name: negation - uid: adaptive-expressions.EOL.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.EOL.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.EOL.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.EOL.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.EOL.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Element.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Element.yml deleted file mode 100644 index 0c2881d0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Element.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Element -uid: adaptive-expressions.Element -package: adaptive-expressions -summary: |- - The indexing operator ([ ]) selects a single element from a sequence. - Support number index for list or string index for object. -fullName: Element -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Element() - uid: adaptive-expressions.Element.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Element](xref:adaptive-expressions.Element) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Element() -properties: - - name: negation - uid: adaptive-expressions.Element.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Element.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Element.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Element.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Element.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ElementContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ElementContext.yml index 7e685b4b..875555bc 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ElementContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ElementContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: ElementContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ElementContext(ParserRuleContext | undefined, number)' + - name: ElementContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.ElementContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ElementContext(parent: ParserRuleContext | undefined, invokingState: + new ElementContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.ElementContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.ElementContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.ElementContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.ElementContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.ElementContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.ElementContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.ElementContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ElementContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.ElementContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.ElementContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.ElementContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.ElementContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.ElementContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ElementContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ElementContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ElementContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ElementContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.ElementContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.ElementContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.ElementContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ElementContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ElementContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.ElementContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ElementContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.ElementContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.ElementContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ElementContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ElementContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ElementContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.ElementContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function atom(): AtomContext' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -874,11 +828,10 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function quantifier(): QuantifierContext | undefined' + content: 'function quantifier(): undefined | QuantifierContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Empty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Empty.yml deleted file mode 100644 index ddae2f26..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Empty.yml +++ /dev/null @@ -1,126 +0,0 @@ -### YamlMime:TSType -name: Empty -uid: adaptive-expressions.Empty -package: adaptive-expressions -summary: >- - Check whether an instance is empty. Return true if the input is empty. Empty - means: - - 1.Input is null or undefined. - - 2.Input is a null or empty string. - - 3.Input is zero size collection. - - 4.Input is an object with no property. -fullName: Empty -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Empty() - uid: adaptive-expressions.Empty.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Empty](xref:adaptive-expressions.Empty) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Empty() -properties: - - name: negation - uid: adaptive-expressions.Empty.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Empty.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Empty.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Empty.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Empty.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EndsWith.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EndsWith.yml deleted file mode 100644 index 18929df9..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EndsWith.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: EndsWith -uid: adaptive-expressions.EndsWith -package: adaptive-expressions -summary: >- - Check whether a string ends with a specific substring. Return true if the - substring is found, or return false if not found. - - This function is case-insensitive. -fullName: EndsWith -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: EndsWith() - uid: adaptive-expressions.EndsWith.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [EndsWith](xref:adaptive-expressions.EndsWith) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new EndsWith() -properties: - - name: negation - uid: adaptive-expressions.EndsWith.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.EndsWith.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.EndsWith.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.EndsWith.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.EndsWith.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpression.yml index 270e8c10..726de6bb 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpression.yml @@ -9,26 +9,23 @@ fullName: EnumExpression remarks: >- String values are always interpreted as an expression whether it has '=' prefix or not, as string values cannot be parsed to enum values. -isPreview: false isDeprecated: false type: class constructors: - - name: EnumExpression(T | string | Expression) + - name: EnumExpression(string | Expression | T) uid: adaptive-expressions.EnumExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [EnumExpression](xref:adaptive-expressions.EnumExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new EnumExpression(value: T | string | Expression)' + content: 'new EnumExpression(value: string | Expression | T)' parameters: - id: value - type: T | string | - description: | - An enum of `T` or a `string` expression which resolves to an `enum`. + type: string | | T + description: An enum of `T` or a `string` expression which resolves to an `enum`. inheritedProperties: - name: expressionText uid: adaptive-expressions.EnumExpression.expressionText @@ -36,7 +33,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -52,7 +48,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: T' @@ -68,7 +63,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): T' @@ -87,7 +81,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -102,7 +95,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -117,7 +109,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: T }' @@ -132,18 +123,16 @@ inheritedMethods: Inherited From [ExpressionProperty.tryGetValue](xref:adaptive-expressions.ExpressionProperty.tryGetValue) methods: - - name: setValue(T | string | Expression) + - name: setValue(string | Expression | T) uid: adaptive-expressions.EnumExpression.setValue package: adaptive-expressions summary: Set an enum value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: T | string | Expression)' + content: 'function setValue(value: string | Expression | T)' parameters: - id: value - type: T | string | - description: | - value to set. + type: string | | T + description: value to set. extends: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpressionConverter.yml index a2e41f52..0223f267 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EnumExpressionConverter.yml @@ -7,11 +7,10 @@ summary: >- converter. fullName: EnumExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: EnumExpressionConverter(unknown) + - name: EnumExpressionConverter(unknown) uid: adaptive-expressions.EnumExpressionConverter.constructor package: adaptive-expressions summary: >- @@ -19,15 +18,13 @@ constructors: [EnumExpressionConverter](xref:adaptive-expressions.EnumExpressionConverter) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new EnumExpressionConverter(enumValue: unknown)' parameters: - id: enumValue type: unknown - description: | - The enum value of the `string` to convert. + description: The enum value of the `string` to convert. methods: - name: convert(Input | EnumExpression) uid: adaptive-expressions.EnumExpressionConverter.convert @@ -36,7 +33,6 @@ methods: Converts a `string` into an [EnumExpression](xref:adaptive-expressions.EnumExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: Input | EnumExpression): EnumExpression' @@ -47,5 +43,5 @@ methods: /><T> description: '`string` to convert.' return: - description: 'The [EnumExpression](xref:adaptive-expressions.EnumExpression).' + description: The [EnumExpression](xref:adaptive-expressions.EnumExpression). type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Equal.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Equal.yml deleted file mode 100644 index eb4ed6b5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Equal.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Equal -uid: adaptive-expressions.Equal -package: adaptive-expressions -summary: |- - Check whether both values, expressions, or objects are equivalent. - Return true if both are equivalent, or return false if they're not equivalent. -fullName: Equal -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Equal() - uid: adaptive-expressions.Equal.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Equal](xref:adaptive-expressions.Equal) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Equal() -properties: - - name: negation - uid: adaptive-expressions.Equal.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Equal.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Equal.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Equal.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Equal.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluateExpressionDelegate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluateExpressionDelegate.yml index edb6e0b1..9bd554b2 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluateExpressionDelegate.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluateExpressionDelegate.yml @@ -9,7 +9,6 @@ summary: >- error rather than throw exceptions if possible. fullName: EvaluateExpressionDelegate remarks: '' -isPreview: false isDeprecated: false syntax: | type EvaluateExpressionDelegate = ( diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluatorLookup.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluatorLookup.yml index f618e1f3..6b43863e 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluatorLookup.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/EvaluatorLookup.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Delegate to lookup function information from the type. fullName: EvaluatorLookup remarks: '' -isPreview: false isDeprecated: false syntax: | type EvaluatorLookup = (type: string) => ExpressionEvaluator diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Exists.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Exists.yml deleted file mode 100644 index f285263f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Exists.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Exists -uid: adaptive-expressions.Exists -package: adaptive-expressions -summary: Evaluates an expression for truthiness. -fullName: Exists -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Exists() - uid: adaptive-expressions.Exists.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Exists](xref:adaptive-expressions.Exists) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Exists() -properties: - - name: negation - uid: adaptive-expressions.Exists.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Exists.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Exists.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Exists.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Exists.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExprContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExprContext.yml index e4dfb490..559b5860 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExprContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExprContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: ExprContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ExprContext(ParserRuleContext | undefined, number)' + - name: ExprContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.ExprContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ExprContext(parent: ParserRuleContext | undefined, invokingState: + new ExprContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.ExprContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.ExprContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.ExprContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.ExprContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.ExprContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.ExprContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.ExprContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ExprContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.ExprContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.ExprContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.ExprContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.ExprContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.ExprContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ExprContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ExprContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ExprContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ExprContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.ExprContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.ExprContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.ExprContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ExprContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ExprContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.ExprContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ExprContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.ExprContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.ExprContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ExprContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ExprContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ExprContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.ExprContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,19 +793,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function element(): ElementContext[]' return: description: '' - type: '[]' + type: [] - name: element(number) uid: adaptive-expressions.ExprContext.element_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function element(i: number): ElementContext' @@ -864,7 +819,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -877,7 +831,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Expression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Expression.yml index ba501647..2efcd3b7 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Expression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Expression.yml @@ -12,16 +12,14 @@ summary: >- that should be exception free. fullName: Expression remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Expression(string, ExpressionEvaluator, Expression[])' + - name: Expression(string, ExpressionEvaluator, Expression[]) uid: adaptive-expressions.Expression.constructor package: adaptive-expressions summary: expression constructor. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -35,9 +33,8 @@ constructors: type: description: Information about how to validate and evaluate expression. - id: children - type: '[]' - description: | - Child expressions. + type: [] + description: Child expressions. properties: - name: children uid: adaptive-expressions.Expression.children @@ -45,20 +42,18 @@ properties: summary: Children expressions. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children: Expression[]' return: description: '' - type: '[]' + type: [] - name: evaluator uid: adaptive-expressions.Expression.evaluator package: adaptive-expressions summary: Evaluator of expression. fullName: evaluator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'evaluator: ExpressionEvaluator' @@ -78,10 +73,9 @@ properties: to the built in functions. fullName: functions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static functions: FunctionTable = new FunctionTable()' + content: 'static functions: FunctionTable' return: description: '' type: @@ -91,10 +85,9 @@ properties: summary: Expected result of evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: - content: ReturnType returnType + content: 'returnType: ReturnType' return: description: The expected result of evaluating the expression. type: @@ -104,26 +97,36 @@ properties: summary: Type of expression. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: string type + content: 'type: string' return: description: The type of the expression. type: string + - name: validate + uid: adaptive-expressions.Expression.validate + package: adaptive-expressions + summary: Validate immediate expression. + fullName: validate + remarks: '' + isDeprecated: false + syntax: + content: 'validate: () => void' + return: + description: '' + type: () => void methods: - - name: 'andExpression(Expression[])' + - name: andExpression(Expression[]) uid: adaptive-expressions.Expression.andExpression package: adaptive-expressions summary: Construct and validate an And expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function andExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -133,7 +136,6 @@ methods: package: adaptive-expressions summary: Do a deep equality between expressions. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deepEquals(other: Expression): boolean' @@ -144,18 +146,17 @@ methods: return: description: True if expressions are the same. type: boolean - - name: 'equalsExpression(Expression[])' + - name: equalsExpression(Expression[]) uid: adaptive-expressions.Expression.equalsExpression package: adaptive-expressions summary: Construct and validate an Equals expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function equalsExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. @@ -165,7 +166,6 @@ methods: package: adaptive-expressions summary: Construct an expression from a EvaluateExpressionDelegate remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -185,7 +185,6 @@ methods: Construct an expression from a lamba expression over the state. Exceptions will be caught and surfaced as an error string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function lambda(func: (arg0: any) => any): Expression' @@ -204,7 +203,6 @@ methods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) function by name. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function lookup(functionName: string): ExpressionEvaluator' @@ -218,12 +216,11 @@ methods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) corresponding to the function name. type: - - name: 'makeExpression(string, ExpressionEvaluator, Expression[])' + - name: makeExpression(string, ExpressionEvaluator, Expression[]) uid: adaptive-expressions.Expression.makeExpression package: adaptive-expressions summary: Make an expression and validate it. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -237,7 +234,7 @@ methods: type: description: Information about how to validate and evaluate expression. - id: children - type: '[]' + type: [] description: Child expressions. return: description: The new expression. @@ -247,7 +244,6 @@ methods: package: adaptive-expressions summary: Construct and validate an Not expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function notExpression(child: Expression): Expression' @@ -258,30 +254,28 @@ methods: return: description: New expression. type: - - name: 'orExpression(Expression[])' + - name: orExpression(Expression[]) uid: adaptive-expressions.Expression.orExpression package: adaptive-expressions summary: Construct and validate an Or expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function orExpression(children: Expression[]): Expression' parameters: - id: children - type: '[]' + type: [] description: Child clauses. return: description: New expression. type: - - name: 'parse(string, EvaluatorLookup)' + - name: parse(string, EvaluatorLookup) uid: adaptive-expressions.Expression.parse package: adaptive-expressions summary: >- Parse an expression string into an [Expression](xref:adaptive-expressions.Expression) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -292,7 +286,7 @@ methods: type: string description: Expression string. - id: lookup - type: + type: description: >- Optional. [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) @@ -315,13 +309,12 @@ methods: but you might get other paths from the computed part as well. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function references(): string[]' return: description: List of the static reference paths. - type: 'string[]' + type: string[] - name: 'referenceWalk(Expression, (arg0: Expression) => boolean)' uid: adaptive-expressions.Expression.referenceWalk package: adaptive-expressions @@ -329,7 +322,6 @@ methods: Walking function for identifying static memory references in an expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -347,12 +339,11 @@ methods: return: description: Accessor path of expression. type: '{ path: string, refs: Set<string> }' - - name: 'setPathToValue(Expression, any)' + - name: setPathToValue(Expression, any) uid: adaptive-expressions.Expression.setPathToValue package: adaptive-expressions summary: Construct and validate an Set a property expression to a value expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -375,7 +366,6 @@ methods: Returns a string that represents the current [Expression](xref:adaptive-expressions.Expression) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -384,20 +374,17 @@ methods: A string that represents the current [Expression](xref:adaptive-expressions.Expression) object. type: string - - name: 'tryEvaluate(MemoryInterface | any, Options)' + - name: tryEvaluate(any, Options) uid: adaptive-expressions.Expression.tryEvaluate package: adaptive-expressions summary: Evaluate the expression. remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(state: MemoryInterface | any, options: Options): - ValueWithError + content: 'function tryEvaluate(state: any, options?: Options): ValueWithError' parameters: - id: state - type: | any + type: any description: >- Global state to evaluate accessor expressions against. Can be Dictionary, otherwise reflection is used to access property and then @@ -410,21 +397,11 @@ methods: Computed value and an error string. If the string is non-null, then there was an evaluation error. type: - - name: validate() - uid: adaptive-expressions.Expression.validate - package: adaptive-expressions - summary: Validate immediate expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function validate() - name: validateTree() uid: adaptive-expressions.Expression.validateTree package: adaptive-expressions summary: Recursively validate the expression tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: function validateTree() diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrLexer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrLexer.yml index dd91b47c..81423e60 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrLexer.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrLexer.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: ExpressionAntlrLexer remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ExpressionAntlrLexer(input: CharStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: ARROW remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ARROW: 27 = 27' + content: 'static ARROW: 27 = 27' return: description: '' type: '27' @@ -42,10 +39,9 @@ properties: summary: '' fullName: ASTERISK remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ASTERISK: 6 = 6' + content: 'static ASTERISK: 6 = 6' return: description: '' type: '6' @@ -55,36 +51,33 @@ properties: summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static channelNames: string[] = [\n\t\t\"DEFAULT_TOKEN_CHANNEL\", \"HIDDEN\",\n\t]" + content: 'channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: channelNames uid: adaptive-expressions.ExpressionAntlrLexer.channelNames package: adaptive-expressions summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] channelNames' + content: 'static channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: CLOSE_BRACKET uid: adaptive-expressions.ExpressionAntlrLexer.CLOSE_BRACKET package: adaptive-expressions summary: '' fullName: CLOSE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLOSE_BRACKET: 19 = 19' + content: 'static CLOSE_BRACKET: 19 = 19' return: description: '' type: '19' @@ -94,10 +87,9 @@ properties: summary: '' fullName: CLOSE_CURLY_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLOSE_CURLY_BRACKET: 24 = 24' + content: 'static CLOSE_CURLY_BRACKET: 24 = 24' return: description: '' type: '24' @@ -107,10 +99,9 @@ properties: summary: '' fullName: CLOSE_SQUARE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLOSE_SQUARE_BRACKET: 22 = 22' + content: 'static CLOSE_SQUARE_BRACKET: 22 = 22' return: description: '' type: '22' @@ -120,10 +111,9 @@ properties: summary: '' fullName: COLON remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COLON: 26 = 26' + content: 'static COLON: 26 = 26' return: description: '' type: '26' @@ -133,10 +123,9 @@ properties: summary: '' fullName: COMMA remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COMMA: 25 = 25' + content: 'static COMMA: 25 = 25' return: description: '' type: '25' @@ -146,10 +135,9 @@ properties: summary: '' fullName: DOT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOT: 20 = 20' + content: 'static DOT: 20 = 20' return: description: '' type: '20' @@ -159,10 +147,9 @@ properties: summary: '' fullName: DOUBLE_AND remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOUBLE_AND: 12 = 12' + content: 'static DOUBLE_AND: 12 = 12' return: description: '' type: '12' @@ -172,10 +159,9 @@ properties: summary: '' fullName: DOUBLE_EQUAL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOUBLE_EQUAL: 9 = 9' + content: 'static DOUBLE_EQUAL: 9 = 9' return: description: '' type: '9' @@ -185,10 +171,9 @@ properties: summary: '' fullName: DOUBLE_VERTICAL_CYLINDER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOUBLE_VERTICAL_CYLINDER: 13 = 13' + content: 'static DOUBLE_VERTICAL_CYLINDER: 13 = 13' return: description: '' type: '13' @@ -198,10 +183,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER: 37 = 37' + content: 'static ESCAPE_CHARACTER: 37 = 37' return: description: '' type: '37' @@ -211,10 +195,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -224,10 +207,9 @@ properties: summary: '' fullName: IDENTIFIER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IDENTIFIER: 32 = 32' + content: 'static IDENTIFIER: 32 = 32' return: description: '' type: '32' @@ -237,10 +219,9 @@ properties: summary: '' fullName: ignoreWS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ignoreWS: boolean = true' + content: 'ignoreWS: boolean' return: description: '' type: boolean @@ -250,10 +231,9 @@ properties: summary: '' fullName: INVALID_TOKEN_DEFAULT_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INVALID_TOKEN_DEFAULT_MODE: 35 = 35' + content: 'static INVALID_TOKEN_DEFAULT_MODE: 35 = 35' return: description: '' type: '35' @@ -263,10 +243,9 @@ properties: summary: '' fullName: LESS_OR_EQUAl remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LESS_OR_EQUAl: 16 = 16' + content: 'static LESS_OR_EQUAl: 16 = 16' return: description: '' type: '16' @@ -276,10 +255,9 @@ properties: summary: '' fullName: LESS_THAN remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LESS_THAN: 14 = 14' + content: 'static LESS_THAN: 14 = 14' return: description: '' type: '14' @@ -289,36 +267,33 @@ properties: summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static modeNames: string[] = [\n\t\t\"DEFAULT_MODE\", \"STRING_INTERPOLATION_MODE\",\n\t]" + content: 'modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: modeNames uid: adaptive-expressions.ExpressionAntlrLexer.modeNames package: adaptive-expressions summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] modeNames' + content: 'static modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: MORE_OR_EQUAL uid: adaptive-expressions.ExpressionAntlrLexer.MORE_OR_EQUAL package: adaptive-expressions summary: '' fullName: MORE_OR_EQUAL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MORE_OR_EQUAL: 17 = 17' + content: 'static MORE_OR_EQUAL: 17 = 17' return: description: '' type: '17' @@ -328,10 +303,9 @@ properties: summary: '' fullName: MORE_THAN remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MORE_THAN: 15 = 15' + content: 'static MORE_THAN: 15 = 15' return: description: '' type: '15' @@ -341,10 +315,9 @@ properties: summary: '' fullName: NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE: 33 = 33' + content: 'static NEWLINE: 33 = 33' return: description: '' type: '33' @@ -354,10 +327,9 @@ properties: summary: '' fullName: NON remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NON: 4 = 4' + content: 'static NON: 4 = 4' return: description: '' type: '4' @@ -367,10 +339,9 @@ properties: summary: '' fullName: NOT_EQUAL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NOT_EQUAL: 10 = 10' + content: 'static NOT_EQUAL: 10 = 10' return: description: '' type: '10' @@ -380,10 +351,9 @@ properties: summary: '' fullName: NULL_COALESCE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NULL_COALESCE: 28 = 28' + content: 'static NULL_COALESCE: 28 = 28' return: description: '' type: '28' @@ -393,10 +363,9 @@ properties: summary: '' fullName: NUMBER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NUMBER: 30 = 30' + content: 'static NUMBER: 30 = 30' return: description: '' type: '30' @@ -406,10 +375,9 @@ properties: summary: '' fullName: OPEN_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPEN_BRACKET: 18 = 18' + content: 'static OPEN_BRACKET: 18 = 18' return: description: '' type: '18' @@ -419,10 +387,9 @@ properties: summary: '' fullName: OPEN_CURLY_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPEN_CURLY_BRACKET: 23 = 23' + content: 'static OPEN_CURLY_BRACKET: 23 = 23' return: description: '' type: '23' @@ -432,10 +399,9 @@ properties: summary: '' fullName: OPEN_SQUARE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPEN_SQUARE_BRACKET: 21 = 21' + content: 'static OPEN_SQUARE_BRACKET: 21 = 21' return: description: '' type: '21' @@ -445,10 +411,9 @@ properties: summary: '' fullName: PERCENT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PERCENT: 8 = 8' + content: 'static PERCENT: 8 = 8' return: description: '' type: '8' @@ -458,10 +423,9 @@ properties: summary: '' fullName: PLUS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PLUS: 2 = 2' + content: 'static PLUS: 2 = 2' return: description: '' type: '2' @@ -471,10 +435,9 @@ properties: summary: '' fullName: QUESTION_MARK remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QUESTION_MARK: 29 = 29' + content: 'static QUESTION_MARK: 29 = 29' return: description: '' type: '29' @@ -484,36 +447,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\n\t\t\"LETTER\", \"DIGIT\", \"OBJECT_DEFINITION\", \"STRING_INTERPOLATION_START\", \n\t\t\"PLUS\", \"SUBSTRACT\", \"NON\", \"XOR\", \"ASTERISK\", \"SLASH\", \"PERCENT\", \"DOUBLE_EQUAL\", \n\t\t\"NOT_EQUAL\", \"SINGLE_AND\", \"DOUBLE_AND\", \"DOUBLE_VERTICAL_CYLINDER\", \"LESS_THAN\", \n\t\t\"MORE_THAN\", \"LESS_OR_EQUAl\", \"MORE_OR_EQUAL\", \"OPEN_BRACKET\", \"CLOSE_BRACKET\", \n\t\t\"DOT\", \"OPEN_SQUARE_BRACKET\", \"CLOSE_SQUARE_BRACKET\", \"OPEN_CURLY_BRACKET\", \n\t\t\"CLOSE_CURLY_BRACKET\", \"COMMA\", \"COLON\", \"ARROW\", \"NULL_COALESCE\", \"QUESTION_MARK\", \n\t\t\"NUMBER\", \"WHITESPACE\", \"IDENTIFIER\", \"NEWLINE\", \"STRING\", \"INVALID_TOKEN_DEFAULT_MODE\", \n\t\t\"STRING_INTERPOLATION_END\", \"TEMPLATE\", \"ESCAPE_CHARACTER\", \"TEXT_CONTENT\",\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: adaptive-expressions.ExpressionAntlrLexer.ruleNames package: adaptive-expressions summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: serializedATN uid: adaptive-expressions.ExpressionAntlrLexer.serializedATN package: adaptive-expressions summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -523,10 +483,9 @@ properties: summary: '' fullName: SINGLE_AND remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SINGLE_AND: 11 = 11' + content: 'static SINGLE_AND: 11 = 11' return: description: '' type: '11' @@ -536,10 +495,9 @@ properties: summary: '' fullName: SLASH remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SLASH: 7 = 7' + content: 'static SLASH: 7 = 7' return: description: '' type: '7' @@ -549,10 +507,9 @@ properties: summary: '' fullName: STRING remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRING: 34 = 34' + content: 'static STRING: 34 = 34' return: description: '' type: '34' @@ -562,10 +519,9 @@ properties: summary: '' fullName: STRING_INTERPOLATION_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRING_INTERPOLATION_MODE: 1 = 1' + content: 'static STRING_INTERPOLATION_MODE: 1 = 1' return: description: '' type: '1' @@ -575,10 +531,9 @@ properties: summary: '' fullName: STRING_INTERPOLATION_START remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRING_INTERPOLATION_START: 1 = 1' + content: 'static STRING_INTERPOLATION_START: 1 = 1' return: description: '' type: '1' @@ -588,10 +543,9 @@ properties: summary: '' fullName: SUBSTRACT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SUBSTRACT: 3 = 3' + content: 'static SUBSTRACT: 3 = 3' return: description: '' type: '3' @@ -601,10 +555,9 @@ properties: summary: '' fullName: TEMPLATE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEMPLATE: 36 = 36' + content: 'static TEMPLATE: 36 = 36' return: description: '' type: '36' @@ -614,39 +567,33 @@ properties: summary: '' fullName: TEXT_CONTENT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT_CONTENT: 38 = 38' + content: 'static TEXT_CONTENT: 38 = 38' return: description: '' type: '38' - - name: VOCABULARY - uid: adaptive-expressions.ExpressionAntlrLexer.VOCABULARY + - name: vocabulary + uid: adaptive-expressions.ExpressionAntlrLexer.vocabulary package: adaptive-expressions summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(ExpressionAntlrLexer._LITERAL_NAMES, - ExpressionAntlrLexer._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: adaptive-expressions.ExpressionAntlrLexer.vocabulary + - name: VOCABULARY + uid: adaptive-expressions.ExpressionAntlrLexer.VOCABULARY package: adaptive-expressions summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -656,10 +603,9 @@ properties: summary: '' fullName: WHITESPACE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WHITESPACE: 31 = 31' + content: 'static WHITESPACE: 31 = 31' return: description: '' type: '31' @@ -669,10 +615,9 @@ properties: summary: '' fullName: XOR remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static XOR: 5 = 5' + content: 'static XOR: 5 = 5' return: description: '' type: '5' @@ -685,21 +630,21 @@ inheritedProperties: the recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by + the recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Lexer.atn - name: channel uid: adaptive-expressions.ExpressionAntlrLexer.channel package: adaptive-expressions summary: '' fullName: channel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channel: number' @@ -713,7 +658,6 @@ inheritedProperties: summary: What is the index of the current character of lookahead? fullName: charIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charIndex: number' @@ -727,7 +671,6 @@ inheritedProperties: summary: '' fullName: charPositionInLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charPositionInLine: number' @@ -741,7 +684,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_MODE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_MODE: number' @@ -755,7 +697,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_TOKEN_CHANNEL remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_TOKEN_CHANNEL: number' @@ -769,21 +710,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Lexer.EOF - name: HIDDEN uid: adaptive-expressions.ExpressionAntlrLexer.HIDDEN package: adaptive-expressions summary: '' fullName: HIDDEN remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static HIDDEN: number' @@ -797,7 +736,6 @@ inheritedProperties: summary: Set the char stream and reset the lexer fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: CharStream' @@ -811,21 +749,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: LexerATNSimulator' return: description: '' type: LexerATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Lexer.interpreter - name: line uid: adaptive-expressions.ExpressionAntlrLexer.line package: adaptive-expressions summary: '' fullName: line remarks: '' - isPreview: false isDeprecated: false syntax: content: 'line: number' @@ -839,7 +775,6 @@ inheritedProperties: summary: '' fullName: MAX_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MAX_CHAR_VALUE: number' @@ -853,7 +788,6 @@ inheritedProperties: summary: '' fullName: MIN_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MIN_CHAR_VALUE: number' @@ -867,7 +801,6 @@ inheritedProperties: summary: '' fullName: MORE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MORE: number' @@ -883,21 +816,19 @@ inheritedProperties: for each decision in recognizer in a ParseInfo object. fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> - inheritanceDescription: Inherited From Recognizer.parseInfo + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Lexer.parseInfo - name: SKIP uid: adaptive-expressions.ExpressionAntlrLexer.SKIP package: adaptive-expressions summary: '' fullName: SKIP remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static SKIP: number' @@ -911,7 +842,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -931,14 +861,13 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Lexer.state - name: text uid: adaptive-expressions.ExpressionAntlrLexer.text package: adaptive-expressions @@ -947,7 +876,6 @@ inheritedProperties: changes to the text. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -961,13 +889,12 @@ inheritedProperties: summary: Override if emitting multiple tokens. fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'token: Token | undefined' + content: 'token: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From Lexer.token - name: tokenFactory uid: adaptive-expressions.ExpressionAntlrLexer.tokenFactory @@ -975,7 +902,6 @@ inheritedProperties: summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -989,7 +915,6 @@ inheritedProperties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: number' @@ -1003,7 +928,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -1011,7 +935,7 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Lexer.addErrorListener - name: emit() uid: adaptive-expressions.ExpressionAntlrLexer.emit_1 package: adaptive-expressions @@ -1021,7 +945,6 @@ inheritedMethods: and getToken (to push tokens into a list and pull from that list rather than a single variable as this implementation does). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(): Token' @@ -1039,7 +962,6 @@ inheritedMethods: use that to set the token's text. Override this method to emit custom Token objects or provide a new factory. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(token: Token): Token' @@ -1056,7 +978,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEOF(): Token' @@ -1071,20 +992,18 @@ inheritedMethods: Return a list of all Token objects in input char stream. Forces load of all tokens. Does not include EOF token. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllTokens(): Token[]' return: description: '' - type: 'Token[]' + type: Token[] inheritanceDescription: Inherited From Lexer.getAllTokens - name: getCharErrorDisplay(number) uid: adaptive-expressions.ExpressionAntlrLexer.getCharErrorDisplay package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCharErrorDisplay(c: number): string' @@ -1101,7 +1020,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorDisplay(s: string | number): string' @@ -1116,9 +1034,8 @@ inheritedMethods: - name: getErrorHeader(RecognitionException) uid: adaptive-expressions.ExpressionAntlrLexer.getErrorHeader package: adaptive-expressions - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -1129,54 +1046,51 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Lexer.getErrorHeader - name: getErrorListenerDispatch() uid: adaptive-expressions.ExpressionAntlrLexer.getErrorListenerDispatch package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ANTLRErrorListener' return: description: '' type: ANTLRErrorListener<number> - inheritanceDescription: Inherited From Recognizer.getErrorListenerDispatch + inheritanceDescription: Inherited From Lexer.getErrorListenerDispatch - name: getErrorListeners() uid: adaptive-expressions.ExpressionAntlrLexer.getErrorListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<number>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<number>[] + inheritanceDescription: Inherited From Lexer.getErrorListeners - name: getRuleIndexMap() uid: adaptive-expressions.ExpressionAntlrLexer.getRuleIndexMap package: adaptive-expressions - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getRuleIndexMap - name: getTokenType(string) uid: adaptive-expressions.ExpressionAntlrLexer.getTokenType package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -1187,28 +1101,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Lexer.getTokenType - name: getTokenTypeMap() uid: adaptive-expressions.ExpressionAntlrLexer.getTokenTypeMap package: adaptive-expressions - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getTokenTypeMap - name: mode(number) uid: adaptive-expressions.ExpressionAntlrLexer.mode package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function mode(m: number)' @@ -1222,7 +1135,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function more() @@ -1234,7 +1146,6 @@ inheritedMethods: Return a token from this source; i.e., match a token on the char stream. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function nextToken(): Token' @@ -1247,7 +1158,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyListeners(e: LexerNoViableAltException)' @@ -1261,7 +1171,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function popMode(): number' @@ -1269,20 +1178,19 @@ inheritedMethods: description: '' type: number inheritanceDescription: Inherited From Lexer.popMode - - name: 'precpred(RuleContext | undefined, number)' + - name: precpred(undefined | RuleContext, number) uid: adaptive-expressions.ExpressionAntlrLexer.precpred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function precpred(localctx: RuleContext | undefined, precedence: + function precpred(localctx: undefined | RuleContext, precedence: number): boolean parameters: - id: localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: precedence type: number @@ -1290,13 +1198,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.precpred + inheritanceDescription: Inherited From Lexer.precpred - name: pushMode(number) uid: adaptive-expressions.ExpressionAntlrLexer.pushMode package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function pushMode(m: number)' @@ -1310,7 +1217,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: LexerNoViableAltException)' @@ -1328,7 +1234,6 @@ inheritedMethods: it all works out. You can instead use the rule invocation stack to do sophisticated error recovery if you are in a fragment rule. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: RecognitionException)' @@ -1342,7 +1247,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -1350,23 +1254,21 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Lexer.removeErrorListener - name: removeErrorListeners() uid: adaptive-expressions.ExpressionAntlrLexer.removeErrorListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Lexer.removeErrorListeners - name: reset() uid: adaptive-expressions.ExpressionAntlrLexer.reset package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -1376,7 +1278,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -1395,18 +1296,16 @@ inheritedMethods: if token==undefined at end of any token rule, it creates one for you and emits it. remarks: '' - isPreview: false isDeprecated: false syntax: content: function skip() inheritanceDescription: Inherited From Lexer.skip methods: - - name: 'action(RuleContext, number, number)' + - name: action(RuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrLexer.action package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1422,12 +1321,11 @@ methods: - id: actionIndex type: number description: '' - - name: 'sempred(RuleContext, number, number)' + - name: sempred(RuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrLexer.sempred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParser.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParser.yml index f27f1d79..5683d417 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParser.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParser.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: ExpressionAntlrParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ExpressionAntlrParser(input: TokenStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: ARROW remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ARROW: 27 = 27' + content: 'static ARROW: 27 = 27' return: description: '' type: '27' @@ -42,10 +39,9 @@ properties: summary: '' fullName: ASTERISK remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ASTERISK: 6 = 6' + content: 'static ASTERISK: 6 = 6' return: description: '' type: '6' @@ -55,10 +51,9 @@ properties: summary: '' fullName: CLOSE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLOSE_BRACKET: 19 = 19' + content: 'static CLOSE_BRACKET: 19 = 19' return: description: '' type: '19' @@ -68,10 +63,9 @@ properties: summary: '' fullName: CLOSE_CURLY_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLOSE_CURLY_BRACKET: 24 = 24' + content: 'static CLOSE_CURLY_BRACKET: 24 = 24' return: description: '' type: '24' @@ -81,10 +75,9 @@ properties: summary: '' fullName: CLOSE_SQUARE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CLOSE_SQUARE_BRACKET: 22 = 22' + content: 'static CLOSE_SQUARE_BRACKET: 22 = 22' return: description: '' type: '22' @@ -94,10 +87,9 @@ properties: summary: '' fullName: COLON remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COLON: 26 = 26' + content: 'static COLON: 26 = 26' return: description: '' type: '26' @@ -107,10 +99,9 @@ properties: summary: '' fullName: COMMA remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COMMA: 25 = 25' + content: 'static COMMA: 25 = 25' return: description: '' type: '25' @@ -120,10 +111,9 @@ properties: summary: '' fullName: DOT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOT: 20 = 20' + content: 'static DOT: 20 = 20' return: description: '' type: '20' @@ -133,10 +123,9 @@ properties: summary: '' fullName: DOUBLE_AND remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOUBLE_AND: 12 = 12' + content: 'static DOUBLE_AND: 12 = 12' return: description: '' type: '12' @@ -146,10 +135,9 @@ properties: summary: '' fullName: DOUBLE_EQUAL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOUBLE_EQUAL: 9 = 9' + content: 'static DOUBLE_EQUAL: 9 = 9' return: description: '' type: '9' @@ -159,10 +147,9 @@ properties: summary: '' fullName: DOUBLE_VERTICAL_CYLINDER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DOUBLE_VERTICAL_CYLINDER: 13 = 13' + content: 'static DOUBLE_VERTICAL_CYLINDER: 13 = 13' return: description: '' type: '13' @@ -172,10 +159,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER: 37 = 37' + content: 'static ESCAPE_CHARACTER: 37 = 37' return: description: '' type: '37' @@ -185,10 +171,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -198,10 +183,9 @@ properties: summary: '' fullName: IDENTIFIER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IDENTIFIER: 32 = 32' + content: 'static IDENTIFIER: 32 = 32' return: description: '' type: '32' @@ -211,10 +195,9 @@ properties: summary: '' fullName: INVALID_TOKEN_DEFAULT_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INVALID_TOKEN_DEFAULT_MODE: 35 = 35' + content: 'static INVALID_TOKEN_DEFAULT_MODE: 35 = 35' return: description: '' type: '35' @@ -224,10 +207,9 @@ properties: summary: '' fullName: LESS_OR_EQUAl remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LESS_OR_EQUAl: 16 = 16' + content: 'static LESS_OR_EQUAl: 16 = 16' return: description: '' type: '16' @@ -237,10 +219,9 @@ properties: summary: '' fullName: LESS_THAN remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LESS_THAN: 14 = 14' + content: 'static LESS_THAN: 14 = 14' return: description: '' type: '14' @@ -250,10 +231,9 @@ properties: summary: '' fullName: MORE_OR_EQUAL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MORE_OR_EQUAL: 17 = 17' + content: 'static MORE_OR_EQUAL: 17 = 17' return: description: '' type: '17' @@ -263,10 +243,9 @@ properties: summary: '' fullName: MORE_THAN remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MORE_THAN: 15 = 15' + content: 'static MORE_THAN: 15 = 15' return: description: '' type: '15' @@ -276,10 +255,9 @@ properties: summary: '' fullName: NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE: 33 = 33' + content: 'static NEWLINE: 33 = 33' return: description: '' type: '33' @@ -289,10 +267,9 @@ properties: summary: '' fullName: NON remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NON: 4 = 4' + content: 'static NON: 4 = 4' return: description: '' type: '4' @@ -302,10 +279,9 @@ properties: summary: '' fullName: NOT_EQUAL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NOT_EQUAL: 10 = 10' + content: 'static NOT_EQUAL: 10 = 10' return: description: '' type: '10' @@ -315,10 +291,9 @@ properties: summary: '' fullName: NULL_COALESCE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NULL_COALESCE: 28 = 28' + content: 'static NULL_COALESCE: 28 = 28' return: description: '' type: '28' @@ -328,10 +303,9 @@ properties: summary: '' fullName: NUMBER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NUMBER: 30 = 30' + content: 'static NUMBER: 30 = 30' return: description: '' type: '30' @@ -341,10 +315,9 @@ properties: summary: '' fullName: OPEN_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPEN_BRACKET: 18 = 18' + content: 'static OPEN_BRACKET: 18 = 18' return: description: '' type: '18' @@ -354,10 +327,9 @@ properties: summary: '' fullName: OPEN_CURLY_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPEN_CURLY_BRACKET: 23 = 23' + content: 'static OPEN_CURLY_BRACKET: 23 = 23' return: description: '' type: '23' @@ -367,10 +339,9 @@ properties: summary: '' fullName: OPEN_SQUARE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPEN_SQUARE_BRACKET: 21 = 21' + content: 'static OPEN_SQUARE_BRACKET: 21 = 21' return: description: '' type: '21' @@ -380,10 +351,9 @@ properties: summary: '' fullName: PERCENT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PERCENT: 8 = 8' + content: 'static PERCENT: 8 = 8' return: description: '' type: '8' @@ -393,10 +363,9 @@ properties: summary: '' fullName: PLUS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static PLUS: 2 = 2' + content: 'static PLUS: 2 = 2' return: description: '' type: '2' @@ -406,10 +375,9 @@ properties: summary: '' fullName: QUESTION_MARK remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static QUESTION_MARK: 29 = 29' + content: 'static QUESTION_MARK: 29 = 29' return: description: '' type: '29' @@ -419,36 +387,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\n\t\t\"file\", \"expression\", \"primaryExpression\", \"stringInterpolation\", \"textContent\", \n\t\t\"argsList\", \"lambda\", \"keyValuePairList\", \"keyValuePair\", \"key\",\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: adaptive-expressions.ExpressionAntlrParser.ruleNames package: adaptive-expressions summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: RULE_argsList uid: adaptive-expressions.ExpressionAntlrParser.RULE_argsList package: adaptive-expressions summary: '' fullName: RULE_argsList remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_argsList: 5 = 5' + content: 'static RULE_argsList: 5 = 5' return: description: '' type: '5' @@ -458,10 +423,9 @@ properties: summary: '' fullName: RULE_expression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_expression: 1 = 1' + content: 'static RULE_expression: 1 = 1' return: description: '' type: '1' @@ -471,10 +435,9 @@ properties: summary: '' fullName: RULE_file remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_file: 0 = 0' + content: 'static RULE_file: 0 = 0' return: description: '' type: '0' @@ -484,10 +447,9 @@ properties: summary: '' fullName: RULE_key remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_key: 9 = 9' + content: 'static RULE_key: 9 = 9' return: description: '' type: '9' @@ -497,10 +459,9 @@ properties: summary: '' fullName: RULE_keyValuePair remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_keyValuePair: 8 = 8' + content: 'static RULE_keyValuePair: 8 = 8' return: description: '' type: '8' @@ -510,10 +471,9 @@ properties: summary: '' fullName: RULE_keyValuePairList remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_keyValuePairList: 7 = 7' + content: 'static RULE_keyValuePairList: 7 = 7' return: description: '' type: '7' @@ -523,10 +483,9 @@ properties: summary: '' fullName: RULE_lambda remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_lambda: 6 = 6' + content: 'static RULE_lambda: 6 = 6' return: description: '' type: '6' @@ -536,10 +495,9 @@ properties: summary: '' fullName: RULE_primaryExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_primaryExpression: 2 = 2' + content: 'static RULE_primaryExpression: 2 = 2' return: description: '' type: '2' @@ -549,10 +507,9 @@ properties: summary: '' fullName: RULE_stringInterpolation remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_stringInterpolation: 3 = 3' + content: 'static RULE_stringInterpolation: 3 = 3' return: description: '' type: '3' @@ -562,10 +519,9 @@ properties: summary: '' fullName: RULE_textContent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_textContent: 4 = 4' + content: 'static RULE_textContent: 4 = 4' return: description: '' type: '4' @@ -575,10 +531,9 @@ properties: summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -588,10 +543,9 @@ properties: summary: '' fullName: SINGLE_AND remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SINGLE_AND: 11 = 11' + content: 'static SINGLE_AND: 11 = 11' return: description: '' type: '11' @@ -601,10 +555,9 @@ properties: summary: '' fullName: SLASH remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SLASH: 7 = 7' + content: 'static SLASH: 7 = 7' return: description: '' type: '7' @@ -614,10 +567,9 @@ properties: summary: '' fullName: STRING remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRING: 34 = 34' + content: 'static STRING: 34 = 34' return: description: '' type: '34' @@ -627,10 +579,9 @@ properties: summary: '' fullName: STRING_INTERPOLATION_START remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRING_INTERPOLATION_START: 1 = 1' + content: 'static STRING_INTERPOLATION_START: 1 = 1' return: description: '' type: '1' @@ -640,10 +591,9 @@ properties: summary: '' fullName: SUBSTRACT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SUBSTRACT: 3 = 3' + content: 'static SUBSTRACT: 3 = 3' return: description: '' type: '3' @@ -653,10 +603,9 @@ properties: summary: '' fullName: TEMPLATE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEMPLATE: 36 = 36' + content: 'static TEMPLATE: 36 = 36' return: description: '' type: '36' @@ -666,39 +615,33 @@ properties: summary: '' fullName: TEXT_CONTENT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT_CONTENT: 38 = 38' + content: 'static TEXT_CONTENT: 38 = 38' return: description: '' type: '38' - - name: VOCABULARY - uid: adaptive-expressions.ExpressionAntlrParser.VOCABULARY + - name: vocabulary + uid: adaptive-expressions.ExpressionAntlrParser.vocabulary package: adaptive-expressions summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(ExpressionAntlrParser._LITERAL_NAMES, - ExpressionAntlrParser._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: adaptive-expressions.ExpressionAntlrParser.vocabulary + - name: VOCABULARY + uid: adaptive-expressions.ExpressionAntlrParser.VOCABULARY package: adaptive-expressions summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -708,10 +651,9 @@ properties: summary: '' fullName: WHITESPACE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WHITESPACE: 31 = 31' + content: 'static WHITESPACE: 31 = 31' return: description: '' type: '31' @@ -721,10 +663,9 @@ properties: summary: '' fullName: XOR remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static XOR: 5 = 5' + content: 'static XOR: 5 = 5' return: description: '' type: '5' @@ -737,22 +678,24 @@ inheritedProperties: the recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by + the recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Parser.atn - name: buildParseTree uid: adaptive-expressions.ExpressionAntlrParser.buildParseTree package: adaptive-expressions - summary: | + summary: |- Track the objects during the parse and hook them up using the list so that it forms a parse tree. The returned from the start rule represents the root of the parse tree. + Note that if we are not building parse trees, rule contexts only point upwards. When a rule exits, it returns the context but that gets garbage collected if nobody holds a reference. It points upwards but nobody @@ -763,7 +706,6 @@ inheritedProperties: for garbage collection. fullName: buildParseTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buildParseTree: boolean' @@ -777,7 +719,6 @@ inheritedProperties: summary: '' fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: ParserRuleContext' @@ -793,7 +734,6 @@ inheritedProperties: into the label for the associated token ref; e.g., x=ID. fullName: currentToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'currentToken: Token' @@ -807,21 +747,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Parser.EOF - name: errorHandler uid: adaptive-expressions.ExpressionAntlrParser.errorHandler package: adaptive-expressions summary: '' fullName: errorHandler remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorHandler: ANTLRErrorStrategy' @@ -835,7 +773,6 @@ inheritedProperties: summary: Set the token stream and reset the parser. fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: TokenStream' @@ -849,21 +786,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: ParserATNSimulator' return: description: '' type: ParserATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Parser.interpreter - name: isMatchedEOF uid: adaptive-expressions.ExpressionAntlrParser.isMatchedEOF package: adaptive-expressions summary: '' fullName: isMatchedEOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isMatchedEOF: boolean' @@ -879,7 +814,6 @@ inheritedProperties: events as well as token matches. This is for quick and dirty debugging. fullName: isTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTrace: boolean' @@ -897,7 +831,6 @@ inheritedProperties: See #notifyErrorListeners fullName: numberOfSyntaxErrors remarks: '' - isPreview: false isDeprecated: false syntax: content: 'numberOfSyntaxErrors: number' @@ -911,13 +844,12 @@ inheritedProperties: summary: '' fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> + type: Promise<undefined | ParseInfo> inheritanceDescription: Inherited From Parser.parseInfo - name: precedence uid: adaptive-expressions.ExpressionAntlrParser.precedence @@ -925,12 +857,13 @@ inheritedProperties: summary: Get the precedence level for the top-most precedence rule. fullName: precedence remarks: '' - isPreview: false isDeprecated: false syntax: content: 'precedence: number' return: - description: '' + description: |- + The precedence level for the top-most precedence rule, or -1 if + the parser context is not nested within a precedence rule. type: number inheritanceDescription: Inherited From Parser.precedence - name: ruleContext @@ -939,7 +872,6 @@ inheritedProperties: summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ruleContext: ParserRuleContext' @@ -953,7 +885,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -973,21 +904,19 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Parser.state - name: tokenFactory uid: adaptive-expressions.ExpressionAntlrParser.tokenFactory package: adaptive-expressions summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -996,20 +925,19 @@ inheritedProperties: type: TokenFactory inheritanceDescription: Inherited From Parser.tokenFactory inheritedMethods: - - name: 'action(RuleContext | undefined, number, number)' + - name: action(undefined | RuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrParser.action package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function action(_localctx: RuleContext | undefined, ruleIndex: number, + function action(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number) parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -1017,13 +945,12 @@ inheritedMethods: - id: actionIndex type: number description: '' - inheritanceDescription: Inherited From Recognizer.action + inheritanceDescription: Inherited From Parser.action - name: addErrorListener(ANTLRErrorListener) uid: adaptive-expressions.ExpressionAntlrParser.addErrorListener package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -1031,12 +958,13 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Parser.addErrorListener - name: addParseListener(ParseTreeListener) uid: adaptive-expressions.ExpressionAntlrParser.addParseListener package: adaptive-expressions - summary: | + summary: |- Registers `listener` to receive events during the parsing process. + To support output-preserving grammar transformations (including but not limited to left-recursion removal, automated left-factoring, and optimized code generation), calls to listener methods during the parse @@ -1057,24 +985,23 @@ inheritedMethods: * Changing the version of the ANTLR Tool used to generate the parser may change the behavior of the listener calls. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to add + description: the listener to add inheritanceDescription: Inherited From Parser.addParseListener - - name: 'compileParseTreePattern(string, number)' + - name: compileParseTreePattern(string, number) uid: adaptive-expressions.ExpressionAntlrParser.compileParseTreePattern package: adaptive-expressions - summary: > + summary: >- The preferred method of getting a tree pattern. For example, here's a sample use: + ``` let t: ParseTree = parser.expr(); @@ -1088,7 +1015,6 @@ inheritedMethods: ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1105,7 +1031,7 @@ inheritedMethods: description: '' type: Promise<ParseTreePattern> inheritanceDescription: Inherited From Parser.compileParseTreePattern - - name: 'compileParseTreePattern(string, number, Lexer)' + - name: compileParseTreePattern(string, number, Lexer) uid: adaptive-expressions.ExpressionAntlrParser.compileParseTreePattern_1 package: adaptive-expressions summary: >- @@ -1115,7 +1041,6 @@ inheritedMethods: rather than trying to deduce it from this parser. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1138,9 +1063,10 @@ inheritedMethods: - name: consume() uid: adaptive-expressions.ExpressionAntlrParser.consume package: adaptive-expressions - summary: > + summary: >- Consume and return the [current symbol](`currentToken`). + E.g., given the following input with `A` being the current lookahead symbol, this function moves the cursor to `B` and returns @@ -1175,7 +1101,6 @@ inheritedMethods: listeners. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function consume(): Token' @@ -1183,14 +1108,13 @@ inheritedMethods: description: '' type: Token inheritanceDescription: Inherited From Parser.consume - - name: 'createErrorNode(ParserRuleContext, Token)' + - name: createErrorNode(ParserRuleContext, Token) uid: adaptive-expressions.ExpressionAntlrParser.createErrorNode package: adaptive-expressions summary: |- How to create an error node, given a token, associated with a parent. Typically, the error node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createErrorNode(parent: ParserRuleContext, t: Token): ErrorNode' @@ -1205,14 +1129,13 @@ inheritedMethods: description: '' type: ErrorNode inheritanceDescription: Inherited From Parser.createErrorNode - - name: 'createTerminalNode(ParserRuleContext, Token)' + - name: createTerminalNode(ParserRuleContext, Token) uid: adaptive-expressions.ExpressionAntlrParser.createTerminalNode package: adaptive-expressions summary: |- How to create a token leaf node associated with a parent. Typically, the terminal node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1234,17 +1157,15 @@ inheritedMethods: package: adaptive-expressions summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: function dumpDFA() inheritanceDescription: Inherited From Parser.dumpDFA - - name: 'enterLeftFactoredRule(ParserRuleContext, number, number)' + - name: enterLeftFactoredRule(ParserRuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrParser.enterLeftFactoredRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1261,12 +1182,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterLeftFactoredRule - - name: 'enterOuterAlt(ParserRuleContext, number)' + - name: enterOuterAlt(ParserRuleContext, number) uid: adaptive-expressions.ExpressionAntlrParser.enterOuterAlt package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterOuterAlt(localctx: ParserRuleContext, altNum: number)' @@ -1278,12 +1198,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterOuterAlt - - name: 'enterRecursionRule(ParserRuleContext, number, number, number)' + - name: enterRecursionRule(ParserRuleContext, number, number, number) uid: adaptive-expressions.ExpressionAntlrParser.enterRecursionRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1303,14 +1222,13 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterRecursionRule - - name: 'enterRule(ParserRuleContext, number, number)' + - name: enterRule(ParserRuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrParser.enterRule package: adaptive-expressions summary: |- Always called by generated parsers upon entry to a rule. Access field get the current context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1332,7 +1250,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function exitRule() @@ -1340,13 +1257,13 @@ inheritedMethods: - name: getATNWithBypassAlts() uid: adaptive-expressions.ExpressionAntlrParser.getATNWithBypassAlts package: adaptive-expressions - summary: | + summary: |- The ATN with bypass alternatives is expensive to create so we create it lazily. + @ if the current parser does not implement the `serializedATN` property. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getATNWithBypassAlts(): ATN' @@ -1359,20 +1276,18 @@ inheritedMethods: package: adaptive-expressions summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getDFAStrings(): string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getDFAStrings - name: getErrorHeader(RecognitionException) uid: adaptive-expressions.ExpressionAntlrParser.getErrorHeader package: adaptive-expressions - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -1383,13 +1298,12 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Parser.getErrorHeader - name: getErrorListenerDispatch() uid: adaptive-expressions.ExpressionAntlrParser.getErrorListenerDispatch package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ParserErrorListener' @@ -1402,14 +1316,13 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<Token>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<Token>[] + inheritanceDescription: Inherited From Parser.getErrorListeners - name: getExpectedTokens() uid: adaptive-expressions.ExpressionAntlrParser.getExpectedTokens package: adaptive-expressions @@ -1424,7 +1337,6 @@ inheritedMethods: See ATN#getExpectedTokens(int, RuleContext) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokens(): IntervalSet' @@ -1438,7 +1350,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokensWithinCurrentRule(): IntervalSet' @@ -1451,39 +1362,36 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function getInvokingContext(ruleIndex: number): ParserRuleContext | - undefined + function getInvokingContext(ruleIndex: number): undefined | + ParserRuleContext parameters: - id: ruleIndex type: number description: '' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From Parser.getInvokingContext - name: getParseListeners() uid: adaptive-expressions.ExpressionAntlrParser.getParseListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getParseListeners(): ParseTreeListener[]' return: description: '' - type: 'ParseTreeListener[]' + type: ParseTreeListener[] inheritanceDescription: Inherited From Parser.getParseListeners - name: getRuleIndex(string) uid: adaptive-expressions.ExpressionAntlrParser.getRuleIndex package: adaptive-expressions - summary: 'Get a rule''s index (i.e., `RULE_ruleName` field) or -1 if not found.' + summary: Get a rule's index (i.e., `RULE_ruleName` field) or -1 if not found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndex(ruleName: string): number' @@ -1498,29 +1406,29 @@ inheritedMethods: - name: getRuleIndexMap() uid: adaptive-expressions.ExpressionAntlrParser.getRuleIndexMap package: adaptive-expressions - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getRuleIndexMap - name: getRuleInvocationStack(RuleContext) uid: adaptive-expressions.ExpressionAntlrParser.getRuleInvocationStack package: adaptive-expressions - summary: | + summary: |- Return List<String> of the rule names in your parser instance leading up to a call to the current rule. You could override if you want more details such as the file/line info of where in the ATN a rule is invoked. + This is very useful for error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleInvocationStack(ctx?: RuleContext): string[]' @@ -1530,14 +1438,13 @@ inheritedMethods: description: '' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getRuleInvocationStack - name: getTokenType(string) uid: adaptive-expressions.ExpressionAntlrParser.getTokenType package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -1548,28 +1455,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Parser.getTokenType - name: getTokenTypeMap() uid: adaptive-expressions.ExpressionAntlrParser.getTokenTypeMap package: adaptive-expressions - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getTokenTypeMap - name: inContext(string) uid: adaptive-expressions.ExpressionAntlrParser.inContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function inContext(context: string): boolean' @@ -1584,16 +1490,16 @@ inheritedMethods: - name: isExpectedToken(number) uid: adaptive-expressions.ExpressionAntlrParser.isExpectedToken package: adaptive-expressions - summary: | + summary: |- Checks whether or not `symbol` can follow the current state in the ATN. The behavior of this method is equivalent to the following, but is implemented such that the complete context-sensitive follow set does not need to be explicitly constructed. + ``` return getExpectedTokens().contains(symbol); ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isExpectedToken(symbol: number): boolean' @@ -1610,13 +1516,14 @@ inheritedMethods: - name: match(number) uid: adaptive-expressions.ExpressionAntlrParser.match package: adaptive-expressions - summary: > + summary: >- Match current input symbol against `ttype`. If the symbol type matches, and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -1632,7 +1539,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function match(ttype: number): Token' @@ -1651,13 +1557,14 @@ inheritedMethods: - name: matchWildcard() uid: adaptive-expressions.ExpressionAntlrParser.matchWildcard package: adaptive-expressions - summary: > + summary: >- Match current input symbol as a wildcard. If the symbol type matches (i.e. has a value greater than 0), and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -1673,7 +1580,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function matchWildcard(): Token' @@ -1694,7 +1600,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyErrorListeners(msg: string)' @@ -1704,35 +1609,33 @@ inheritedMethods: description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - name: >- - notifyErrorListeners(string, Token | null, RecognitionException | - undefined) + notifyErrorListeners(string, null | Token, undefined | + RecognitionException) uid: adaptive-expressions.ExpressionAntlrParser.notifyErrorListeners_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function notifyErrorListeners(msg: string, offendingToken: Token | null, - e: RecognitionException | undefined) + function notifyErrorListeners(msg: string, offendingToken: null | Token, + e: undefined | RecognitionException) parameters: - id: msg type: string description: '' - id: offendingToken - type: Token | null + type: null | Token description: '' - id: e - type: RecognitionException | undefined + type: undefined | RecognitionException description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - - name: 'precpred(RuleContext, number)' + - name: precpred(RuleContext, number) uid: adaptive-expressions.ExpressionAntlrParser.precpred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function precpred(localctx: RuleContext, precedence: number): boolean' @@ -1747,14 +1650,13 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From Parser.precpred - - name: 'pushNewRecursionContext(ParserRuleContext, number, number)' + - name: pushNewRecursionContext(ParserRuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrParser.pushNewRecursionContext package: adaptive-expressions summary: |- Like but for recursive rules. Make the current context the child of the incoming localctx. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1776,7 +1678,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -1784,37 +1685,34 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Parser.removeErrorListener - name: removeErrorListeners() uid: adaptive-expressions.ExpressionAntlrParser.removeErrorListeners package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Parser.removeErrorListeners - name: removeParseListener(ParseTreeListener) uid: adaptive-expressions.ExpressionAntlrParser.removeParseListener package: adaptive-expressions summary: |- Remove `listener` from the list of parse listeners. + If `listener` is `undefined` or has not been added as a parse listener, this method does nothing. - See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to remove + description: the listener to remove inheritanceDescription: Inherited From Parser.removeParseListener - name: removeParseListeners() uid: adaptive-expressions.ExpressionAntlrParser.removeParseListeners @@ -1824,7 +1722,6 @@ inheritedMethods: See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeParseListeners() @@ -1834,7 +1731,6 @@ inheritedMethods: package: adaptive-expressions summary: reset the parser's state remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -1844,7 +1740,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -1858,7 +1753,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setProfile(profile: boolean): Promise' @@ -1875,7 +1769,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unrollRecursionContexts(_parentctx: ParserRuleContext)' @@ -1890,7 +1783,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function argsList(): ArgsListContext' @@ -1902,7 +1794,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -1914,7 +1805,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(_p: number): ExpressionContext' @@ -1930,7 +1820,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function file(): FileContext' @@ -1942,7 +1831,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function key(): KeyContext' @@ -1954,7 +1842,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValuePair(): KeyValuePairContext' @@ -1966,7 +1853,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValuePairList(): KeyValuePairListContext' @@ -1978,7 +1864,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function lambda(): LambdaContext' @@ -1990,7 +1875,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function primaryExpression(): PrimaryExpressionContext' @@ -2002,7 +1886,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function primaryExpression(_p: number): PrimaryExpressionContext' @@ -2013,12 +1896,11 @@ methods: return: description: '' type: - - name: 'sempred(RuleContext, number, number)' + - name: sempred(RuleContext, number, number) uid: adaptive-expressions.ExpressionAntlrParser.sempred package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -2042,7 +1924,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function stringInterpolation(): StringInterpolationContext' @@ -2054,7 +1935,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function textContent(): TextContentContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserListener.yml index 85c9a0b9..55e69ad7 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserListener.yml @@ -7,7 +7,6 @@ summary: |- `ExpressionAntlrParser`. fullName: ExpressionAntlrParserListener remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.argsList`. fullName: enterArgsList remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterArgsList?: (ctx: ArgsListContext) => void' @@ -32,7 +30,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterArrayCreationExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterArrayCreationExp?: (ctx: ArrayCreationExpContext) => void' @@ -47,7 +44,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: enterBinaryOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterBinaryOpExp?: (ctx: BinaryOpExpContext) => void' @@ -60,7 +56,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.expression`. fullName: enterExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterExpression?: (ctx: ExpressionContext) => void' @@ -73,7 +68,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.file`. fullName: enterFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterFile?: (ctx: FileContext) => void' @@ -88,7 +82,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterFuncInvokeExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterFuncInvokeExp?: (ctx: FuncInvokeExpContext) => void' @@ -103,7 +96,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterIdAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterIdAtom?: (ctx: IdAtomContext) => void' @@ -118,7 +110,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterIndexAccessExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterIndexAccessExp?: (ctx: IndexAccessExpContext) => void' @@ -133,7 +124,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterJsonCreationExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterJsonCreationExp?: (ctx: JsonCreationExpContext) => void' @@ -146,7 +136,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.key`. fullName: enterKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterKey?: (ctx: KeyContext) => void' @@ -159,7 +148,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.keyValuePair`. fullName: enterKeyValuePair remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterKeyValuePair?: (ctx: KeyValuePairContext) => void' @@ -172,7 +160,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.keyValuePairList`. fullName: enterKeyValuePairList remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterKeyValuePairList?: (ctx: KeyValuePairListContext) => void' @@ -185,7 +172,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.lambda`. fullName: enterLambda remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterLambda?: (ctx: LambdaContext) => void' @@ -200,7 +186,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterMemberAccessExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterMemberAccessExp?: (ctx: MemberAccessExpContext) => void' @@ -215,7 +200,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterNumericAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNumericAtom?: (ctx: NumericAtomContext) => void' @@ -230,7 +214,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterParenthesisExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterParenthesisExp?: (ctx: ParenthesisExpContext) => void' @@ -245,7 +228,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: enterPrimaryExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterPrimaryExp?: (ctx: PrimaryExpContext) => void' @@ -258,7 +240,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.primaryExpression`. fullName: enterPrimaryExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterPrimaryExpression?: (ctx: PrimaryExpressionContext) => void' @@ -273,7 +254,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterStringAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterStringAtom?: (ctx: StringAtomContext) => void' @@ -289,7 +269,6 @@ properties: `ExpressionAntlrParser.stringInterpolation`. fullName: enterStringInterpolation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterStringInterpolation?: (ctx: StringInterpolationContext) => void' @@ -305,7 +284,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: enterStringInterpolationAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -320,7 +298,6 @@ properties: summary: Enter a parse tree produced by `ExpressionAntlrParser.textContent`. fullName: enterTextContent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTextContent?: (ctx: TextContentContext) => void' @@ -335,7 +312,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: enterTripleOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTripleOpExp?: (ctx: TripleOpExpContext) => void' @@ -350,7 +326,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: enterUnaryOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterUnaryOpExp?: (ctx: UnaryOpExpContext) => void' @@ -363,7 +338,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.argsList`. fullName: exitArgsList remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitArgsList?: (ctx: ArgsListContext) => void' @@ -378,7 +352,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitArrayCreationExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitArrayCreationExp?: (ctx: ArrayCreationExpContext) => void' @@ -393,7 +366,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: exitBinaryOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitBinaryOpExp?: (ctx: BinaryOpExpContext) => void' @@ -406,7 +378,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.expression`. fullName: exitExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitExpression?: (ctx: ExpressionContext) => void' @@ -419,7 +390,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.file`. fullName: exitFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitFile?: (ctx: FileContext) => void' @@ -434,7 +404,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitFuncInvokeExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitFuncInvokeExp?: (ctx: FuncInvokeExpContext) => void' @@ -449,7 +418,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitIdAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitIdAtom?: (ctx: IdAtomContext) => void' @@ -464,7 +432,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitIndexAccessExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitIndexAccessExp?: (ctx: IndexAccessExpContext) => void' @@ -479,7 +446,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitJsonCreationExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitJsonCreationExp?: (ctx: JsonCreationExpContext) => void' @@ -492,7 +458,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.key`. fullName: exitKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitKey?: (ctx: KeyContext) => void' @@ -505,7 +470,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.keyValuePair`. fullName: exitKeyValuePair remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitKeyValuePair?: (ctx: KeyValuePairContext) => void' @@ -518,7 +482,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.keyValuePairList`. fullName: exitKeyValuePairList remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitKeyValuePairList?: (ctx: KeyValuePairListContext) => void' @@ -531,7 +494,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.lambda`. fullName: exitLambda remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitLambda?: (ctx: LambdaContext) => void' @@ -546,7 +508,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitMemberAccessExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitMemberAccessExp?: (ctx: MemberAccessExpContext) => void' @@ -561,7 +522,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitNumericAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNumericAtom?: (ctx: NumericAtomContext) => void' @@ -576,7 +536,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitParenthesisExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitParenthesisExp?: (ctx: ParenthesisExpContext) => void' @@ -591,7 +550,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: exitPrimaryExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitPrimaryExp?: (ctx: PrimaryExpContext) => void' @@ -604,7 +562,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.primaryExpression`. fullName: exitPrimaryExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitPrimaryExpression?: (ctx: PrimaryExpressionContext) => void' @@ -619,7 +576,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitStringAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitStringAtom?: (ctx: StringAtomContext) => void' @@ -632,7 +588,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.stringInterpolation`. fullName: exitStringInterpolation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitStringInterpolation?: (ctx: StringInterpolationContext) => void' @@ -648,7 +603,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: exitStringInterpolationAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -663,7 +617,6 @@ properties: summary: Exit a parse tree produced by `ExpressionAntlrParser.textContent`. fullName: exitTextContent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTextContent?: (ctx: TextContentContext) => void' @@ -678,7 +631,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: exitTripleOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTripleOpExp?: (ctx: TripleOpExpContext) => void' @@ -693,7 +645,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: exitUnaryOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitUnaryOpExp?: (ctx: UnaryOpExpContext) => void' @@ -707,7 +658,6 @@ inheritedProperties: summary: '' fullName: enterEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterEveryRule?: (ctx: ParserRuleContext) => void' @@ -721,7 +671,6 @@ inheritedProperties: summary: '' fullName: exitEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitEveryRule?: (ctx: ParserRuleContext) => void' @@ -735,7 +684,6 @@ inheritedProperties: summary: '' fullName: visitErrorNode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorNode?: (node: ErrorNode) => void' @@ -749,7 +697,6 @@ inheritedProperties: summary: '' fullName: visitTerminal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTerminal?: (node: TerminalNode) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserVisitor.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserVisitor.yml index 3f8e6ab1..453a66b6 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserVisitor.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionAntlrParserVisitor.yml @@ -7,7 +7,6 @@ summary: |- by `ExpressionAntlrParser`. fullName: ExpressionAntlrParserVisitor remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.argsList`. fullName: visitArgsList remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitArgsList?: (ctx: ArgsListContext) => Result' @@ -32,7 +30,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitArrayCreationExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitArrayCreationExp?: (ctx: ArrayCreationExpContext) => Result' @@ -47,7 +44,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: visitBinaryOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitBinaryOpExp?: (ctx: BinaryOpExpContext) => Result' @@ -60,7 +56,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.expression`. fullName: visitExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitExpression?: (ctx: ExpressionContext) => Result' @@ -73,7 +68,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.file`. fullName: visitFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitFile?: (ctx: FileContext) => Result' @@ -88,7 +82,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitFuncInvokeExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitFuncInvokeExp?: (ctx: FuncInvokeExpContext) => Result' @@ -103,7 +96,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitIdAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitIdAtom?: (ctx: IdAtomContext) => Result' @@ -118,7 +110,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitIndexAccessExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitIndexAccessExp?: (ctx: IndexAccessExpContext) => Result' @@ -133,7 +124,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitJsonCreationExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitJsonCreationExp?: (ctx: JsonCreationExpContext) => Result' @@ -146,7 +136,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.key`. fullName: visitKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitKey?: (ctx: KeyContext) => Result' @@ -159,7 +148,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.keyValuePair`. fullName: visitKeyValuePair remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitKeyValuePair?: (ctx: KeyValuePairContext) => Result' @@ -172,7 +160,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.keyValuePairList`. fullName: visitKeyValuePairList remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitKeyValuePairList?: (ctx: KeyValuePairListContext) => Result' @@ -185,7 +172,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.lambda`. fullName: visitLambda remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitLambda?: (ctx: LambdaContext) => Result' @@ -200,7 +186,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitMemberAccessExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitMemberAccessExp?: (ctx: MemberAccessExpContext) => Result' @@ -215,7 +200,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitNumericAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNumericAtom?: (ctx: NumericAtomContext) => Result' @@ -230,7 +214,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitParenthesisExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitParenthesisExp?: (ctx: ParenthesisExpContext) => Result' @@ -245,7 +228,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: visitPrimaryExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitPrimaryExp?: (ctx: PrimaryExpContext) => Result' @@ -258,7 +240,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.primaryExpression`. fullName: visitPrimaryExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitPrimaryExpression?: (ctx: PrimaryExpressionContext) => Result' @@ -273,7 +254,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitStringAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitStringAtom?: (ctx: StringAtomContext) => Result' @@ -288,7 +268,6 @@ properties: `ExpressionAntlrParser.stringInterpolation`. fullName: visitStringInterpolation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitStringInterpolation?: (ctx: StringInterpolationContext) => Result' @@ -304,7 +283,6 @@ properties: labeled alternative in `ExpressionAntlrParser.primaryExpression`. fullName: visitStringInterpolationAtom remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -319,7 +297,6 @@ properties: summary: Visit a parse tree produced by `ExpressionAntlrParser.textContent`. fullName: visitTextContent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTextContent?: (ctx: TextContentContext) => Result' @@ -334,7 +311,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: visitTripleOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTripleOpExp?: (ctx: TripleOpExpContext) => Result' @@ -349,7 +325,6 @@ properties: labeled alternative in `ExpressionAntlrParser.expression`. fullName: visitUnaryOpExp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitUnaryOpExp?: (ctx: UnaryOpExpContext) => Result' @@ -360,9 +335,8 @@ inheritedMethods: - name: visit(ParseTree) uid: adaptive-expressions.ExpressionAntlrParserVisitor.visit package: adaptive-expressions - summary: 'Visit a parse tree, and return a user-defined result of the operation.' + summary: Visit a parse tree, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): Result' @@ -383,14 +357,13 @@ inheritedMethods: Visit the children of a node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): Result' parameters: - id: node type: RuleNode - description: 'The whose children should be visited.' + description: The whose children should be visited. return: description: The result of visiting the children of the node. type: Result @@ -398,16 +371,15 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: adaptive-expressions.ExpressionAntlrParserVisitor.visitErrorNode package: adaptive-expressions - summary: 'Visit an error node, and return a user-defined result of the operation.' + summary: Visit an error node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): Result' parameters: - id: node type: ErrorNode - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the node. type: Result @@ -415,9 +387,8 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: adaptive-expressions.ExpressionAntlrParserVisitor.visitTerminal package: adaptive-expressions - summary: 'Visit a terminal node, and return a user-defined result of the operation.' + summary: Visit a terminal node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): Result' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionContext.yml index 4ba9be7b..12417fdc 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: ExpressionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ExpressionContext(ParserRuleContext | undefined, number)' + - name: ExpressionContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.ExpressionContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ExpressionContext(parent: ParserRuleContext | undefined, + new ExpressionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.ExpressionContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.ExpressionContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.ExpressionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.ExpressionContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.ExpressionContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.ExpressionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.ExpressionContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ExpressionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.ExpressionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,40 +216,38 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.ExpressionContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: accept(ParseTreeVisitor) uid: adaptive-expressions.ExpressionContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: ParseTreeVisitor): T' @@ -275,22 +258,20 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From RuleContext.accept + inheritanceDescription: Inherited From ParserRuleContext.accept - name: addAnyChild(T) uid: adaptive-expressions.ExpressionContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -307,7 +288,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -321,7 +301,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -343,7 +322,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -361,7 +339,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -386,7 +363,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -404,20 +380,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.ExpressionContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -430,7 +404,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ParseTreeListener)' @@ -444,7 +417,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ParseTreeListener)' @@ -458,7 +430,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -470,32 +441,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ExpressionContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ExpressionContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -511,50 +480,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ExpressionContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ExpressionContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.ExpressionContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -574,7 +540,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -584,7 +549,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.ExpressionContext.removeLastChild @@ -594,7 +559,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -604,7 +568,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -612,7 +575,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.ExpressionContext.toInfoString package: adaptive-expressions @@ -620,7 +583,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -637,105 +599,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ExpressionContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ExpressionContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.ExpressionContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ExpressionContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.ExpressionContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.ExpressionContext.toStringTree package: adaptive-expressions @@ -744,7 +700,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -755,75 +710,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ExpressionContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ExpressionContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ExpressionContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.ExpressionContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -833,7 +788,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: copyFrom(ExpressionContext) @@ -841,7 +796,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ExpressionContext)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionConverter.yml index 4028886b..0510a9fc 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionConverter.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '`string` to json [Expression](xref:adaptive-expressions.Expression) converter.' fullName: ExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: Converts a `string` into an [Expression](xref:adaptive-expressions.Expression). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: string | Expression): Expression' @@ -25,5 +23,5 @@ methods: type: string | description: '`string` to convert.' return: - description: 'The [Expression](xref:adaptive-expressions.Expression).' + description: The [Expression](xref:adaptive-expressions.Expression). type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionEvaluator.yml index 4200789f..cb3517aa 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionEvaluator.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Information on how to evaluate an expression. fullName: ExpressionEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,12 +15,11 @@ constructors: package: adaptive-expressions summary: Initializes a new instance of the class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new ExpressionEvaluator(type: string, evaluator: - EvaluateExpressionDelegate, returnType: ReturnType, validator?: + EvaluateExpressionDelegate, returnType?: ReturnType, validator?: ValidateExpressionDelegate) parameters: - id: type @@ -35,23 +33,19 @@ constructors: description: Type expected from evaluation. - id: validator type: - description: | - Static validation of expression. + description: Static validation of expression. properties: - name: negation uid: adaptive-expressions.ExpressionEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: - name: returnType uid: adaptive-expressions.ExpressionEvaluator.returnType @@ -59,61 +53,49 @@ properties: summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' return: description: '' type: + - name: tryEvaluate + uid: adaptive-expressions.ExpressionEvaluator.tryEvaluate + package: adaptive-expressions + summary: Evaluate an expression. + fullName: tryEvaluate + remarks: '' + isDeprecated: false + syntax: + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError + return: + description: '' + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError - name: type uid: adaptive-expressions.ExpressionEvaluator.type package: adaptive-expressions summary: Gets the expression type for evaluator. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' return: description: '' type: string -methods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ExpressionEvaluator.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - - name: validateExpression(Expression) + - name: validateExpression uid: adaptive-expressions.ExpressionEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionFunctions.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionFunctions.yml index e4ac6793..d3f1da68 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionFunctions.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionFunctions.yml @@ -17,7 +17,6 @@ summary: |- fullName: ExpressionFunctions remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -27,12 +26,9 @@ properties: summary: Read only Dictionary of built in functions. fullName: standardFunctions remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static standardFunctions: ReadonlyMap = - ExpressionFunctions.getStandardFunctions() + content: 'static standardFunctions: ReadonlyMap' return: description: '' type: >- diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParser.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParser.yml index 122782ec..ec256100 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParser.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParser.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Parser to turn strings into Expression fullName: ExpressionParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,16 +15,15 @@ constructors: Initializes a new instance of the [ExpressionParser](xref:adaptive-expressions.ExpressionParser) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ExpressionParser(lookup?: EvaluatorLookup)' parameters: - id: lookup - type: - description: > - (xref:adaptive-expressions.EvaluatorLookup) for information from - type string. + type: + description: >- + [EvaluatorLookup](xref:adaptive-expressions.EvaluatorLookup) for + information from type string. properties: - name: EvaluatorLookup uid: adaptive-expressions.ExpressionParser.EvaluatorLookup @@ -33,20 +31,18 @@ properties: summary: The delegate to lookup function information from the type. fullName: EvaluatorLookup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'EvaluatorLookup: EvaluatorLookup' return: description: '' - type: + type: methods: - name: parse(string) uid: adaptive-expressions.ExpressionParser.parse package: adaptive-expressions summary: Parse the input into an expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function parse(expression: string): Expression' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParserInterface.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParserInterface.yml index 09733a7c..56b2d712 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParserInterface.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionParserInterface.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Interface to parse a string into an Expression fullName: ExpressionParserInterface remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: adaptive-expressions summary: Parse a string into an Expression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function parse(expression: string): Expression' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionProperty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionProperty.yml index f9c60c98..d3a24610 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionProperty.yml @@ -5,11 +5,10 @@ package: adaptive-expressions summary: Base class which defines an Expression or value for a property. fullName: ExpressionProperty remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ExpressionProperty(T | string | Expression, T)' + - name: ExpressionProperty(string | Expression | T, T) uid: adaptive-expressions.ExpressionProperty.constructor package: adaptive-expressions summary: >- @@ -17,20 +16,18 @@ constructors: [ExpressionProperty](xref:adaptive-expressions.ExpressionProperty) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ExpressionProperty(value?: T | string | Expression, defaultValue?: + new ExpressionProperty(value?: string | Expression | T, defaultValue?: T) parameters: - id: value - type: T | string | + type: string | | T description: Optional. Raw value of the expression property. - id: defaultValue type: T - description: | - Optional. Default value for the property. + description: Optional. Default value for the property. properties: - name: expressionText uid: adaptive-expressions.ExpressionProperty.expressionText @@ -38,7 +35,6 @@ properties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -51,7 +47,6 @@ properties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: T' @@ -64,7 +59,6 @@ methods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): T' @@ -75,26 +69,23 @@ methods: return: description: The value. type: T - - name: setValue(T | string | Expression) + - name: setValue(string | Expression | T) uid: adaptive-expressions.ExpressionProperty.setValue package: adaptive-expressions summary: Set the value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: T | string | Expression)' + content: 'function setValue(value: string | Expression | T)' parameters: - id: value - type: T | string | - description: | - Value to set. + type: string | | T + description: Value to set. - name: toExpression() uid: adaptive-expressions.ExpressionProperty.toExpression package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -106,7 +97,6 @@ methods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -118,7 +108,6 @@ methods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: T }' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionType.yml index bf787fad..cea0d414 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionType.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ExpressionType.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Built-in expression types. fullName: ExpressionType remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: Abs remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Abs: string = "abs"' + content: 'static Abs: string' return: description: '' type: string @@ -28,10 +26,9 @@ properties: summary: '' fullName: Accessor remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Accessor: string = "Accessor"' + content: 'static Accessor: string' return: description: '' type: string @@ -41,10 +38,9 @@ properties: summary: '' fullName: Add remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Add: string = "+"' + content: 'static Add: string' return: description: '' type: string @@ -54,10 +50,9 @@ properties: summary: '' fullName: AddDays remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddDays: string = "addDays"' + content: 'static AddDays: string' return: description: '' type: string @@ -67,10 +62,9 @@ properties: summary: '' fullName: AddHours remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddHours: string = "addHours"' + content: 'static AddHours: string' return: description: '' type: string @@ -80,10 +74,9 @@ properties: summary: '' fullName: AddMinutes remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddMinutes: string = "addMinutes"' + content: 'static AddMinutes: string' return: description: '' type: string @@ -93,10 +86,9 @@ properties: summary: '' fullName: AddOrdinal remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddOrdinal: string = "addOrdinal"' + content: 'static AddOrdinal: string' return: description: '' type: string @@ -106,10 +98,9 @@ properties: summary: '' fullName: AddProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddProperty: string = "addProperty"' + content: 'static AddProperty: string' return: description: '' type: string @@ -119,10 +110,9 @@ properties: summary: '' fullName: AddSeconds remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddSeconds: string = "addSeconds"' + content: 'static AddSeconds: string' return: description: '' type: string @@ -132,10 +122,9 @@ properties: summary: '' fullName: AddToTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static AddToTime: string = "addToTime"' + content: 'static AddToTime: string' return: description: '' type: string @@ -145,10 +134,9 @@ properties: summary: '' fullName: All remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static All: string = "all"' + content: 'static All: string' return: description: '' type: string @@ -158,10 +146,9 @@ properties: summary: '' fullName: And remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static And: string = "&&"' + content: 'static And: string' return: description: '' type: string @@ -171,10 +158,9 @@ properties: summary: '' fullName: Any remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Any: string = "any"' + content: 'static Any: string' return: description: '' type: string @@ -184,10 +170,9 @@ properties: summary: '' fullName: Average remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Average: string = "average"' + content: 'static Average: string' return: description: '' type: string @@ -197,10 +182,9 @@ properties: summary: '' fullName: Base64 remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Base64: string = "base64"' + content: 'static Base64: string' return: description: '' type: string @@ -210,10 +194,9 @@ properties: summary: '' fullName: Base64ToBinary remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Base64ToBinary: string = "base64ToBinary"' + content: 'static Base64ToBinary: string' return: description: '' type: string @@ -223,10 +206,9 @@ properties: summary: '' fullName: Base64ToString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Base64ToString: string = "base64ToString"' + content: 'static Base64ToString: string' return: description: '' type: string @@ -236,10 +218,9 @@ properties: summary: '' fullName: Binary remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Binary: string = "binary"' + content: 'static Binary: string' return: description: '' type: string @@ -249,10 +230,9 @@ properties: summary: '' fullName: Bool remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Bool: string = "bool"' + content: 'static Bool: string' return: description: '' type: string @@ -262,10 +242,9 @@ properties: summary: '' fullName: Ceiling remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Ceiling: string = "ceiling"' + content: 'static Ceiling: string' return: description: '' type: string @@ -275,10 +254,9 @@ properties: summary: '' fullName: Coalesce remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Coalesce: string = "coalesce"' + content: 'static Coalesce: string' return: description: '' type: string @@ -288,10 +266,9 @@ properties: summary: '' fullName: Concat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Concat: string = "concat"' + content: 'static Concat: string' return: description: '' type: string @@ -301,10 +278,9 @@ properties: summary: '' fullName: Constant remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Constant: string = "Constant"' + content: 'static Constant: string' return: description: '' type: string @@ -314,10 +290,9 @@ properties: summary: '' fullName: Contains remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Contains: string = "contains"' + content: 'static Contains: string' return: description: '' type: string @@ -327,10 +302,9 @@ properties: summary: '' fullName: ConvertFromUTC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static ConvertFromUTC: string = "convertFromUTC"' + content: 'static ConvertFromUTC: string' return: description: '' type: string @@ -340,10 +314,9 @@ properties: summary: '' fullName: ConvertToUTC remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static ConvertToUTC: string = "convertToUTC"' + content: 'static ConvertToUTC: string' return: description: '' type: string @@ -353,10 +326,9 @@ properties: summary: '' fullName: Count remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Count: string = "count"' + content: 'static Count: string' return: description: '' type: string @@ -366,10 +338,9 @@ properties: summary: '' fullName: CountWord remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static CountWord: string = "countWord"' + content: 'static CountWord: string' return: description: '' type: string @@ -379,10 +350,9 @@ properties: summary: '' fullName: CreateArray remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static CreateArray: string = "createArray"' + content: 'static CreateArray: string' return: description: '' type: string @@ -392,10 +362,9 @@ properties: summary: '' fullName: DataUri remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DataUri: string = "dataUri"' + content: 'static DataUri: string' return: description: '' type: string @@ -405,10 +374,9 @@ properties: summary: '' fullName: DataUriToBinary remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DataUriToBinary: string = "dataUriToBinary"' + content: 'static DataUriToBinary: string' return: description: '' type: string @@ -418,10 +386,9 @@ properties: summary: '' fullName: DataUriToString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DataUriToString: string = "dataUriToString"' + content: 'static DataUriToString: string' return: description: '' type: string @@ -431,10 +398,9 @@ properties: summary: '' fullName: Date remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Date: string = "date"' + content: 'static Date: string' return: description: '' type: string @@ -444,10 +410,9 @@ properties: summary: '' fullName: DateReadBack remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DateReadBack: string = "dateReadBack"' + content: 'static DateReadBack: string' return: description: '' type: string @@ -457,10 +422,9 @@ properties: summary: '' fullName: DateTimeDiff remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DateTimeDiff: string = "dateTimeDiff"' + content: 'static DateTimeDiff: string' return: description: '' type: string @@ -470,10 +434,9 @@ properties: summary: '' fullName: DayOfMonth remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DayOfMonth: string = "dayOfMonth"' + content: 'static DayOfMonth: string' return: description: '' type: string @@ -483,10 +446,9 @@ properties: summary: '' fullName: DayOfWeek remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DayOfWeek: string = "dayOfWeek"' + content: 'static DayOfWeek: string' return: description: '' type: string @@ -496,10 +458,9 @@ properties: summary: '' fullName: DayOfYear remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DayOfYear: string = "dayOfYear"' + content: 'static DayOfYear: string' return: description: '' type: string @@ -509,10 +470,9 @@ properties: summary: '' fullName: Divide remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Divide: string = "/"' + content: 'static Divide: string' return: description: '' type: string @@ -522,10 +482,9 @@ properties: summary: '' fullName: Element remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Element: string = "Element"' + content: 'static Element: string' return: description: '' type: string @@ -535,10 +494,9 @@ properties: summary: '' fullName: Empty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Empty: string = "empty"' + content: 'static Empty: string' return: description: '' type: string @@ -548,10 +506,9 @@ properties: summary: '' fullName: EndsWith remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static EndsWith: string = "endsWith"' + content: 'static EndsWith: string' return: description: '' type: string @@ -561,10 +518,9 @@ properties: summary: '' fullName: EOL remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static EOL: string = "EOL"' + content: 'static EOL: string' return: description: '' type: string @@ -574,10 +530,9 @@ properties: summary: '' fullName: Equal remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Equal: string = "=="' + content: 'static Equal: string' return: description: '' type: string @@ -587,10 +542,9 @@ properties: summary: '' fullName: Exists remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Exists: string = "exists"' + content: 'static Exists: string' return: description: '' type: string @@ -600,10 +554,9 @@ properties: summary: '' fullName: FilterNotEqual remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static FilterNotEqual: string = "filterNotEqual"' + content: 'static FilterNotEqual: string' return: description: '' type: string @@ -613,10 +566,9 @@ properties: summary: '' fullName: First remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static First: string = "first"' + content: 'static First: string' return: description: '' type: string @@ -626,10 +578,9 @@ properties: summary: '' fullName: Flatten remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Flatten: string = "flatten"' + content: 'static Flatten: string' return: description: '' type: string @@ -639,10 +590,9 @@ properties: summary: '' fullName: Float remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Float: string = "float"' + content: 'static Float: string' return: description: '' type: string @@ -652,10 +602,9 @@ properties: summary: '' fullName: Floor remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Floor: string = "floor"' + content: 'static Floor: string' return: description: '' type: string @@ -665,10 +614,9 @@ properties: summary: '' fullName: Foreach remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Foreach: string = "foreach"' + content: 'static Foreach: string' return: description: '' type: string @@ -678,10 +626,9 @@ properties: summary: '' fullName: FormatDateTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static FormatDateTime: string = "formatDateTime"' + content: 'static FormatDateTime: string' return: description: '' type: string @@ -691,10 +638,9 @@ properties: summary: '' fullName: FormatEpoch remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static FormatEpoch: string = "formatEpoch"' + content: 'static FormatEpoch: string' return: description: '' type: string @@ -704,10 +650,9 @@ properties: summary: '' fullName: FormatNumber remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static FormatNumber: string = "formatNumber"' + content: 'static FormatNumber: string' return: description: '' type: string @@ -717,10 +662,9 @@ properties: summary: '' fullName: FormatTicks remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static FormatTicks: string = "formatTicks"' + content: 'static FormatTicks: string' return: description: '' type: string @@ -730,10 +674,9 @@ properties: summary: '' fullName: GetFutureTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetFutureTime: string = "getFutureTime"' + content: 'static GetFutureTime: string' return: description: '' type: string @@ -743,10 +686,9 @@ properties: summary: '' fullName: GetNextViableDate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetNextViableDate: string = "getNextViableDate"' + content: 'static GetNextViableDate: string' return: description: '' type: string @@ -756,10 +698,9 @@ properties: summary: '' fullName: GetNextViableTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetNextViableTime: string = "getNextViableTime"' + content: 'static GetNextViableTime: string' return: description: '' type: string @@ -769,10 +710,9 @@ properties: summary: '' fullName: GetPastTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetPastTime: string = "getPastTime"' + content: 'static GetPastTime: string' return: description: '' type: string @@ -782,10 +722,9 @@ properties: summary: '' fullName: GetPreviousViableDate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetPreviousViableDate: string = "getPreviousViableDate"' + content: 'static GetPreviousViableDate: string' return: description: '' type: string @@ -795,10 +734,9 @@ properties: summary: '' fullName: GetPreviousViableTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetPreviousViableTime: string = "getPreviousViableTime"' + content: 'static GetPreviousViableTime: string' return: description: '' type: string @@ -808,10 +746,9 @@ properties: summary: '' fullName: GetProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetProperty: string = "getProperty"' + content: 'static GetProperty: string' return: description: '' type: string @@ -821,10 +758,9 @@ properties: summary: '' fullName: GetTimeOfDay remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GetTimeOfDay: string = "getTimeOfDay"' + content: 'static GetTimeOfDay: string' return: description: '' type: string @@ -834,10 +770,9 @@ properties: summary: '' fullName: GreaterThan remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GreaterThan: string = ">"' + content: 'static GreaterThan: string' return: description: '' type: string @@ -847,10 +782,9 @@ properties: summary: '' fullName: GreaterThanOrEqual remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static GreaterThanOrEqual: string = ">="' + content: 'static GreaterThanOrEqual: string' return: description: '' type: string @@ -860,10 +794,9 @@ properties: summary: '' fullName: If remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static If: string = "if"' + content: 'static If: string' return: description: '' type: string @@ -873,10 +806,9 @@ properties: summary: '' fullName: Ignore remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Ignore: string = "ignore"' + content: 'static Ignore: string' return: description: '' type: string @@ -886,10 +818,9 @@ properties: summary: '' fullName: IndexOf remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IndexOf: string = "indexOf"' + content: 'static IndexOf: string' return: description: '' type: string @@ -899,10 +830,9 @@ properties: summary: '' fullName: IndicesAndValues remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IndicesAndValues: string = "indicesAndValues"' + content: 'static IndicesAndValues: string' return: description: '' type: string @@ -912,10 +842,9 @@ properties: summary: '' fullName: Int remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Int: string = "int"' + content: 'static Int: string' return: description: '' type: string @@ -925,10 +854,9 @@ properties: summary: '' fullName: Intersection remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Intersection: string = "intersection"' + content: 'static Intersection: string' return: description: '' type: string @@ -938,10 +866,9 @@ properties: summary: '' fullName: IsArray remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsArray: string = "isArray"' + content: 'static IsArray: string' return: description: '' type: string @@ -951,10 +878,9 @@ properties: summary: '' fullName: IsBoolean remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsBoolean: string = "isBoolean"' + content: 'static IsBoolean: string' return: description: '' type: string @@ -964,10 +890,9 @@ properties: summary: '' fullName: IsDate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsDate: string = "isDate"' + content: 'static IsDate: string' return: description: '' type: string @@ -977,10 +902,9 @@ properties: summary: '' fullName: IsDateRange remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsDateRange: string = "isDateRange"' + content: 'static IsDateRange: string' return: description: '' type: string @@ -990,10 +914,9 @@ properties: summary: '' fullName: IsDateTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsDateTime: string = "isDateTime"' + content: 'static IsDateTime: string' return: description: '' type: string @@ -1003,10 +926,9 @@ properties: summary: '' fullName: IsDefinite remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsDefinite: string = "isDefinite"' + content: 'static IsDefinite: string' return: description: '' type: string @@ -1016,10 +938,9 @@ properties: summary: '' fullName: IsDuration remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsDuration: string = "isDuration"' + content: 'static IsDuration: string' return: description: '' type: string @@ -1029,10 +950,9 @@ properties: summary: '' fullName: IsFloat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsFloat: string = "isFloat"' + content: 'static IsFloat: string' return: description: '' type: string @@ -1042,10 +962,9 @@ properties: summary: '' fullName: IsInteger remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsInteger: string = "isInteger"' + content: 'static IsInteger: string' return: description: '' type: string @@ -1055,10 +974,9 @@ properties: summary: '' fullName: IsMatch remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsMatch: string = "isMatch"' + content: 'static IsMatch: string' return: description: '' type: string @@ -1068,10 +986,9 @@ properties: summary: '' fullName: IsObject remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsObject: string = "isObject"' + content: 'static IsObject: string' return: description: '' type: string @@ -1081,10 +998,9 @@ properties: summary: '' fullName: IsPresent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsPresent: string = "isPresent"' + content: 'static IsPresent: string' return: description: '' type: string @@ -1094,10 +1010,9 @@ properties: summary: '' fullName: IsString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsString: string = "isString"' + content: 'static IsString: string' return: description: '' type: string @@ -1107,10 +1022,9 @@ properties: summary: '' fullName: IsTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsTime: string = "isTime"' + content: 'static IsTime: string' return: description: '' type: string @@ -1120,10 +1034,9 @@ properties: summary: '' fullName: IsTimeRange remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static IsTimeRange: string = "isTimeRange"' + content: 'static IsTimeRange: string' return: description: '' type: string @@ -1133,10 +1046,9 @@ properties: summary: '' fullName: Join remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Join: string = "join"' + content: 'static Join: string' return: description: '' type: string @@ -1146,10 +1058,9 @@ properties: summary: '' fullName: JPath remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static JPath: string = "jPath"' + content: 'static JPath: string' return: description: '' type: string @@ -1159,10 +1070,9 @@ properties: summary: '' fullName: Json remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Json: string = "json"' + content: 'static Json: string' return: description: '' type: string @@ -1172,10 +1082,9 @@ properties: summary: '' fullName: JsonStringify remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static JsonStringify: string = "jsonStringify"' + content: 'static JsonStringify: string' return: description: '' type: string @@ -1185,10 +1094,9 @@ properties: summary: '' fullName: Lambda remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Lambda: string = "Lambda"' + content: 'static Lambda: string' return: description: '' type: string @@ -1198,10 +1106,9 @@ properties: summary: '' fullName: Last remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Last: string = "last"' + content: 'static Last: string' return: description: '' type: string @@ -1211,10 +1118,9 @@ properties: summary: '' fullName: LastIndexOf remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static LastIndexOf: string = "lastIndexOf"' + content: 'static LastIndexOf: string' return: description: '' type: string @@ -1224,10 +1130,9 @@ properties: summary: '' fullName: Length remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Length: string = "length"' + content: 'static Length: string' return: description: '' type: string @@ -1237,10 +1142,9 @@ properties: summary: '' fullName: LessThan remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static LessThan: string = "<"' + content: 'static LessThan: string' return: description: '' type: string @@ -1250,10 +1154,9 @@ properties: summary: '' fullName: LessThanOrEqual remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static LessThanOrEqual: string = "<="' + content: 'static LessThanOrEqual: string' return: description: '' type: string @@ -1263,10 +1166,9 @@ properties: summary: '' fullName: Max remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Max: string = "max"' + content: 'static Max: string' return: description: '' type: string @@ -1276,10 +1178,9 @@ properties: summary: '' fullName: Merge remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Merge: string = "merge"' + content: 'static Merge: string' return: description: '' type: string @@ -1289,10 +1190,9 @@ properties: summary: '' fullName: Min remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Min: string = "min"' + content: 'static Min: string' return: description: '' type: string @@ -1302,10 +1202,9 @@ properties: summary: '' fullName: Mod remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Mod: string = "%"' + content: 'static Mod: string' return: description: '' type: string @@ -1315,10 +1214,9 @@ properties: summary: '' fullName: Month remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Month: string = "month"' + content: 'static Month: string' return: description: '' type: string @@ -1328,10 +1226,9 @@ properties: summary: '' fullName: Multiply remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Multiply: string = "*"' + content: 'static Multiply: string' return: description: '' type: string @@ -1341,10 +1238,9 @@ properties: summary: '' fullName: NewGuid remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static NewGuid: string = "newGuid"' + content: 'static NewGuid: string' return: description: '' type: string @@ -1354,10 +1250,9 @@ properties: summary: '' fullName: Not remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Not: string = "!"' + content: 'static Not: string' return: description: '' type: string @@ -1367,10 +1262,9 @@ properties: summary: '' fullName: NotEqual remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static NotEqual: string = "!="' + content: 'static NotEqual: string' return: description: '' type: string @@ -1380,10 +1274,9 @@ properties: summary: '' fullName: Optional remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Optional: string = "optional"' + content: 'static Optional: string' return: description: '' type: string @@ -1393,10 +1286,9 @@ properties: summary: '' fullName: Or remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Or: string = "||"' + content: 'static Or: string' return: description: '' type: string @@ -1406,10 +1298,9 @@ properties: summary: '' fullName: Power remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Power: string = "^"' + content: 'static Power: string' return: description: '' type: string @@ -1419,10 +1310,9 @@ properties: summary: '' fullName: Rand remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Rand: string = "rand"' + content: 'static Rand: string' return: description: '' type: string @@ -1432,10 +1322,9 @@ properties: summary: '' fullName: Range remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Range: string = "range"' + content: 'static Range: string' return: description: '' type: string @@ -1445,10 +1334,9 @@ properties: summary: '' fullName: RemoveProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static RemoveProperty: string = "removeProperty"' + content: 'static RemoveProperty: string' return: description: '' type: string @@ -1458,10 +1346,9 @@ properties: summary: '' fullName: Replace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Replace: string = "replace"' + content: 'static Replace: string' return: description: '' type: string @@ -1471,10 +1358,9 @@ properties: summary: '' fullName: ReplaceIgnoreCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static ReplaceIgnoreCase: string = "replaceIgnoreCase"' + content: 'static ReplaceIgnoreCase: string' return: description: '' type: string @@ -1484,10 +1370,9 @@ properties: summary: '' fullName: Reverse remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Reverse: string = "reverse"' + content: 'static Reverse: string' return: description: '' type: string @@ -1497,10 +1382,9 @@ properties: summary: '' fullName: Round remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Round: string = "round"' + content: 'static Round: string' return: description: '' type: string @@ -1510,10 +1394,9 @@ properties: summary: '' fullName: Select remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Select: string = "select"' + content: 'static Select: string' return: description: '' type: string @@ -1523,10 +1406,9 @@ properties: summary: '' fullName: SentenceCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SentenceCase: string = "sentenceCase"' + content: 'static SentenceCase: string' return: description: '' type: string @@ -1536,10 +1418,9 @@ properties: summary: '' fullName: SetPathToValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SetPathToValue: string = "setPathToValue"' + content: 'static SetPathToValue: string' return: description: '' type: string @@ -1549,10 +1430,9 @@ properties: summary: '' fullName: SetProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SetProperty: string = "setProperty"' + content: 'static SetProperty: string' return: description: '' type: string @@ -1562,10 +1442,9 @@ properties: summary: '' fullName: Skip remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Skip: string = "skip"' + content: 'static Skip: string' return: description: '' type: string @@ -1575,10 +1454,9 @@ properties: summary: '' fullName: SortBy remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SortBy: string = "sortBy"' + content: 'static SortBy: string' return: description: '' type: string @@ -1588,10 +1466,9 @@ properties: summary: '' fullName: SortByDescending remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SortByDescending: string = "sortByDescending"' + content: 'static SortByDescending: string' return: description: '' type: string @@ -1601,10 +1478,9 @@ properties: summary: '' fullName: Split remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Split: string = "split"' + content: 'static Split: string' return: description: '' type: string @@ -1614,10 +1490,9 @@ properties: summary: '' fullName: Sqrt remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Sqrt: string = "sqrt"' + content: 'static Sqrt: string' return: description: '' type: string @@ -1627,10 +1502,9 @@ properties: summary: '' fullName: StartOfDay remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static StartOfDay: string = "startOfDay"' + content: 'static StartOfDay: string' return: description: '' type: string @@ -1640,10 +1514,9 @@ properties: summary: '' fullName: StartOfHour remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static StartOfHour: string = "startOfHour"' + content: 'static StartOfHour: string' return: description: '' type: string @@ -1653,10 +1526,9 @@ properties: summary: '' fullName: StartOfMonth remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static StartOfMonth: string = "startOfMonth"' + content: 'static StartOfMonth: string' return: description: '' type: string @@ -1666,10 +1538,9 @@ properties: summary: '' fullName: StartsWith remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static StartsWith: string = "startsWith"' + content: 'static StartsWith: string' return: description: '' type: string @@ -1679,10 +1550,9 @@ properties: summary: '' fullName: String remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static String: string = "string"' + content: 'static String: string' return: description: '' type: string @@ -1692,10 +1562,9 @@ properties: summary: '' fullName: StringOrValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static StringOrValue: string = "stringOrValue"' + content: 'static StringOrValue: string' return: description: '' type: string @@ -1705,10 +1574,9 @@ properties: summary: '' fullName: SubArray remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SubArray: string = "subArray"' + content: 'static SubArray: string' return: description: '' type: string @@ -1718,10 +1586,9 @@ properties: summary: '' fullName: Substring remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Substring: string = "substring"' + content: 'static Substring: string' return: description: '' type: string @@ -1731,10 +1598,9 @@ properties: summary: '' fullName: Subtract remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Subtract: string = "-"' + content: 'static Subtract: string' return: description: '' type: string @@ -1744,10 +1610,9 @@ properties: summary: '' fullName: SubtractFromTime remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static SubtractFromTime: string = "subtractFromTime"' + content: 'static SubtractFromTime: string' return: description: '' type: string @@ -1757,10 +1622,9 @@ properties: summary: '' fullName: Sum remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Sum: string = "sum"' + content: 'static Sum: string' return: description: '' type: string @@ -1770,10 +1634,9 @@ properties: summary: '' fullName: Take remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Take: string = "take"' + content: 'static Take: string' return: description: '' type: string @@ -1783,10 +1646,9 @@ properties: summary: '' fullName: Ticks remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Ticks: string = "ticks"' + content: 'static Ticks: string' return: description: '' type: string @@ -1796,10 +1658,9 @@ properties: summary: '' fullName: TicksToDays remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static TicksToDays: string = "ticksToDays"' + content: 'static TicksToDays: string' return: description: '' type: string @@ -1809,10 +1670,9 @@ properties: summary: '' fullName: TicksToHours remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static TicksToHours: string = "ticksToHours"' + content: 'static TicksToHours: string' return: description: '' type: string @@ -1822,10 +1682,9 @@ properties: summary: '' fullName: TicksToMinutes remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static TicksToMinutes: string = "ticksToMinutes"' + content: 'static TicksToMinutes: string' return: description: '' type: string @@ -1835,10 +1694,9 @@ properties: summary: '' fullName: TimexResolve remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static TimexResolve: string = "resolve"' + content: 'static TimexResolve: string' return: description: '' type: string @@ -1848,10 +1706,9 @@ properties: summary: '' fullName: TitleCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static TitleCase: string = "titleCase"' + content: 'static TitleCase: string' return: description: '' type: string @@ -1861,10 +1718,9 @@ properties: summary: '' fullName: ToLower remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static ToLower: string = "toLower"' + content: 'static ToLower: string' return: description: '' type: string @@ -1874,10 +1730,9 @@ properties: summary: '' fullName: ToUpper remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static ToUpper: string = "toUpper"' + content: 'static ToUpper: string' return: description: '' type: string @@ -1887,10 +1742,9 @@ properties: summary: '' fullName: Trim remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Trim: string = "trim"' + content: 'static Trim: string' return: description: '' type: string @@ -1900,10 +1754,9 @@ properties: summary: '' fullName: Union remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Union: string = "union"' + content: 'static Union: string' return: description: '' type: string @@ -1913,10 +1766,9 @@ properties: summary: '' fullName: Unique remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Unique: string = "unique"' + content: 'static Unique: string' return: description: '' type: string @@ -1926,10 +1778,9 @@ properties: summary: '' fullName: UriComponent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriComponent: string = "uriComponent"' + content: 'static UriComponent: string' return: description: '' type: string @@ -1939,10 +1790,9 @@ properties: summary: '' fullName: UriComponentToString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriComponentToString: string = "uriComponentToString"' + content: 'static UriComponentToString: string' return: description: '' type: string @@ -1952,10 +1802,9 @@ properties: summary: '' fullName: UriHost remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriHost: string = "uriHost"' + content: 'static UriHost: string' return: description: '' type: string @@ -1965,10 +1814,9 @@ properties: summary: '' fullName: UriPath remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriPath: string = "uriPath"' + content: 'static UriPath: string' return: description: '' type: string @@ -1978,10 +1826,9 @@ properties: summary: '' fullName: UriPathAndQuery remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriPathAndQuery: string = "uriPathAndQuery"' + content: 'static UriPathAndQuery: string' return: description: '' type: string @@ -1991,10 +1838,9 @@ properties: summary: '' fullName: UriPort remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriPort: string = "uriPort"' + content: 'static UriPort: string' return: description: '' type: string @@ -2004,10 +1850,9 @@ properties: summary: '' fullName: UriQuery remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriQuery: string = "uriQuery"' + content: 'static UriQuery: string' return: description: '' type: string @@ -2017,10 +1862,9 @@ properties: summary: '' fullName: UriScheme remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UriScheme: string = "uriScheme"' + content: 'static UriScheme: string' return: description: '' type: string @@ -2030,10 +1874,9 @@ properties: summary: '' fullName: UtcNow remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static UtcNow: string = "utcNow"' + content: 'static UtcNow: string' return: description: '' type: string @@ -2043,10 +1886,9 @@ properties: summary: '' fullName: Where remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Where: string = "where"' + content: 'static Where: string' return: description: '' type: string @@ -2056,10 +1898,9 @@ properties: summary: '' fullName: XML remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static XML: string = "xml"' + content: 'static XML: string' return: description: '' type: string @@ -2069,10 +1910,9 @@ properties: summary: '' fullName: XPath remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static XPath: string = "xPath"' + content: 'static XPath: string' return: description: '' type: string @@ -2082,10 +1922,9 @@ properties: summary: '' fullName: Year remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Year: string = "year"' + content: 'static Year: string' return: description: '' type: string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Extensions.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Extensions.yml index d518e170..f1c32f70 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Extensions.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Extensions.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Some util and extension functions fullName: Extensions remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -20,7 +19,6 @@ methods: To judge if an object is implements MemoryInterface. Same with 'is MemoryInterface' in C# remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isMemoryInterface(obj: any): boolean' @@ -31,7 +29,7 @@ methods: return: description: True if the object implements MemoryInterface; False if it isn't. type: boolean - - name: 'randomNext(MemoryInterface, number, number)' + - name: randomNext(MemoryInterface, number, number) uid: adaptive-expressions.Extensions.randomNext package: adaptive-expressions summary: >- @@ -40,7 +38,6 @@ methods: If value is not null, the mock random value result would be: min + (value % (max - min)). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FileContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FileContext.yml index 964822e5..d8c726b9 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FileContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FileContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: FileContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'FileContext(ParserRuleContext | undefined, number)' + - name: FileContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.FileContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new FileContext(parent: ParserRuleContext | undefined, invokingState: + new FileContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.FileContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.FileContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.FileContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.FileContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.FileContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.FileContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.FileContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: FileContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.FileContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.FileContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.FileContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.FileContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.FileContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.FileContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.FileContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.FileContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.FileContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.FileContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.FileContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.FileContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.FileContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.FileContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.FileContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.FileContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.FileContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.FileContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.FileContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.FileContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.FileContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.FileContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,7 +797,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +809,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function EOF(): TerminalNode' @@ -865,7 +820,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -878,7 +832,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/First.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/First.yml deleted file mode 100644 index fc60f6a9..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/First.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: First -uid: adaptive-expressions.First -package: adaptive-expressions -summary: Return the first item from a string or array. -fullName: First -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: First() - uid: adaptive-expressions.First.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [First](xref:adaptive-expressions.First) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new First() -properties: - - name: negation - uid: adaptive-expressions.First.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.First.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.First.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.First.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.First.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Flatten.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Flatten.yml deleted file mode 100644 index f8323cb7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Flatten.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Flatten -uid: adaptive-expressions.Flatten -package: adaptive-expressions -summary: >- - Flatten an array into non-array values. You can optionally set the maximum - depth to flatten to. -fullName: Flatten -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Flatten() - uid: adaptive-expressions.Flatten.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Flatten](xref:adaptive-expressions.Flatten) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Flatten() -properties: - - name: negation - uid: adaptive-expressions.Flatten.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Flatten.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Flatten.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Flatten.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Flatten.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Float.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Float.yml deleted file mode 100644 index ca47a24f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Float.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Float -uid: adaptive-expressions.Float -package: adaptive-expressions -summary: >- - Convert the string version of a floating-point number to a floating-point - number. -fullName: Float -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Float() - uid: adaptive-expressions.Float.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Float](xref:adaptive-expressions.Float) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Float() -properties: - - name: negation - uid: adaptive-expressions.Float.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Float.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Float.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Float.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Float.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Floor.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Floor.yml deleted file mode 100644 index 2bf91e83..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Floor.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Floor -uid: adaptive-expressions.Floor -package: adaptive-expressions -summary: Returns the largest integer less than or equal to the specified number. -fullName: Floor -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Floor() - uid: adaptive-expressions.Floor.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Floor](xref:adaptive-expressions.Floor) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Floor() -properties: - - name: negation - uid: adaptive-expressions.Floor.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Floor.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Floor.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Floor.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Floor.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Foreach.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Foreach.yml deleted file mode 100644 index 425052cd..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Foreach.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Foreach -uid: adaptive-expressions.Foreach -package: adaptive-expressions -summary: Operate on each element and return the new collection. -fullName: Foreach -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Foreach() - uid: adaptive-expressions.Foreach.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Foreach](xref:adaptive-expressions.Foreach) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Foreach() -properties: - - name: negation - uid: adaptive-expressions.Foreach.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Foreach.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Foreach.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Foreach.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Foreach.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatDateTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatDateTime.yml deleted file mode 100644 index fd348840..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatDateTime.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: FormatDateTime -uid: adaptive-expressions.FormatDateTime -package: adaptive-expressions -summary: >- - Return a timestamp in the specified format. - - Format reference: - https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings -fullName: FormatDateTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: FormatDateTime() - uid: adaptive-expressions.FormatDateTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [FormatDateTime](xref:adaptive-expressions.FormatDateTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new FormatDateTime() -properties: - - name: negation - uid: adaptive-expressions.FormatDateTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.FormatDateTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.FormatDateTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.FormatDateTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.FormatDateTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatEpoch.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatEpoch.yml deleted file mode 100644 index 82efe410..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatEpoch.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: FormatEpoch -uid: adaptive-expressions.FormatEpoch -package: adaptive-expressions -summary: >- - Return a timestamp in the specified format from UNIX time (also know as Epoch - time, POSIX time, UNIX Epoch time). -fullName: FormatEpoch -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: FormatEpoch() - uid: adaptive-expressions.FormatEpoch.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [FormatEpoch](xref:adaptive-expressions.FormatEpoch) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new FormatEpoch() -properties: - - name: negation - uid: adaptive-expressions.FormatEpoch.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.FormatEpoch.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.FormatEpoch.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.FormatEpoch.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.FormatEpoch.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatNumber.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatNumber.yml deleted file mode 100644 index 6096317b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatNumber.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: FormatNumber -uid: adaptive-expressions.FormatNumber -package: adaptive-expressions -summary: Format number into required decimal numbers. -fullName: FormatNumber -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: FormatNumber() - uid: adaptive-expressions.FormatNumber.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [FormatNumber](xref:adaptive-expressions.FormatNumber) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new FormatNumber() -properties: - - name: negation - uid: adaptive-expressions.FormatNumber.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.FormatNumber.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.FormatNumber.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.FormatNumber.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.FormatNumber.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatTicks.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatTicks.yml deleted file mode 100644 index 6d1fc78b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FormatTicks.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: FormatTicks -uid: adaptive-expressions.FormatTicks -package: adaptive-expressions -summary: Return a timestamp in the specified format from ticks. -fullName: FormatTicks -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: FormatTicks() - uid: adaptive-expressions.FormatTicks.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [FormatTicks](xref:adaptive-expressions.FormatTicks) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new FormatTicks() -properties: - - name: negation - uid: adaptive-expressions.FormatTicks.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.FormatTicks.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.FormatTicks.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.FormatTicks.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.FormatTicks.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FuncInvokeExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FuncInvokeExpContext.yml index c20fc567..0f7baeec 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FuncInvokeExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FuncInvokeExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: FuncInvokeExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new FuncInvokeExpContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.FuncInvokeExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.FuncInvokeExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.FuncInvokeExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.FuncInvokeExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.FuncInvokeExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.FuncInvokeExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.FuncInvokeExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.FuncInvokeExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.FuncInvokeExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.FuncInvokeExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: FuncInvokeExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.FuncInvokeExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.FuncInvokeExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.FuncInvokeExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.FuncInvokeExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.FuncInvokeExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.FuncInvokeExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.FuncInvokeExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.FuncInvokeExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.FuncInvokeExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.FuncInvokeExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.FuncInvokeExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.FuncInvokeExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.FuncInvokeExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.FuncInvokeExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.FuncInvokeExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.FuncInvokeExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.FuncInvokeExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.FuncInvokeExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.FuncInvokeExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.FuncInvokeExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.FuncInvokeExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.FuncInvokeExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.FuncInvokeExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.FuncInvokeExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.FuncInvokeExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.FuncInvokeExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.FuncInvokeExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.FuncInvokeExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.FuncInvokeExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.FuncInvokeExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.FuncInvokeExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.FuncInvokeExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.FuncInvokeExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.FuncInvokeExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.FuncInvokeExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,19 +869,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function argsList(): ArgsListContext | undefined' + content: 'function argsList(): undefined | ArgsListContext' return: description: '' - type: | undefined + type: undefined | - name: CLOSE_BRACKET() uid: adaptive-expressions.FuncInvokeExpContext.CLOSE_BRACKET package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CLOSE_BRACKET(): TerminalNode' @@ -851,7 +891,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -864,7 +903,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -877,19 +915,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NON(): TerminalNode | undefined' + content: 'function NON(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: OPEN_BRACKET() uid: adaptive-expressions.FuncInvokeExpContext.OPEN_BRACKET package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OPEN_BRACKET(): TerminalNode' @@ -901,7 +937,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function primaryExpression(): PrimaryExpressionContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionTable.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionTable.yml index 5bbd7718..efb7e886 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionTable.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionTable.yml @@ -7,7 +7,6 @@ summary: >- CustomDictionary. fullName: FunctionTable remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -19,10 +18,9 @@ properties: [FunctionTable](xref:adaptive-expressions.FunctionTable) is readonly. fullName: isReadOnly remarks: '' - isPreview: false isDeprecated: false syntax: - content: boolean isReadOnly + content: 'isReadOnly: boolean' return: description: >- A boolean value indicating whether the @@ -38,23 +36,46 @@ properties: [customFunctions](xref:adaptive-expressions.FunctionTable.customFunctions). fullName: size remarks: '' - isPreview: false isDeprecated: false syntax: - content: number size + content: 'size: number' return: description: An integer value. type: number + - name: '[iterator]' + uid: adaptive-expressions.FunctionTable.[iterator] + package: adaptive-expressions + summary: |- + Returns an iterable of key, value pairs. + Not implemented. + fullName: '[iterator]' + remarks: '' + isDeprecated: false + syntax: + content: '[iterator]: () => IterableIterator<[string, ExpressionEvaluator]>' + return: + description: '' + type: () => IterableIterator<[string, ExpressionEvaluator]> + - name: '[toStringTag]' + uid: adaptive-expressions.FunctionTable.[toStringTag] + package: adaptive-expressions + summary: |- + Returns a string value. + Not implemented. + fullName: '[toStringTag]' + remarks: '' + isDeprecated: false + syntax: + content: '[toStringTag]: string' + return: + description: '' + type: string methods: - - name: 'add(string, customFunction)' + - name: add(string, customFunction) uid: adaptive-expressions.FunctionTable.add_2 package: adaptive-expressions - summary: >- - Inserts a mapping of a string key to - [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) into - [FunctionTable](xref:adaptive-expressions.FunctionTable). + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function add(key: string, value: customFunction)' @@ -65,15 +86,11 @@ methods: - id: value type: customFunction description: '' - - name: 'add(string, ExpressionEvaluator)' + - name: add(string, ExpressionEvaluator) uid: adaptive-expressions.FunctionTable.add_1 package: adaptive-expressions - summary: >- - Inserts a mapping of a string key to - [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) into - [FunctionTable](xref:adaptive-expressions.FunctionTable). + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function add(key: string, value: ExpressionEvaluator)' @@ -87,12 +104,8 @@ methods: - name: 'add({ key: string, value: ExpressionEvaluator })' uid: adaptive-expressions.FunctionTable.add package: adaptive-expressions - summary: >- - Inserts a mapping of a string key to - [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) into - [FunctionTable](xref:adaptive-expressions.FunctionTable). + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function add(item: { key: string, value: ExpressionEvaluator })' @@ -107,7 +120,6 @@ methods: Clears the user [customFunctions](xref:adaptive-expressions.FunctionTable.customFunctions). remarks: '' - isPreview: false isDeprecated: false syntax: content: function clear() @@ -118,7 +130,6 @@ methods: Deletes a specified key from user [customFunctions](xref:adaptive-expressions.FunctionTable.customFunctions). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(key: string): boolean' @@ -136,13 +147,12 @@ methods: Returns an iterable of key, value pairs for every entry in the map. Not implemented. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function entries(): IterableIterator<[string, ExpressionEvaluator]>' return: description: '' - type: 'IterableIterator<[string, ExpressionEvaluator]>' + type: IterableIterator<[string, ExpressionEvaluator]> - name: >- forEach((value: ExpressionEvaluator, key: string, map: Map) => void, any) @@ -154,7 +164,6 @@ methods: Not implemented. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,8 +177,7 @@ methods: description: Callback function. - id: _thisArg type: any - description: | - Optional. This args. + description: Optional. This args. - name: get(string) uid: adaptive-expressions.FunctionTable.get package: adaptive-expressions @@ -178,7 +186,6 @@ methods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) corresponding to the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(key: string): ExpressionEvaluator' @@ -198,7 +205,6 @@ methods: Determines if the [FunctionTable](xref:adaptive-expressions.FunctionTable) has a given string key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function has(key: string): boolean' @@ -216,14 +222,13 @@ methods: Gets a collection of string values that represent the keys of the [ExpressionFunctions.standardFunctions](xref:adaptive-expressions.ExpressionFunctions.standardFunctions). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keys(): IterableIterator' return: description: A list of string values. type: IterableIterator<string> - - name: 'set(string, ExpressionEvaluator)' + - name: set(string, ExpressionEvaluator) uid: adaptive-expressions.FunctionTable.set package: adaptive-expressions summary: >- @@ -231,10 +236,9 @@ methods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) corresponding to the given key. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function set(key: string, value: ExpressionEvaluator): this' + content: 'function set(key: string, value: ExpressionEvaluator): FunctionTable' parameters: - id: key type: string @@ -248,7 +252,7 @@ methods: description: >- The value of the [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator). - type: this + type: - name: values() uid: adaptive-expressions.FunctionTable.values package: adaptive-expressions @@ -257,7 +261,6 @@ methods: [ExpressionEvaluator](xref:adaptive-expressions.ExpressionEvaluator) which is the value of the StandardFunctions. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function values(): IterableIterator' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionUtils.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionUtils.yml index f26a4c41..64cc2a43 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionUtils.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/FunctionUtils.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Utility functions in AdaptiveExpression. fullName: FunctionUtils remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,10 +14,9 @@ properties: summary: The default date time format string. fullName: DefaultDateTimeFormat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DefaultDateTimeFormat: string = "YYYY-MM-DDTHH:mm:ss.SSS[Z]"' + content: 'static DefaultDateTimeFormat: string' return: description: '' type: string @@ -30,7 +28,6 @@ methods: Generate an expression delegate that applies function after verifying all children. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -53,7 +50,6 @@ methods: Generate an expression delegate that applies function on the accumulated value after verifying all children. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -76,7 +72,6 @@ methods: Generate an expression delegate that applies function on the accumulated value after verifying all children. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -99,7 +94,6 @@ methods: Generate an expression delegate that applies function after verifying all children. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -124,7 +118,6 @@ methods: Generate an expression delegate that applies function after verifying all children. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -150,7 +143,6 @@ methods: Generate an expression delegate that applies function after verifying all children. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -169,14 +161,13 @@ methods: return: description: Delegate for evaluating an expression. type: - - name: 'commonEquals(unknown, unknown)' + - name: commonEquals(unknown, unknown) uid: adaptive-expressions.FunctionUtils.commonEquals package: adaptive-expressions summary: |- Equal helper function. Compare the first param and second param. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function commonEquals(obj1: unknown, obj2: unknown): boolean' @@ -190,21 +181,20 @@ methods: return: description: A boolean based on the comparison. type: boolean - - name: 'determineFormatAndLocale(unknown[], number, string, string)' + - name: determineFormatAndLocale(unknown[], number, string, string) uid: adaptive-expressions.FunctionUtils.determineFormatAndLocale package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function determineFormatAndLocale(args: unknown[], maxArgsLength: - number, format: string, locale: string): { format: string, locale: + number, format: string, locale?: string): { format: string, locale: string } parameters: - id: args - type: 'unknown[]' + type: unknown[] description: An array of arguments. - id: maxArgsLength type: number @@ -220,20 +210,19 @@ methods: The format and the locale from the args param, otherwise the locale and format strings. type: '{ format: string, locale: string }' - - name: 'determineLocale(unknown[], number, string)' + - name: determineLocale(unknown[], number, string) uid: adaptive-expressions.FunctionUtils.determineLocale package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function determineLocale(args: unknown[], maxArgsLength: number, - locale: string): string + locale?: string): string parameters: - id: args - type: 'unknown[]' + type: unknown[] description: An array of arguments. - id: maxArgsLength type: number @@ -242,14 +231,13 @@ methods: type: string description: A locale string return: - description: 'The last item from the args param, otherwise the locale string.' + description: The last item from the args param, otherwise the locale string. type: string - - name: 'evaluateChildren(Expression, MemoryInterface, Options, VerifyExpression)' + - name: evaluateChildren(Expression, MemoryInterface, Options, VerifyExpression) uid: adaptive-expressions.FunctionUtils.evaluateChildren package: adaptive-expressions summary: Evaluate expression children and return them. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -277,23 +265,21 @@ methods: package: adaptive-expressions summary: Is number helper function. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function isNumber(instance: any): boolean' + content: 'static function isNumber(instance: any): instance' parameters: - id: instance type: any description: Input. return: description: True if the input is a number. - type: boolean + type: instance - name: timestampFormatter(string) uid: adaptive-expressions.FunctionUtils.timestampFormatter package: adaptive-expressions - summary: 'Timestamp formatter, convert C# datetime to day.js format.' + summary: Timestamp formatter, convert C# datetime to day.js format. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function timestampFormatter(formatter: string): string' @@ -304,12 +290,11 @@ methods: return: description: The formated datetime. type: string - - name: 'tryAccumulatePath(Expression, MemoryInterface, Options)' + - name: tryAccumulatePath(Expression, MemoryInterface, Options) uid: adaptive-expressions.FunctionUtils.tryAccumulatePath package: adaptive-expressions summary: State object for resolving memory paths. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -331,19 +316,18 @@ methods: Return the accumulated path and the expression left unable to accumulate. type: '{ error: string, left: any, path: string }' - - name: 'validateArityAndAnyType(Expression, number, number, ReturnType)' + - name: validateArityAndAnyType(Expression, number, number, ReturnType) uid: adaptive-expressions.FunctionUtils.validateArityAndAnyType package: adaptive-expressions summary: >- Validate that expression has a certain number of children that are of any of the supported types. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function validateArityAndAnyType(expression: Expression, - minArity: number, maxArity: number, returnType: ReturnType) + minArity: number, maxArity: number, returnType?: ReturnType) parameters: - id: expression type: @@ -356,7 +340,7 @@ methods: description: Maximum number of children. - id: returnType type: - description: > + description: >- Allowed return types for children. If a child has a return type of Object then validation will happen @@ -366,77 +350,66 @@ methods: package: adaptive-expressions summary: Validate at least 1 argument of any type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateAtLeastOne(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateBinary(Expression) uid: adaptive-expressions.FunctionUtils.validateBinary package: adaptive-expressions summary: Validate there are two children. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateBinary(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateBinaryNumber(Expression) uid: adaptive-expressions.FunctionUtils.validateBinaryNumber package: adaptive-expressions summary: Validate 2 numeric arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateBinaryNumber(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateBinaryNumberOrString(Expression) uid: adaptive-expressions.FunctionUtils.validateBinaryNumberOrString package: adaptive-expressions summary: Validate there are 2 numeric or string arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateBinaryNumberOrString(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateNumber(Expression) uid: adaptive-expressions.FunctionUtils.validateNumber package: adaptive-expressions summary: Validate 1 or more numeric arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateNumber(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. - - name: 'validateOrder(Expression, ReturnType[], ReturnType[])' + description: Expression to validate. + - name: validateOrder(Expression, ReturnType[], ReturnType[]) uid: adaptive-expressions.FunctionUtils.validateOrder package: adaptive-expressions summary: Validate the number and type of arguments to a function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -447,135 +420,117 @@ methods: type: description: Expression to validate. - id: optional - type: '[]' + type: [] description: Optional types in order. - id: types - type: '[]' - description: | - Expected types in order. + type: [] + description: Expected types in order. - name: validateString(Expression) uid: adaptive-expressions.FunctionUtils.validateString package: adaptive-expressions summary: Validate 1 or more string arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateString(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateTwoOrMoreThanTwoNumbers(Expression) uid: adaptive-expressions.FunctionUtils.validateTwoOrMoreThanTwoNumbers package: adaptive-expressions summary: Validate 2 or more than 2 numeric arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateTwoOrMoreThanTwoNumbers(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateUnary(Expression) uid: adaptive-expressions.FunctionUtils.validateUnary package: adaptive-expressions summary: Validate there is a single argument. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateUnary(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateUnaryBoolean(Expression) uid: adaptive-expressions.FunctionUtils.validateUnaryBoolean package: adaptive-expressions summary: Validate there is a single boolean argument. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateUnaryBoolean(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateUnaryNumber(Expression) uid: adaptive-expressions.FunctionUtils.validateUnaryNumber package: adaptive-expressions summary: Validate there is a single argument. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateUnaryNumber(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateUnaryOrBinaryNumber(Expression) uid: adaptive-expressions.FunctionUtils.validateUnaryOrBinaryNumber package: adaptive-expressions summary: Validate 1 or 2 numeric arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateUnaryOrBinaryNumber(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateUnaryOrBinaryString(Expression) uid: adaptive-expressions.FunctionUtils.validateUnaryOrBinaryString package: adaptive-expressions summary: Validate there is one or two string arguments. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateUnaryOrBinaryString(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. + description: Expression to validate. - name: validateUnaryString(Expression) uid: adaptive-expressions.FunctionUtils.validateUnaryString package: adaptive-expressions summary: Validate there is a single string argument. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function validateUnaryString(expression: Expression)' parameters: - id: expression type: - description: | - Expression to validate. - - name: 'verifyBoolean(any, Expression, number)' + description: Expression to validate. + - name: verifyBoolean(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyBoolean package: adaptive-expressions summary: Verify value is boolean. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyBoolean(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -588,18 +543,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyContainer(any, Expression, number)' + type: undefined | string + - name: verifyContainer(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyContainer package: adaptive-expressions summary: Verify value contains elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyContainer(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -612,18 +566,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyContainerOrNull(unknown, Expression, number)' + type: undefined | string + - name: verifyContainerOrNull(unknown, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyContainerOrNull package: adaptive-expressions summary: Verify value contains elements or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyContainerOrNull(value: unknown, expression: - Expression, _: number): string | undefined + Expression, _: number): undefined | string parameters: - id: value type: unknown @@ -636,18 +589,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyInteger(any, Expression, number)' + type: undefined | string + - name: verifyInteger(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyInteger package: adaptive-expressions summary: Verify value is an integer. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyInteger(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -660,18 +612,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyList(any, Expression)' + type: undefined | string + - name: verifyList(any, Expression) uid: adaptive-expressions.FunctionUtils.verifyList package: adaptive-expressions summary: Verify value is an list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function verifyList(value: any, expression: Expression): string | - undefined + static function verifyList(value: any, expression: Expression): + undefined | string parameters: - id: value type: any @@ -681,18 +632,17 @@ methods: description: Expression that led to value. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyNotNull(any, Expression, number)' + type: undefined | string + - name: verifyNotNull(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyNotNull package: adaptive-expressions summary: Verify value is not null or undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyNotNull(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -705,18 +655,17 @@ methods: description: No function. return: description: Error or undefined if valid. - type: string | undefined - - name: 'verifyNumber(any, Expression, number)' + type: undefined | string + - name: verifyNumber(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyNumber package: adaptive-expressions summary: Verify value is numeric. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyNumber(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -729,18 +678,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyNumberOrNumericList(any, Expression, number)' + type: undefined | string + - name: verifyNumberOrNumericList(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyNumberOrNumericList package: adaptive-expressions summary: Verify value is numeric. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyNumberOrNumericList(value: any, expression: - Expression, _: number): string | undefined + Expression, _: number): undefined | string parameters: - id: value type: any @@ -753,18 +701,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyNumberOrString(any, Expression, number)' + type: undefined | string + - name: verifyNumberOrString(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyNumberOrString package: adaptive-expressions summary: Verify value is a number or string. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyNumberOrString(value: any, expression: Expression, - _: number): string | undefined + _: number): undefined | string parameters: - id: value type: any @@ -777,18 +724,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyNumberOrStringOrNull(any, Expression, number)' + type: undefined | string + - name: verifyNumberOrStringOrNull(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyNumberOrStringOrNull package: adaptive-expressions summary: Verify value is a number or string or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyNumberOrStringOrNull(value: any, expression: - Expression, _: number): string | undefined + Expression, _: number): undefined | string parameters: - id: value type: any @@ -801,18 +747,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyNumericList(any, Expression, number)' + type: undefined | string + - name: verifyNumericList(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyNumericList package: adaptive-expressions summary: Verify value is numeric list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyNumericList(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -825,18 +770,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyString(any, Expression, number)' + type: undefined | string + - name: verifyString(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyString package: adaptive-expressions summary: Verify value is a string. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyString(value: any, expression: Expression, _: - number): string | undefined + number): undefined | string parameters: - id: value type: any @@ -849,18 +793,17 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined - - name: 'verifyStringOrNull(any, Expression, number)' + type: undefined | string + - name: verifyStringOrNull(any, Expression, number) uid: adaptive-expressions.FunctionUtils.verifyStringOrNull package: adaptive-expressions summary: Verify an object is neither a string nor null. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function verifyStringOrNull(value: any, expression: Expression, - _: number): string | undefined + _: number): undefined | string parameters: - id: value type: any @@ -873,4 +816,4 @@ methods: description: No function. return: description: Error or undefined if invalid. - type: string | undefined + type: undefined | string diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetFutureTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetFutureTime.yml deleted file mode 100644 index a25da32b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetFutureTime.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: GetFutureTime -uid: adaptive-expressions.GetFutureTime -package: adaptive-expressions -summary: Return the current timestamp plus the specified time units. -fullName: GetFutureTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetFutureTime() - uid: adaptive-expressions.GetFutureTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetFutureTime](xref:adaptive-expressions.GetFutureTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetFutureTime() -properties: - - name: negation - uid: adaptive-expressions.GetFutureTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetFutureTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetFutureTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetFutureTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetFutureTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableDate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableDate.yml deleted file mode 100644 index 0e1948bd..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableDate.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: GetNextViableDate -uid: adaptive-expressions.GetNextViableDate -package: adaptive-expressions -summary: >- - Return the next viable date of a timex expression based on the current date - and user's timezone. -fullName: GetNextViableDate -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetNextViableDate() - uid: adaptive-expressions.GetNextViableDate.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetNextViableDate](xref:adaptive-expressions.GetNextViableDate) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetNextViableDate() -properties: - - name: negation - uid: adaptive-expressions.GetNextViableDate.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetNextViableDate.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetNextViableDate.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetNextViableDate.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetNextViableDate.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableTime.yml deleted file mode 100644 index 5cf25254..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetNextViableTime.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: GetNextViableTime -uid: adaptive-expressions.GetNextViableTime -package: adaptive-expressions -summary: >- - Return the next viable time of a timex expression based on the current time - and user's timezone. -fullName: GetNextViableTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetNextViableTime() - uid: adaptive-expressions.GetNextViableTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetNextViableTime](xref:adaptive-expressions.GetNextViableTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetNextViableTime() -properties: - - name: negation - uid: adaptive-expressions.GetNextViableTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetNextViableTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetNextViableTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetNextViableTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetNextViableTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPastTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPastTime.yml deleted file mode 100644 index 1fd21651..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPastTime.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: GetPastTime -uid: adaptive-expressions.GetPastTime -package: adaptive-expressions -summary: Return the current timestamp minus the specified time units. -fullName: GetPastTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetPastTime() - uid: adaptive-expressions.GetPastTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetPastTime](xref:adaptive-expressions.GetPastTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetPastTime() -properties: - - name: negation - uid: adaptive-expressions.GetPastTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetPastTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetPastTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetPastTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetPastTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableDate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableDate.yml deleted file mode 100644 index 21872ddd..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableDate.yml +++ /dev/null @@ -1,119 +0,0 @@ -### YamlMime:TSType -name: GetPreviousViableDate -uid: adaptive-expressions.GetPreviousViableDate -package: adaptive-expressions -summary: >- - Return the previous viable date of a timex expression based on the current - date and user's timezone. -fullName: GetPreviousViableDate -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetPreviousViableDate() - uid: adaptive-expressions.GetPreviousViableDate.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetPreviousViableDate](xref:adaptive-expressions.GetPreviousViableDate) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetPreviousViableDate() -properties: - - name: negation - uid: adaptive-expressions.GetPreviousViableDate.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetPreviousViableDate.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetPreviousViableDate.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetPreviousViableDate.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetPreviousViableDate.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableTime.yml deleted file mode 100644 index 2028f4b2..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetPreviousViableTime.yml +++ /dev/null @@ -1,119 +0,0 @@ -### YamlMime:TSType -name: GetPreviousViableTime -uid: adaptive-expressions.GetPreviousViableTime -package: adaptive-expressions -summary: >- - Return the previous viable time of a timex expression based on the current - time and user's timezone. -fullName: GetPreviousViableTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetPreviousViableTime() - uid: adaptive-expressions.GetPreviousViableTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetPreviousViableTime](xref:adaptive-expressions.GetPreviousViableTime) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetPreviousViableTime() -properties: - - name: negation - uid: adaptive-expressions.GetPreviousViableTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetPreviousViableTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetPreviousViableTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetPreviousViableTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetPreviousViableTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetProperty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetProperty.yml deleted file mode 100644 index 481322ff..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetProperty.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: GetProperty -uid: adaptive-expressions.GetProperty -package: adaptive-expressions -summary: Retrieve the value of the specified property from the JSON object. -fullName: GetProperty -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetProperty() - uid: adaptive-expressions.GetProperty.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetProperty](xref:adaptive-expressions.GetProperty) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetProperty() -properties: - - name: negation - uid: adaptive-expressions.GetProperty.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetProperty.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetProperty.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetProperty.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetProperty.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetTimeOfDay.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetTimeOfDay.yml deleted file mode 100644 index 4d3e780c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GetTimeOfDay.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: GetTimeOfDay -uid: adaptive-expressions.GetTimeOfDay -package: adaptive-expressions -summary: Returns time of day for a given timestamp. -fullName: GetTimeOfDay -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GetTimeOfDay() - uid: adaptive-expressions.GetTimeOfDay.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GetTimeOfDay](xref:adaptive-expressions.GetTimeOfDay) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetTimeOfDay() -properties: - - name: negation - uid: adaptive-expressions.GetTimeOfDay.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GetTimeOfDay.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GetTimeOfDay.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GetTimeOfDay.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GetTimeOfDay.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThan.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThan.yml deleted file mode 100644 index 2da03ac1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThan.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: GreaterThan -uid: adaptive-expressions.GreaterThan -package: adaptive-expressions -summary: |- - Check whether the first value is greater than the second value. - Return true if the first value is more, or return false if less. -fullName: GreaterThan -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GreaterThan() - uid: adaptive-expressions.GreaterThan.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GreaterThan](xref:adaptive-expressions.GreaterThan) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GreaterThan() -properties: - - name: negation - uid: adaptive-expressions.GreaterThan.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GreaterThan.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GreaterThan.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GreaterThan.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GreaterThan.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThanOrEqual.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThanOrEqual.yml deleted file mode 100644 index 6250cb6b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/GreaterThanOrEqual.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: GreaterThanOrEqual -uid: adaptive-expressions.GreaterThanOrEqual -package: adaptive-expressions -summary: >- - Check whether the first value is greater than or equal to the second value. - Return true when the first value is greater or equal, - - or return false if the first value is less. -fullName: GreaterThanOrEqual -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GreaterThanOrEqual() - uid: adaptive-expressions.GreaterThanOrEqual.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [GreaterThanOrEqual](xref:adaptive-expressions.GreaterThanOrEqual) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GreaterThanOrEqual() -properties: - - name: negation - uid: adaptive-expressions.GreaterThanOrEqual.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.GreaterThanOrEqual.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.GreaterThanOrEqual.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.GreaterThanOrEqual.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.GreaterThanOrEqual.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IdAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IdAtomContext.yml index 9963a752..9bcb1039 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IdAtomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IdAtomContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: IdAtomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new IdAtomContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.IdAtomContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.IdAtomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.IdAtomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.IdAtomContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.IdAtomContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.IdAtomContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.IdAtomContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.IdAtomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.IdAtomContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.IdAtomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: IdAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.IdAtomContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.IdAtomContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.IdAtomContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.IdAtomContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.IdAtomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.IdAtomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.IdAtomContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.IdAtomContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.IdAtomContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.IdAtomContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.IdAtomContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.IdAtomContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.IdAtomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.IdAtomContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.IdAtomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.IdAtomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.IdAtomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.IdAtomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.IdAtomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.IdAtomContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.IdAtomContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.IdAtomContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.IdAtomContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.IdAtomContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.IdAtomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.IdAtomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.IdAtomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.IdAtomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.IdAtomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.IdAtomContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.IdAtomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.IdAtomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.IdAtomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.IdAtomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.IdAtomContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -840,7 +881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function IDENTIFIER(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/If.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/If.yml deleted file mode 100644 index 0ad01af3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/If.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: If -uid: adaptive-expressions.If -package: adaptive-expressions -summary: >- - Check whether an expression is true or false. Based on the result, return a - specified value. -fullName: If -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: If() - uid: adaptive-expressions.If.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [If](xref:adaptive-expressions.If) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new If() -properties: - - name: negation - uid: adaptive-expressions.If.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.If.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.If.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.If.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.If.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ignore.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ignore.yml deleted file mode 100644 index d5dd63f5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ignore.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: Ignore -uid: adaptive-expressions.Ignore -package: adaptive-expressions -summary: >- - Mark a clause so that MostSpecificSelector will ignore it. - - MostSpecificSelector considers A & B to be more specific than A, but some - clauses are unique and incomparable. -fullName: Ignore -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Ignore() - uid: adaptive-expressions.Ignore.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Ignore](xref:adaptive-expressions.Ignore) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Ignore() -properties: - - name: negation - uid: adaptive-expressions.Ignore.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Ignore.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Ignore.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Ignore.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Ignore.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexAccessExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexAccessExpContext.yml index 0b17ebc2..da309ab0 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexAccessExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexAccessExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: IndexAccessExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new IndexAccessExpContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.IndexAccessExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.IndexAccessExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.IndexAccessExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.IndexAccessExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.IndexAccessExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.IndexAccessExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.IndexAccessExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.IndexAccessExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.IndexAccessExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.IndexAccessExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: IndexAccessExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.IndexAccessExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.IndexAccessExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.IndexAccessExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.IndexAccessExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.IndexAccessExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.IndexAccessExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.IndexAccessExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.IndexAccessExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.IndexAccessExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.IndexAccessExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.IndexAccessExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.IndexAccessExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.IndexAccessExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.IndexAccessExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.IndexAccessExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.IndexAccessExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.IndexAccessExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.IndexAccessExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.IndexAccessExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.IndexAccessExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.IndexAccessExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.IndexAccessExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.IndexAccessExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.IndexAccessExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.IndexAccessExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.IndexAccessExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.IndexAccessExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.IndexAccessExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.IndexAccessExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.IndexAccessExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.IndexAccessExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.IndexAccessExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.IndexAccessExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.IndexAccessExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.IndexAccessExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CLOSE_SQUARE_BRACKET(): TerminalNode' @@ -839,7 +880,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -852,7 +892,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -865,7 +904,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -877,7 +915,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OPEN_SQUARE_BRACKET(): TerminalNode' @@ -889,7 +926,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function primaryExpression(): PrimaryExpressionContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexOf.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexOf.yml deleted file mode 100644 index f6065c18..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndexOf.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: IndexOf -uid: adaptive-expressions.IndexOf -package: adaptive-expressions -summary: >- - Returns the index of the first occurrence of a value in an array. - - The zero-based index position of value if that value is found, or -1 if it is - not. -fullName: IndexOf -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IndexOf() - uid: adaptive-expressions.IndexOf.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IndexOf](xref:adaptive-expressions.IndexOf) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IndexOf() -properties: - - name: negation - uid: adaptive-expressions.IndexOf.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IndexOf.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IndexOf.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IndexOf.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IndexOf.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndicesAndValues.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndicesAndValues.yml deleted file mode 100644 index ed6548a8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IndicesAndValues.yml +++ /dev/null @@ -1,122 +0,0 @@ -### YamlMime:TSType -name: IndicesAndValues -uid: adaptive-expressions.IndicesAndValues -package: adaptive-expressions -summary: >- - Turn an array or object into an array of objects with index and value - properties. - - For arrays, the index is the position in the array. - - For objects, it is the key for the value. -fullName: IndicesAndValues -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IndicesAndValues() - uid: adaptive-expressions.IndicesAndValues.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IndicesAndValues](xref:adaptive-expressions.IndicesAndValues) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IndicesAndValues() -properties: - - name: negation - uid: adaptive-expressions.IndicesAndValues.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IndicesAndValues.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IndicesAndValues.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IndicesAndValues.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IndicesAndValues.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Int.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Int.yml deleted file mode 100644 index 6e7b63e5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Int.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Int -uid: adaptive-expressions.Int -package: adaptive-expressions -summary: Return the integer version of a string. -fullName: Int -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Int() - uid: adaptive-expressions.Int.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Int](xref:adaptive-expressions.Int) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Int() -properties: - - name: negation - uid: adaptive-expressions.Int.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Int.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Int.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Int.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Int.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpression.yml index c5c25d38..9d573b7c 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpression.yml @@ -9,25 +9,23 @@ fullName: IntExpression remarks: >- String values are always interpreted as an expression, whether it has '=' prefix or not. -isPreview: false isDeprecated: false type: class constructors: - - name: IntExpression(number | string | Expression) + - name: IntExpression(string | number | Expression) uid: adaptive-expressions.IntExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [IntExpression](xref:adaptive-expressions.IntExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new IntExpression(value?: number | string | Expression)' + content: 'new IntExpression(value?: string | number | Expression)' parameters: - id: value - type: number | string | - description: > + type: string | number | + description: >- An int `number` or `string` expression which resolves to an int `number`. inheritedProperties: @@ -37,7 +35,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -53,7 +50,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: number' @@ -69,7 +65,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): number' @@ -88,7 +83,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -103,7 +97,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -114,26 +107,23 @@ inheritedMethods: Inherited From [ExpressionProperty.toString](xref:adaptive-expressions.ExpressionProperty.toString) methods: - - name: setValue(number | string | Expression) + - name: setValue(string | number | Expression) uid: adaptive-expressions.IntExpression.setValue package: adaptive-expressions summary: Set an integer value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: number | string | Expression)' + content: 'function setValue(value: string | number | Expression)' parameters: - id: value - type: number | string | - description: | - Value to set. + type: string | number | + description: Value to set. - name: tryGetValue(object) uid: adaptive-expressions.IntExpression.tryGetValue package: adaptive-expressions summary: Try to get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: number }' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpressionConverter.yml index 600542a6..2ee8e7fc 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IntExpressionConverter.yml @@ -7,7 +7,6 @@ summary: >- [IntExpression](xref:adaptive-expressions.IntExpression) converter. fullName: IntExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -18,7 +17,6 @@ methods: Converts a `string` or `number` into an [IntExpression](xref:adaptive-expressions.IntExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: Input | IntExpression): IntExpression' @@ -27,5 +25,5 @@ methods: type: Input | description: '`string` or `number` to convert.' return: - description: 'The [IntExpression](xref:adaptive-expressions.IntExpression).' + description: The [IntExpression](xref:adaptive-expressions.IntExpression). type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/InternalFunctionUtils.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/InternalFunctionUtils.yml deleted file mode 100644 index b1c792e4..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/InternalFunctionUtils.yml +++ /dev/null @@ -1,394 +0,0 @@ -### YamlMime:TSType -name: InternalFunctionUtils -uid: adaptive-expressions.InternalFunctionUtils -package: adaptive-expressions -summary: Utility functions only used internal -fullName: InternalFunctionUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: MillisecondToTickConstant - uid: adaptive-expressions.InternalFunctionUtils.MillisecondToTickConstant - package: adaptive-expressions - summary: Constant to convert between ticks and ms. - fullName: MillisecondToTickConstant - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static MillisecondToTickConstant: BigInteger = bigInt(''10000'')' - return: - description: '' - type: BigInteger - - name: UnixMilliSecondToTicksConstant - uid: adaptive-expressions.InternalFunctionUtils.UnixMilliSecondToTicksConstant - package: adaptive-expressions - summary: Constant for converting unix timestamp to ticks. - fullName: UnixMilliSecondToTicksConstant - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static UnixMilliSecondToTicksConstant: BigInteger = - bigInt('621355968000000000') - return: - description: '' - type: BigInteger -methods: - - name: 'accessIndex(any, number)' - uid: adaptive-expressions.InternalFunctionUtils.accessIndex - package: adaptive-expressions - summary: Lookup a string or number index of an Object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function accessIndex(instance: any, index: number): - ValueWithError - parameters: - - id: instance - type: any - description: Instance with property. - - id: index - type: number - description: Property to lookup. - return: - description: Value and error information if any. - type: - - name: 'accessProperty(any, string)' - uid: adaptive-expressions.InternalFunctionUtils.accessProperty - package: adaptive-expressions - summary: Lookup a property in Map or Object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function accessProperty(instance: any, property: string): - ValueWithError - parameters: - - id: instance - type: any - description: Instance with property. - - id: property - type: string - description: Property to lookup. - return: - description: Value and error information if any. - type: - - name: commonStringify(unknown) - uid: adaptive-expressions.InternalFunctionUtils.commonStringify - package: adaptive-expressions - summary: Common Stringify an object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function commonStringify(input: unknown): string' - parameters: - - id: input - type: unknown - description: input object. - return: - description: the stringified object. - type: string - - name: convertToList(unknown) - uid: adaptive-expressions.InternalFunctionUtils.convertToList - package: adaptive-expressions - summary: |- - Convert an object into array. - If the instance is array, return itself. - If the instance is object, return {key, value} pair list. - Else return undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function convertToList(instance: unknown): unknown[] | undefined' - parameters: - - id: instance - type: unknown - description: input instance. - return: - description: The generated list. - type: 'unknown[] | undefined' - - name: 'foreach(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.InternalFunctionUtils.foreach - package: adaptive-expressions - summary: Evaluator for foreach and select functions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function foreach(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression. - - id: state - type: - description: Memory scope. - - id: options - type: - description: Options. - return: - description: The evaluated list. - type: - - name: getTextDecoder(string) - uid: adaptive-expressions.InternalFunctionUtils.getTextDecoder - package: adaptive-expressions - summary: TextDecoder helper function. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getTextDecoder(code: string): TextDecoder' - parameters: - - id: code - type: string - description: The encoding format. - return: - description: The text decoder. - type: TextDecoder - - name: getTextEncoder() - uid: adaptive-expressions.InternalFunctionUtils.getTextEncoder - package: adaptive-expressions - summary: TextEncoder helper function. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getTextEncoder(): TextEncoder' - return: - description: The text encoder. - type: TextEncoder - - name: isLogicTrue(any) - uid: adaptive-expressions.InternalFunctionUtils.isLogicTrue - package: adaptive-expressions - summary: Test result to see if True in logical comparison functions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function isLogicTrue(instance: any): boolean' - parameters: - - id: instance - type: any - description: Computed value. - return: - description: True if boolean true or non-null. - type: boolean - - name: >- - lambdaEvaluator(Expression, MemoryInterface, Options, T[], - (currentItem: T, result: U, error: string) => boolean) - uid: adaptive-expressions.InternalFunctionUtils.lambdaEvaluator - package: adaptive-expressions - summary: Lambda evaluator. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function lambdaEvaluator(expression: Expression, state: - MemoryInterface, options: Options, list: T[], callback: (currentItem: T, - result: U, error: string) => boolean) - parameters: - - id: expression - type: - description: expression. - - id: state - type: - description: memory state. - - id: options - type: - description: options. - - id: list - type: 'T[]' - description: item list. - - id: callback - type: '(currentItem: T, result: U, error: string) => boolean' - description: | - call back. return the should break flag. - - name: parseStringOrUndefined(string | undefined) - uid: adaptive-expressions.InternalFunctionUtils.parseStringOrUndefined - package: adaptive-expressions - summary: Wrap string or undefined into string. Default to empty string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function parseStringOrUndefined(input: string | undefined): - string - parameters: - - id: input - type: string | undefined - description: Input string - return: - description: The wrapped string. - type: string - - name: parseTimexProperty(any) - uid: adaptive-expressions.InternalFunctionUtils.parseTimexProperty - package: adaptive-expressions - summary: Parse timex funcition. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function parseTimexProperty(timexExpr: any): { error: string, - timexProperty: TimexProperty } - parameters: - - id: timexExpr - type: any - description: String or TimexProperty input. - return: - description: TimexProperty and error. - type: '{ error: string, timexProperty: TimexProperty }' - - name: parseUri(string) - uid: adaptive-expressions.InternalFunctionUtils.parseUri - package: adaptive-expressions - summary: Parse string into URL object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function parseUri(uri: string): ValueWithError' - parameters: - - id: uri - type: string - description: Input string uri. - return: - description: The parsed URL object. - type: - - name: sortBy(boolean) - uid: adaptive-expressions.InternalFunctionUtils.sortBy - package: adaptive-expressions - summary: Sort helper function. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function sortBy(isDescending: boolean): - EvaluateExpressionDelegate - parameters: - - id: isDescending - type: boolean - description: Descending flag. - return: - description: The sorted array. - type: - - name: ticks(string) - uid: adaptive-expressions.InternalFunctionUtils.ticks - package: adaptive-expressions - summary: Convert a string input to ticks number. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function ticks(timeStamp: string): ValueWithError' - parameters: - - id: timeStamp - type: string - description: String timestamp input. - return: - description: The string converted in ticks. - type: - - name: 'timeUnitTransformer(number, string)' - uid: adaptive-expressions.InternalFunctionUtils.timeUnitTransformer - package: adaptive-expressions - summary: Transform C# period and unit into js period and unit. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function timeUnitTransformer(duration: number, cSharpStr: - string): { duration: number, tsStr: OpUnitType } - parameters: - - id: duration - type: number - description: C# duration. - - id: cSharpStr - type: string - description: C# unit. - return: - description: The transformed timeUnit. - type: '{ duration: number, tsStr: OpUnitType }' - - name: ValidateLambdaExpression(Expression) - uid: adaptive-expressions.InternalFunctionUtils.ValidateLambdaExpression - package: adaptive-expressions - summary: 'Validator for foreach, select, and where functions.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function ValidateLambdaExpression(expression: Expression)' - parameters: - - id: expression - type: - description: | - The expression to validate. - - name: verifyISOTimestamp(any) - uid: adaptive-expressions.InternalFunctionUtils.verifyISOTimestamp - package: adaptive-expressions - summary: Verify a timestamp string is valid ISO timestamp format. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function verifyISOTimestamp(value: any): string | undefined' - parameters: - - id: value - type: any - description: Timestamp string to check. - return: - description: Error or undefined if invalid. - type: string | undefined - - name: verifyTimestamp(any) - uid: adaptive-expressions.InternalFunctionUtils.verifyTimestamp - package: adaptive-expressions - summary: Verify a timestamp string is valid timestamp format. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function verifyTimestamp(value: any): string | undefined' - parameters: - - id: value - type: any - description: Timestamp string to check. - return: - description: Error or undefined if invalid. - type: string | undefined - - name: 'wrapGetValue(MemoryInterface, string, Options)' - uid: adaptive-expressions.InternalFunctionUtils.wrapGetValue - package: adaptive-expressions - summary: Get the value of a path from a memory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function wrapGetValue(state: MemoryInterface, path: string, - options: Options): any - parameters: - - id: state - type: - description: Memory. - - id: path - type: string - description: Path string. - - id: options - type: - description: Options. - return: - description: The value of a path from a memory. - type: any diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Intersection.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Intersection.yml deleted file mode 100644 index d913107c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Intersection.yml +++ /dev/null @@ -1,125 +0,0 @@ -### YamlMime:TSType -name: Intersection -uid: adaptive-expressions.Intersection -package: adaptive-expressions -summary: >- - Return a collection that has only the common items across the specified - collections. - - To appear in the result, an item must appear in all the collections passed to - this function. - - If one or more items have the same name, - - the last item with that name appears in the result. -fullName: Intersection -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Intersection() - uid: adaptive-expressions.Intersection.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Intersection](xref:adaptive-expressions.Intersection) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Intersection() -properties: - - name: negation - uid: adaptive-expressions.Intersection.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Intersection.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Intersection.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Intersection.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Intersection.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsArray.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsArray.yml deleted file mode 100644 index 4a1e8aaf..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsArray.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: IsArray -uid: adaptive-expressions.IsArray -package: adaptive-expressions -summary: Return true if a given input is an array. -fullName: IsArray -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsArray() - uid: adaptive-expressions.IsArray.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsArray](xref:adaptive-expressions.IsArray) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsArray() -properties: - - name: negation - uid: adaptive-expressions.IsArray.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsArray.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsArray.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsArray.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsArray.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsBoolean.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsBoolean.yml deleted file mode 100644 index 727db424..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsBoolean.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: IsBoolean -uid: adaptive-expressions.IsBoolean -package: adaptive-expressions -summary: Return true if a given input is a Boolean. -fullName: IsBoolean -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsBoolean() - uid: adaptive-expressions.IsBoolean.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsBoolean](xref:adaptive-expressions.IsBoolean) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsBoolean() -properties: - - name: negation - uid: adaptive-expressions.IsBoolean.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsBoolean.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsBoolean.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsBoolean.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsBoolean.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDate.yml deleted file mode 100644 index 6ddf7502..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDate.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsDate -uid: adaptive-expressions.IsDate -package: adaptive-expressions -summary: |- - Return true if a given `TimexProperty` or timex string refers to a valid date. - Valid dates contain the month and dayOfMonth, or contain the dayOfWeek. -fullName: IsDate -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsDate() - uid: adaptive-expressions.IsDate.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsDate](xref:adaptive-expressions.IsDate) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsDate() -properties: - - name: negation - uid: adaptive-expressions.IsDate.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsDate.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsDate.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsDate.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsDate.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateRange.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateRange.yml deleted file mode 100644 index ac05811f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateRange.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsDateRange -uid: adaptive-expressions.IsDateRange -package: adaptive-expressions -summary: >- - Return true if a given TimexProperty or Timex expression refers to a valid - date range. -fullName: IsDateRange -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsDateRange() - uid: adaptive-expressions.IsDateRange.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsDateRange](xref:adaptive-expressions.IsDateRange) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsDateRange() -properties: - - name: negation - uid: adaptive-expressions.IsDateRange.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsDateRange.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsDateRange.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsDateRange.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsDateRange.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateTime.yml deleted file mode 100644 index 7dee1bd9..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDateTime.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsDateTime -uid: adaptive-expressions.IsDateTime -package: adaptive-expressions -summary: >- - Return true if a given input is a UTC ISO format (YYYY-MM-DDTHH:mm:ss.fffZ) - timestamp string. -fullName: IsDateTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsDateTime() - uid: adaptive-expressions.IsDateTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsDateTime](xref:adaptive-expressions.IsDateTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsDateTime() -properties: - - name: negation - uid: adaptive-expressions.IsDateTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsDateTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsDateTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsDateTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsDateTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDefinite.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDefinite.yml deleted file mode 100644 index 7e8b1db7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDefinite.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsDefinite -uid: adaptive-expressions.IsDefinite -package: adaptive-expressions -summary: >- - Return true if a given TimexProperty or Timex expression refers to a valid - date. Valid dates contain the year, month and dayOfMonth. -fullName: IsDefinite -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsDefinite() - uid: adaptive-expressions.IsDefinite.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsDefinite](xref:adaptive-expressions.IsDefinite) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsDefinite() -properties: - - name: negation - uid: adaptive-expressions.IsDefinite.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsDefinite.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsDefinite.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsDefinite.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsDefinite.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDuration.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDuration.yml deleted file mode 100644 index adac3e0b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsDuration.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsDuration -uid: adaptive-expressions.IsDuration -package: adaptive-expressions -summary: >- - Return true if a given TimexProperty or Timex expression refers to a valid - duration. -fullName: IsDuration -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsDuration() - uid: adaptive-expressions.IsDuration.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsDuration](xref:adaptive-expressions.IsDuration) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsDuration() -properties: - - name: negation - uid: adaptive-expressions.IsDuration.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsDuration.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsDuration.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsDuration.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsDuration.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsFloat.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsFloat.yml deleted file mode 100644 index f5ed4f7f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsFloat.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: IsFloat -uid: adaptive-expressions.IsFloat -package: adaptive-expressions -summary: >- - Return true if a given input is a floating-point number. - - Due to the alignment between C# and JavaScript, a number with an non-zero - residue of its modulo 1 will be treated as a floating-point number. -fullName: IsFloat -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsFloat() - uid: adaptive-expressions.IsFloat.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsFloat](xref:adaptive-expressions.IsFloat) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsFloat() -properties: - - name: negation - uid: adaptive-expressions.IsFloat.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsFloat.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsFloat.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsFloat.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsFloat.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsInteger.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsInteger.yml deleted file mode 100644 index 1312b977..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsInteger.yml +++ /dev/null @@ -1,119 +0,0 @@ -### YamlMime:TSType -name: IsInteger -uid: adaptive-expressions.IsInteger -package: adaptive-expressions -summary: >- - Return true if a given input is an integer number. Due to the alignment - between C# and JavaScript, a number with a zero residue of its modulo 1 will - be treated as an integer number. -fullName: IsInteger -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsInteger() - uid: adaptive-expressions.IsInteger.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsInteger](xref:adaptive-expressions.IsInteger) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsInteger() -properties: - - name: negation - uid: adaptive-expressions.IsInteger.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsInteger.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsInteger.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsInteger.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsInteger.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsMatch.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsMatch.yml deleted file mode 100644 index 4807ab99..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsMatch.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: IsMatch -uid: adaptive-expressions.IsMatch -package: adaptive-expressions -summary: Return true if a given string matches a specified regular expression pattern. -fullName: IsMatch -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsMatch() - uid: adaptive-expressions.IsMatch.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsMatch](xref:adaptive-expressions.IsMatch) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsMatch() -properties: - - name: negation - uid: adaptive-expressions.IsMatch.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsMatch.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsMatch.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsMatch.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsMatch.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsObject.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsObject.yml deleted file mode 100644 index 1fff8722..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsObject.yml +++ /dev/null @@ -1,122 +0,0 @@ -### YamlMime:TSType -name: IsObject -uid: adaptive-expressions.IsObject -package: adaptive-expressions -summary: >- - Return true if a given input is a complex object or return false if it is a - primitive object. - - Primitive objects include strings, numbers, and Booleans; - - complex types, contain properties. -fullName: IsObject -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsObject() - uid: adaptive-expressions.IsObject.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsObject](xref:adaptive-expressions.IsObject) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsObject() -properties: - - name: negation - uid: adaptive-expressions.IsObject.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsObject.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsObject.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsObject.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsObject.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsPresent.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsPresent.yml deleted file mode 100644 index b55b1c99..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsPresent.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsPresent -uid: adaptive-expressions.IsPresent -package: adaptive-expressions -summary: >- - Return true if a given TimexProperty or Timex expression refers to the - present. -fullName: IsPresent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsPresent() - uid: adaptive-expressions.IsPresent.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsPresent](xref:adaptive-expressions.IsPresent) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsPresent() -properties: - - name: negation - uid: adaptive-expressions.IsPresent.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsPresent.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsPresent.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsPresent.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsPresent.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsString.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsString.yml deleted file mode 100644 index 5b8f4040..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsString.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: IsString -uid: adaptive-expressions.IsString -package: adaptive-expressions -summary: Return true if a given input is a string. -fullName: IsString -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsString() - uid: adaptive-expressions.IsString.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsString](xref:adaptive-expressions.IsString) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsString() -properties: - - name: negation - uid: adaptive-expressions.IsString.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsString.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsString.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsString.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsString.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTime.yml deleted file mode 100644 index 8a5c2f7d..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTime.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: IsTime -uid: adaptive-expressions.IsTime -package: adaptive-expressions -summary: >- - Return true if a given TimexProperty or Timex expression refers to a valid - time. - - Valid time contains hours, minutes and seconds. -fullName: IsTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsTime() - uid: adaptive-expressions.IsTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsTime](xref:adaptive-expressions.IsTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsTime() -properties: - - name: negation - uid: adaptive-expressions.IsTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTimeRange.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTimeRange.yml deleted file mode 100644 index 4bfd17a8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/IsTimeRange.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: IsTimeRange -uid: adaptive-expressions.IsTimeRange -package: adaptive-expressions -summary: >- - Return true if a given `TimexProperty` or Timex string refers to a valid time - range Valid time ranges contain partOfDay. -fullName: IsTimeRange -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: IsTimeRange() - uid: adaptive-expressions.IsTimeRange.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [IsTimeRange](xref:adaptive-expressions.IsTimeRange) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IsTimeRange() -properties: - - name: negation - uid: adaptive-expressions.IsTimeRange.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.IsTimeRange.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.IsTimeRange.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.IsTimeRange.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.IsTimeRange.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JPath.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JPath.yml deleted file mode 100644 index 43aead13..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JPath.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: JPath -uid: adaptive-expressions.JPath -package: adaptive-expressions -summary: >- - Check JSON or a JSON string for nodes or values that match a path expression, - and return the matching nodes. -fullName: JPath -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: JPath() - uid: adaptive-expressions.JPath.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [JPath](xref:adaptive-expressions.JPath) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new JPath() -properties: - - name: negation - uid: adaptive-expressions.JPath.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.JPath.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.JPath.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.JPath.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.JPath.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Join.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Join.yml deleted file mode 100644 index f987904b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Join.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Join -uid: adaptive-expressions.Join -package: adaptive-expressions -summary: >- - Return a string that has all the items from an array, with each character - separated by a delimiter. -fullName: Join -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Join() - uid: adaptive-expressions.Join.constructor - package: adaptive-expressions - summary: Initializes a new instance of the Join class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Join() -properties: - - name: negation - uid: adaptive-expressions.Join.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Join.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Join.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Join.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Join.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Json.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Json.yml deleted file mode 100644 index aba8fdb6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Json.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Json -uid: adaptive-expressions.Json -package: adaptive-expressions -summary: >- - Return the JavaScript Object Notation (JSON) type value or object of a string - or XML. -fullName: Json -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Json() - uid: adaptive-expressions.Json.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Json](xref:adaptive-expressions.Json) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Json() -properties: - - name: negation - uid: adaptive-expressions.Json.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Json.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Json.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Json.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Json.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonCreationExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonCreationExpContext.yml index 246f80f1..373f8bf0 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonCreationExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonCreationExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: JsonCreationExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new JsonCreationExpContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.JsonCreationExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.JsonCreationExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.JsonCreationExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.JsonCreationExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.JsonCreationExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.JsonCreationExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.JsonCreationExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.JsonCreationExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.JsonCreationExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.JsonCreationExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: JsonCreationExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.JsonCreationExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.JsonCreationExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.JsonCreationExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.JsonCreationExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.JsonCreationExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.JsonCreationExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.JsonCreationExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.JsonCreationExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.JsonCreationExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.JsonCreationExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.JsonCreationExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.JsonCreationExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.JsonCreationExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.JsonCreationExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.JsonCreationExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.JsonCreationExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.JsonCreationExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.JsonCreationExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.JsonCreationExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.JsonCreationExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.JsonCreationExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.JsonCreationExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.JsonCreationExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.JsonCreationExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.JsonCreationExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.JsonCreationExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.JsonCreationExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.JsonCreationExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.JsonCreationExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.JsonCreationExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.JsonCreationExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.JsonCreationExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.JsonCreationExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.JsonCreationExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.JsonCreationExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CLOSE_CURLY_BRACKET(): TerminalNode' @@ -839,7 +880,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -852,7 +892,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -865,21 +904,19 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function keyValuePairList(): KeyValuePairListContext | undefined' + content: 'function keyValuePairList(): undefined | KeyValuePairListContext' return: description: '' type: >- - | - undefined + undefined | - name: OPEN_CURLY_BRACKET() uid: adaptive-expressions.JsonCreationExpContext.OPEN_CURLY_BRACKET package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OPEN_CURLY_BRACKET(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonStringify.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonStringify.yml deleted file mode 100644 index 813b147c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/JsonStringify.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: JsonStringify -uid: adaptive-expressions.JsonStringify -package: adaptive-expressions -summary: Return the string version of a value. -fullName: JsonStringify -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: JsonStringify() - uid: adaptive-expressions.JsonStringify.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [JsonStringify](xref:adaptive-expressions.JsonStringify) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new JsonStringify() -properties: - - name: negation - uid: adaptive-expressions.JsonStringify.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.JsonStringify.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.JsonStringify.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.JsonStringify.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.JsonStringify.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyContext.yml index 8e44c73a..63fb7f2d 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: KeyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'KeyContext(ParserRuleContext | undefined, number)' + - name: KeyContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.KeyContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new KeyContext(parent: ParserRuleContext | undefined, invokingState: + new KeyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.KeyContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.KeyContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.KeyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.KeyContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.KeyContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.KeyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.KeyContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: KeyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.KeyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.KeyContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.KeyContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.KeyContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.KeyContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.KeyContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.KeyContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.KeyContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.KeyContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.KeyContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.KeyContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.KeyContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.KeyContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.KeyContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.KeyContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.KeyContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.KeyContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.KeyContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.KeyContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.KeyContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.KeyContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.KeyContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,7 +797,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +809,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -866,23 +821,21 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function IDENTIFIER(): TerminalNode | undefined' + content: 'function IDENTIFIER(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: STRING() uid: adaptive-expressions.KeyContext.STRING package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function STRING(): TerminalNode | undefined' + content: 'function STRING(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairContext.yml index 68eca10f..fbb4728a 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: KeyValuePairContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'KeyValuePairContext(ParserRuleContext | undefined, number)' + - name: KeyValuePairContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.KeyValuePairContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new KeyValuePairContext(parent: ParserRuleContext | undefined, + new KeyValuePairContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.KeyValuePairContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.KeyValuePairContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.KeyValuePairContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.KeyValuePairContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.KeyValuePairContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.KeyValuePairContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.KeyValuePairContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: KeyValuePairContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.KeyValuePairContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.KeyValuePairContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.KeyValuePairContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.KeyValuePairContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.KeyValuePairContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.KeyValuePairContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.KeyValuePairContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.KeyValuePairContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.KeyValuePairContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.KeyValuePairContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.KeyValuePairContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.KeyValuePairContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.KeyValuePairContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.KeyValuePairContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.KeyValuePairContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.KeyValuePairContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.KeyValuePairContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.KeyValuePairContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,7 +797,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COLON(): TerminalNode' @@ -852,7 +808,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -865,7 +820,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -878,7 +832,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -890,7 +843,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function key(): KeyContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairListContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairListContext.yml index 0dee77e7..727e3d80 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairListContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/KeyValuePairListContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: KeyValuePairListContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'KeyValuePairListContext(ParserRuleContext | undefined, number)' + - name: KeyValuePairListContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.KeyValuePairListContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new KeyValuePairListContext(parent: ParserRuleContext | undefined, + new KeyValuePairListContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.KeyValuePairListContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.KeyValuePairListContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.KeyValuePairListContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.KeyValuePairListContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.KeyValuePairListContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.KeyValuePairListContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.KeyValuePairListContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: KeyValuePairListContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.KeyValuePairListContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.KeyValuePairListContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.KeyValuePairListContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.KeyValuePairListContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.KeyValuePairListContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairListContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.KeyValuePairListContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairListContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.KeyValuePairListContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.KeyValuePairListContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.KeyValuePairListContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.KeyValuePairListContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.KeyValuePairListContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.KeyValuePairListContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.KeyValuePairListContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.KeyValuePairListContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.KeyValuePairListContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.KeyValuePairListContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.KeyValuePairListContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairListContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.KeyValuePairListContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.KeyValuePairListContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,19 +797,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COMMA(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: COMMA(number) uid: adaptive-expressions.KeyValuePairListContext.COMMA_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COMMA(i: number): TerminalNode' @@ -868,7 +823,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -881,7 +835,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -894,19 +847,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValuePair(): KeyValuePairContext[]' return: description: '' - type: '[]' + type: [] - name: keyValuePair(number) uid: adaptive-expressions.KeyValuePairListContext.keyValuePair_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValuePair(i: number): KeyValuePairContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LambdaContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LambdaContext.yml index ed83efdb..0d459e2f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LambdaContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LambdaContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: LambdaContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'LambdaContext(ParserRuleContext | undefined, number)' + - name: LambdaContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.LambdaContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new LambdaContext(parent: ParserRuleContext | undefined, invokingState: + new LambdaContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.LambdaContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.LambdaContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.LambdaContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.LambdaContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.LambdaContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.LambdaContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.LambdaContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: LambdaContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.LambdaContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.LambdaContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.LambdaContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.LambdaContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.LambdaContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.LambdaContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.LambdaContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.LambdaContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.LambdaContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.LambdaContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.LambdaContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.LambdaContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.LambdaContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.LambdaContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.LambdaContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.LambdaContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.LambdaContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.LambdaContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.LambdaContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.LambdaContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.LambdaContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.LambdaContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,7 +797,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ARROW(): TerminalNode' @@ -852,7 +808,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -865,7 +820,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -878,7 +832,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -890,7 +843,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function IDENTIFIER(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Last.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Last.yml deleted file mode 100644 index d138f0d5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Last.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Last -uid: adaptive-expressions.Last -package: adaptive-expressions -summary: Return the last item from a collection. -fullName: Last -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Last() - uid: adaptive-expressions.Last.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Last](xref:adaptive-expressions.Last) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Last() -properties: - - name: negation - uid: adaptive-expressions.Last.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Last.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Last.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Last.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Last.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LastIndexOf.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LastIndexOf.yml deleted file mode 100644 index 2dd51afe..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LastIndexOf.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: LastIndexOf -uid: adaptive-expressions.LastIndexOf -package: adaptive-expressions -summary: >- - Returns the index of the last occurrence of a specified value in an array. - - The zero-based index position of value if that value is found, or -1 if it is - not. -fullName: LastIndexOf -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: LastIndexOf() - uid: adaptive-expressions.LastIndexOf.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [LastIndexOf](xref:adaptive-expressions.LastIndexOf) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new LastIndexOf() -properties: - - name: negation - uid: adaptive-expressions.LastIndexOf.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.LastIndexOf.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.LastIndexOf.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.LastIndexOf.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.LastIndexOf.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Length.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Length.yml deleted file mode 100644 index 777dcadf..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Length.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Length -uid: adaptive-expressions.Length -package: adaptive-expressions -summary: Return the length of a string. -fullName: Length -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Length() - uid: adaptive-expressions.Length.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Length](xref:adaptive-expressions.Length) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Length() -properties: - - name: negation - uid: adaptive-expressions.Length.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Length.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Length.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Length.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Length.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThan.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThan.yml deleted file mode 100644 index 00042ec6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThan.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: LessThan -uid: adaptive-expressions.LessThan -package: adaptive-expressions -summary: >- - Check whether the first value is less than the second value. - - Return true if the first value is less, or return false if the first value is - more. -fullName: LessThan -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: LessThan() - uid: adaptive-expressions.LessThan.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [LessThan](xref:adaptive-expressions.LessThan) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new LessThan() -properties: - - name: negation - uid: adaptive-expressions.LessThan.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.LessThan.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.LessThan.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.LessThan.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.LessThan.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThanOrEqual.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThanOrEqual.yml deleted file mode 100644 index e598f88c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LessThanOrEqual.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: LessThanOrEqual -uid: adaptive-expressions.LessThanOrEqual -package: adaptive-expressions -summary: >- - Check whether the first value is less than or equal to the second value. - - Return true if the first value is less than or equal, or return false if the - first value is more. -fullName: LessThanOrEqual -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: LessThanOrEqual() - uid: adaptive-expressions.LessThanOrEqual.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [LessThanOrEqual](xref:adaptive-expressions.LessThanOrEqual) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new LessThanOrEqual() -properties: - - name: negation - uid: adaptive-expressions.LessThanOrEqual.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.LessThanOrEqual.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.LessThanOrEqual.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.LessThanOrEqual.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.LessThanOrEqual.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LetterContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LetterContext.yml index cbcc5479..5e888d43 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LetterContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LetterContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: LetterContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'LetterContext(ParserRuleContext | undefined, number)' + - name: LetterContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.LetterContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new LetterContext(parent: ParserRuleContext | undefined, invokingState: + new LetterContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.LetterContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.LetterContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.LetterContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.LetterContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.LetterContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.LetterContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.LetterContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: LetterContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.LetterContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.LetterContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.LetterContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.LetterContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.LetterContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.LetterContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.LetterContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.LetterContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.LetterContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.LetterContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.LetterContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.LetterContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.LetterContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.LetterContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.LetterContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.LetterContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.LetterContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.LetterContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.LetterContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.LetterContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.LetterContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.LetterContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,115 +793,105 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ALC(): TerminalNode | undefined' + content: 'function ALC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: AUC() uid: adaptive-expressions.LetterContext.AUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function AUC(): TerminalNode | undefined' + content: 'function AUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: BLC() uid: adaptive-expressions.LetterContext.BLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function BLC(): TerminalNode | undefined' + content: 'function BLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: BUC() uid: adaptive-expressions.LetterContext.BUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function BUC(): TerminalNode | undefined' + content: 'function BUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CLC() uid: adaptive-expressions.LetterContext.CLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CLC(): TerminalNode | undefined' + content: 'function CLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CUC() uid: adaptive-expressions.LetterContext.CUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CUC(): TerminalNode | undefined' + content: 'function CUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DLC() uid: adaptive-expressions.LetterContext.DLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DLC(): TerminalNode | undefined' + content: 'function DLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DUC() uid: adaptive-expressions.LetterContext.DUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DUC(): TerminalNode | undefined' + content: 'function DUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ELC() uid: adaptive-expressions.LetterContext.ELC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ELC(): TerminalNode | undefined' + content: 'function ELC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.LetterContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -957,19 +904,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function EUC(): TerminalNode | undefined' + content: 'function EUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: exitRule(CommonRegexListener) uid: adaptive-expressions.LetterContext.exitRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -982,503 +927,461 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function FLC(): TerminalNode | undefined' + content: 'function FLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: FUC() uid: adaptive-expressions.LetterContext.FUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function FUC(): TerminalNode | undefined' + content: 'function FUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: GLC() uid: adaptive-expressions.LetterContext.GLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function GLC(): TerminalNode | undefined' + content: 'function GLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: GUC() uid: adaptive-expressions.LetterContext.GUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function GUC(): TerminalNode | undefined' + content: 'function GUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: HLC() uid: adaptive-expressions.LetterContext.HLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function HLC(): TerminalNode | undefined' + content: 'function HLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: HUC() uid: adaptive-expressions.LetterContext.HUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function HUC(): TerminalNode | undefined' + content: 'function HUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ILC() uid: adaptive-expressions.LetterContext.ILC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ILC(): TerminalNode | undefined' + content: 'function ILC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: IUC() uid: adaptive-expressions.LetterContext.IUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function IUC(): TerminalNode | undefined' + content: 'function IUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: JLC() uid: adaptive-expressions.LetterContext.JLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function JLC(): TerminalNode | undefined' + content: 'function JLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: JUC() uid: adaptive-expressions.LetterContext.JUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function JUC(): TerminalNode | undefined' + content: 'function JUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: KLC() uid: adaptive-expressions.LetterContext.KLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function KLC(): TerminalNode | undefined' + content: 'function KLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: KUC() uid: adaptive-expressions.LetterContext.KUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function KUC(): TerminalNode | undefined' + content: 'function KUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: LLC() uid: adaptive-expressions.LetterContext.LLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function LLC(): TerminalNode | undefined' + content: 'function LLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: LUC() uid: adaptive-expressions.LetterContext.LUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function LUC(): TerminalNode | undefined' + content: 'function LUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MLC() uid: adaptive-expressions.LetterContext.MLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MLC(): TerminalNode | undefined' + content: 'function MLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MUC() uid: adaptive-expressions.LetterContext.MUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MUC(): TerminalNode | undefined' + content: 'function MUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: NLC() uid: adaptive-expressions.LetterContext.NLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NLC(): TerminalNode | undefined' + content: 'function NLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: NUC() uid: adaptive-expressions.LetterContext.NUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NUC(): TerminalNode | undefined' + content: 'function NUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: OLC() uid: adaptive-expressions.LetterContext.OLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function OLC(): TerminalNode | undefined' + content: 'function OLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: OUC() uid: adaptive-expressions.LetterContext.OUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function OUC(): TerminalNode | undefined' + content: 'function OUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: PLC() uid: adaptive-expressions.LetterContext.PLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function PLC(): TerminalNode | undefined' + content: 'function PLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: PUC() uid: adaptive-expressions.LetterContext.PUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function PUC(): TerminalNode | undefined' + content: 'function PUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: QLC() uid: adaptive-expressions.LetterContext.QLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function QLC(): TerminalNode | undefined' + content: 'function QLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: QUC() uid: adaptive-expressions.LetterContext.QUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function QUC(): TerminalNode | undefined' + content: 'function QUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: RLC() uid: adaptive-expressions.LetterContext.RLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function RLC(): TerminalNode | undefined' + content: 'function RLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: RUC() uid: adaptive-expressions.LetterContext.RUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function RUC(): TerminalNode | undefined' + content: 'function RUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SLC() uid: adaptive-expressions.LetterContext.SLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SLC(): TerminalNode | undefined' + content: 'function SLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SUC() uid: adaptive-expressions.LetterContext.SUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SUC(): TerminalNode | undefined' + content: 'function SUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TLC() uid: adaptive-expressions.LetterContext.TLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function TLC(): TerminalNode | undefined' + content: 'function TLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TUC() uid: adaptive-expressions.LetterContext.TUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function TUC(): TerminalNode | undefined' + content: 'function TUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ULC() uid: adaptive-expressions.LetterContext.ULC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ULC(): TerminalNode | undefined' + content: 'function ULC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: UUC() uid: adaptive-expressions.LetterContext.UUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function UUC(): TerminalNode | undefined' + content: 'function UUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: VLC() uid: adaptive-expressions.LetterContext.VLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function VLC(): TerminalNode | undefined' + content: 'function VLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: VUC() uid: adaptive-expressions.LetterContext.VUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function VUC(): TerminalNode | undefined' + content: 'function VUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: WLC() uid: adaptive-expressions.LetterContext.WLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function WLC(): TerminalNode | undefined' + content: 'function WLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: WUC() uid: adaptive-expressions.LetterContext.WUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function WUC(): TerminalNode | undefined' + content: 'function WUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: XLC() uid: adaptive-expressions.LetterContext.XLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function XLC(): TerminalNode | undefined' + content: 'function XLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: XUC() uid: adaptive-expressions.LetterContext.XUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function XUC(): TerminalNode | undefined' + content: 'function XUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: YLC() uid: adaptive-expressions.LetterContext.YLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function YLC(): TerminalNode | undefined' + content: 'function YLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: YUC() uid: adaptive-expressions.LetterContext.YUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function YUC(): TerminalNode | undefined' + content: 'function YUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ZLC() uid: adaptive-expressions.LetterContext.ZLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ZLC(): TerminalNode | undefined' + content: 'function ZLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ZUC() uid: adaptive-expressions.LetterContext.ZUC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ZUC(): TerminalNode | undefined' + content: 'function ZUC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LiteralContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LiteralContext.yml index 597362c6..687d6bab 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LiteralContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/LiteralContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: LiteralContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'LiteralContext(ParserRuleContext | undefined, number)' + - name: LiteralContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.LiteralContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new LiteralContext(parent: ParserRuleContext | undefined, invokingState: + new LiteralContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.LiteralContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.LiteralContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.LiteralContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.LiteralContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.LiteralContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.LiteralContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.LiteralContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: LiteralContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.LiteralContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.LiteralContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.LiteralContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.LiteralContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.LiteralContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.LiteralContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.LiteralContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.LiteralContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.LiteralContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.LiteralContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.LiteralContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.LiteralContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.LiteralContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.LiteralContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.LiteralContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.LiteralContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.LiteralContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.LiteralContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.LiteralContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.LiteralContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.LiteralContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.LiteralContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,19 +793,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CharacterClassEnd(): TerminalNode | undefined' + content: 'function CharacterClassEnd(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.LiteralContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -874,11 +828,10 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shared_literal(): Shared_literalContext | undefined' + content: 'function shared_literal(): undefined | Shared_literalContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Max.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Max.yml deleted file mode 100644 index 7058ffad..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Max.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Max -uid: adaptive-expressions.Max -package: adaptive-expressions -summary: Return the highest value from an array. The array is inclusive at both ends. -fullName: Max -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Max() - uid: adaptive-expressions.Max.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Max](xref:adaptive-expressions.Max) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Max() -properties: - - name: negation - uid: adaptive-expressions.Max.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Max.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Max.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Max.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Max.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemberAccessExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemberAccessExpContext.yml index 5cfebe4d..48ff00a3 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemberAccessExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemberAccessExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: MemberAccessExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MemberAccessExpContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.MemberAccessExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.MemberAccessExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.MemberAccessExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.MemberAccessExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.MemberAccessExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.MemberAccessExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.MemberAccessExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.MemberAccessExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.MemberAccessExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.MemberAccessExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: MemberAccessExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.MemberAccessExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.MemberAccessExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.MemberAccessExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.MemberAccessExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.MemberAccessExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.MemberAccessExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.MemberAccessExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.MemberAccessExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.MemberAccessExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.MemberAccessExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.MemberAccessExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.MemberAccessExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.MemberAccessExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.MemberAccessExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.MemberAccessExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.MemberAccessExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.MemberAccessExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.MemberAccessExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.MemberAccessExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.MemberAccessExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.MemberAccessExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.MemberAccessExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.MemberAccessExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.MemberAccessExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.MemberAccessExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.MemberAccessExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.MemberAccessExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.MemberAccessExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.MemberAccessExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.MemberAccessExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.MemberAccessExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.MemberAccessExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.MemberAccessExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.MemberAccessExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.MemberAccessExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function DOT(): TerminalNode' @@ -839,7 +880,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -852,7 +892,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -865,7 +904,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function IDENTIFIER(): TerminalNode' @@ -877,7 +915,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function primaryExpression(): PrimaryExpressionContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemoryInterface.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemoryInterface.yml index 6b7c7c24..9188e2b7 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemoryInterface.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MemoryInterface.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Interface to parse a string into an Expression fullName: MemoryInterface remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -18,7 +17,6 @@ methods: a combined path like "a.b", "a.b[2]", "a.b[2].c", inside [] is guranteed to be a int number or a string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getValue(path: string): any' @@ -29,12 +27,11 @@ methods: return: description: value. type: any - - name: 'setValue(string, any)' + - name: setValue(string, any) uid: adaptive-expressions.MemoryInterface.setValue package: adaptive-expressions summary: Set value to a given path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setValue(path: string, value: any)' @@ -55,7 +52,6 @@ methods: If version is not changed, the caller may choose to use the cached result instead of recomputing everything. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function version(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Merge.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Merge.yml deleted file mode 100644 index 0555b5bd..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Merge.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Merge -uid: adaptive-expressions.Merge -package: adaptive-expressions -summary: |- - Merge multiple object(json) into one object(json). - If the item is array, the elements of the array are merged as well. -fullName: Merge -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Merge() - uid: adaptive-expressions.Merge.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Merge](xref:adaptive-expressions.Merge) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Merge() -properties: - - name: negation - uid: adaptive-expressions.Merge.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Merge.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Merge.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Merge.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Merge.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Min.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Min.yml deleted file mode 100644 index 581dc9ab..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Min.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Min -uid: adaptive-expressions.Min -package: adaptive-expressions -summary: Return the lowest value from a set of numbers in an array. -fullName: Min -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Min() - uid: adaptive-expressions.Min.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Min](xref:adaptive-expressions.Min) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Min() -properties: - - name: negation - uid: adaptive-expressions.Min.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Min.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Min.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Min.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Min.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Mod.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Mod.yml deleted file mode 100644 index e2e57a83..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Mod.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Mod -uid: adaptive-expressions.Mod -package: adaptive-expressions -summary: Return the remainder from dividing two numbers. -fullName: Mod -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Mod() - uid: adaptive-expressions.Mod.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Mod](xref:adaptive-expressions.Mod) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Mod() -properties: - - name: negation - uid: adaptive-expressions.Mod.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Mod.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Mod.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Mod.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Mod.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Month.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Month.yml deleted file mode 100644 index 7ee7370a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Month.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Month -uid: adaptive-expressions.Month -package: adaptive-expressions -summary: Return the month of the specified timestamp. -fullName: Month -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Month() - uid: adaptive-expressions.Month.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Month](xref:adaptive-expressions.Month) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Month() -properties: - - name: negation - uid: adaptive-expressions.Month.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Month.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Month.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Month.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Month.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Multiply.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Multiply.yml deleted file mode 100644 index dc8dc672..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Multiply.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Multiply -uid: adaptive-expressions.Multiply -package: adaptive-expressions -summary: Return the product from multiplying any number of numbers. -fullName: Multiply -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Multiply() - uid: adaptive-expressions.Multiply.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Multiply](xref:adaptive-expressions.Multiply) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Multiply() -properties: - - name: negation - uid: adaptive-expressions.Multiply.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Multiply.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Multiply.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Multiply.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Multiply.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MultivariateNumericEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MultivariateNumericEvaluator.yml index 356e548e..046bba0b 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MultivariateNumericEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/MultivariateNumericEvaluator.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Numeric operators that can have 2 or more args. fullName: MultivariateNumericEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: [MultivariateNumericEvaluator](xref:adaptive-expressions.MultivariateNumericEvaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,34 +34,32 @@ constructors: number. - id: verify type: - description: > + description: >- Optional. [VerifyExpression](xref:adaptive-expressions.VerifyExpression) function to verify each child's result. -properties: +inheritedProperties: - name: negation uid: adaptive-expressions.MultivariateNumericEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: -inheritedProperties: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions.ExpressionEvaluator.negation) - name: returnType uid: adaptive-expressions.MultivariateNumericEvaluator.returnType package: adaptive-expressions summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -73,63 +69,52 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.MultivariateNumericEvaluator.type + - name: tryEvaluate + uid: adaptive-expressions.MultivariateNumericEvaluator.tryEvaluate package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type + summary: Evaluate an expression. + fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: string' + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError return: description: '' - type: string + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError inheritanceDescription: >- Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.MultivariateNumericEvaluator.tryEvaluate + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions.MultivariateNumericEvaluator.type package: adaptive-expressions - summary: Evaluate an expression. + summary: Gets the expression type for evaluator. + fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. + content: 'type: string' return: - description: The value and error string that is non-null if there is an error. - type: + description: '' + type: string inheritanceDescription: >- Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) + [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) + - name: validateExpression uid: adaptive-expressions.MultivariateNumericEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' inheritanceDescription: >- Inherited From [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NameContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NameContext.yml index 4ad43f15..58c3aaed 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NameContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NameContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: NameContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NameContext(ParserRuleContext | undefined, number)' + - name: NameContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.NameContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new NameContext(parent: ParserRuleContext | undefined, invokingState: + new NameContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.NameContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.NameContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.NameContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.NameContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.NameContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.NameContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.NameContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: NameContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.NameContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.NameContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.NameContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.NameContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.NameContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.NameContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.NameContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.NameContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.NameContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.NameContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.NameContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.NameContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.NameContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.NameContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.NameContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.NameContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.NameContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.NameContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.NameContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.NameContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.NameContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.NameContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function alpha_nums(): Alpha_numsContext' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NewGuid.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NewGuid.yml deleted file mode 100644 index e9b1c470..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NewGuid.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: NewGuid -uid: adaptive-expressions.NewGuid -package: adaptive-expressions -summary: Return a new Guid string. -fullName: NewGuid -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: NewGuid() - uid: adaptive-expressions.NewGuid.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [NewGuid](xref:adaptive-expressions.NewGuid) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new NewGuid() -properties: - - name: negation - uid: adaptive-expressions.NewGuid.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.NewGuid.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.NewGuid.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.NewGuid.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.NewGuid.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Node.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Node.yml index ca458b08..098ed801 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Node.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Node.yml @@ -5,16 +5,14 @@ package: adaptive-expressions summary: Node in a trigger tree. fullName: Node remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Node(Clause, TriggerTree, Trigger)' + - name: Node(Clause, TriggerTree, Trigger) uid: adaptive-expressions.Node.constructor package: adaptive-expressions summary: Intializes a new instance of the `Node` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Node(clause: Clause, tree: TriggerTree, trigger?: Trigger)' @@ -27,8 +25,7 @@ constructors: description: The trigger tree this node is found in. - id: trigger type: - description: | - The trigger to initialize this node. + description: The trigger to initialize this node. properties: - name: allTriggers uid: adaptive-expressions.Node.allTriggers @@ -36,20 +33,18 @@ properties: summary: Gets all triggers that contain the `Clause` in this node. fullName: allTriggers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'Trigger[] allTriggers' + content: 'allTriggers: Trigger[]' return: description: All triggers that contain the `Clause` in this node. - type: '[]' + type: [] - name: clause uid: adaptive-expressions.Node.clause package: adaptive-expressions summary: Gets the logical conjunction this node represents. fullName: clause remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clause: Clause' @@ -62,20 +57,18 @@ properties: summary: Gets specialized children of this node. fullName: specializations remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'Node[] specializations' + content: 'specializations: Node[]' return: description: Specialized children of this node. - type: '[]' + type: [] - name: tree uid: adaptive-expressions.Node.tree package: adaptive-expressions summary: Gets the tree this node is found in. fullName: tree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tree: TriggerTree' @@ -90,22 +83,20 @@ properties: node. fullName: triggers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'Trigger[] triggers' + content: 'triggers: Trigger[]' return: description: >- All of the most specific triggers that contains the `Clause` in this node. - type: '[]' + type: [] methods: - name: addNode(Node) uid: adaptive-expressions.Node.addNode package: adaptive-expressions summary: Adds a child node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addNode(triggerNode: Node): boolean' @@ -116,28 +107,26 @@ methods: return: description: Whether adding node operation is successful. type: boolean - - name: matches(MemoryInterface | any) + - name: matches(any) uid: adaptive-expressions.Node.matches package: adaptive-expressions summary: Gets the most specific matches below this node. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function matches(state: MemoryInterface | any): Trigger[]' + content: 'function matches(state: any): Trigger[]' parameters: - id: state - type: | any + type: any description: Frame to evaluate against. return: description: List of the most specific matches found. - type: '[]' + type: [] - name: relationship(Node) uid: adaptive-expressions.Node.relationship package: adaptive-expressions summary: Identify the relationship between two nodes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function relationship(other: Node): RelationshipType' @@ -153,7 +142,6 @@ methods: package: adaptive-expressions summary: Removes a trigger from node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeTrigger(trigger: Trigger): boolean' @@ -164,18 +152,17 @@ methods: return: description: Whether removing trigger operation is successful. type: boolean - - name: 'toString(string[], number)' + - name: toString(string[], number) uid: adaptive-expressions.Node.toString package: adaptive-expressions summary: Gets a string that represents the current node. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(builder: string[], indent: number): string' + content: 'function toString(builder?: string[], indent?: number): string' parameters: - id: builder - type: 'string[]' + type: string[] description: An array of string to build the string of node. - id: indent type: number diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_captureContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_captureContext.yml index 11a48bcd..2a3217df 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_captureContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_captureContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Non_captureContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Non_captureContext(ParserRuleContext | undefined, number)' + - name: Non_captureContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Non_captureContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Non_captureContext(parent: ParserRuleContext | undefined, + new Non_captureContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Non_captureContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Non_captureContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Non_captureContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Non_captureContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Non_captureContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Non_captureContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Non_captureContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Non_captureContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Non_captureContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Non_captureContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Non_captureContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Non_captureContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Non_captureContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Non_captureContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Non_captureContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Non_captureContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Non_captureContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Non_captureContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Non_captureContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Non_captureContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Non_captureContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Non_captureContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Non_captureContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Non_captureContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Non_captureContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Non_captureContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Non_captureContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Non_captureContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Non_captureContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Non_captureContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function alternation(): AlternationContext' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CloseParen(): TerminalNode' @@ -860,7 +815,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function Colon(): TerminalNode' @@ -872,7 +826,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -885,7 +838,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -898,7 +850,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OpenParen(): TerminalNode' @@ -910,7 +861,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function QuestionMark(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parenContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parenContext.yml index d0767adf..16b8364c 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parenContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parenContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Non_close_parenContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Non_close_parenContext(ParserRuleContext | undefined, number)' + - name: Non_close_parenContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Non_close_parenContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Non_close_parenContext(parent: ParserRuleContext | undefined, + new Non_close_parenContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Non_close_parenContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Non_close_parenContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Non_close_parenContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Non_close_parenContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Non_close_parenContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Non_close_parenContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Non_close_parenContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Non_close_parenContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Non_close_parenContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Non_close_parenContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Non_close_parenContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Non_close_parenContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Non_close_parenContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parenContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Non_close_parenContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parenContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Non_close_parenContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Non_close_parenContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Non_close_parenContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Non_close_parenContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Non_close_parenContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Non_close_parenContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Non_close_parenContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Non_close_parenContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Non_close_parenContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Non_close_parenContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Non_close_parenContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parenContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parenContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Non_close_parenContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CloseParen(): TerminalNode' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parensContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parensContext.yml index c710ac4a..87d89ec2 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parensContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Non_close_parensContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Non_close_parensContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Non_close_parensContext(ParserRuleContext | undefined, number)' + - name: Non_close_parensContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Non_close_parensContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Non_close_parensContext(parent: ParserRuleContext | undefined, + new Non_close_parensContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Non_close_parensContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Non_close_parensContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Non_close_parensContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Non_close_parensContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Non_close_parensContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Non_close_parensContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Non_close_parensContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Non_close_parensContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Non_close_parensContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Non_close_parensContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Non_close_parensContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Non_close_parensContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Non_close_parensContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parensContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Non_close_parensContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parensContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Non_close_parensContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Non_close_parensContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Non_close_parensContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Non_close_parensContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Non_close_parensContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Non_close_parensContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Non_close_parensContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Non_close_parensContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Non_close_parensContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Non_close_parensContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Non_close_parensContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parensContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Non_close_parensContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Non_close_parensContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -849,7 +805,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -862,19 +817,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function non_close_paren(): Non_close_parenContext[]' return: description: '' - type: '[]' + type: [] - name: non_close_paren(number) uid: adaptive-expressions.Non_close_parensContext.non_close_paren_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function non_close_paren(i: number): Non_close_parenContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Not.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Not.yml deleted file mode 100644 index 00d66ee7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Not.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Not -uid: adaptive-expressions.Not -package: adaptive-expressions -summary: |- - Check whether an expression is false. - Return true if the expression is false, or return false if true. -fullName: Not -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Not() - uid: adaptive-expressions.Not.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Not](xref:adaptive-expressions.Not) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Not() -properties: - - name: negation - uid: adaptive-expressions.Not.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Not.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Not.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Not.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Not.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NotEqual.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NotEqual.yml deleted file mode 100644 index 732501d9..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NotEqual.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: NotEqual -uid: adaptive-expressions.NotEqual -package: adaptive-expressions -summary: Return true if the two items are not equal. -fullName: NotEqual -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: NotEqual() - uid: adaptive-expressions.NotEqual.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [NotEqual](xref:adaptive-expressions.NotEqual) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new NotEqual() -properties: - - name: negation - uid: adaptive-expressions.NotEqual.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.NotEqual.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.NotEqual.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.NotEqual.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.NotEqual.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberContext.yml index 19b88a8b..451d018d 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: NumberContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NumberContext(ParserRuleContext | undefined, number)' + - name: NumberContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.NumberContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new NumberContext(parent: ParserRuleContext | undefined, invokingState: + new NumberContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.NumberContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.NumberContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.NumberContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.NumberContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.NumberContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.NumberContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.NumberContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: NumberContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.NumberContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.NumberContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.NumberContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.NumberContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.NumberContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.NumberContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.NumberContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.NumberContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.NumberContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.NumberContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.NumberContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.NumberContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.NumberContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.NumberContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.NumberContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.NumberContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.NumberContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.NumberContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.NumberContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.NumberContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.NumberContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.NumberContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function digits(): DigitsContext' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpression.yml index adb77aed..6ed6019c 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpression.yml @@ -9,25 +9,23 @@ fullName: NumberExpression remarks: >- String values are always interpreted as an expression, whether it has '=' prefix or not. -isPreview: false isDeprecated: false type: class constructors: - - name: NumberExpression(number | string | Expression) + - name: NumberExpression(string | number | Expression) uid: adaptive-expressions.NumberExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [NumberExpression](xref:adaptive-expressions.NumberExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new NumberExpression(value?: number | string | Expression)' + content: 'new NumberExpression(value?: string | number | Expression)' parameters: - id: value - type: number | string | - description: > + type: string | number | + description: >- A float `number` or `string` expression which resolves to a float `number`. inheritedProperties: @@ -37,7 +35,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -53,7 +50,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: number' @@ -69,7 +65,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): number' @@ -88,7 +83,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -103,7 +97,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -118,7 +111,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: number }' @@ -133,18 +125,16 @@ inheritedMethods: Inherited From [ExpressionProperty.tryGetValue](xref:adaptive-expressions.ExpressionProperty.tryGetValue) methods: - - name: setValue(number | string | Expression) + - name: setValue(string | number | Expression) uid: adaptive-expressions.NumberExpression.setValue package: adaptive-expressions summary: Set a number value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: number | string | Expression)' + content: 'function setValue(value: string | number | Expression)' parameters: - id: value - type: number | string | - description: | - Value to set. + type: string | number | + description: Value to set. extends: <number> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpressionConverter.yml index d184bb5d..53004465 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberExpressionConverter.yml @@ -7,7 +7,6 @@ summary: >- [NumberExpression](xref:adaptive-expressions.NumberExpression) converter. fullName: NumberExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -18,7 +17,6 @@ methods: Converts a `string` or `number` into a [NumberExpression](xref:adaptive-expressions.NumberExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: Input | NumberExpression): NumberExpression' @@ -27,5 +25,5 @@ methods: type: Input | description: '`string` or `number` to convert.' return: - description: 'The [NumberExpression](xref:adaptive-expressions.NumberExpression).' + description: The [NumberExpression](xref:adaptive-expressions.NumberExpression). type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberTransformEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberTransformEvaluator.yml index fea77abb..154747e8 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberTransformEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumberTransformEvaluator.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Evaluator that transforms a number to another number. fullName: NumberTransformEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: [NumberTransformEvaluator](xref:adaptive-expressions.NumberTransformEvaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,33 +27,31 @@ constructors: description: Name of the built-in function. - id: func type: '(args: any[]) => number' - description: > + description: >- The evaluation function, it takes a list of objects and returns a number. -properties: +inheritedProperties: - name: negation uid: adaptive-expressions.NumberTransformEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: -inheritedProperties: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions.ExpressionEvaluator.negation) - name: returnType uid: adaptive-expressions.NumberTransformEvaluator.returnType package: adaptive-expressions summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -65,63 +61,52 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.NumberTransformEvaluator.type + - name: tryEvaluate + uid: adaptive-expressions.NumberTransformEvaluator.tryEvaluate package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type + summary: Evaluate an expression. + fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: string' + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError return: description: '' - type: string + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError inheritanceDescription: >- Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.NumberTransformEvaluator.tryEvaluate + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions.NumberTransformEvaluator.type package: adaptive-expressions - summary: Evaluate an expression. + summary: Gets the expression type for evaluator. + fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. + content: 'type: string' return: - description: The value and error string that is non-null if there is an error. - type: + description: '' + type: string inheritanceDescription: >- Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) + [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) + - name: validateExpression uid: adaptive-expressions.NumberTransformEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' inheritanceDescription: >- Inherited From [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericAtomContext.yml index 9c9aed05..691ae415 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericAtomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericAtomContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: NumericAtomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new NumericAtomContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.NumericAtomContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.NumericAtomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.NumericAtomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.NumericAtomContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.NumericAtomContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.NumericAtomContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.NumericAtomContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.NumericAtomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.NumericAtomContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.NumericAtomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: NumericAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.NumericAtomContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.NumericAtomContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.NumericAtomContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.NumericAtomContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.NumericAtomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.NumericAtomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.NumericAtomContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.NumericAtomContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.NumericAtomContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.NumericAtomContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.NumericAtomContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.NumericAtomContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.NumericAtomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.NumericAtomContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.NumericAtomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.NumericAtomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.NumericAtomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.NumericAtomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.NumericAtomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.NumericAtomContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.NumericAtomContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.NumericAtomContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.NumericAtomContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.NumericAtomContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.NumericAtomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.NumericAtomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.NumericAtomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.NumericAtomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.NumericAtomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.NumericAtomContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.NumericAtomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.NumericAtomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.NumericAtomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.NumericAtomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.NumericAtomContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -840,7 +881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function NUMBER(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericEvaluator.yml index d50edafa..f8370dcf 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/NumericEvaluator.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Numeric operators that can have 1 or more args. fullName: NumericEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [NumericEvaluator](xref:adaptive-expressions.NumericEvaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new NumericEvaluator(type: string, func: (args: any[]) => any)' @@ -26,33 +24,31 @@ constructors: description: Name of the built-in function. - id: func type: '(args: any[]) => any' - description: > + description: >- The evaluation function, it takes a list of objects and returns a number. -properties: +inheritedProperties: - name: negation uid: adaptive-expressions.NumericEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: -inheritedProperties: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions.ExpressionEvaluator.negation) - name: returnType uid: adaptive-expressions.NumericEvaluator.returnType package: adaptive-expressions summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -62,63 +58,52 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.NumericEvaluator.type + - name: tryEvaluate + uid: adaptive-expressions.NumericEvaluator.tryEvaluate package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type + summary: Evaluate an expression. + fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: string' + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError return: description: '' - type: string + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError inheritanceDescription: >- Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.NumericEvaluator.tryEvaluate + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions.NumericEvaluator.type package: adaptive-expressions - summary: Evaluate an expression. + summary: Gets the expression type for evaluator. + fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. + content: 'type: string' return: - description: The value and error string that is non-null if there is an error. - type: + description: '' + type: string inheritanceDescription: >- Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) + [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) + - name: validateExpression uid: adaptive-expressions.NumericEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' inheritanceDescription: >- Inherited From [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpression.yml index 9d851ac4..3b637853 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpression.yml @@ -11,25 +11,23 @@ fullName: ObjectExpression remarks: >- String values are always interpreted as an expression, whether it has '=' prefix or not. -isPreview: false isDeprecated: false type: class constructors: - - name: ObjectExpression(T | string | Expression) + - name: ObjectExpression(string | Expression | T) uid: adaptive-expressions.ObjectExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [ObjectExpression](xref:adaptive-expressions.ObjectExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ObjectExpression(value?: T | string | Expression)' + content: 'new ObjectExpression(value?: string | Expression | T)' parameters: - id: value - type: T | string | - description: > + type: string | | T + description: >- An object of type `T` or a `string` expression which resolves to a object of type `T`. inheritedProperties: @@ -39,7 +37,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -55,7 +52,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: T' @@ -71,7 +67,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): T' @@ -85,20 +80,18 @@ inheritedMethods: inheritanceDescription: >- Inherited From [ExpressionProperty.getValue](xref:adaptive-expressions.ExpressionProperty.getValue) - - name: setValue(T | string | Expression) + - name: setValue(string | Expression | T) uid: adaptive-expressions.ObjectExpression.setValue package: adaptive-expressions summary: Set the value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: T | string | Expression)' + content: 'function setValue(value: string | Expression | T)' parameters: - id: value - type: T | string | - description: | - Value to set. + type: string | | T + description: Value to set. inheritanceDescription: >- Inherited From [ExpressionProperty.setValue](xref:adaptive-expressions.ExpressionProperty.setValue) @@ -107,7 +100,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -122,7 +114,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -137,7 +128,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: T }' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpressionConverter.yml index 1661de76..e2638980 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ObjectExpressionConverter.yml @@ -8,7 +8,6 @@ summary: >- converter. fullName: ObjectExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -19,7 +18,6 @@ methods: Converts value of type `T` into an [ObjectExpression](xref:adaptive-expressions.ObjectExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,5 +30,5 @@ methods: /><T> description: Value of type `T` to convert. return: - description: 'The [ObjectExpression](xref:adaptive-expressions.ObjectExpression).' + description: The [ObjectExpression](xref:adaptive-expressions.ObjectExpression). type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_charContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_charContext.yml index 0703500d..4585bd4b 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_charContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_charContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Octal_charContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Octal_charContext(ParserRuleContext | undefined, number)' + - name: Octal_charContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Octal_charContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Octal_charContext(parent: ParserRuleContext | undefined, + new Octal_charContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Octal_charContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Octal_charContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Octal_charContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Octal_charContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Octal_charContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Octal_charContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Octal_charContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Octal_charContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Octal_charContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Octal_charContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Octal_charContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Octal_charContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Octal_charContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_charContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Octal_charContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_charContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Octal_charContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Octal_charContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Octal_charContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Octal_charContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Octal_charContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Octal_charContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Octal_charContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Octal_charContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Octal_charContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Octal_charContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Octal_charContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_charContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_charContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Octal_charContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,67 +793,61 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Backslash(): TerminalNode | undefined' + content: 'function Backslash(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D0() uid: adaptive-expressions.Octal_charContext.D0 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D0(): TerminalNode | undefined' + content: 'function D0(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D1() uid: adaptive-expressions.Octal_charContext.D1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D1(): TerminalNode | undefined' + content: 'function D1(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D2() uid: adaptive-expressions.Octal_charContext.D2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D2(): TerminalNode | undefined' + content: 'function D2(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D3() uid: adaptive-expressions.Octal_charContext.D3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D3(): TerminalNode | undefined' + content: 'function D3(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.Octal_charContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -909,7 +860,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -922,19 +872,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function octal_digit(): Octal_digitContext[]' return: description: '' - type: '[]' + type: [] - name: octal_digit(number) uid: adaptive-expressions.Octal_charContext.octal_digit_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function octal_digit(i: number): Octal_digitContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_digitContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_digitContext.yml index daa5f35e..03548066 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_digitContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Octal_digitContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Octal_digitContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Octal_digitContext(ParserRuleContext | undefined, number)' + - name: Octal_digitContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Octal_digitContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Octal_digitContext(parent: ParserRuleContext | undefined, + new Octal_digitContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Octal_digitContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Octal_digitContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Octal_digitContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Octal_digitContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Octal_digitContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Octal_digitContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Octal_digitContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Octal_digitContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Octal_digitContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Octal_digitContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Octal_digitContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Octal_digitContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Octal_digitContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_digitContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Octal_digitContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_digitContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Octal_digitContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Octal_digitContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Octal_digitContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Octal_digitContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Octal_digitContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Octal_digitContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Octal_digitContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Octal_digitContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Octal_digitContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Octal_digitContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Octal_digitContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_digitContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Octal_digitContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Octal_digitContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,103 +793,94 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D0(): TerminalNode | undefined' + content: 'function D0(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D1() uid: adaptive-expressions.Octal_digitContext.D1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D1(): TerminalNode | undefined' + content: 'function D1(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D2() uid: adaptive-expressions.Octal_digitContext.D2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D2(): TerminalNode | undefined' + content: 'function D2(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D3() uid: adaptive-expressions.Octal_digitContext.D3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D3(): TerminalNode | undefined' + content: 'function D3(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D4() uid: adaptive-expressions.Octal_digitContext.D4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D4(): TerminalNode | undefined' + content: 'function D4(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D5() uid: adaptive-expressions.Octal_digitContext.D5 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D5(): TerminalNode | undefined' + content: 'function D5(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D6() uid: adaptive-expressions.Octal_digitContext.D6 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D6(): TerminalNode | undefined' + content: 'function D6(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: D7() uid: adaptive-expressions.Octal_digitContext.D7 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function D7(): TerminalNode | undefined' + content: 'function D7(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.Octal_digitContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -945,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optimizer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optimizer.yml index e5801c3f..c5b22edc 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optimizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optimizer.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Optimize a clause by rewriting it. fullName: Optimizer remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: adaptive-expressions summary: Optionally rewrite a clause. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function optimize(clause: Clause): Clause' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/OptionContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/OptionContext.yml index 3b604a19..4af6618f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/OptionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/OptionContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: OptionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OptionContext(ParserRuleContext | undefined, number)' + - name: OptionContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.OptionContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new OptionContext(parent: ParserRuleContext | undefined, invokingState: + new OptionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.OptionContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.OptionContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.OptionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.OptionContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.OptionContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.OptionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.OptionContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: OptionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.OptionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.OptionContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.OptionContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.OptionContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.OptionContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.OptionContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.OptionContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.OptionContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.OptionContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.OptionContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.OptionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.OptionContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.OptionContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.OptionContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.OptionContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.OptionContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.OptionContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.OptionContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.OptionContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.OptionContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.OptionContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.OptionContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CloseParen(): TerminalNode' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -874,7 +828,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OpenParen(): TerminalNode' @@ -886,19 +839,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function option_flag(): Option_flagContext[]' return: description: '' - type: '[]' + type: [] - name: option_flag(number) uid: adaptive-expressions.OptionContext.option_flag_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function option_flag(i: number): Option_flagContext' @@ -914,7 +865,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function QuestionMark(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Option_flagContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Option_flagContext.yml index 696ca7b5..9ce6aa53 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Option_flagContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Option_flagContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Option_flagContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Option_flagContext(ParserRuleContext | undefined, number)' + - name: Option_flagContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Option_flagContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Option_flagContext(parent: ParserRuleContext | undefined, + new Option_flagContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Option_flagContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Option_flagContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Option_flagContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Option_flagContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Option_flagContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Option_flagContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Option_flagContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Option_flagContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Option_flagContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Option_flagContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Option_flagContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Option_flagContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Option_flagContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Option_flagContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Option_flagContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Option_flagContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Option_flagContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Option_flagContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Option_flagContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Option_flagContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Option_flagContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Option_flagContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Option_flagContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Option_flagContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Option_flagContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Option_flagContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Option_flagContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Option_flagContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Option_flagContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Option_flagContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -849,7 +805,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -862,35 +817,32 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ILC(): TerminalNode | undefined' + content: 'function ILC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MLC() uid: adaptive-expressions.Option_flagContext.MLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MLC(): TerminalNode | undefined' + content: 'function MLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SLC() uid: adaptive-expressions.Option_flagContext.SLC package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SLC(): TerminalNode | undefined' + content: 'function SLC(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optional.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optional.yml deleted file mode 100644 index f8898027..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Optional.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Optional -uid: adaptive-expressions.Optional -package: adaptive-expressions -summary: >- - For the MostSpecificSelector, this is a short hand so that instead of having - to do A & B || A you can do A & optional(B) to mean the same thing. -fullName: Optional -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Optional() - uid: adaptive-expressions.Optional.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Optional](xref:adaptive-expressions.Optional) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Optional() -properties: - - name: negation - uid: adaptive-expressions.Optional.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Optional.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Optional.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Optional.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Optional.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Options.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Options.yml index c2c08ad7..db28fe0a 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Options.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Options.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Options used to define evaluation behaviors. fullName: Options remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,15 +15,13 @@ constructors: Initializes a new instance of the [Options](xref:adaptive-expressions.Options) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Options(opt?: Options)' parameters: - id: opt type: - description: | - Optional. An [Options](xref:adaptive-expressions.Options) instance. + description: Optional. An [Options](xref:adaptive-expressions.Options) instance. properties: - name: locale uid: adaptive-expressions.Options.locale @@ -32,7 +29,6 @@ properties: summary: The locale info for evaluating Expressions. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale: string' @@ -45,7 +41,6 @@ properties: summary: '' fullName: nullSubstitution remarks: '' - isPreview: false isDeprecated: false syntax: content: 'nullSubstitution: (path: string) => unknown' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Or.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Or.yml deleted file mode 100644 index 5afa0226..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Or.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: Or -uid: adaptive-expressions.Or -package: adaptive-expressions -summary: >- - Check whether at least one expression is true. - - Return true if at least one expression is true, or return false if all are - false. -fullName: Or -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Or() - uid: adaptive-expressions.Or.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Or](xref:adaptive-expressions.Or) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Or() -properties: - - name: negation - uid: adaptive-expressions.Or.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Or.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Or.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Or.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Or.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParenthesisExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParenthesisExpContext.yml index 1c509690..531cb732 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParenthesisExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParenthesisExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: ParenthesisExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ParenthesisExpContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.ParenthesisExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.ParenthesisExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.ParenthesisExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.ParenthesisExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.ParenthesisExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.ParenthesisExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.ParenthesisExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.ParenthesisExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.ParenthesisExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.ParenthesisExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ParenthesisExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.ParenthesisExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.ParenthesisExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.ParenthesisExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.ParenthesisExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.ParenthesisExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.ParenthesisExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.ParenthesisExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.ParenthesisExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.ParenthesisExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.ParenthesisExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.ParenthesisExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.ParenthesisExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.ParenthesisExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.ParenthesisExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ParenthesisExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ParenthesisExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ParenthesisExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ParenthesisExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.ParenthesisExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.ParenthesisExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.ParenthesisExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.ParenthesisExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.ParenthesisExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.ParenthesisExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ParenthesisExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ParenthesisExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.ParenthesisExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ParenthesisExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.ParenthesisExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.ParenthesisExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ParenthesisExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ParenthesisExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ParenthesisExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.ParenthesisExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.ParenthesisExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function CLOSE_BRACKET(): TerminalNode' @@ -839,7 +880,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -852,7 +892,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -865,7 +904,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -877,7 +915,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OPEN_BRACKET(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseContext.yml index 2007b003..595ec1b0 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: ParseContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ParseContext(ParserRuleContext | undefined, number)' + - name: ParseContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.ParseContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ParseContext(parent: ParserRuleContext | undefined, invokingState: + new ParseContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.ParseContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.ParseContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.ParseContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.ParseContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.ParseContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.ParseContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.ParseContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ParseContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.ParseContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.ParseContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.ParseContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.ParseContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.ParseContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.ParseContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.ParseContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ParseContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.ParseContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.ParseContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.ParseContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.ParseContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.ParseContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.ParseContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.ParseContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.ParseContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.ParseContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.ParseContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.ParseContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.ParseContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.ParseContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.ParseContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function alternation(): AlternationContext' @@ -848,7 +804,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -861,7 +816,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function EOF(): TerminalNode' @@ -873,7 +827,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseErrorListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseErrorListener.yml index 5dca2237..57ab7337 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseErrorListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ParseErrorListener.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Expression parser error listener. fullName: ParseErrorListener remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,31 +14,29 @@ properties: summary: '' fullName: Instance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Instance: ParseErrorListener = new ParseErrorListener()' + content: 'static Instance: ParseErrorListener' return: description: '' type: methods: - name: >- - syntaxError(Recognizer, T, number, number, string, - RecognitionException | undefined) + syntaxError(Recognizer, T, number, number, string, undefined | + RecognitionException) uid: adaptive-expressions.ParseErrorListener.syntaxError package: adaptive-expressions summary: Throws a syntax error based on the current context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function syntaxError(_recognizer: Recognizer, _offendingSymbol: T, line: number, charPositionInLine: number, _msg: - string, _e: RecognitionException | undefined) + string, _e: undefined | RecognitionException) parameters: - id: _recognizer - type: 'Recognizer<T, any>' + type: Recognizer<T, any> description: An Antlr4 runtime recognizer. - id: _offendingSymbol type: T @@ -54,6 +51,5 @@ methods: type: string description: The error message. - id: _e - type: RecognitionException | undefined - description: | - The `RecognitionException`. + type: undefined | RecognitionException + description: The `RecognitionException`. diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Power.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Power.yml deleted file mode 100644 index c672c10e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Power.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Power -uid: adaptive-expressions.Power -package: adaptive-expressions -summary: Return exponentiation of one number to another. -fullName: Power -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Power() - uid: adaptive-expressions.Power.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Power](xref:adaptive-expressions.Power) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Power() -properties: - - name: negation - uid: adaptive-expressions.Power.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Power.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Power.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Power.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Power.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparer.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparer.yml index 41a6d100..90e7a619 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparer.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparer.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Compare two predicates to identifiy the relationship between them. fullName: PredicateComparer remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Name of the predicate. fullName: predicate remarks: '' - isPreview: false isDeprecated: false syntax: content: 'predicate: string' @@ -23,12 +21,11 @@ properties: description: '' type: string methods: - - name: 'relationship(Expression, Expression)' + - name: relationship(Expression, Expression) uid: adaptive-expressions.PredicateComparer.relationship package: adaptive-expressions summary: Identify the relationship between two predicates. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparers.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparers.yml index 9ac61dfb..2cf23b69 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparers.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PredicateComparers.yml @@ -5,6 +5,6 @@ package: adaptive-expressions summary: '' fullName: PredicateComparers remarks: '' -isPreview: false isDeprecated: false -syntax: 'type PredicateComparers = [key: string]: PredicateComparer' +syntax: | + type PredicateComparers = { [name: string]: PredicateComparer } diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpContext.yml index 85d64763..84c9d02b 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: PrimaryExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new PrimaryExpContext(ctx: ExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.PrimaryExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.PrimaryExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions.ExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.PrimaryExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions.ExpressionContext.childCount) - name: children uid: adaptive-expressions.PrimaryExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions.ExpressionContext.children) - name: exception uid: adaptive-expressions.PrimaryExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions.ExpressionContext.exception) - name: invokingState uid: adaptive-expressions.PrimaryExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions.ExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.PrimaryExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions.ExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.PrimaryExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions.ExpressionContext.parent) - name: payload uid: adaptive-expressions.PrimaryExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions.ExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.PrimaryExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: PrimaryExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.PrimaryExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions.ExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.PrimaryExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions.ExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.PrimaryExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions.ExpressionContext.start) - name: stop uid: adaptive-expressions.PrimaryExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions.ExpressionContext.stop) - name: text uid: adaptive-expressions.PrimaryExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions.ExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.PrimaryExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions.ExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.PrimaryExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.PrimaryExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.PrimaryExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.PrimaryExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.PrimaryExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: copyFrom(ExpressionContext) uid: adaptive-expressions.PrimaryExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions.ExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.PrimaryExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions.ExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.PrimaryExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.PrimaryExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.PrimaryExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions.ExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.PrimaryExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions.ExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.PrimaryExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions.ExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.PrimaryExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions.ExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.PrimaryExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions.ExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.PrimaryExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions.ExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.PrimaryExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.PrimaryExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.PrimaryExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.PrimaryExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.PrimaryExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.PrimaryExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.PrimaryExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.PrimaryExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.PrimaryExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions.ExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.PrimaryExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -840,7 +881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function primaryExpression(): PrimaryExpressionContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpressionContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpressionContext.yml index 073d070e..55ede634 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpressionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/PrimaryExpressionContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: PrimaryExpressionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'PrimaryExpressionContext(ParserRuleContext | undefined, number)' + - name: PrimaryExpressionContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.PrimaryExpressionContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new PrimaryExpressionContext(parent: ParserRuleContext | undefined, + new PrimaryExpressionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.PrimaryExpressionContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.PrimaryExpressionContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.PrimaryExpressionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.PrimaryExpressionContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.PrimaryExpressionContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.PrimaryExpressionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.PrimaryExpressionContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: PrimaryExpressionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.PrimaryExpressionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,40 +216,38 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.PrimaryExpressionContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: accept(ParseTreeVisitor) uid: adaptive-expressions.PrimaryExpressionContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: ParseTreeVisitor): T' @@ -275,22 +258,20 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From RuleContext.accept + inheritanceDescription: Inherited From ParserRuleContext.accept - name: addAnyChild(T) uid: adaptive-expressions.PrimaryExpressionContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -307,7 +288,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -321,7 +301,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -343,7 +322,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -361,7 +339,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -386,7 +363,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -404,20 +380,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.PrimaryExpressionContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -430,7 +404,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ParseTreeListener)' @@ -444,7 +417,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ParseTreeListener)' @@ -458,7 +430,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -470,32 +441,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpressionContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.PrimaryExpressionContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -511,50 +480,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpressionContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.PrimaryExpressionContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.PrimaryExpressionContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -574,7 +540,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -584,7 +549,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.PrimaryExpressionContext.removeLastChild @@ -594,7 +559,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -604,7 +568,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -612,7 +575,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.PrimaryExpressionContext.toInfoString package: adaptive-expressions @@ -620,7 +583,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -637,105 +599,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.PrimaryExpressionContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.PrimaryExpressionContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.PrimaryExpressionContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.PrimaryExpressionContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.PrimaryExpressionContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.PrimaryExpressionContext.toStringTree package: adaptive-expressions @@ -744,7 +700,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -755,75 +710,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.PrimaryExpressionContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpressionContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.PrimaryExpressionContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -833,7 +788,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: copyFrom(PrimaryExpressionContext) @@ -841,7 +796,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier.yml index b6aa249c..1d360ac0 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier.yml @@ -5,16 +5,14 @@ package: adaptive-expressions summary: Quantifier for allowing runtime expansion of expressions. fullName: Quantifier remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Quantifier(string, QuantifierType, string[])' + - name: Quantifier(string, QuantifierType, string[]) uid: adaptive-expressions.Quantifier.constructor package: adaptive-expressions summary: Initializes a new instance of the `Quantifier` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -28,30 +26,27 @@ constructors: type: description: Type of quantifier. - id: bindings - type: 'string[]' - description: | - Possible bindings for variable. + type: string[] + description: Possible bindings for variable. properties: - name: bindings uid: adaptive-expressions.Quantifier.bindings package: adaptive-expressions - summary: Possible bindings for variable. + summary: '' fullName: bindings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bindings: string[]' return: description: '' - type: 'string[]' + type: string[] - name: type uid: adaptive-expressions.Quantifier.type package: adaptive-expressions - summary: Type of quantifier. + summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: QuantifierType' @@ -61,10 +56,9 @@ properties: - name: variable uid: adaptive-expressions.Quantifier.variable package: adaptive-expressions - summary: Name of variable to replace. + summary: '' fullName: variable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'variable: string' @@ -77,7 +71,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierContext.yml index 03695c8c..ba07acb8 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: QuantifierContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'QuantifierContext(ParserRuleContext | undefined, number)' + - name: QuantifierContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.QuantifierContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new QuantifierContext(parent: ParserRuleContext | undefined, + new QuantifierContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.QuantifierContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.QuantifierContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.QuantifierContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.QuantifierContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.QuantifierContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.QuantifierContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.QuantifierContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: QuantifierContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.QuantifierContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.QuantifierContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.QuantifierContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.QuantifierContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.QuantifierContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.QuantifierContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.QuantifierContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.QuantifierContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.QuantifierContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.QuantifierContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.QuantifierContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.QuantifierContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.QuantifierContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.QuantifierContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.QuantifierContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.QuantifierContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.QuantifierContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.QuantifierContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.QuantifierContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.QuantifierContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.QuantifierContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.QuantifierContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,31 +793,28 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CloseBrace(): TerminalNode | undefined' + content: 'function CloseBrace(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Comma() uid: adaptive-expressions.QuantifierContext.Comma package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Comma(): TerminalNode | undefined' + content: 'function Comma(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.QuantifierContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -873,7 +827,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -886,19 +839,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function number(): NumberContext[]' return: description: '' - type: '[]' + type: [] - name: number(number) uid: adaptive-expressions.QuantifierContext.number_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function number(i: number): NumberContext' @@ -914,31 +865,28 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function OpenBrace(): TerminalNode | undefined' + content: 'function OpenBrace(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Plus() uid: adaptive-expressions.QuantifierContext.Plus package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Plus(): TerminalNode | undefined' + content: 'function Plus(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: quantifier_type() uid: adaptive-expressions.QuantifierContext.quantifier_type package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function quantifier_type(): Quantifier_typeContext' @@ -950,23 +898,21 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function QuestionMark(): TerminalNode | undefined' + content: 'function QuestionMark(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Star() uid: adaptive-expressions.QuantifierContext.Star package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Star(): TerminalNode | undefined' + content: 'function Star(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierType.yml index 9c8e2663..b11ab23e 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierType.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/QuantifierType.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Type of quantifier for expanding trigger expressions. fullName: QuantifierType remarks: '' -isPreview: false isDeprecated: false fields: - name: all diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier_typeContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier_typeContext.yml index e9b3e5d6..a3ef4290 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier_typeContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Quantifier_typeContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Quantifier_typeContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Quantifier_typeContext(ParserRuleContext | undefined, number)' + - name: Quantifier_typeContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Quantifier_typeContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Quantifier_typeContext(parent: ParserRuleContext | undefined, + new Quantifier_typeContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Quantifier_typeContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Quantifier_typeContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Quantifier_typeContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Quantifier_typeContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Quantifier_typeContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Quantifier_typeContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Quantifier_typeContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Quantifier_typeContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Quantifier_typeContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Quantifier_typeContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Quantifier_typeContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Quantifier_typeContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Quantifier_typeContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Quantifier_typeContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Quantifier_typeContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Quantifier_typeContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Quantifier_typeContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Quantifier_typeContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Quantifier_typeContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Quantifier_typeContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Quantifier_typeContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Quantifier_typeContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Quantifier_typeContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Quantifier_typeContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Quantifier_typeContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Quantifier_typeContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Quantifier_typeContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Quantifier_typeContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Quantifier_typeContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Quantifier_typeContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,7 +793,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -849,7 +805,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -862,23 +817,21 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Plus(): TerminalNode | undefined' + content: 'function Plus(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: QuestionMark() uid: adaptive-expressions.Quantifier_typeContext.QuestionMark package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function QuestionMark(): TerminalNode | undefined' + content: 'function QuestionMark(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Rand.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Rand.yml deleted file mode 100644 index c4303533..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Rand.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Rand -uid: adaptive-expressions.Rand -package: adaptive-expressions -summary: >- - Return a random integer from a specified range, which is inclusive only at the - starting end. -fullName: Rand -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Rand() - uid: adaptive-expressions.Rand.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Rand](xref:adaptive-expressions.Rand) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Rand() -properties: - - name: negation - uid: adaptive-expressions.Rand.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Rand.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Rand.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Rand.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Rand.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Range.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Range.yml deleted file mode 100644 index da0859b3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Range.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Range -uid: adaptive-expressions.Range -package: adaptive-expressions -summary: >- - Return an integer array that starts from a specified integer with the given - length. -fullName: Range -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Range() - uid: adaptive-expressions.Range.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Range](xref:adaptive-expressions.Range) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Range() -properties: - - name: negation - uid: adaptive-expressions.Range.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Range.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Range.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Range.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Range.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RegexErrorListener.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RegexErrorListener.yml index 8ea3b6f9..9ae0efe1 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RegexErrorListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RegexErrorListener.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Error listener for Regex. fullName: RegexErrorListener remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,31 +14,29 @@ properties: summary: '' fullName: Instance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Instance: RegexErrorListener = new RegexErrorListener()' + content: 'static Instance: RegexErrorListener' return: description: '' type: methods: - name: >- - syntaxError(Recognizer, T, number, number, string, - RecognitionException | undefined) + syntaxError(Recognizer, T, number, number, string, undefined | + RecognitionException) uid: adaptive-expressions.RegexErrorListener.syntaxError package: adaptive-expressions - summary: 'Upon syntax error, notify any interested parties.' + summary: Upon syntax error, notify any interested parties. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function syntaxError(_recognizer: Recognizer, _offendingSymbol: T, _line: number, _charPositionInLine: number, _msg: - string, _e: RecognitionException | undefined) + string, _e: undefined | RecognitionException) parameters: - id: _recognizer - type: 'Recognizer<T, any>' + type: Recognizer<T, any> description: >- What parser got the error. From this object, you can access the context as well as the input stream. @@ -58,7 +55,7 @@ methods: type: string description: Message to emit. - id: _e - type: RecognitionException | undefined - description: > + type: undefined | RecognitionException + description: >- Exception generated by the parser that led to the reporting of an error. diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RelationshipType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RelationshipType.yml index ed1155b8..fc380ee8 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RelationshipType.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RelationshipType.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Relationship between trigger expressions. fullName: RelationshipType remarks: '' -isPreview: false isDeprecated: false fields: - name: equal diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RemoveProperty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RemoveProperty.yml deleted file mode 100644 index 4b0b1568..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/RemoveProperty.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: RemoveProperty -uid: adaptive-expressions.RemoveProperty -package: adaptive-expressions -summary: Remove a property from an object and return the updated object. -fullName: RemoveProperty -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: RemoveProperty() - uid: adaptive-expressions.RemoveProperty.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [RemoveProperty](xref:adaptive-expressions.RemoveProperty) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new RemoveProperty() -properties: - - name: negation - uid: adaptive-expressions.RemoveProperty.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.RemoveProperty.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.RemoveProperty.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.RemoveProperty.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.RemoveProperty.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Replace.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Replace.yml deleted file mode 100644 index 672966de..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Replace.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Replace -uid: adaptive-expressions.Replace -package: adaptive-expressions -summary: |- - Replace a substring with the specified string, and return the result string. - This function is case-sensitive. -fullName: Replace -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Replace() - uid: adaptive-expressions.Replace.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Replace](xref:adaptive-expressions.Replace) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Replace() -properties: - - name: negation - uid: adaptive-expressions.Replace.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Replace.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Replace.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Replace.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Replace.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReplaceIgnoreCase.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReplaceIgnoreCase.yml deleted file mode 100644 index c2895f15..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReplaceIgnoreCase.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: ReplaceIgnoreCase -uid: adaptive-expressions.ReplaceIgnoreCase -package: adaptive-expressions -summary: |- - Replace a substring with the specified string, and return the result string. - This function is case-insensitive. -fullName: ReplaceIgnoreCase -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: ReplaceIgnoreCase() - uid: adaptive-expressions.ReplaceIgnoreCase.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [ReplaceIgnoreCase](xref:adaptive-expressions.ReplaceIgnoreCase) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ReplaceIgnoreCase() -properties: - - name: negation - uid: adaptive-expressions.ReplaceIgnoreCase.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.ReplaceIgnoreCase.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.ReplaceIgnoreCase.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ReplaceIgnoreCase.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.ReplaceIgnoreCase.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReturnType.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReturnType.yml index 5b2066c1..30c14a35 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReturnType.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ReturnType.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Type expected from evalating an expression. fullName: ReturnType remarks: '' -isPreview: false isDeprecated: false fields: - name: Boolean @@ -16,7 +15,7 @@ fields: - name: Number uid: adaptive-expressions.ReturnType.Number package: adaptive-expressions - summary: 'Numerical value like int, float, double, ...' + summary: Numerical value like int, float, double, ... numericValue: 2 - name: Object uid: adaptive-expressions.ReturnType.Object diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Reverse.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Reverse.yml deleted file mode 100644 index 1cbd67b0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Reverse.yml +++ /dev/null @@ -1,114 +0,0 @@ -### YamlMime:TSType -name: Reverse -uid: adaptive-expressions.Reverse -package: adaptive-expressions -summary: Reverses the order of the elements in a String or Array. -fullName: Reverse -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Reverse() - uid: adaptive-expressions.Reverse.constructor - package: adaptive-expressions - summary: Initializes a new instance of the `Reverse` class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Reverse() -properties: - - name: negation - uid: adaptive-expressions.Reverse.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Reverse.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Reverse.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Reverse.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Reverse.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Round.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Round.yml deleted file mode 100644 index a30826bb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Round.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Round -uid: adaptive-expressions.Round -package: adaptive-expressions -summary: Rounds a number value to the nearest integer. -fullName: Round -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Round() - uid: adaptive-expressions.Round.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Round](xref:adaptive-expressions.Round) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Round() -properties: - - name: negation - uid: adaptive-expressions.Round.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Round.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Round.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Round.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Round.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Select.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Select.yml deleted file mode 100644 index 83d657d8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Select.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Select -uid: adaptive-expressions.Select -package: adaptive-expressions -summary: Operate on each element and return the new collection of transformed elements. -fullName: Select -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Select() - uid: adaptive-expressions.Select.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Select](xref:adaptive-expressions.Select) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Select() -properties: - - name: negation - uid: adaptive-expressions.Select.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Select.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Select.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Select.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Select.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SentenceCase.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SentenceCase.yml deleted file mode 100644 index 74f3b7b0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SentenceCase.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: SentenceCase -uid: adaptive-expressions.SentenceCase -package: adaptive-expressions -summary: Capitalizing only the first word and leave others lowercase. -fullName: SentenceCase -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SentenceCase() - uid: adaptive-expressions.SentenceCase.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SentenceCase](xref:adaptive-expressions.SentenceCase) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SentenceCase() -properties: - - name: negation - uid: adaptive-expressions.SentenceCase.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SentenceCase.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SentenceCase.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SentenceCase.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SentenceCase.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetPathToValue.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetPathToValue.yml deleted file mode 100644 index 0bc3c59d..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetPathToValue.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: SetPathToValue -uid: adaptive-expressions.SetPathToValue -package: adaptive-expressions -summary: Set path in a JSON object to value. -fullName: SetPathToValue -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SetPathToValue() - uid: adaptive-expressions.SetPathToValue.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SetPathToValue](xref:adaptive-expressions.SetPathToValue) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SetPathToValue() -properties: - - name: negation - uid: adaptive-expressions.SetPathToValue.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SetPathToValue.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SetPathToValue.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SetPathToValue.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SetPathToValue.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetProperty.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetProperty.yml deleted file mode 100644 index fc42478f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SetProperty.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: SetProperty -uid: adaptive-expressions.SetProperty -package: adaptive-expressions -summary: Set the value of an object's property and return the updated object. -fullName: SetProperty -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SetProperty() - uid: adaptive-expressions.SetProperty.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SetProperty](xref:adaptive-expressions.SetProperty) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SetProperty() -properties: - - name: negation - uid: adaptive-expressions.SetProperty.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SetProperty.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SetProperty.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SetProperty.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SetProperty.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_atomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_atomContext.yml index 0fc99a95..f32def50 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_atomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_atomContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Shared_atomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Shared_atomContext(ParserRuleContext | undefined, number)' + - name: Shared_atomContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Shared_atomContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Shared_atomContext(parent: ParserRuleContext | undefined, + new Shared_atomContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Shared_atomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Shared_atomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Shared_atomContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Shared_atomContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Shared_atomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Shared_atomContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Shared_atomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Shared_atomContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Shared_atomContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Shared_atomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Shared_atomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Shared_atomContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Shared_atomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_atomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Shared_atomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_atomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Shared_atomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Shared_atomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Shared_atomContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Shared_atomContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Shared_atomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Shared_atomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Shared_atomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Shared_atomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Shared_atomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Shared_atomContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Shared_atomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_atomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_atomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Shared_atomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,55 +793,50 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CharWithoutProperty(): TerminalNode | undefined' + content: 'function CharWithoutProperty(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CharWithProperty() uid: adaptive-expressions.Shared_atomContext.CharWithProperty package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CharWithProperty(): TerminalNode | undefined' + content: 'function CharWithProperty(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ControlChar() uid: adaptive-expressions.Shared_atomContext.ControlChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ControlChar(): TerminalNode | undefined' + content: 'function ControlChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DecimalDigit() uid: adaptive-expressions.Shared_atomContext.DecimalDigit package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DecimalDigit(): TerminalNode | undefined' + content: 'function DecimalDigit(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(CommonRegexListener) uid: adaptive-expressions.Shared_atomContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -897,7 +849,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -910,59 +861,54 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NotDecimalDigit(): TerminalNode | undefined' + content: 'function NotDecimalDigit(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: NotWhiteSpace() uid: adaptive-expressions.Shared_atomContext.NotWhiteSpace package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NotWhiteSpace(): TerminalNode | undefined' + content: 'function NotWhiteSpace(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: NotWordChar() uid: adaptive-expressions.Shared_atomContext.NotWordChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NotWordChar(): TerminalNode | undefined' + content: 'function NotWordChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: WhiteSpace() uid: adaptive-expressions.Shared_atomContext.WhiteSpace package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function WhiteSpace(): TerminalNode | undefined' + content: 'function WhiteSpace(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: WordChar() uid: adaptive-expressions.Shared_atomContext.WordChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function WordChar(): TerminalNode | undefined' + content: 'function WordChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_literalContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_literalContext.yml index 6ecf75ee..b856e42f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_literalContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Shared_literalContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: Shared_literalContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Shared_literalContext(ParserRuleContext | undefined, number)' + - name: Shared_literalContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.Shared_literalContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Shared_literalContext(parent: ParserRuleContext | undefined, + new Shared_literalContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.Shared_literalContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.Shared_literalContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.Shared_literalContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.Shared_literalContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.Shared_literalContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.Shared_literalContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.Shared_literalContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: Shared_literalContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.Shared_literalContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.Shared_literalContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.Shared_literalContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.Shared_literalContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.Shared_literalContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_literalContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.Shared_literalContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_literalContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.Shared_literalContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.Shared_literalContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.Shared_literalContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.Shared_literalContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.Shared_literalContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.Shared_literalContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.Shared_literalContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.Shared_literalContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.Shared_literalContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.Shared_literalContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.Shared_literalContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_literalContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.Shared_literalContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.Shared_literalContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(CommonRegexVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: CommonRegexVisitor): Result' @@ -836,103 +793,94 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Ampersand(): TerminalNode | undefined' + content: 'function Ampersand(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: BellChar() uid: adaptive-expressions.Shared_literalContext.BellChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function BellChar(): TerminalNode | undefined' + content: 'function BellChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: BlockQuoted() uid: adaptive-expressions.Shared_literalContext.BlockQuoted package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function BlockQuoted(): TerminalNode | undefined' + content: 'function BlockQuoted(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CarriageReturn() uid: adaptive-expressions.Shared_literalContext.CarriageReturn package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CarriageReturn(): TerminalNode | undefined' + content: 'function CarriageReturn(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: CloseBrace() uid: adaptive-expressions.Shared_literalContext.CloseBrace package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CloseBrace(): TerminalNode | undefined' + content: 'function CloseBrace(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Colon() uid: adaptive-expressions.Shared_literalContext.Colon package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Colon(): TerminalNode | undefined' + content: 'function Colon(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Comma() uid: adaptive-expressions.Shared_literalContext.Comma package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Comma(): TerminalNode | undefined' + content: 'function Comma(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: digit() uid: adaptive-expressions.Shared_literalContext.digit package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function digit(): DigitContext | undefined' + content: 'function digit(): undefined | DigitContext' return: description: '' - type: | undefined + type: undefined | - name: enterRule(CommonRegexListener) uid: adaptive-expressions.Shared_literalContext.enterRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: CommonRegexListener)' @@ -945,43 +893,39 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Equals(): TerminalNode | undefined' + content: 'function Equals(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: EscapeChar() uid: adaptive-expressions.Shared_literalContext.EscapeChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function EscapeChar(): TerminalNode | undefined' + content: 'function EscapeChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Exclamation() uid: adaptive-expressions.Shared_literalContext.Exclamation package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Exclamation(): TerminalNode | undefined' + content: 'function Exclamation(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: exitRule(CommonRegexListener) uid: adaptive-expressions.Shared_literalContext.exitRule package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: CommonRegexListener)' @@ -994,179 +938,164 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function FormFeed(): TerminalNode | undefined' + content: 'function FormFeed(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: GreaterThan() uid: adaptive-expressions.Shared_literalContext.GreaterThan package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function GreaterThan(): TerminalNode | undefined' + content: 'function GreaterThan(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Hash() uid: adaptive-expressions.Shared_literalContext.Hash package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Hash(): TerminalNode | undefined' + content: 'function Hash(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: HexChar() uid: adaptive-expressions.Shared_literalContext.HexChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function HexChar(): TerminalNode | undefined' + content: 'function HexChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Hyphen() uid: adaptive-expressions.Shared_literalContext.Hyphen package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Hyphen(): TerminalNode | undefined' + content: 'function Hyphen(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: LessThan() uid: adaptive-expressions.Shared_literalContext.LessThan package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function LessThan(): TerminalNode | undefined' + content: 'function LessThan(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: letter() uid: adaptive-expressions.Shared_literalContext.letter package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function letter(): LetterContext | undefined' + content: 'function letter(): undefined | LetterContext' return: description: '' - type: | undefined + type: undefined | - name: NewLine() uid: adaptive-expressions.Shared_literalContext.NewLine package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NewLine(): TerminalNode | undefined' + content: 'function NewLine(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: octal_char() uid: adaptive-expressions.Shared_literalContext.octal_char package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function octal_char(): Octal_charContext | undefined' + content: 'function octal_char(): undefined | Octal_charContext' return: description: '' - type: | undefined + type: undefined | - name: OpenBrace() uid: adaptive-expressions.Shared_literalContext.OpenBrace package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function OpenBrace(): TerminalNode | undefined' + content: 'function OpenBrace(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: OtherChar() uid: adaptive-expressions.Shared_literalContext.OtherChar package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function OtherChar(): TerminalNode | undefined' + content: 'function OtherChar(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Quoted() uid: adaptive-expressions.Shared_literalContext.Quoted package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Quoted(): TerminalNode | undefined' + content: 'function Quoted(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SingleQuote() uid: adaptive-expressions.Shared_literalContext.SingleQuote package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SingleQuote(): TerminalNode | undefined' + content: 'function SingleQuote(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Tab() uid: adaptive-expressions.Shared_literalContext.Tab package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Tab(): TerminalNode | undefined' + content: 'function Tab(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: Underscore() uid: adaptive-expressions.Shared_literalContext.Underscore package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function Underscore(): TerminalNode | undefined' + content: 'function Underscore(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SimpleObjectMemory.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SimpleObjectMemory.yml index 31b257a4..69bbcfa3 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SimpleObjectMemory.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SimpleObjectMemory.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Simple implement of MemoryInterface fullName: SimpleObjectMemory remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,22 +18,19 @@ constructors: This wraps a simple object as [MemoryInterface](xref:adaptive-expressions.MemoryInterface). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SimpleObjectMemory(memory: any)' parameters: - id: memory type: any - description: | - The object to wrap. + description: The object to wrap. methods: - name: getValue(string) uid: adaptive-expressions.SimpleObjectMemory.getValue package: adaptive-expressions summary: Gets the value from a given path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getValue(path: string): any' @@ -45,7 +41,7 @@ methods: return: description: The value in the given path or undefined. type: any - - name: 'setValue(string, any)' + - name: setValue(string, any) uid: adaptive-expressions.SimpleObjectMemory.setValue package: adaptive-expressions summary: >- @@ -61,7 +57,6 @@ methods: you can implement a customzied Scope that support such behavior remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setValue(path: string, input: any)' @@ -71,8 +66,7 @@ methods: description: Memory path. - id: input type: any - description: | - Value to set. + description: Value to set. - name: toString() uid: adaptive-expressions.SimpleObjectMemory.toString package: adaptive-expressions @@ -80,7 +74,6 @@ methods: Returns a string that represents the current [SimpleObjectMemory](xref:adaptive-expressions.SimpleObjectMemory) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -97,7 +90,6 @@ methods: Returns the version info of [SimpleObjectMemory](xref:adaptive-expressions.SimpleObjectMemory). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function version(): string' @@ -109,7 +101,6 @@ methods: package: adaptive-expressions summary: Transfer a common object to simple memory. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function wrap(obj: any): MemoryInterface' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Skip.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Skip.yml deleted file mode 100644 index bccbfb25..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Skip.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Skip -uid: adaptive-expressions.Skip -package: adaptive-expressions -summary: 'Remove items from the front of a collection, and return all the other items.' -fullName: Skip -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Skip() - uid: adaptive-expressions.Skip.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Skip](xref:adaptive-expressions.Skip) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Skip() -properties: - - name: negation - uid: adaptive-expressions.Skip.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Skip.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Skip.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Skip.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Skip.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortBy.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortBy.yml deleted file mode 100644 index 49fd2c56..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortBy.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: SortBy -uid: adaptive-expressions.SortBy -package: adaptive-expressions -summary: >- - Sort elements in the collection in ascending order and return the sorted - collection. -fullName: SortBy -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SortBy() - uid: adaptive-expressions.SortBy.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SortBy](xref:adaptive-expressions.SortBy) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SortBy() -properties: - - name: negation - uid: adaptive-expressions.SortBy.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SortBy.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SortBy.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SortBy.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SortBy.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortByDescending.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortByDescending.yml deleted file mode 100644 index ae884954..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SortByDescending.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: SortByDescending -uid: adaptive-expressions.SortByDescending -package: adaptive-expressions -summary: >- - Sort elements in the collection in descending order, and return the sorted - collection. -fullName: SortByDescending -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SortByDescending() - uid: adaptive-expressions.SortByDescending.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SortByDescending](xref:adaptive-expressions.SortByDescending) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SortByDescending() -properties: - - name: negation - uid: adaptive-expressions.SortByDescending.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SortByDescending.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SortByDescending.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SortByDescending.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SortByDescending.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Split.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Split.yml deleted file mode 100644 index c4583338..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Split.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Split -uid: adaptive-expressions.Split -package: adaptive-expressions -summary: >- - Return an array that contains substrings, separated by commas, based on the - specified delimiter character in the original string. -fullName: Split -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Split() - uid: adaptive-expressions.Split.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Split](xref:adaptive-expressions.Split) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Split() -properties: - - name: negation - uid: adaptive-expressions.Split.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Split.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Split.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Split.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Split.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sqrt.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sqrt.yml deleted file mode 100644 index 76761a49..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sqrt.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Sqrt -uid: adaptive-expressions.Sqrt -package: adaptive-expressions -summary: Returns the square root of a specified number. -fullName: Sqrt -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Sqrt() - uid: adaptive-expressions.Sqrt.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [SortBy](xref:adaptive-expressions.Sqrt) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Sqrt() -properties: - - name: negation - uid: adaptive-expressions.Sqrt.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Sqrt.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Sqrt.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Sqrt.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Sqrt.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StackedMemory.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StackedMemory.yml index 4053d9cc..987dc264 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StackedMemory.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StackedMemory.yml @@ -7,33 +7,42 @@ summary: |- Memory variables have a hierarchical relationship. fullName: StackedMemory remarks: '' -isPreview: false isDeprecated: false type: class -properties: - - name: Array - uid: adaptive-expressions.StackedMemory.Array +constructors: + - name: StackedMemory(MemoryInterface[]) + uid: adaptive-expressions.StackedMemory.constructor_1 package: adaptive-expressions summary: '' - fullName: Array remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Array: ArrayConstructor' - return: - description: '' - type: ArrayConstructor + content: 'new StackedMemory(items: MemoryInterface[])' + parameters: + - id: items + type: [] + description: '' + - name: StackedMemory(number) + uid: adaptive-expressions.StackedMemory.constructor + package: adaptive-expressions + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new StackedMemory(arrayLength: number)' + parameters: + - id: arrayLength + type: number + description: '' inheritedProperties: - name: length uid: adaptive-expressions.StackedMemory.length package: adaptive-expressions summary: >- Gets or sets the length of the array. This is a number one higher than the - highest element defined in an array. + highest index in the array. fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: 'length: number' @@ -41,13 +50,69 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From Array.length + - name: '[species]' + uid: adaptive-expressions.StackedMemory.[species] + package: adaptive-expressions + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: ArrayConstructor' + return: + description: '' + type: ArrayConstructor + inheritanceDescription: Inherited From Array.__@species@2759 inheritedMethods: - - name: 'concat(ConcatArray[])' + - name: at(number) + uid: adaptive-expressions.StackedMemory.at + package: adaptive-expressions + summary: |- + Takes an integer value and returns the item at that index, + allowing for positive and negative integers. + Negative integers count back from the last item in the array. + remarks: '' + isDeprecated: false + syntax: + content: 'function at(index: number): undefined | MemoryInterface' + parameters: + - id: index + type: number + description: '' + return: + description: '' + type: undefined | + inheritanceDescription: Inherited From Array.at + - name: concat((MemoryInterface | ConcatArray)[]) + uid: adaptive-expressions.StackedMemory.concat_1 + package: adaptive-expressions + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. + remarks: '' + isDeprecated: false + syntax: + content: >- + function concat(items: (MemoryInterface | + ConcatArray)[]): MemoryInterface[] + parameters: + - id: items + type: >- + ( | + ConcatArray<>)[] + description: Additional arrays and/or items to add to the end of the array. + return: + description: '' + type: [] + inheritanceDescription: Inherited From Array.concat + - name: concat(ConcatArray[]) uid: adaptive-expressions.StackedMemory.concat package: adaptive-expressions - summary: Combines two or more arrays. + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -58,62 +123,169 @@ inheritedMethods: type: >- ConcatArray<>[] - description: | - Additional items to add to the end of array1. + description: Additional arrays and/or items to add to the end of the array. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.concat - - name: 'concat(T | ConcatArray[])' - uid: adaptive-expressions.StackedMemory.concat_1 + - name: copyWithin(number, number, number) + uid: adaptive-expressions.StackedMemory.copyWithin package: adaptive-expressions - summary: Combines two or more arrays. + summary: >- + Returns the this object after copying a section of the array identified by + start and end + + to the same array starting at position target remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function concat(items: T | ConcatArray[]): MemoryInterface[]' + content: >- + function copyWithin(target: number, start: number, end?: number): + StackedMemory parameters: - - id: items - type: 'T | ConcatArray<T>[]' - description: | - Additional items to add to the end of array1. + - id: target + type: number + description: >- + If target is negative, it is treated as length+target where length + is the + + length of the array. + - id: start + type: number + description: >- + If start is negative, it is treated as length+start. If end is + negative, it + + is treated as length+end. + - id: end + type: number + description: >- + If not specified, length of the this object is used as its default + value. return: description: '' - type: '[]' - inheritanceDescription: Inherited From Array.concat + type: + inheritanceDescription: Inherited From Array.copyWithin + - name: entries() + uid: adaptive-expressions.StackedMemory.entries + package: adaptive-expressions + summary: Returns an iterable of key, value pairs for every entry in the array + remarks: '' + isDeprecated: false + syntax: + content: 'function entries(): IterableIterator<[number, MemoryInterface]>' + return: + description: '' + type: IterableIterator<[number, MemoryInterface]> + inheritanceDescription: Inherited From Array.entries - name: >- every((value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown, any) - uid: adaptive-expressions.StackedMemory.every + uid: adaptive-expressions.StackedMemory.every_1 package: adaptive-expressions summary: Determines whether all the members of an array satisfy the specified test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function every(callbackfn: (value: MemoryInterface, index: number, - array: MemoryInterface[]) => unknown, thisArg?: any): boolean + function every(predicate: (value: MemoryInterface, index: number, array: + MemoryInterface[]) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn + - id: predicate type: >- (value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown description: >- A function that accepts up to three arguments. The every method - calls the callbackfn function for each element in array1 until the - callbackfn returns false, or until the end of the array. + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn - function. If thisArg is omitted, undefined is used as the this - value. + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. return: description: '' type: boolean inheritanceDescription: Inherited From Array.every + - name: >- + every((value: MemoryInterface, index: number, array: MemoryInterface[]) + => value, any) + uid: adaptive-expressions.StackedMemory.every + package: adaptive-expressions + summary: Determines whether all the members of an array satisfy the specified test. + remarks: '' + isDeprecated: false + syntax: + content: >- + function every(predicate: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => value, thisArg?: any): this + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, array: MemoryInterface[]) + => value + description: >- + A function that accepts up to three arguments. The every method + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: this + inheritanceDescription: Inherited From Array.every + - name: fill(MemoryInterface, number, number) + uid: adaptive-expressions.StackedMemory.fill + package: adaptive-expressions + summary: >- + Changes all array elements from `start` to `end` index to a static `value` + and returns the modified array + remarks: '' + isDeprecated: false + syntax: + content: >- + function fill(value: MemoryInterface, start?: number, end?: number): + StackedMemory + parameters: + - id: value + type: + description: value to fill array section with + - id: start + type: number + description: >- + index to start filling the array at. If start is negative, it is + treated as + + length+start where length is the length of the array. + - id: end + type: number + description: >- + index to stop filling the array at. If end is negative, it is + treated as + + length+end. + return: + description: '' + type: + inheritanceDescription: Inherited From Array.fill - name: >- filter((value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown, any) @@ -123,65 +295,232 @@ inheritedMethods: Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: MemoryInterface, index: number, + function filter(predicate: (value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown, thisArg?: any): MemoryInterface[] parameters: - - id: callbackfn + - id: predicate type: >- (value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown description: >- A function that accepts up to three arguments. The filter method - calls the callbackfn function one time for each element in the - array. + calls the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.filter - name: >- filter((value: MemoryInterface, index: number, array: - MemoryInterface[]) => boolean, any) + MemoryInterface[]) => value, any) uid: adaptive-expressions.StackedMemory.filter package: adaptive-expressions summary: >- Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: MemoryInterface, index: number, - array: MemoryInterface[]) => boolean, thisArg?: any): S[] + function filter(predicate: (value: MemoryInterface, index: number, + array: MemoryInterface[]) => value, thisArg?: any): S[] parameters: - - id: callbackfn + - id: predicate type: >- (value: MemoryInterface, index: number, array: MemoryInterface[]) - => boolean + => value description: >- A function that accepts up to three arguments. The filter method - calls the callbackfn function one time for each element in the - array. + calls the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'S[]' + type: S[] inheritanceDescription: Inherited From Array.filter + - name: >- + find((value: MemoryInterface, index: number, obj: MemoryInterface[]) => + unknown, any) + uid: adaptive-expressions.StackedMemory.find_1 + package: adaptive-expressions + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function find(predicate: (value: MemoryInterface, index: number, obj: + MemoryInterface[]) => unknown, thisArg?: any): undefined | + MemoryInterface + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, obj: MemoryInterface[]) + => unknown + description: '' + - id: thisArg + type: any + description: '' + return: + description: '' + type: undefined | + inheritanceDescription: Inherited From Array.find + - name: >- + find((this: void, value: MemoryInterface, index: number, obj: + MemoryInterface[]) => value, any) + uid: adaptive-expressions.StackedMemory.find + package: adaptive-expressions + summary: >- + Returns the value of the first element in the array where predicate is + true, and undefined + + otherwise. + remarks: '' + isDeprecated: false + syntax: + content: >- + function find(predicate: (this: void, value: MemoryInterface, index: + number, obj: MemoryInterface[]) => value, thisArg?: any): undefined | S + parameters: + - id: predicate + type: >- + (this: void, value: MemoryInterface, index: number, obj: + MemoryInterface[]) => value + description: >- + find calls predicate once for each element of the array, in + ascending + + order, until it finds one where predicate returns true. If such an + element is found, find + + immediately returns that element value. Otherwise, find returns + undefined. + - id: thisArg + type: any + description: >- + If provided, it will be used as the this value for each invocation + of + + predicate. If it is not provided, undefined is used instead. + return: + description: '' + type: undefined | S + inheritanceDescription: Inherited From Array.find + - name: >- + findIndex((value: MemoryInterface, index: number, obj: MemoryInterface[]) + => unknown, any) + uid: adaptive-expressions.StackedMemory.findIndex + package: adaptive-expressions + summary: >- + Returns the index of the first element in the array where predicate is + true, and -1 + + otherwise. + remarks: '' + isDeprecated: false + syntax: + content: >- + function findIndex(predicate: (value: MemoryInterface, index: number, + obj: MemoryInterface[]) => unknown, thisArg?: any): number + parameters: + - id: predicate + type: >- + (value: MemoryInterface, index: number, obj: MemoryInterface[]) + => unknown + description: >- + find calls predicate once for each element of the array, in + ascending + + order, until it finds one where predicate returns true. If such an + element is found, + + findIndex immediately returns that element index. Otherwise, + findIndex returns -1. + - id: thisArg + type: any + description: >- + If provided, it will be used as the this value for each invocation + of + + predicate. If it is not provided, undefined is used instead. + return: + description: '' + type: number + inheritanceDescription: Inherited From Array.findIndex + - name: flat(A, D) + uid: adaptive-expressions.StackedMemory.flat + package: adaptive-expressions + summary: >- + Returns a new array with all sub-array elements concatenated into it + recursively up to the + + specified depth. + remarks: '' + isDeprecated: false + syntax: + content: 'function flat(this: A, depth?: D): FlatArray[]' + parameters: + - id: this + type: A + description: '' + - id: depth + type: D + description: The maximum recursion depth + return: + description: '' + type: FlatArray<A, D>[] + inheritanceDescription: Inherited From Array.flat + - name: >- + flatMap((this: This, value: MemoryInterface, index: number, + array: MemoryInterface[]) => U | (readonly U[]), This) + uid: adaptive-expressions.StackedMemory.flatMap + package: adaptive-expressions + summary: >- + Calls a defined callback function on each element of an array. Then, + flattens the result into + + a new array. + + This is identical to a map followed by flat with depth 1. + remarks: '' + isDeprecated: false + syntax: + content: >- + function flatMap(callback: (this: This, value: MemoryInterface, + index: number, array: MemoryInterface[]) => U | (readonly U[]), + thisArg?: This): U[] + parameters: + - id: callback + type: >- + (this: This, value: MemoryInterface, index: number, array: + MemoryInterface[]) => U | (readonly U[]) + description: >- + A function that accepts up to three arguments. The flatMap method + calls the + + callback function one time for each element in the array. + - id: thisArg + type: This + description: >- + An object to which the this keyword can refer in the callback + function. If + + thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.flatMap - name: >- forEach((value: MemoryInterface, index: number, array: MemoryInterface[]) => void, any) @@ -189,7 +528,6 @@ inheritedMethods: package: adaptive-expressions summary: Performs the specified action for each element in an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -205,17 +543,123 @@ inheritedMethods: callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. inheritanceDescription: Inherited From Array.forEach - - name: 'indexOf(MemoryInterface, number)' + - name: 'from(ArrayLike, (v: T, k: number) => U, any)' + uid: adaptive-expressions.StackedMemory.from_1 + package: adaptive-expressions + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(arrayLike: ArrayLike, mapfn: (v: T, k: + number) => U, thisArg?: any): U[] + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: 'from(Iterable | ArrayLike, (v: T, k: number) => U, any)' + uid: adaptive-expressions.StackedMemory.from_3 + package: adaptive-expressions + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(iterable: Iterable | ArrayLike, mapfn: + (v: T, k: number) => U, thisArg?: any): U[] + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: from(ArrayLike) + uid: adaptive-expressions.StackedMemory.from + package: adaptive-expressions + summary: Creates an array from an array-like object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(arrayLike: ArrayLike): T[]' + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: from(Iterable | ArrayLike) + uid: adaptive-expressions.StackedMemory.from_2 + package: adaptive-expressions + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(iterable: Iterable | ArrayLike): T[]' + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: includes(MemoryInterface, number) + uid: adaptive-expressions.StackedMemory.includes + package: adaptive-expressions + summary: >- + Determines whether an array includes a certain element, returning true or + false as appropriate. + remarks: '' + isDeprecated: false + syntax: + content: >- + function includes(searchElement: MemoryInterface, fromIndex?: number): + boolean + parameters: + - id: searchElement + type: + description: The element to search for. + - id: fromIndex + type: number + description: >- + The position in this array at which to begin searching for + searchElement. + return: + description: '' + type: boolean + inheritanceDescription: Inherited From Array.includes + - name: indexOf(MemoryInterface, number) uid: adaptive-expressions.StackedMemory.indexOf package: adaptive-expressions - summary: Returns the index of the first occurrence of a value in an array. + summary: >- + Returns the index of the first occurrence of a value in an array, or -1 if + it is not present. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -227,41 +671,69 @@ inheritedMethods: description: The value to locate in the array. - id: fromIndex type: number - description: > + description: >- The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. return: description: '' type: number inheritanceDescription: Inherited From Array.indexOf + - name: isArray(any) + uid: adaptive-expressions.StackedMemory.isArray + package: adaptive-expressions + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function isArray(arg: any): arg' + parameters: + - id: arg + type: any + description: '' + return: + description: '' + type: arg + inheritanceDescription: Inherited From Array.isArray - name: join(string) uid: adaptive-expressions.StackedMemory.join package: adaptive-expressions summary: >- - Adds all the elements of an array separated by the specified separator - string. + Adds all the elements of an array into a string, separated by the + specified separator string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function join(separator?: string): string' parameters: - id: separator type: string - description: > - A string used to separate one element of an array from the next in - the resulting String. If omitted, the array elements are separated + description: >- + A string used to separate one element of the array from the next in + the resulting string. If omitted, the array elements are separated with a comma. return: description: '' type: string inheritanceDescription: Inherited From Array.join - - name: 'lastIndexOf(MemoryInterface, number)' + - name: keys() + uid: adaptive-expressions.StackedMemory.keys + package: adaptive-expressions + summary: Returns an iterable of keys in the array + remarks: '' + isDeprecated: false + syntax: + content: 'function keys(): IterableIterator' + return: + description: '' + type: IterableIterator<number> + inheritanceDescription: Inherited From Array.keys + - name: lastIndexOf(MemoryInterface, number) uid: adaptive-expressions.StackedMemory.lastIndexOf package: adaptive-expressions - summary: Returns the index of the last occurrence of a specified value in an array. + summary: >- + Returns the index of the last occurrence of a specified value in an array, + or -1 if it is not present. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -273,9 +745,9 @@ inheritedMethods: description: The value to locate in the array. - id: fromIndex type: number - description: > - The array index at which to begin the search. If fromIndex is - omitted, the search starts at the last index in the array. + description: >- + The array index at which to begin searching backward. If fromIndex + is omitted, the search starts at the last index in the array. return: description: '' type: number @@ -289,7 +761,6 @@ inheritedMethods: Calls a defined callback function on each element of an array, and returns an array that contains the results. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -305,41 +776,60 @@ inheritedMethods: the callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'U[]' + type: U[] inheritanceDescription: Inherited From Array.map + - name: of(T[]) + uid: adaptive-expressions.StackedMemory.of + package: adaptive-expressions + summary: Returns a new array from a set of elements. + remarks: '' + isDeprecated: false + syntax: + content: 'static function of(items: T[]): T[]' + parameters: + - id: items + type: T[] + description: A set of elements to include in the new array object. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.of - name: pop() uid: adaptive-expressions.StackedMemory.pop package: adaptive-expressions - summary: Removes the last element from an array and returns it. + summary: >- + Removes the last element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function pop(): MemoryInterface | undefined' + content: 'function pop(): undefined | MemoryInterface' return: description: '' - type: | undefined + type: undefined | inheritanceDescription: Inherited From Array.pop - - name: 'push(MemoryInterface[])' + - name: push(MemoryInterface[]) uid: adaptive-expressions.StackedMemory.push package: adaptive-expressions - summary: 'Appends new elements to an array, and returns the new length of the array.' + summary: >- + Appends new elements to the end of an array, and returns the new length of + the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function push(items: MemoryInterface[]): number' parameters: - id: items - type: '[]' - description: | - New elements of the Array. + type: [] + description: New elements to add to the array. return: description: '' type: number @@ -354,7 +844,6 @@ inheritedMethods: The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -383,7 +872,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -415,7 +903,6 @@ inheritedMethods: The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -433,7 +920,7 @@ inheritedMethods: array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @@ -453,7 +940,6 @@ inheritedMethods: accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -482,7 +968,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -515,7 +1000,6 @@ inheritedMethods: accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -533,7 +1017,7 @@ inheritedMethods: array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @@ -544,49 +1028,63 @@ inheritedMethods: - name: reverse() uid: adaptive-expressions.StackedMemory.reverse package: adaptive-expressions - summary: Reverses the elements in an Array. + summary: |- + Reverses the elements in an array in place. + This method mutates the array and returns a reference to the same array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reverse(): MemoryInterface[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.reverse - name: shift() uid: adaptive-expressions.StackedMemory.shift package: adaptive-expressions - summary: Removes the first element from an array and returns it. + summary: >- + Removes the first element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shift(): MemoryInterface | undefined' + content: 'function shift(): undefined | MemoryInterface' return: description: '' - type: | undefined + type: undefined | inheritanceDescription: Inherited From Array.shift - - name: 'slice(number, number)' + - name: slice(number, number) uid: adaptive-expressions.StackedMemory.slice package: adaptive-expressions - summary: Returns a section of an array. + summary: >- + Returns a copy of a section of an array. + + For both start and end, a negative index can be used to indicate an offset + from the end of the array. + + For example, -2 refers to the second to last element of the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function slice(start?: number, end?: number): MemoryInterface[]' parameters: - id: start type: number - description: The beginning of the specified portion of the array. + description: |- + The beginning index of the specified portion of the array. + If start is undefined, then the slice begins at index 0. - id: end type: number - description: | - The end of the specified portion of the array. + description: >- + The end index of the specified portion of the array. This is + exclusive of the element at the index 'end'. + + If end is undefined, then the slice extends to the end of the array. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.slice - name: >- some((value: MemoryInterface, index: number, array: MemoryInterface[]) => @@ -597,27 +1095,31 @@ inheritedMethods: Determines whether the specified callback function returns true for any element of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function some(callbackfn: (value: MemoryInterface, index: number, array: + function some(predicate: (value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn + - id: predicate type: >- (value: MemoryInterface, index: number, array: MemoryInterface[]) => unknown description: >- A function that accepts up to three arguments. The some method calls - the callbackfn function for each element in array1 until the - callbackfn returns true, or until the end of the array. + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value true, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn - function. If thisArg is omitted, undefined is used as the this - value. + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. return: description: '' type: boolean @@ -625,33 +1127,44 @@ inheritedMethods: - name: 'sort((a: MemoryInterface, b: MemoryInterface) => number)' uid: adaptive-expressions.StackedMemory.sort package: adaptive-expressions - summary: Sorts an array. + summary: |- + Sorts an array in place. + This method mutates the array and returns a reference to the same array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function sort(compareFn?: (a: MemoryInterface, b: MemoryInterface) => - number): this + number): StackedMemory parameters: - id: compareFn type: '(a: MemoryInterface, b: MemoryInterface) => number' - description: > - The name of the function used to determine the order of the - elements. If omitted, the elements are sorted in ascending, ASCII - character order. + description: >- + Function used to determine the order of the elements. It is expected + to return + + a negative value if the first argument is less than the second + argument, zero if they're equal, and a positive + + value otherwise. If omitted, the elements are sorted in ascending, + ASCII character order. + + ```ts + + [11,2,22,1].sort((a, b) => a - b) + + ``` return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.sort - - name: 'splice(number, number)' + - name: splice(number, number) uid: adaptive-expressions.StackedMemory.splice package: adaptive-expressions summary: >- Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function splice(start: number, deleteCount?: number): MemoryInterface[]' @@ -663,20 +1176,18 @@ inheritedMethods: elements. - id: deleteCount type: number - description: | - The number of elements to remove. + description: The number of elements to remove. return: - description: '' - type: '[]' + description: An array containing the elements that were deleted. + type: [] inheritanceDescription: Inherited From Array.splice - - name: 'splice(number, number, MemoryInterface[])' + - name: splice(number, number, MemoryInterface[]) uid: adaptive-expressions.StackedMemory.splice_1 package: adaptive-expressions summary: >- Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -692,21 +1203,19 @@ inheritedMethods: type: number description: The number of elements to remove. - id: items - type: '[]' - description: | - Elements to insert into the array in place of the deleted elements. + type: [] + description: Elements to insert into the array in place of the deleted elements. return: - description: '' - type: '[]' + description: An array containing the elements that were deleted. + type: [] inheritanceDescription: Inherited From Array.splice - name: toLocaleString() uid: adaptive-expressions.StackedMemory.toLocaleString package: adaptive-expressions summary: >- Returns a string representation of an array. The elements are converted to - string using their toLocalString methods. + string using their toLocaleString methods. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toLocaleString(): string' @@ -719,7 +1228,6 @@ inheritedMethods: package: adaptive-expressions summary: Returns a string representation of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -727,31 +1235,77 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From Array.toString - - name: 'unshift(MemoryInterface[])' + - name: unshift(MemoryInterface[]) uid: adaptive-expressions.StackedMemory.unshift package: adaptive-expressions - summary: Inserts new elements at the start of an array. + summary: >- + Inserts new elements at the start of an array, and returns the new length + of the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unshift(items: MemoryInterface[]): number' parameters: - id: items - type: '[]' - description: | - Elements to insert at the start of the Array. + type: [] + description: Elements to insert at the start of the array. return: description: '' type: number inheritanceDescription: Inherited From Array.unshift + - name: values() + uid: adaptive-expressions.StackedMemory.values + package: adaptive-expressions + summary: Returns an iterable of values in the array + remarks: '' + isDeprecated: false + syntax: + content: 'function values(): IterableIterator' + return: + description: '' + type: >- + IterableIterator<> + inheritanceDescription: Inherited From Array.values + - name: '[iterator]()' + uid: adaptive-expressions.StackedMemory.[iterator] + package: adaptive-expressions + summary: Iterator + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator' + return: + description: '' + type: >- + IterableIterator<> + inheritanceDescription: Inherited From Array.__@iterator@2800 + - name: '[unscopables]()' + uid: adaptive-expressions.StackedMemory.[unscopables] + package: adaptive-expressions + summary: |- + Returns an object whose properties have the value 'true' + when they will be absent when used in a 'with' statement. + remarks: '' + isDeprecated: false + syntax: + content: >- + function [unscopables](): { copyWithin: boolean, entries: boolean, fill: + boolean, find: boolean, findIndex: boolean, keys: boolean, values: + boolean } + return: + description: '' + type: >- + { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, + findIndex: boolean, keys: boolean, values: boolean } + inheritanceDescription: Inherited From Array.__@unscopables@2802 methods: - name: getValue(string) uid: adaptive-expressions.StackedMemory.getValue package: adaptive-expressions summary: Gets the value from a given path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getValue(path: string): any' @@ -760,14 +1314,13 @@ methods: type: string description: Given path. return: - description: 'The value from the given path if found, otherwise, undefined.' + description: The value from the given path if found, otherwise, undefined. type: any - - name: 'setValue(string, any)' + - name: setValue(string, any) uid: adaptive-expressions.StackedMemory.setValue package: adaptive-expressions summary: Sets value to a given path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setValue(_path: string, _value: any)' @@ -777,8 +1330,7 @@ methods: description: Memory path. - id: _value type: any - description: | - Value to set. + description: Value to set. - name: version() uid: adaptive-expressions.StackedMemory.version package: adaptive-expressions @@ -786,7 +1338,6 @@ methods: Gets the version of the current [StackedMemory](xref:adaptive-expressions.StackedMemory). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function version(): string' @@ -801,7 +1352,6 @@ methods: [MemoryInterface](xref:adaptive-expressions.MemoryInterface) into a [StackedMemory](xref:adaptive-expressions.StackedMemory) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function wrap(memory: MemoryInterface): StackedMemory' @@ -812,6 +1362,6 @@ methods: An object that implements [MemoryInterface](xref:adaptive-expressions.MemoryInterface). return: - description: 'A [StackedMemory](xref:adaptive-expressions.StackedMemory) object.' + description: A [StackedMemory](xref:adaptive-expressions.StackedMemory) object. type: extends: Array<> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfDay.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfDay.yml deleted file mode 100644 index 6e3cc348..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfDay.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: StartOfDay -uid: adaptive-expressions.StartOfDay -package: adaptive-expressions -summary: Return the start of the day for a timestamp. -fullName: StartOfDay -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: StartOfDay() - uid: adaptive-expressions.StartOfDay.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [StartOfDay](xref:adaptive-expressions.StartOfDay) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new StartOfDay() -properties: - - name: negation - uid: adaptive-expressions.StartOfDay.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.StartOfDay.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.StartOfDay.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.StartOfDay.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.StartOfDay.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfHour.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfHour.yml deleted file mode 100644 index 56eeb5d6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfHour.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: StartOfHour -uid: adaptive-expressions.StartOfHour -package: adaptive-expressions -summary: Return the start of the hour for a timestamp. -fullName: StartOfHour -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: StartOfHour() - uid: adaptive-expressions.StartOfHour.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [StartOfHour](xref:adaptive-expressions.StartOfHour) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new StartOfHour() -properties: - - name: negation - uid: adaptive-expressions.StartOfHour.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.StartOfHour.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.StartOfHour.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.StartOfHour.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.StartOfHour.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfMonth.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfMonth.yml deleted file mode 100644 index da61441b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartOfMonth.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: StartOfMonth -uid: adaptive-expressions.StartOfMonth -package: adaptive-expressions -summary: Return the start of the month for a timestamp. -fullName: StartOfMonth -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: StartOfMonth() - uid: adaptive-expressions.StartOfMonth.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [StartOfMonth](xref:adaptive-expressions.StartOfMonth) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new StartOfMonth() -properties: - - name: negation - uid: adaptive-expressions.StartOfMonth.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.StartOfMonth.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.StartOfMonth.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.StartOfMonth.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.StartOfMonth.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartsWith.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartsWith.yml deleted file mode 100644 index d72dfdea..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StartsWith.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: StartsWith -uid: adaptive-expressions.StartsWith -package: adaptive-expressions -summary: >- - Check whether a string starts with a specific substring. Return true if the - substring is found, or return false if not found. - - This function is case-insensitive. -fullName: StartsWith -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: StartsWith() - uid: adaptive-expressions.StartsWith.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [StartsWith](xref:adaptive-expressions.StartsWith) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new StartsWith() -properties: - - name: negation - uid: adaptive-expressions.StartsWith.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.StartsWith.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.StartsWith.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.StartsWith.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.StartsWith.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/String.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/String.yml deleted file mode 100644 index 0d73b683..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/String.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: String -uid: adaptive-expressions.String -package: adaptive-expressions -summary: Return the string version of a value. -fullName: String -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: String() - uid: adaptive-expressions.String.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [String](xref:adaptive-expressions.String) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new String() -properties: - - name: negation - uid: adaptive-expressions.String.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.String.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.String.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.String.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.String.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringAtomContext.yml index e20ddd76..52d7c0a6 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringAtomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringAtomContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: StringAtomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StringAtomContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.StringAtomContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.StringAtomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.StringAtomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.StringAtomContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.StringAtomContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.StringAtomContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.StringAtomContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.StringAtomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.StringAtomContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.StringAtomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StringAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.StringAtomContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.StringAtomContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.StringAtomContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.StringAtomContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.StringAtomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.StringAtomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.StringAtomContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.StringAtomContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.StringAtomContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.StringAtomContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.StringAtomContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.StringAtomContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.StringAtomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.StringAtomContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.StringAtomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.StringAtomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.StringAtomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.StringAtomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.StringAtomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.StringAtomContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.StringAtomContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.StringAtomContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.StringAtomContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.StringAtomContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.StringAtomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.StringAtomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.StringAtomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.StringAtomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.StringAtomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.StringAtomContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.StringAtomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.StringAtomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.StringAtomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.StringAtomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.StringAtomContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -840,7 +881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRING(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpression.yml index 0b91c95e..b171768b 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpression.yml @@ -20,7 +20,6 @@ remarks: >- prop = "=length(user.name)" => "3" prop = "=user.name" => "Joe" prop = "\=user" => "=user". -isPreview: false isDeprecated: false type: class constructors: @@ -31,15 +30,13 @@ constructors: Initializes a new instance of the [StringExpression](xref:adaptive-expressions.StringExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StringExpression(value?: string | Expression)' parameters: - id: value type: string | - description: | - A `string` value or a `string` expression. + description: A `string` value or a `string` expression. inheritedProperties: - name: expressionText uid: adaptive-expressions.StringExpression.expressionText @@ -47,7 +44,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -63,7 +59,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' @@ -79,7 +74,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): string' @@ -98,7 +92,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -113,7 +106,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -128,7 +120,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: string }' @@ -148,13 +139,11 @@ methods: package: adaptive-expressions summary: Set a string value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setValue(value: string | Expression)' parameters: - id: value type: string | - description: | - Value to set. + description: Value to set. extends: <string> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpressionConverter.yml index 9afcd531..cad55d02 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringExpressionConverter.yml @@ -7,7 +7,6 @@ summary: >- [StringExpression](xref:adaptive-expressions.StringExpression) converter. fullName: StringExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -18,7 +17,6 @@ methods: Converts a string into an [StringExpression](xref:adaptive-expressions.StringExpression). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: Input | StringExpression): StringExpression' @@ -27,5 +25,5 @@ methods: type: Input | description: '`string` to convert.' return: - description: 'The [StringExpression](xref:adaptive-expressions.StringExpression).' + description: The [StringExpression](xref:adaptive-expressions.StringExpression). type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationAtomContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationAtomContext.yml index a2509364..09d7f81f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationAtomContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationAtomContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: StringInterpolationAtomContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StringInterpolationAtomContext(ctx: PrimaryExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.StringInterpolationAtomContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.StringInterpolationAtomContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.altNumber](xref:adaptive-expressions.PrimaryExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.StringInterpolationAtomContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.childCount](xref:adaptive-expressions.PrimaryExpressionContext.childCount) - name: children uid: adaptive-expressions.StringInterpolationAtomContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.children](xref:adaptive-expressions.PrimaryExpressionContext.children) - name: exception uid: adaptive-expressions.StringInterpolationAtomContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.exception](xref:adaptive-expressions.PrimaryExpressionContext.exception) - name: invokingState uid: adaptive-expressions.StringInterpolationAtomContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.invokingState](xref:adaptive-expressions.PrimaryExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.StringInterpolationAtomContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.isEmpty](xref:adaptive-expressions.PrimaryExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.StringInterpolationAtomContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.parent](xref:adaptive-expressions.PrimaryExpressionContext.parent) - name: payload uid: adaptive-expressions.StringInterpolationAtomContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.payload](xref:adaptive-expressions.PrimaryExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.StringInterpolationAtomContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StringInterpolationAtomContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleContext](xref:adaptive-expressions.PrimaryExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.StringInterpolationAtomContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.ruleIndex](xref:adaptive-expressions.PrimaryExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.StringInterpolationAtomContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.sourceInterval](xref:adaptive-expressions.PrimaryExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.StringInterpolationAtomContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.start](xref:adaptive-expressions.PrimaryExpressionContext.start) - name: stop uid: adaptive-expressions.StringInterpolationAtomContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.stop](xref:adaptive-expressions.PrimaryExpressionContext.stop) - name: text uid: adaptive-expressions.StringInterpolationAtomContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.text](xref:adaptive-expressions.PrimaryExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.StringInterpolationAtomContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addAnyChild](xref:adaptive-expressions.PrimaryExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.StringInterpolationAtomContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.StringInterpolationAtomContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.StringInterpolationAtomContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addChild](xref:adaptive-expressions.PrimaryExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.StringInterpolationAtomContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.StringInterpolationAtomContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.addErrorNode](xref:adaptive-expressions.PrimaryExpressionContext.addErrorNode) - name: copyFrom(PrimaryExpressionContext) uid: adaptive-expressions.StringInterpolationAtomContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: PrimaryExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.depth](xref:adaptive-expressions.PrimaryExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.StringInterpolationAtomContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.emptyContext](xref:adaptive-expressions.PrimaryExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.StringInterpolationAtomContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationAtomContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChild](xref:adaptive-expressions.PrimaryExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.StringInterpolationAtomContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getChildContext](xref:adaptive-expressions.PrimaryExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationAtomContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.StringInterpolationAtomContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getRuleContexts](xref:adaptive-expressions.PrimaryExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.StringInterpolationAtomContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getToken](xref:adaptive-expressions.PrimaryExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.StringInterpolationAtomContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.getTokens](xref:adaptive-expressions.PrimaryExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.StringInterpolationAtomContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.removeLastChild](xref:adaptive-expressions.PrimaryExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.StringInterpolationAtomContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.setParent](xref:adaptive-expressions.PrimaryExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.StringInterpolationAtomContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toInfoString](xref:adaptive-expressions.PrimaryExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.StringInterpolationAtomContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.StringInterpolationAtomContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.StringInterpolationAtomContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.StringInterpolationAtomContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.StringInterpolationAtomContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toString](xref:adaptive-expressions.PrimaryExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.StringInterpolationAtomContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.StringInterpolationAtomContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.StringInterpolationAtomContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.toStringTree](xref:adaptive-expressions.PrimaryExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationAtomContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetChild](xref:adaptive-expressions.PrimaryExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationAtomContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetRuleContext](xref:adaptive-expressions.PrimaryExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.StringInterpolationAtomContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [PrimaryExpressionContext.tryGetToken](xref:adaptive-expressions.PrimaryExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.StringInterpolationAtomContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -840,7 +881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function stringInterpolation(): StringInterpolationContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationContext.yml index e16cd1be..560e7edd 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringInterpolationContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: StringInterpolationContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'StringInterpolationContext(ParserRuleContext | undefined, number)' + - name: StringInterpolationContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.StringInterpolationContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new StringInterpolationContext(parent: ParserRuleContext | undefined, + new StringInterpolationContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.StringInterpolationContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.StringInterpolationContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.StringInterpolationContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.StringInterpolationContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.StringInterpolationContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.StringInterpolationContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.StringInterpolationContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StringInterpolationContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.StringInterpolationContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.StringInterpolationContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.StringInterpolationContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.StringInterpolationContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.StringInterpolationContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.StringInterpolationContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.StringInterpolationContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.StringInterpolationContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.StringInterpolationContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.StringInterpolationContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.StringInterpolationContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.StringInterpolationContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.StringInterpolationContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.StringInterpolationContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.StringInterpolationContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.StringInterpolationContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.StringInterpolationContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.StringInterpolationContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.StringInterpolationContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,7 +797,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -853,19 +809,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: ESCAPE_CHARACTER(number) uid: adaptive-expressions.StringInterpolationContext.ESCAPE_CHARACTER_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER(i: number): TerminalNode' @@ -881,7 +835,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -894,20 +847,18 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRING_INTERPOLATION_START(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRING_INTERPOLATION_START(number) uid: >- adaptive-expressions.StringInterpolationContext.STRING_INTERPOLATION_START_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRING_INTERPOLATION_START(i: number): TerminalNode' @@ -923,19 +874,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEMPLATE(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEMPLATE(number) uid: adaptive-expressions.StringInterpolationContext.TEMPLATE_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEMPLATE(i: number): TerminalNode' @@ -951,19 +900,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function textContent(): TextContentContext[]' return: description: '' - type: '[]' + type: [] - name: textContent(number) uid: adaptive-expressions.StringInterpolationContext.textContent_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function textContent(i: number): TextContentContext' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringOrValue.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringOrValue.yml deleted file mode 100644 index 5f4376d3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringOrValue.yml +++ /dev/null @@ -1,119 +0,0 @@ -### YamlMime:TSType -name: StringOrValue -uid: adaptive-expressions.StringOrValue -package: adaptive-expressions -summary: |- - Wrap string interpolation to get real value. - For example: stringOrValue('${1}'), would get number 1 - stringOrValue('${1} item'), would get string "1 item". -fullName: StringOrValue -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: StringOrValue() - uid: adaptive-expressions.StringOrValue.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [StringOrValue](xref:adaptive-expressions.StringOrValue) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new StringOrValue() -properties: - - name: negation - uid: adaptive-expressions.StringOrValue.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.StringOrValue.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.StringOrValue.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.StringOrValue.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.StringOrValue.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringTransformEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringTransformEvaluator.yml index 3c009fdd..0a92597b 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringTransformEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/StringTransformEvaluator.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Evaluator that transforms a string to another string. fullName: StringTransformEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: [StringTransformEvaluator](xref:adaptive-expressions.StringTransformEvaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,32 +34,29 @@ constructors: returns an string. - id: validator type: '(expr: Expression) => void' - description: | - The validation function. -properties: + description: The validation function. +inheritedProperties: - name: negation uid: adaptive-expressions.StringTransformEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: -inheritedProperties: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions.ExpressionEvaluator.negation) - name: returnType uid: adaptive-expressions.StringTransformEvaluator.returnType package: adaptive-expressions summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -71,63 +66,52 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.StringTransformEvaluator.type + - name: tryEvaluate + uid: adaptive-expressions.StringTransformEvaluator.tryEvaluate package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type + summary: Evaluate an expression. + fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: string' + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError return: description: '' - type: string + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError inheritanceDescription: >- Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.StringTransformEvaluator.tryEvaluate + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions.StringTransformEvaluator.type package: adaptive-expressions - summary: Evaluate an expression. + summary: Gets the expression type for evaluator. + fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. + content: 'type: string' return: - description: The value and error string that is non-null if there is an error. - type: + description: '' + type: string inheritanceDescription: >- Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) + [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) + - name: validateExpression uid: adaptive-expressions.StringTransformEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' inheritanceDescription: >- Inherited From [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubArray.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubArray.yml deleted file mode 100644 index cd294889..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubArray.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: SubArray -uid: adaptive-expressions.SubArray -package: adaptive-expressions -summary: >- - Returns a subarray from specified start and end positions. Index values start - with the number 0. -fullName: SubArray -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SubArray() - uid: adaptive-expressions.SubArray.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SubArray](xref:adaptive-expressions.SubArray) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SubArray() -properties: - - name: negation - uid: adaptive-expressions.SubArray.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SubArray.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SubArray.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SubArray.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SubArray.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Substring.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Substring.yml deleted file mode 100644 index 0fdcef75..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Substring.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Substring -uid: adaptive-expressions.Substring -package: adaptive-expressions -summary: >- - Return characters from a string, starting from the specified position or - index. Index values start with the number 0. -fullName: Substring -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Substring() - uid: adaptive-expressions.Substring.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Substring](xref:adaptive-expressions.Substring) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Substring() -properties: - - name: negation - uid: adaptive-expressions.Substring.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Substring.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Substring.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Substring.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Substring.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Subtract.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Subtract.yml deleted file mode 100644 index 63b31d5a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Subtract.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Subtract -uid: adaptive-expressions.Subtract -package: adaptive-expressions -summary: Return the result from subtracting the next number from the previous number. -fullName: Subtract -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Subtract() - uid: adaptive-expressions.Subtract.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Subtract](xref:adaptive-expressions.Subtract) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Subtract() -properties: - - name: negation - uid: adaptive-expressions.Subtract.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Subtract.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Subtract.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Subtract.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Subtract.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubtractFromTime.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubtractFromTime.yml deleted file mode 100644 index 10af6920..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/SubtractFromTime.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: SubtractFromTime -uid: adaptive-expressions.SubtractFromTime -package: adaptive-expressions -summary: Subtract a number of time units from a timestamp. -fullName: SubtractFromTime -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SubtractFromTime() - uid: adaptive-expressions.SubtractFromTime.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [SubtractFromTime](xref:adaptive-expressions.SubtractFromTime) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SubtractFromTime() -properties: - - name: negation - uid: adaptive-expressions.SubtractFromTime.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.SubtractFromTime.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.SubtractFromTime.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.SubtractFromTime.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.SubtractFromTime.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sum.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sum.yml deleted file mode 100644 index f2ef809e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Sum.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Sum -uid: adaptive-expressions.Sum -package: adaptive-expressions -summary: Return the result from adding numbers in an array. -fullName: Sum -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Sum() - uid: adaptive-expressions.Sum.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Sum](xref:adaptive-expressions.Sum) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Sum() -properties: - - name: negation - uid: adaptive-expressions.Sum.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Sum.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Sum.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Sum.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Sum.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Take.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Take.yml deleted file mode 100644 index eba9e95a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Take.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Take -uid: adaptive-expressions.Take -package: adaptive-expressions -summary: >- - Return items from the front of an array or take the specific prefix from a - string. -fullName: Take -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Take() - uid: adaptive-expressions.Take.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Take](xref:adaptive-expressions.Take) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Take() -properties: - - name: negation - uid: adaptive-expressions.Take.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Take.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Take.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Take.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Take.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TextContentContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TextContentContext.yml index 3fe1a482..71be7895 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TextContentContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TextContentContext.yml @@ -5,24 +5,22 @@ package: adaptive-expressions summary: '' fullName: TextContentContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TextContentContext(ParserRuleContext | undefined, number)' + - name: TextContentContext(undefined | ParserRuleContext, number) uid: adaptive-expressions.TextContentContext.constructor package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TextContentContext(parent: ParserRuleContext | undefined, + new TextContentContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: adaptive-expressions.TextContentContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: adaptive-expressions.TextContentContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: adaptive-expressions.TextContentContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: adaptive-expressions.TextContentContext.isEmpty package: adaptive-expressions @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: adaptive-expressions.TextContentContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: adaptive-expressions.TextContentContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: adaptive-expressions.TextContentContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TextContentContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: adaptive-expressions.TextContentContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: adaptive-expressions.TextContentContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.TextContentContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: adaptive-expressions.TextContentContext.copyFrom package: adaptive-expressions - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: adaptive-expressions.TextContentContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.TextContentContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.TextContentContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.TextContentContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.TextContentContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: adaptive-expressions.TextContentContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: adaptive-expressions.TextContentContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: adaptive-expressions.TextContentContext.toInfoString package: adaptive-expressions @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: adaptive-expressions.TextContentContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.TextContentContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: adaptive-expressions.TextContentContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.TextContentContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: adaptive-expressions.TextContentContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: adaptive-expressions.TextContentContext.toStringTree package: adaptive-expressions @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.TextContentContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.TextContentContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.TextContentContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: adaptive-expressions.TextContentContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(ExpressionAntlrParserVisitor) @@ -820,7 +778,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -840,7 +797,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +809,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -866,19 +821,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_CONTENT(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT_CONTENT(number) uid: adaptive-expressions.TextContentContext.TEXT_CONTENT_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_CONTENT(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ticks.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ticks.yml deleted file mode 100644 index 224b1849..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Ticks.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Ticks -uid: adaptive-expressions.Ticks -package: adaptive-expressions -summary: >- - Return the ticks property value of a specified timestamp. A tick is - 100-nanosecond interval. -fullName: Ticks -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Ticks() - uid: adaptive-expressions.Ticks.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Ticks](xref:adaptive-expressions.Ticks) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Ticks() -properties: - - name: negation - uid: adaptive-expressions.Ticks.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Ticks.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Ticks.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Ticks.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Ticks.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToDays.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToDays.yml deleted file mode 100644 index 522277ac..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToDays.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: TicksToDays -uid: adaptive-expressions.TicksToDays -package: adaptive-expressions -summary: Convert ticks to number of days. -fullName: TicksToDays -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TicksToDays() - uid: adaptive-expressions.TicksToDays.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [TicksToDays](xref:adaptive-expressions.TicksToDays) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new TicksToDays() -properties: - - name: negation - uid: adaptive-expressions.TicksToDays.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.TicksToDays.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.TicksToDays.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.TicksToDays.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.TicksToDays.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToHours.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToHours.yml deleted file mode 100644 index 8d6d76cc..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToHours.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: TicksToHours -uid: adaptive-expressions.TicksToHours -package: adaptive-expressions -summary: Convert ticks to number of hours. -fullName: TicksToHours -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TicksToHours() - uid: adaptive-expressions.TicksToHours.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [TicksToHours](xref:adaptive-expressions.TicksToHours) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new TicksToHours() -properties: - - name: negation - uid: adaptive-expressions.TicksToHours.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.TicksToHours.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.TicksToHours.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.TicksToHours.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.TicksToHours.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToMinutes.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToMinutes.yml deleted file mode 100644 index 16b25ca7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TicksToMinutes.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: TicksToMinutes -uid: adaptive-expressions.TicksToMinutes -package: adaptive-expressions -summary: Convert ticks to number of minutes. -fullName: TicksToMinutes -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TicksToMinutes() - uid: adaptive-expressions.TicksToMinutes.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [TicksToMinutes](xref:adaptive-expressions.TicksToMinutes) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new TicksToMinutes() -properties: - - name: negation - uid: adaptive-expressions.TicksToMinutes.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.TicksToMinutes.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.TicksToMinutes.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.TicksToMinutes.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.TicksToMinutes.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeTransformEvaluator.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeTransformEvaluator.yml index 119bb382..f657c6df 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeTransformEvaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeTransformEvaluator.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Evaluator that transforms a datetime to another datetime. fullName: TimeTransformEvaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: [TimeTransformEvaluator](xref:adaptive-expressions.TimeTransformEvaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,33 +29,31 @@ constructors: description: Name of the built-in function. - id: func type: '(timestamp: Date, numOfTransformation: number) => Date' - description: > + description: >- The evaluation function, it takes a timestamp and the number of transformation, and returns a `Date`. -properties: +inheritedProperties: - name: negation uid: adaptive-expressions.TimeTransformEvaluator.negation package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. + summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: - content: ExpressionEvaluator negation + content: 'negation: ExpressionEvaluator' return: - description: The evaluator that is a negation of this one. + description: '' type: -inheritedProperties: + inheritanceDescription: >- + Inherited From + [ExpressionEvaluator.negation](xref:adaptive-expressions.ExpressionEvaluator.negation) - name: returnType uid: adaptive-expressions.TimeTransformEvaluator.returnType package: adaptive-expressions summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -67,63 +63,52 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.TimeTransformEvaluator.type + - name: tryEvaluate + uid: adaptive-expressions.TimeTransformEvaluator.tryEvaluate package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type + summary: Evaluate an expression. + fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: string' + content: >- + tryEvaluate: (expression: Expression, state: MemoryInterface, options: + Options) => ValueWithError return: description: '' - type: string + type: >- + (expression: Expression, state: MemoryInterface, options: Options) + => ValueWithError inheritanceDescription: >- Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.TimeTransformEvaluator.tryEvaluate + [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) + - name: type + uid: adaptive-expressions.TimeTransformEvaluator.type package: adaptive-expressions - summary: Evaluate an expression. + summary: Gets the expression type for evaluator. + fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. + content: 'type: string' return: - description: The value and error string that is non-null if there is an error. - type: + description: '' + type: string inheritanceDescription: >- Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) + [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) + - name: validateExpression uid: adaptive-expressions.TimeTransformEvaluator.validateExpression package: adaptive-expressions summary: Validate an expression. + fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. + content: 'validateExpression: (expression: Expression) => void' + return: + description: '' + type: '(expression: Expression) => void' inheritanceDescription: >- Inherited From [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeZoneConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeZoneConverter.yml index 1b96d5f2..df90ebbc 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeZoneConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimeZoneConverter.yml @@ -15,7 +15,6 @@ summary: >- iana ref: https://www.iana.org/time-zones. fullName: TimeZoneConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -24,7 +23,6 @@ methods: package: adaptive-expressions summary: convert IANA timezone format to windows timezone format. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function ianaToWindows(ianaTimeZoneId: string): string' @@ -40,7 +38,6 @@ methods: package: adaptive-expressions summary: Verify the string is windows timezone or iana string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function verifyTimeZoneStr(timezoneStr: string): boolean' @@ -56,7 +53,6 @@ methods: package: adaptive-expressions summary: Convert windows timezone to iana timezone. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function windowsToIana(windowsTimeZoneId: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimexResolve.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimexResolve.yml deleted file mode 100644 index 2dbde00b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TimexResolve.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: TimexResolve -uid: adaptive-expressions.TimexResolve -package: adaptive-expressions -summary: >- - Return true if a given TimexProperty or Timex expression refers to a valid - time. -fullName: TimexResolve -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TimexResolve() - uid: adaptive-expressions.TimexResolve.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [TimexResolve](xref:adaptive-expressions.TimexResolve) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new TimexResolve() -properties: - - name: negation - uid: adaptive-expressions.TimexResolve.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.TimexResolve.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.TimexResolve.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.TimexResolve.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.TimexResolve.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TitleCase.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TitleCase.yml deleted file mode 100644 index 718a5704..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TitleCase.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: TitleCase -uid: adaptive-expressions.TitleCase -package: adaptive-expressions -summary: Converts the specified string to title case. -fullName: TitleCase -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TitleCase() - uid: adaptive-expressions.TitleCase.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [TitleCase](xref:adaptive-expressions.TitleCase) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new TitleCase() -properties: - - name: negation - uid: adaptive-expressions.TitleCase.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.TitleCase.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.TitleCase.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.TitleCase.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.TitleCase.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToLower.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToLower.yml deleted file mode 100644 index a17a01cb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToLower.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: ToLower -uid: adaptive-expressions.ToLower -package: adaptive-expressions -summary: >- - Return a string in lowercase format. - - If a character in the string doesn't have a lowercase version, that character - stays unchanged in the returned string. -fullName: ToLower -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: ToLower() - uid: adaptive-expressions.ToLower.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [ToLower](xref:adaptive-expressions.ToLower) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ToLower() -properties: - - name: negation - uid: adaptive-expressions.ToLower.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.ToLower.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.ToLower.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ToLower.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.ToLower.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToUpper.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToUpper.yml deleted file mode 100644 index 37be1b1b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ToUpper.yml +++ /dev/null @@ -1,120 +0,0 @@ -### YamlMime:TSType -name: ToUpper -uid: adaptive-expressions.ToUpper -package: adaptive-expressions -summary: >- - Return a string in uppercase format. - - If a character in the string doesn't have an uppercase version, that character - stays unchanged in the returned string. -fullName: ToUpper -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: ToUpper() - uid: adaptive-expressions.ToUpper.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [ToUpper](xref:adaptive-expressions.ToUpper) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ToUpper() -properties: - - name: negation - uid: adaptive-expressions.ToUpper.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.ToUpper.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.ToUpper.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.ToUpper.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.ToUpper.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trigger.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trigger.yml index 2aabed94..e4a336e8 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trigger.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trigger.yml @@ -7,16 +7,14 @@ summary: >- action. fullName: Trigger remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Trigger(TriggerTree, Expression, any, Quantifier[])' + - name: Trigger(TriggerTree, Expression, any, Quantifier[]) uid: adaptive-expressions.Trigger.constructor package: adaptive-expressions summary: Intializes a new instance of the `Trigger` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -33,9 +31,8 @@ constructors: type: any description: Action to take when a trigger matches. - id: quantifiers - type: '[]' - description: | - Quantifiers to dynamically expand the expression. + type: [] + description: Quantifiers to dynamically expand the expression. properties: - name: action uid: adaptive-expressions.Trigger.action @@ -43,7 +40,6 @@ properties: summary: Action to take when trigger is true. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action: any' @@ -60,20 +56,18 @@ properties: there is an implicit || between clauses and && within a clause. fullName: clauses remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'Clause[] clauses' + content: 'clauses: Clause[]' return: description: The list of clauses. - type: '[]' + type: [] - name: originalExpression uid: adaptive-expressions.Trigger.originalExpression package: adaptive-expressions summary: Original trigger expression. fullName: originalExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'originalExpression: Expression' @@ -81,37 +75,33 @@ properties: description: '' type: methods: - - name: 'matches(Clause, MemoryInterface | any)' + - name: matches(Clause, any) uid: adaptive-expressions.Trigger.matches package: adaptive-expressions summary: >- Determines whether there is a member in the current `Clause` that matches the nodeClause parameter. remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function matches(nodeClause: Clause, state: MemoryInterface | any): - boolean + content: 'function matches(nodeClause: Clause, state: any): boolean' parameters: - id: nodeClause type: description: The other Clause instance to match. - id: state - type: | any + type: any description: The scope for looking up variables. return: description: A boolean value inidicating whether there is a member matches. type: boolean - - name: 'relationship(Trigger, PredicateComparers)' + - name: relationship(Trigger, PredicateComparers) uid: adaptive-expressions.Trigger.relationship package: adaptive-expressions summary: >- Determines the relationship between current instance and another `Trigger` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -127,18 +117,17 @@ methods: return: description: A `RelationshipType` value. type: - - name: 'toString(string[], number)' + - name: toString(string[], number) uid: adaptive-expressions.Trigger.toString package: adaptive-expressions summary: Gets a string that represents the current trigger. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(builder: string[], indent: number): string' + content: 'function toString(builder?: string[], indent?: number): string' parameters: - id: builder - type: 'string[]' + type: string[] description: An array of string to build the string of trigger. - id: indent type: number diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TriggerTree.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TriggerTree.yml index 41440c08..ccafb89f 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TriggerTree.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TriggerTree.yml @@ -7,7 +7,6 @@ summary: >- in order to make it easier to use rules. fullName: TriggerTree remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: adaptive-expressions summary: Intializes a new instance of the `TriggerTree` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new TriggerTree() @@ -24,10 +22,9 @@ properties: - name: comparers uid: adaptive-expressions.TriggerTree.comparers package: adaptive-expressions - summary: 'A dictionary of `PredicateComparer` values, with string keys.' + summary: A dictionary of `PredicateComparer` values, with string keys. fullName: comparers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'comparers: PredicateComparers' @@ -40,20 +37,18 @@ properties: summary: A list of `Optimizer` for optimizing claues. fullName: optimizers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'optimizers: Optimizer[] = []' + content: 'optimizers: Optimizer[]' return: description: '' - type: '[]' + type: [] - name: root uid: adaptive-expressions.TriggerTree.root package: adaptive-expressions summary: The root node instance. fullName: root remarks: '' - isPreview: false isDeprecated: false syntax: content: 'root: Node' @@ -66,20 +61,18 @@ properties: summary: The total number of triggers. fullName: totalTriggers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'totalTriggers: number = 0' + content: 'totalTriggers: number' return: description: '' type: number methods: - - name: 'addTrigger(string | Expression, any, Quantifier[])' + - name: addTrigger(string | Expression, any, Quantifier[]) uid: adaptive-expressions.TriggerTree.addTrigger package: adaptive-expressions summary: Add a trigger expression to the tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -93,33 +86,31 @@ methods: type: any description: Action when triggered. - id: quantifiers - type: '[]' + type: [] description: Quantifiers to use when expanding expressions. return: description: New trigger. type: - - name: matches(MemoryInterface | any) + - name: matches(any) uid: adaptive-expressions.TriggerTree.matches package: adaptive-expressions summary: Return the possible matches given the current state. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function matches(state: MemoryInterface | any): Trigger[]' + content: 'function matches(state: any): Trigger[]' parameters: - id: state - type: | any + type: any description: State to evaluate against. return: description: List of possible matches. - type: '[]' + type: [] - name: removeTrigger(Trigger) uid: adaptive-expressions.TriggerTree.removeTrigger package: adaptive-expressions summary: Remove trigger from tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeTrigger(trigger: Trigger): boolean' @@ -135,7 +126,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -147,10 +137,9 @@ methods: package: adaptive-expressions summary: Generates a string describing the tree. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function treeToString(indent: number): string' + content: 'function treeToString(indent?: number): string' parameters: - id: indent type: number @@ -163,7 +152,6 @@ methods: package: adaptive-expressions summary: Verify the tree meets specialization/generalization invariants. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function verifyTree(): Node' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trim.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trim.yml deleted file mode 100644 index a4fba331..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Trim.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Trim -uid: adaptive-expressions.Trim -package: adaptive-expressions -summary: >- - Remove leading and trailing whitespace from a string, and return the updated - string. -fullName: Trim -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Trim() - uid: adaptive-expressions.Trim.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Trim](xref:adaptive-expressions.Trim) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Trim() -properties: - - name: negation - uid: adaptive-expressions.Trim.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Trim.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Trim.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Trim.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Trim.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TripleOpExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TripleOpExpContext.yml index 31d63434..78a56085 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TripleOpExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/TripleOpExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: TripleOpExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TripleOpExpContext(ctx: ExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.TripleOpExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.TripleOpExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions.ExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.TripleOpExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions.ExpressionContext.childCount) - name: children uid: adaptive-expressions.TripleOpExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions.ExpressionContext.children) - name: exception uid: adaptive-expressions.TripleOpExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions.ExpressionContext.exception) - name: invokingState uid: adaptive-expressions.TripleOpExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions.ExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.TripleOpExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions.ExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.TripleOpExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions.ExpressionContext.parent) - name: payload uid: adaptive-expressions.TripleOpExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions.ExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.TripleOpExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TripleOpExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.TripleOpExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions.ExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.TripleOpExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions.ExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.TripleOpExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions.ExpressionContext.start) - name: stop uid: adaptive-expressions.TripleOpExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions.ExpressionContext.stop) - name: text uid: adaptive-expressions.TripleOpExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions.ExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.TripleOpExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions.ExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.TripleOpExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.TripleOpExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.TripleOpExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.TripleOpExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.TripleOpExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: copyFrom(ExpressionContext) uid: adaptive-expressions.TripleOpExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions.ExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.TripleOpExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions.ExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.TripleOpExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.TripleOpExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.TripleOpExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.TripleOpExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.TripleOpExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions.ExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.TripleOpExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions.ExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.TripleOpExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions.ExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.TripleOpExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions.ExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.TripleOpExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions.ExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.TripleOpExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions.ExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.TripleOpExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.TripleOpExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.TripleOpExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.TripleOpExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.TripleOpExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.TripleOpExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.TripleOpExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.TripleOpExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.TripleOpExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.TripleOpExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.TripleOpExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions.ExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.TripleOpExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COLON(): TerminalNode' @@ -839,7 +880,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -852,7 +892,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -865,19 +904,17 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext[]' return: description: '' - type: '[]' + type: [] - name: expression(number) uid: adaptive-expressions.TripleOpExpContext.expression_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(i: number): ExpressionContext' @@ -893,7 +930,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function QUESTION_MARK(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UnaryOpExpContext.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UnaryOpExpContext.yml index 7c815342..1f57b0f3 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UnaryOpExpContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UnaryOpExpContext.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: '' fullName: UnaryOpExpContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new UnaryOpExpContext(ctx: ExpressionContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: adaptive-expressions.UnaryOpExpContext.ruleIndex - package: adaptive-expressions - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: adaptive-expressions.UnaryOpExpContext.altNumber package: adaptive-expressions - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [ExpressionContext.altNumber](xref:adaptive-expressions.ExpressionContext.altNumber) - name: childCount uid: adaptive-expressions.UnaryOpExpContext.childCount package: adaptive-expressions summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [ExpressionContext.childCount](xref:adaptive-expressions.ExpressionContext.childCount) - name: children uid: adaptive-expressions.UnaryOpExpContext.children package: adaptive-expressions @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.children](xref:adaptive-expressions.ExpressionContext.children) - name: exception uid: adaptive-expressions.UnaryOpExpContext.exception package: adaptive-expressions @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [ExpressionContext.exception](xref:adaptive-expressions.ExpressionContext.exception) - name: invokingState uid: adaptive-expressions.UnaryOpExpContext.invokingState package: adaptive-expressions summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [ExpressionContext.invokingState](xref:adaptive-expressions.ExpressionContext.invokingState) - name: isEmpty uid: adaptive-expressions.UnaryOpExpContext.isEmpty package: adaptive-expressions @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [ExpressionContext.isEmpty](xref:adaptive-expressions.ExpressionContext.isEmpty) - name: parent uid: adaptive-expressions.UnaryOpExpContext.parent package: adaptive-expressions summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.parent](xref:adaptive-expressions.ExpressionContext.parent) - name: payload uid: adaptive-expressions.UnaryOpExpContext.payload package: adaptive-expressions summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [ExpressionContext.payload](xref:adaptive-expressions.ExpressionContext.payload) - name: ruleContext uid: adaptive-expressions.UnaryOpExpContext.ruleContext package: adaptive-expressions summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: UnaryOpExpContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleContext](xref:adaptive-expressions.ExpressionContext.ruleContext) + - name: ruleIndex + uid: adaptive-expressions.UnaryOpExpContext.ruleIndex + package: adaptive-expressions + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [ExpressionContext.ruleIndex](xref:adaptive-expressions.ExpressionContext.ruleIndex) - name: sourceInterval uid: adaptive-expressions.UnaryOpExpContext.sourceInterval package: adaptive-expressions summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [ExpressionContext.sourceInterval](xref:adaptive-expressions.ExpressionContext.sourceInterval) - name: start uid: adaptive-expressions.UnaryOpExpContext.start package: adaptive-expressions @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [ExpressionContext.start](xref:adaptive-expressions.ExpressionContext.start) - name: stop uid: adaptive-expressions.UnaryOpExpContext.stop package: adaptive-expressions @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [ExpressionContext.stop](xref:adaptive-expressions.ExpressionContext.stop) - name: text uid: adaptive-expressions.UnaryOpExpContext.text package: adaptive-expressions - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [ExpressionContext.text](xref:adaptive-expressions.ExpressionContext.text) inheritedMethods: - name: addAnyChild(T) uid: adaptive-expressions.UnaryOpExpContext.addAnyChild package: adaptive-expressions - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addAnyChild](xref:adaptive-expressions.ExpressionContext.addAnyChild) - name: addChild(RuleContext) uid: adaptive-expressions.UnaryOpExpContext.addChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(TerminalNode) uid: adaptive-expressions.UnaryOpExpContext.addChild package: adaptive-expressions summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addChild(Token) uid: adaptive-expressions.UnaryOpExpContext.addChild_2 package: adaptive-expressions @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.addChild](xref:adaptive-expressions.ExpressionContext.addChild) - name: addErrorNode(ErrorNode) uid: adaptive-expressions.UnaryOpExpContext.addErrorNode package: adaptive-expressions summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: addErrorNode(Token) uid: adaptive-expressions.UnaryOpExpContext.addErrorNode_1 package: adaptive-expressions @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.addErrorNode](xref:adaptive-expressions.ExpressionContext.addErrorNode) - name: copyFrom(ExpressionContext) uid: adaptive-expressions.UnaryOpExpContext.copyFrom package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ExpressionContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [ExpressionContext.depth](xref:adaptive-expressions.ExpressionContext.depth) - name: emptyContext() uid: adaptive-expressions.UnaryOpExpContext.emptyContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [ExpressionContext.emptyContext](xref:adaptive-expressions.ExpressionContext.emptyContext) - name: getChild(number) uid: adaptive-expressions.UnaryOpExpContext.getChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: adaptive-expressions.UnaryOpExpContext.getChild_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChild](xref:adaptive-expressions.ExpressionContext.getChild) + - name: getChildContext(RuleContext, number) uid: adaptive-expressions.UnaryOpExpContext.getChildContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getChildContext](xref:adaptive-expressions.ExpressionContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.UnaryOpExpContext.getRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContext](xref:adaptive-expressions.ExpressionContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: adaptive-expressions.UnaryOpExpContext.getRuleContexts package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getRuleContexts](xref:adaptive-expressions.ExpressionContext.getRuleContexts) + - name: getToken(number, number) uid: adaptive-expressions.UnaryOpExpContext.getToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [ExpressionContext.getToken](xref:adaptive-expressions.ExpressionContext.getToken) - name: getTokens(number) uid: adaptive-expressions.UnaryOpExpContext.getTokens package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [ExpressionContext.getTokens](xref:adaptive-expressions.ExpressionContext.getTokens) - name: removeLastChild() uid: adaptive-expressions.UnaryOpExpContext.removeLastChild package: adaptive-expressions @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [ExpressionContext.removeLastChild](xref:adaptive-expressions.ExpressionContext.removeLastChild) - name: setParent(RuleContext) uid: adaptive-expressions.UnaryOpExpContext.setParent package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [ExpressionContext.setParent](xref:adaptive-expressions.ExpressionContext.setParent) - name: toInfoString(Parser) uid: adaptive-expressions.UnaryOpExpContext.toInfoString package: adaptive-expressions @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toInfoString](xref:adaptive-expressions.ExpressionContext.toInfoString) - name: toString() uid: adaptive-expressions.UnaryOpExpContext.toString package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer) uid: adaptive-expressions.UnaryOpExpContext.toString_1 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: adaptive-expressions.UnaryOpExpContext.toString_3 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[]) uid: adaptive-expressions.UnaryOpExpContext.toString_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: adaptive-expressions.UnaryOpExpContext.toString_4 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [ExpressionContext.toString](xref:adaptive-expressions.ExpressionContext.toString) - name: toStringTree() uid: adaptive-expressions.UnaryOpExpContext.toStringTree_2 package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) - name: toStringTree(Parser) uid: adaptive-expressions.UnaryOpExpContext.toStringTree package: adaptive-expressions @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: adaptive-expressions.UnaryOpExpContext.toStringTree_1 package: adaptive-expressions summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [ExpressionContext.toStringTree](xref:adaptive-expressions.ExpressionContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: adaptive-expressions.UnaryOpExpContext.tryGetChild package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetChild](xref:adaptive-expressions.ExpressionContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: adaptive-expressions.UnaryOpExpContext.tryGetRuleContext package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetRuleContext](xref:adaptive-expressions.ExpressionContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: adaptive-expressions.UnaryOpExpContext.tryGetToken package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [ExpressionContext.tryGetToken](xref:adaptive-expressions.ExpressionContext.tryGetToken) methods: - name: accept(ExpressionAntlrParserVisitor) uid: adaptive-expressions.UnaryOpExpContext.accept package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,7 +869,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ExpressionAntlrParserListener)' @@ -840,7 +881,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ExpressionAntlrParserListener)' @@ -853,7 +893,6 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -865,35 +904,32 @@ methods: package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NON(): TerminalNode | undefined' + content: 'function NON(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: PLUS() uid: adaptive-expressions.UnaryOpExpContext.PLUS package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function PLUS(): TerminalNode | undefined' + content: 'function PLUS(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: SUBSTRACT() uid: adaptive-expressions.UnaryOpExpContext.SUBSTRACT package: adaptive-expressions summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SUBSTRACT(): TerminalNode | undefined' + content: 'function SUBSTRACT(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Union.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Union.yml deleted file mode 100644 index a00ad21b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Union.yml +++ /dev/null @@ -1,123 +0,0 @@ -### YamlMime:TSType -name: Union -uid: adaptive-expressions.Union -package: adaptive-expressions -summary: >- - Return a collection that has all the items from the specified collections. - - To appear in the result, an item can appear in any collection passed to this - function. - - If one or more items have the same name, the last item with that name appears - in the result. -fullName: Union -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Union() - uid: adaptive-expressions.Union.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Union](xref:adaptive-expressions.Union) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Union() -properties: - - name: negation - uid: adaptive-expressions.Union.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Union.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Union.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Union.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Union.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Unique.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Unique.yml deleted file mode 100644 index 371c0ca4..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Unique.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Unique -uid: adaptive-expressions.Unique -package: adaptive-expressions -summary: Remove all duplicates from an array. -fullName: Unique -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Unique() - uid: adaptive-expressions.Unique.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [Unique](xref:adaptive-expressions.Unique) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Unique() -properties: - - name: negation - uid: adaptive-expressions.Unique.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Unique.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Unique.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Unique.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Unique.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponent.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponent.yml deleted file mode 100644 index 00c36b87..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponent.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriComponent -uid: adaptive-expressions.UriComponent -package: adaptive-expressions -summary: Return the binary version of a uniform resource identifier (URI) component. -fullName: UriComponent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriComponent() - uid: adaptive-expressions.UriComponent.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriComponent](xref:adaptive-expressions.UriComponent) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriComponent() -properties: - - name: negation - uid: adaptive-expressions.UriComponent.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriComponent.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriComponent.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriComponent.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriComponent.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponentToString.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponentToString.yml deleted file mode 100644 index 8a9890ed..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriComponentToString.yml +++ /dev/null @@ -1,119 +0,0 @@ -### YamlMime:TSType -name: UriComponentToString -uid: adaptive-expressions.UriComponentToString -package: adaptive-expressions -summary: >- - Return the string version of a uniform resource identifier (URI) encoded - string, effectively decoding the URI-encoded string. -fullName: UriComponentToString -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriComponentToString() - uid: adaptive-expressions.UriComponentToString.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriComponentToString](xref:adaptive-expressions.UriComponentToString) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriComponentToString() -properties: - - name: negation - uid: adaptive-expressions.UriComponentToString.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriComponentToString.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriComponentToString.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriComponentToString.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriComponentToString.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriHost.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriHost.yml deleted file mode 100644 index 06b45319..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriHost.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriHost -uid: adaptive-expressions.UriHost -package: adaptive-expressions -summary: Return the host value of a unified resource identifier (URI). -fullName: UriHost -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriHost() - uid: adaptive-expressions.UriHost.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriHost](xref:adaptive-expressions.UriHost) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriHost() -properties: - - name: negation - uid: adaptive-expressions.UriHost.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriHost.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriHost.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriHost.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriHost.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPath.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPath.yml deleted file mode 100644 index 2e07a0d2..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPath.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriPath -uid: adaptive-expressions.UriPath -package: adaptive-expressions -summary: Return the path value of a unified resource identifier (URI). -fullName: UriPath -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriPath() - uid: adaptive-expressions.UriPath.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriPath](xref:adaptive-expressions.UriPath) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriPath() -properties: - - name: negation - uid: adaptive-expressions.UriPath.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriPath.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriPath.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriPath.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriPath.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPathAndQuery.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPathAndQuery.yml deleted file mode 100644 index 5532640c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPathAndQuery.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriPathAndQuery -uid: adaptive-expressions.UriPathAndQuery -package: adaptive-expressions -summary: Return the path and query value of a unified resource identifier (URI). -fullName: UriPathAndQuery -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriPathAndQuery() - uid: adaptive-expressions.UriPathAndQuery.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriPathAndQuery](xref:adaptive-expressions.UriPathAndQuery) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriPathAndQuery() -properties: - - name: negation - uid: adaptive-expressions.UriPathAndQuery.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriPathAndQuery.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriPathAndQuery.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriPathAndQuery.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriPathAndQuery.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPort.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPort.yml deleted file mode 100644 index 566077e1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriPort.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriPort -uid: adaptive-expressions.UriPort -package: adaptive-expressions -summary: Return the port value of a unified resource identifier (URI). -fullName: UriPort -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriPort() - uid: adaptive-expressions.UriPort.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriPort](xref:adaptive-expressions.UriPort) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriPort() -properties: - - name: negation - uid: adaptive-expressions.UriPort.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriPort.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriPort.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriPort.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriPort.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriQuery.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriQuery.yml deleted file mode 100644 index 479ffac5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriQuery.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriQuery -uid: adaptive-expressions.UriQuery -package: adaptive-expressions -summary: Return the query value of a unified resource identifier (URI). -fullName: UriQuery -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriQuery() - uid: adaptive-expressions.UriQuery.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriQuery](xref:adaptive-expressions.UriQuery) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriQuery() -properties: - - name: negation - uid: adaptive-expressions.UriQuery.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriQuery.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriQuery.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriQuery.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriQuery.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriScheme.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriScheme.yml deleted file mode 100644 index a280cf66..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UriScheme.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UriScheme -uid: adaptive-expressions.UriScheme -package: adaptive-expressions -summary: Return the scheme value of a unified resource identifier (URI). -fullName: UriScheme -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UriScheme() - uid: adaptive-expressions.UriScheme.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UriScheme](xref:adaptive-expressions.UriScheme) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UriScheme() -properties: - - name: negation - uid: adaptive-expressions.UriScheme.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UriScheme.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UriScheme.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UriScheme.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UriScheme.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UtcNow.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UtcNow.yml deleted file mode 100644 index 36a8df30..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/UtcNow.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: UtcNow -uid: adaptive-expressions.UtcNow -package: adaptive-expressions -summary: Return the current timestamp. -fullName: UtcNow -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UtcNow() - uid: adaptive-expressions.UtcNow.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the - [UtcNow](xref:adaptive-expressions.UtcNow) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UtcNow() -properties: - - name: negation - uid: adaptive-expressions.UtcNow.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.UtcNow.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.UtcNow.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.UtcNow.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.UtcNow.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Util.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Util.yml index ec001233..7256f908 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Util.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Util.yml @@ -5,16 +5,14 @@ package: adaptive-expressions summary: util class fullName: Util remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'trim(string, string)' + - name: trim(string, string) uid: adaptive-expressions.Util.trim package: adaptive-expressions summary: trim char. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function trim(str: string, char: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValidateExpressionDelegate.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValidateExpressionDelegate.yml index 892d6140..692f9c92 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValidateExpressionDelegate.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValidateExpressionDelegate.yml @@ -7,7 +7,6 @@ summary: |- Validators can and should throw exceptions if the expression is not valid. fullName: ValidateExpressionDelegate remarks: '' -isPreview: false isDeprecated: false syntax: | type ValidateExpressionDelegate = (expression: Expression) => any diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpression.yml index 6e8086ba..b3dfbcb9 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpression.yml @@ -20,26 +20,23 @@ remarks: >- prop = "=length(user.name)" => "3" prop = "=user.name" => "Joe" prop = "\=user" => "=user". -isPreview: false isDeprecated: false type: class constructors: - - name: ValueExpression(any | string | Expression) + - name: ValueExpression(any) uid: adaptive-expressions.ValueExpression.constructor package: adaptive-expressions summary: >- Initializes a new instance of the [ValueExpression](xref:adaptive-expressions.ValueExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ValueExpression(value?: any | string | Expression)' + content: 'new ValueExpression(value?: any)' parameters: - id: value - type: any | string | - description: | - An object of `any` kind or a `string` expression. + type: any + description: An object of `any` kind or a `string` expression. inheritedProperties: - name: expressionText uid: adaptive-expressions.ValueExpression.expressionText @@ -47,7 +44,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -63,7 +59,6 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: any' @@ -79,7 +74,6 @@ inheritedMethods: package: adaptive-expressions summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: content: 'function getValue(data: object): any' @@ -98,7 +92,6 @@ inheritedMethods: package: adaptive-expressions summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -113,7 +106,6 @@ inheritedMethods: package: adaptive-expressions summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -128,7 +120,6 @@ inheritedMethods: package: adaptive-expressions summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tryGetValue(data: object): { error: Error, value: any }' @@ -143,18 +134,16 @@ inheritedMethods: Inherited From [ExpressionProperty.tryGetValue](xref:adaptive-expressions.ExpressionProperty.tryGetValue) methods: - - name: setValue(any | string | Expression) + - name: setValue(any) uid: adaptive-expressions.ValueExpression.setValue package: adaptive-expressions summary: Set value as value expression. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: any | string | Expression)' + content: 'function setValue(value: any)' parameters: - id: value - type: any | string | - description: | - Value to set. + type: any + description: Value to set. extends: <any> diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpressionConverter.yml index af8a193b..6ce32483 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueExpressionConverter.yml @@ -7,25 +7,23 @@ summary: >- [ValueExpression](xref:adaptive-expressions.ValueExpression) converter. fullName: ValueExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: convert(unknown | ValueExpression) + - name: convert(unknown) uid: adaptive-expressions.ValueExpressionConverter.convert package: adaptive-expressions summary: >- Converts `any` value into a [ValueExpression](xref:adaptive-expressions.ValueExpression). remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function convert(value: unknown | ValueExpression): ValueExpression' + content: 'function convert(value: unknown): ValueExpression' parameters: - id: value - type: unknown | + type: unknown description: '`any` value to convert.' return: - description: 'The [ValueExpression](xref:adaptive-expressions.ValueExpression).' + description: The [ValueExpression](xref:adaptive-expressions.ValueExpression). type: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueWithError.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueWithError.yml index 5d83d2c8..7553d43d 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueWithError.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/ValueWithError.yml @@ -5,7 +5,6 @@ package: adaptive-expressions summary: Value result with error. fullName: ValueWithError remarks: '' -isPreview: false isDeprecated: false syntax: | - type ValueWithError = { error: string, value: any } + type ValueWithError = { error: string; value: any } diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/VerifyExpression.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/VerifyExpression.yml index b2c95bd7..f08a8b9e 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/VerifyExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/VerifyExpression.yml @@ -7,7 +7,6 @@ summary: >- string if not. fullName: VerifyExpression remarks: '' -isPreview: false isDeprecated: false syntax: | type VerifyExpression = ( diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Where.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Where.yml deleted file mode 100644 index 7c41204e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Where.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: Where -uid: adaptive-expressions.Where -package: adaptive-expressions -summary: >- - Filter on each element and return the new collection of filtered elements - which match a specific condition. -fullName: Where -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Where() - uid: adaptive-expressions.Where.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Where](xref:adaptive-expressions.Where) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Where() -properties: - - name: negation - uid: adaptive-expressions.Where.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Where.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Where.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Where.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Where.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XML.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XML.yml deleted file mode 100644 index 4851a535..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XML.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: XML -uid: adaptive-expressions.XML -package: adaptive-expressions -summary: Return the newline string according to the environment. -fullName: XML -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: XML() - uid: adaptive-expressions.XML.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [EOL](xref:adaptive-expressions.EOL) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new XML() -properties: - - name: negation - uid: adaptive-expressions.XML.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.XML.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.XML.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.XML.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.XML.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XPath.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XPath.yml deleted file mode 100644 index c46035c0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/XPath.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: XPath -uid: adaptive-expressions.XPath -package: adaptive-expressions -summary: Return the newline string according to the environment. -fullName: XPath -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: XPath() - uid: adaptive-expressions.XPath.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [EOL](xref:adaptive-expressions.EOL) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new XPath() -properties: - - name: negation - uid: adaptive-expressions.XPath.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.XPath.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.XPath.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.XPath.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.XPath.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Year.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Year.yml deleted file mode 100644 index b7e24a3f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/Year.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: Year -uid: adaptive-expressions.Year -package: adaptive-expressions -summary: Return the year of the specified timestamp. -fullName: Year -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Year() - uid: adaptive-expressions.Year.constructor - package: adaptive-expressions - summary: >- - Initializes a new instance of the [Year](xref:adaptive-expressions.Year) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new Year() -properties: - - name: negation - uid: adaptive-expressions.Year.negation - package: adaptive-expressions - summary: |- - Gets the evaluator that is a negation of this one. - Sets the evaluator that is a negation of this one. - fullName: negation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ExpressionEvaluator negation - return: - description: The evaluator that is a negation of this one. - type: -inheritedProperties: - - name: returnType - uid: adaptive-expressions.Year.returnType - package: adaptive-expressions - summary: Type expected by evaluating the expression. - fullName: returnType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'returnType: ReturnType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.returnType](xref:adaptive-expressions.ExpressionEvaluator.returnType) - - name: type - uid: adaptive-expressions.Year.type - package: adaptive-expressions - summary: Gets the expression type for evaluator. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.type](xref:adaptive-expressions.ExpressionEvaluator.type) -inheritedMethods: - - name: 'tryEvaluate(Expression, MemoryInterface, Options)' - uid: adaptive-expressions.Year.tryEvaluate - package: adaptive-expressions - summary: Evaluate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function tryEvaluate(expression: Expression, state: MemoryInterface, - options: Options): ValueWithError - parameters: - - id: expression - type: - description: Expression to evaluate. - - id: state - type: - description: Global state information. - - id: options - type: - description: Options used in the evaluation. - return: - description: The value and error string that is non-null if there is an error. - type: - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.tryEvaluate](xref:adaptive-expressions.ExpressionEvaluator.tryEvaluate) - - name: validateExpression(Expression) - uid: adaptive-expressions.Year.validateExpression - package: adaptive-expressions - summary: Validate an expression. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateExpression(expression: Expression)' - parameters: - - id: expression - type: - description: Expression to validate. - inheritanceDescription: >- - Inherited From - [ExpressionEvaluator.validateExpression](xref:adaptive-expressions.ExpressionEvaluator.validateExpression) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/index.yml b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/index.yml index 43a8d99e..e66eaa79 100644 --- a/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/adaptive-expressions/index.yml @@ -3,266 +3,128 @@ uid: adaptive-expressions name: adaptive-expressions summary: '' type: package +enums: + - adaptive-expressions.QuantifierType + - adaptive-expressions.RelationshipType + - adaptive-expressions.ReturnType classes: - - adaptive-expressions.Abs - - adaptive-expressions.Accessor - - adaptive-expressions.Add - - adaptive-expressions.AddDays - - adaptive-expressions.AddHours - - adaptive-expressions.AddMinutes - - adaptive-expressions.AddOrdinal - - adaptive-expressions.AddProperty - - adaptive-expressions.AddSeconds - - adaptive-expressions.AddToTime - - adaptive-expressions.All - - adaptive-expressions.And - - adaptive-expressions.Any - - adaptive-expressions.Average - - adaptive-expressions.Base64 - - adaptive-expressions.Base64ToBinary - - adaptive-expressions.Base64ToString - - adaptive-expressions.Binary - - adaptive-expressions.Bool - - adaptive-expressions.Ceiling - - adaptive-expressions.Coalesce - - adaptive-expressions.ComparisonEvaluator - - adaptive-expressions.Concat - - adaptive-expressions.Contains - - adaptive-expressions.ConvertFromUTC - - adaptive-expressions.ConvertToUTC - - adaptive-expressions.Count - - adaptive-expressions.CountWord - - adaptive-expressions.CreateArray - - adaptive-expressions.DataUri - - adaptive-expressions.DataUriToBinary - - adaptive-expressions.DataUriToString - - adaptive-expressions.DateFunc - - adaptive-expressions.DateReadBack - - adaptive-expressions.DateTimeDiff - - adaptive-expressions.DayOfMonth - - adaptive-expressions.DayOfWeek - - adaptive-expressions.DayOfYear - - adaptive-expressions.Divide - - adaptive-expressions.Element - - adaptive-expressions.Empty - - adaptive-expressions.EndsWith - - adaptive-expressions.EOL - - adaptive-expressions.Equal - - adaptive-expressions.Exists - - adaptive-expressions.First - - adaptive-expressions.Flatten - - adaptive-expressions.Float - - adaptive-expressions.Floor - - adaptive-expressions.Foreach - - adaptive-expressions.FormatDateTime - - adaptive-expressions.FormatEpoch - - adaptive-expressions.FormatNumber - - adaptive-expressions.FormatTicks - - adaptive-expressions.GetFutureTime - - adaptive-expressions.GetNextViableDate - - adaptive-expressions.GetNextViableTime - - adaptive-expressions.GetPastTime - - adaptive-expressions.GetPreviousViableDate - - adaptive-expressions.GetPreviousViableTime - - adaptive-expressions.GetProperty - - adaptive-expressions.GetTimeOfDay - - adaptive-expressions.GreaterThan - - adaptive-expressions.GreaterThanOrEqual - - adaptive-expressions.If - - adaptive-expressions.Ignore - - adaptive-expressions.IndexOf - - adaptive-expressions.IndicesAndValues - - adaptive-expressions.Int - - adaptive-expressions.Intersection - - adaptive-expressions.IsArray - - adaptive-expressions.IsBoolean - - adaptive-expressions.IsDate - - adaptive-expressions.IsDateRange - - adaptive-expressions.IsDateTime - - adaptive-expressions.IsDefinite - - adaptive-expressions.IsDuration - - adaptive-expressions.IsFloat - - adaptive-expressions.IsInteger - - adaptive-expressions.IsMatch - - adaptive-expressions.IsObject - - adaptive-expressions.IsPresent - - adaptive-expressions.IsString - - adaptive-expressions.IsTime - - adaptive-expressions.IsTimeRange - - adaptive-expressions.JPath - - adaptive-expressions.Join - - adaptive-expressions.Json - - adaptive-expressions.JsonStringify - - adaptive-expressions.Last - - adaptive-expressions.LastIndexOf - - adaptive-expressions.Length - - adaptive-expressions.LessThan - - adaptive-expressions.LessThanOrEqual - - adaptive-expressions.Max - - adaptive-expressions.Merge - - adaptive-expressions.Min - - adaptive-expressions.Mod - - adaptive-expressions.Month - - adaptive-expressions.Multiply - - adaptive-expressions.MultivariateNumericEvaluator - - adaptive-expressions.NewGuid - - adaptive-expressions.Not - - adaptive-expressions.NotEqual - - adaptive-expressions.NumberTransformEvaluator - - adaptive-expressions.NumericEvaluator - - adaptive-expressions.Optional - - adaptive-expressions.Or - - adaptive-expressions.Power - - adaptive-expressions.Rand - - adaptive-expressions.Range - - adaptive-expressions.RemoveProperty - - adaptive-expressions.Replace - - adaptive-expressions.ReplaceIgnoreCase - - adaptive-expressions.Reverse - - adaptive-expressions.Round - - adaptive-expressions.Select - - adaptive-expressions.SentenceCase - - adaptive-expressions.SetPathToValue - - adaptive-expressions.SetProperty - - adaptive-expressions.Skip - - adaptive-expressions.SortBy - - adaptive-expressions.SortByDescending - - adaptive-expressions.Split - - adaptive-expressions.Sqrt - - adaptive-expressions.StartOfDay - - adaptive-expressions.StartOfHour - - adaptive-expressions.StartOfMonth - - adaptive-expressions.StartsWith - - adaptive-expressions.String - - adaptive-expressions.StringOrValue - - adaptive-expressions.StringTransformEvaluator - - adaptive-expressions.SubArray - - adaptive-expressions.Substring - - adaptive-expressions.Subtract - - adaptive-expressions.SubtractFromTime - - adaptive-expressions.Sum - - adaptive-expressions.Take - - adaptive-expressions.Ticks - - adaptive-expressions.TicksToDays - - adaptive-expressions.TicksToHours - - adaptive-expressions.TicksToMinutes - - adaptive-expressions.TimeTransformEvaluator - - adaptive-expressions.TimexResolve - - adaptive-expressions.TitleCase - - adaptive-expressions.ToLower - - adaptive-expressions.ToUpper - - adaptive-expressions.Trim - - adaptive-expressions.Union - - adaptive-expressions.Unique - - adaptive-expressions.UriComponent - - adaptive-expressions.UriComponentToString - - adaptive-expressions.UriHost - - adaptive-expressions.UriPath - - adaptive-expressions.UriPathAndQuery - - adaptive-expressions.UriPort - - adaptive-expressions.UriQuery - - adaptive-expressions.UriScheme - - adaptive-expressions.UtcNow - - adaptive-expressions.Where - - adaptive-expressions.XML - - adaptive-expressions.XPath - - adaptive-expressions.Year - - adaptive-expressions.CommonRegex - - adaptive-expressions.Constant - - adaptive-expressions.ArrayExpressionConverter - - adaptive-expressions.BoolExpressionConverter - - adaptive-expressions.EnumExpressionConverter - - adaptive-expressions.ExpressionConverter - - adaptive-expressions.IntExpressionConverter - - adaptive-expressions.NumberExpressionConverter - - adaptive-expressions.ObjectExpressionConverter - - adaptive-expressions.StringExpressionConverter - - adaptive-expressions.ValueExpressionConverter - - adaptive-expressions.Expression - - adaptive-expressions.ExpressionEvaluator - - adaptive-expressions.ExpressionFunctions - - adaptive-expressions.ArrayExpression - - adaptive-expressions.BoolExpression - - adaptive-expressions.EnumExpression - - adaptive-expressions.ExpressionProperty - - adaptive-expressions.IntExpression - - adaptive-expressions.NumberExpression - - adaptive-expressions.ObjectExpression - - adaptive-expressions.StringExpression - - adaptive-expressions.ValueExpression - - adaptive-expressions.ExpressionType - - adaptive-expressions.Extensions - - adaptive-expressions.FunctionTable - - adaptive-expressions.FunctionUtils - - adaptive-expressions.InternalFunctionUtils - - adaptive-expressions.CommonRegexLexer - adaptive-expressions.Alpha_numsContext - adaptive-expressions.AlternationContext + - adaptive-expressions.ArgsListContext + - adaptive-expressions.ArrayCreationExpContext + - adaptive-expressions.ArrayExpression + - adaptive-expressions.ArrayExpressionConverter - adaptive-expressions.AtomContext + - adaptive-expressions.BinaryOpExpContext + - adaptive-expressions.BoolExpression + - adaptive-expressions.BoolExpressionConverter - adaptive-expressions.CaptureContext - adaptive-expressions.Cc_atomContext - adaptive-expressions.Cc_literalContext - adaptive-expressions.Character_classContext + - adaptive-expressions.Clause + - adaptive-expressions.CommonRegex + - adaptive-expressions.CommonRegexLexer - adaptive-expressions.CommonRegexParser + - adaptive-expressions.ComparisonEvaluator + - adaptive-expressions.Constant - adaptive-expressions.DigitContext - adaptive-expressions.DigitsContext - adaptive-expressions.ElementContext + - adaptive-expressions.EnumExpression + - adaptive-expressions.EnumExpressionConverter - adaptive-expressions.ExprContext + - adaptive-expressions.Expression + - adaptive-expressions.ExpressionAntlrLexer + - adaptive-expressions.ExpressionAntlrParser + - adaptive-expressions.ExpressionContext + - adaptive-expressions.ExpressionConverter + - adaptive-expressions.ExpressionEvaluator + - adaptive-expressions.ExpressionFunctions + - adaptive-expressions.ExpressionParser + - adaptive-expressions.ExpressionProperty + - adaptive-expressions.ExpressionType + - adaptive-expressions.Extensions + - adaptive-expressions.FileContext + - adaptive-expressions.FuncInvokeExpContext + - adaptive-expressions.FunctionTable + - adaptive-expressions.FunctionUtils + - adaptive-expressions.IdAtomContext + - adaptive-expressions.IndexAccessExpContext + - adaptive-expressions.IntExpression + - adaptive-expressions.IntExpressionConverter + - adaptive-expressions.JsonCreationExpContext + - adaptive-expressions.KeyContext + - adaptive-expressions.KeyValuePairContext + - adaptive-expressions.KeyValuePairListContext + - adaptive-expressions.LambdaContext - adaptive-expressions.LetterContext - adaptive-expressions.LiteralContext + - adaptive-expressions.MemberAccessExpContext + - adaptive-expressions.MultivariateNumericEvaluator - adaptive-expressions.NameContext + - adaptive-expressions.Node - adaptive-expressions.Non_captureContext - adaptive-expressions.Non_close_parenContext - adaptive-expressions.Non_close_parensContext - adaptive-expressions.NumberContext + - adaptive-expressions.NumberExpression + - adaptive-expressions.NumberExpressionConverter + - adaptive-expressions.NumberTransformEvaluator + - adaptive-expressions.NumericAtomContext + - adaptive-expressions.NumericEvaluator + - adaptive-expressions.ObjectExpression + - adaptive-expressions.ObjectExpressionConverter - adaptive-expressions.Octal_charContext - adaptive-expressions.Octal_digitContext - adaptive-expressions.OptionContext - adaptive-expressions.Option_flagContext + - adaptive-expressions.Options + - adaptive-expressions.ParenthesisExpContext - adaptive-expressions.ParseContext + - adaptive-expressions.ParseErrorListener + - adaptive-expressions.PrimaryExpContext + - adaptive-expressions.PrimaryExpressionContext + - adaptive-expressions.Quantifier - adaptive-expressions.QuantifierContext - adaptive-expressions.Quantifier_typeContext + - adaptive-expressions.RegexErrorListener - adaptive-expressions.Shared_atomContext - adaptive-expressions.Shared_literalContext - adaptive-expressions.SimpleObjectMemory - adaptive-expressions.StackedMemory - - adaptive-expressions.Options - - adaptive-expressions.ExpressionParser - - adaptive-expressions.ExpressionAntlrLexer - - adaptive-expressions.ArgsListContext - - adaptive-expressions.ArrayCreationExpContext - - adaptive-expressions.BinaryOpExpContext - - adaptive-expressions.ExpressionAntlrParser - - adaptive-expressions.ExpressionContext - - adaptive-expressions.FileContext - - adaptive-expressions.FuncInvokeExpContext - - adaptive-expressions.IdAtomContext - - adaptive-expressions.IndexAccessExpContext - - adaptive-expressions.JsonCreationExpContext - - adaptive-expressions.KeyContext - - adaptive-expressions.KeyValuePairContext - - adaptive-expressions.KeyValuePairListContext - - adaptive-expressions.LambdaContext - - adaptive-expressions.MemberAccessExpContext - - adaptive-expressions.NumericAtomContext - - adaptive-expressions.ParenthesisExpContext - - adaptive-expressions.PrimaryExpContext - - adaptive-expressions.PrimaryExpressionContext - adaptive-expressions.StringAtomContext + - adaptive-expressions.StringExpression + - adaptive-expressions.StringExpressionConverter - adaptive-expressions.StringInterpolationAtomContext - adaptive-expressions.StringInterpolationContext + - adaptive-expressions.StringTransformEvaluator - adaptive-expressions.TextContentContext - - adaptive-expressions.TripleOpExpContext - - adaptive-expressions.UnaryOpExpContext - - adaptive-expressions.ParseErrorListener - - adaptive-expressions.Util - - adaptive-expressions.RegexErrorListener + - adaptive-expressions.TimeTransformEvaluator - adaptive-expressions.TimeZoneConverter - - adaptive-expressions.Clause - - adaptive-expressions.Node - - adaptive-expressions.Quantifier - adaptive-expressions.Trigger - adaptive-expressions.TriggerTree + - adaptive-expressions.TripleOpExpContext + - adaptive-expressions.UnaryOpExpContext + - adaptive-expressions.Util + - adaptive-expressions.ValueExpression + - adaptive-expressions.ValueExpressionConverter +interfaces: + - adaptive-expressions.CommonRegexListener + - adaptive-expressions.CommonRegexVisitor + - adaptive-expressions.ExpressionAntlrParserListener + - adaptive-expressions.ExpressionAntlrParserVisitor + - adaptive-expressions.ExpressionParserInterface + - adaptive-expressions.MemoryInterface + - adaptive-expressions.Optimizer + - adaptive-expressions.PredicateComparer +typeAliases: + - adaptive-expressions.EvaluateExpressionDelegate + - adaptive-expressions.EvaluatorLookup + - adaptive-expressions.PredicateComparers + - adaptive-expressions.ValidateExpressionDelegate + - adaptive-expressions.ValueWithError + - adaptive-expressions.VerifyExpression functions: - name: convertCSharpDateTimeToDayjs(string) uid: adaptive-expressions.convertCSharpDateTimeToDayjs @@ -272,7 +134,6 @@ functions: format string. Ref: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convertCSharpDateTimeToDayjs(fmtString: string): string' @@ -285,23 +146,3 @@ functions: return: description: A Momengt.js style datetime format string. type: string -typeAliases: - - adaptive-expressions.EvaluateExpressionDelegate - - adaptive-expressions.EvaluatorLookup - - adaptive-expressions.ValidateExpressionDelegate - - adaptive-expressions.ValueWithError - - adaptive-expressions.VerifyExpression - - adaptive-expressions.PredicateComparers -interfaces: - - adaptive-expressions.ExpressionParserInterface - - adaptive-expressions.CommonRegexListener - - adaptive-expressions.CommonRegexVisitor - - adaptive-expressions.MemoryInterface - - adaptive-expressions.ExpressionAntlrParserListener - - adaptive-expressions.ExpressionAntlrParserVisitor - - adaptive-expressions.Optimizer - - adaptive-expressions.PredicateComparer -enums: - - adaptive-expressions.ReturnType - - adaptive-expressions.QuantifierType - - adaptive-expressions.RelationshipType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Label.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Label.yml deleted file mode 100644 index 4ef2cc37..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Label.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: Label -uid: botbuilder-ai-orchestrator.Label -package: botbuilder-ai-orchestrator -summary: '' -fullName: Label -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: name - uid: botbuilder-ai-orchestrator.Label.name - package: botbuilder-ai-orchestrator - summary: '' - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: span - uid: botbuilder-ai-orchestrator.Label.span - package: botbuilder-ai-orchestrator - summary: '' - fullName: span - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'span: { length: number, offset: number }' - return: - description: '' - type: '{ length: number, offset: number }' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelResolver.yml deleted file mode 100644 index 77cf0286..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelResolver.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSType -name: LabelResolver -uid: botbuilder-ai-orchestrator.LabelResolver -package: botbuilder-ai-orchestrator -summary: '' -fullName: LabelResolver -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'score(string, number)' - uid: botbuilder-ai-orchestrator.LabelResolver.score - package: botbuilder-ai-orchestrator - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function score(text: string, labelType?: number): Result[]' - parameters: - - id: text - type: string - description: '' - - id: labelType - type: number - description: '' - return: - description: '' - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelType.yml index d56b7ba6..a4e9dd5a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/LabelType.yml @@ -5,7 +5,6 @@ package: botbuilder-ai-orchestrator summary: '' fullName: LabelType remarks: '' -isPreview: false isDeprecated: false fields: - name: Intent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorBotComponent.yml index aaa65db2..d6184c2e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorBotComponent.yml @@ -5,7 +5,6 @@ package: botbuilder-ai-orchestrator summary: Define component assets for Orchestrator. fullName: OrchestratorBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,21 +14,19 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: botbuilder-ai-orchestrator.OrchestratorBotComponent.configureServices package: botbuilder-ai-orchestrator summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,6 +38,5 @@ methods: description: Services collection. - id: _configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizer.yml index 4b3eaa49..8e36c945 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizer.yml @@ -5,16 +5,14 @@ package: botbuilder-ai-orchestrator summary: Class that represents an adaptive Orchestrator recognizer. fullName: OrchestratorRecognizer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OrchestratorRecognizer(string, string, LabelResolver)' + - name: OrchestratorRecognizer(string, string, LabelResolver) uid: botbuilder-ai-orchestrator.OrchestratorRecognizer.constructor package: botbuilder-ai-orchestrator summary: Returns an OrchestratorRecognizer instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -28,9 +26,8 @@ constructors: type: string description: Path to snapshot. - id: resolverExternal - type: - description: | - Orchestrator resolver to use. + type: LabelResolver + description: Orchestrator resolver to use. properties: - name: $kind uid: botbuilder-ai-orchestrator.OrchestratorRecognizer.$kind @@ -38,7 +35,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -51,7 +47,6 @@ properties: summary: Intent name if ambiguous intents are detected. fullName: chooseIntent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'chooseIntent: "ChooseIntent" = "ChooseIntent"' @@ -64,7 +59,6 @@ properties: summary: Enable ambiguous intent detection. Defaults to false. fullName: detectAmbiguousIntents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'detectAmbiguousIntents: BoolExpression' @@ -82,7 +76,6 @@ properties: classified within this threshold of the top scoring intent. fullName: disambiguationScoreThreshold remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disambiguationScoreThreshold: NumberExpression' @@ -95,7 +88,6 @@ properties: summary: Full entity recognition results are available under this property fullName: entityProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entityProperty: "entityResult" = "entityResult"' @@ -108,7 +100,6 @@ properties: summary: The external entity recognizer. fullName: externalEntityRecognizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'externalEntityRecognizer?: Recognizer' @@ -121,7 +112,6 @@ properties: summary: Path to Orchestrator base model folder. fullName: modelFolder remarks: '' - isPreview: false isDeprecated: false syntax: content: 'modelFolder: StringExpression' @@ -134,7 +124,6 @@ properties: summary: Full intent recognition results are available under this property fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty: "result" = "result"' @@ -152,7 +141,6 @@ properties: (V5). fullName: scoreEntities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'scoreEntities: boolean' @@ -165,7 +153,6 @@ properties: summary: Path to the snapshot (.blu file) to load. fullName: snapshotFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'snapshotFile: StringExpression' @@ -179,14 +166,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From AdaptiveRecognizer.id - name: logPersonalInformation uid: botbuilder-ai-orchestrator.OrchestratorRecognizer.logPersonalInformation package: botbuilder-ai-orchestrator @@ -195,7 +181,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -211,51 +196,55 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From AdaptiveRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-ai-orchestrator.OrchestratorRecognizer.configure package: botbuilder-ai-orchestrator summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OrchestratorRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From AdaptiveRecognizer.configure methods: - - name: getConverter(Object) + - name: getConverter(keyof OrchestratorRecognizerConfiguration) uid: botbuilder-ai-orchestrator.OrchestratorRecognizer.getConverter package: botbuilder-ai-orchestrator summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + OrchestratorRecognizerConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof OrchestratorRecognizerConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- recognize(DialogContext, Partial, Record, Record) @@ -263,7 +252,6 @@ methods: package: botbuilder-ai-orchestrator summary: Returns a new OrchestratorRecognizer instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -278,10 +266,10 @@ methods: type: Partial<Activity> description: Current activity sent from user. - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Recognized result. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizerConfiguration.yml deleted file mode 100644 index ae922fa1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/OrchestratorRecognizerConfiguration.yml +++ /dev/null @@ -1,113 +0,0 @@ -### YamlMime:TSType -name: OrchestratorRecognizerConfiguration -uid: botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration -package: botbuilder-ai-orchestrator -summary: '' -fullName: OrchestratorRecognizerConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: detectAmbiguousIntents - uid: >- - botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.detectAmbiguousIntents - package: botbuilder-ai-orchestrator - summary: '' - fullName: detectAmbiguousIntents - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'detectAmbiguousIntents?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: disambiguationScoreThreshold - uid: >- - botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.disambiguationScoreThreshold - package: botbuilder-ai-orchestrator - summary: '' - fullName: disambiguationScoreThreshold - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - disambiguationScoreThreshold?: number | string | Expression | - NumberExpression - return: - description: '' - type: number | string | Expression | NumberExpression - - name: externalEntityRecognizer - uid: >- - botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.externalEntityRecognizer - package: botbuilder-ai-orchestrator - summary: '' - fullName: externalEntityRecognizer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'externalEntityRecognizer?: Recognizer' - return: - description: '' - type: Recognizer - - name: modelFolder - uid: botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.modelFolder - package: botbuilder-ai-orchestrator - summary: '' - fullName: modelFolder - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'modelFolder?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: snapshotFile - uid: >- - botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.snapshotFile - package: botbuilder-ai-orchestrator - summary: '' - fullName: snapshotFile - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'snapshotFile?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression -inheritedProperties: - - name: id - uid: botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.id - package: botbuilder-ai-orchestrator - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From RecognizerConfiguration.id - - name: telemetryClient - uid: >- - botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration.telemetryClient - package: botbuilder-ai-orchestrator - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient?: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From RecognizerConfiguration.telemetryClient -extends: RecognizerConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Result.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Result.yml deleted file mode 100644 index cb9cd52c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/Result.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: Result -uid: botbuilder-ai-orchestrator.Result -package: botbuilder-ai-orchestrator -summary: '' -fullName: Result -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: closest_text - uid: botbuilder-ai-orchestrator.Result.closest_text - package: botbuilder-ai-orchestrator - summary: '' - fullName: closest_text - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'closest_text: string' - return: - description: '' - type: string - - name: label - uid: botbuilder-ai-orchestrator.Result.label - package: botbuilder-ai-orchestrator - summary: '' - fullName: label - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'label: Label' - return: - description: '' - type: - - name: score - uid: botbuilder-ai-orchestrator.Result.score - package: botbuilder-ai-orchestrator - summary: '' - fullName: score - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'score: number' - return: - description: '' - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/index.yml index 5ca75b4d..d9f985c7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai-orchestrator/index.yml @@ -3,13 +3,8 @@ uid: botbuilder-ai-orchestrator name: botbuilder-ai-orchestrator summary: '' type: package +enums: + - botbuilder-ai-orchestrator.LabelType classes: - botbuilder-ai-orchestrator.OrchestratorBotComponent - botbuilder-ai-orchestrator.OrchestratorRecognizer -enums: - - botbuilder-ai-orchestrator.LabelType -interfaces: - - botbuilder-ai-orchestrator.Label - - botbuilder-ai-orchestrator.LabelResolver - - botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration - - botbuilder-ai-orchestrator.Result diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ActiveLearningUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ActiveLearningUtils.yml index 3e674e3d..b7c736a9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ActiveLearningUtils.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ActiveLearningUtils.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Generate Answer api utils class. fullName: ActiveLearningUtils remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: Maximum Score For Low Score Variation. fullName: MaximumScoreForLowScoreVariation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MaximumScoreForLowScoreVariation: 95 = 95' @@ -28,7 +26,6 @@ properties: summary: Max Low Score Variation Multiplier. fullName: MaxLowScoreVariationMultiplier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MaxLowScoreVariationMultiplier: 1 = 1' @@ -41,7 +38,6 @@ properties: summary: Minimum Score For Low Score Variation. fullName: MinimumScoreForLowScoreVariation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MinimumScoreForLowScoreVariation: 20 = 20' @@ -54,7 +50,6 @@ properties: summary: Previous Low Score Variation Multiplier. fullName: PreviousLowScoreVariationMultiplier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static PreviousLowScoreVariationMultiplier: 0.7 = 0.7' @@ -62,12 +57,11 @@ properties: description: '' type: methods: - - name: 'getLowScoreVariation(QnAMakerResult[])' + - name: getLowScoreVariation(QnAMakerResult[]) uid: botbuilder-ai.ActiveLearningUtils.getLowScoreVariation package: botbuilder-ai summary: Returns list of qnaSearch results which have low score variation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -75,8 +69,8 @@ methods: QnAMakerResult[]): QnAMakerResult[] parameters: - id: qnaSearchResults - type: '[]' + type: [] description: A list of results returned from the QnA getAnswer call. return: description: List of filtered qnaSearch results. - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Anchor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Anchor.yml index 8ded711a..b219c37b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Anchor.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Anchor.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Anchor for relative position in a sequence. fullName: Anchor remarks: '' -isPreview: false isDeprecated: false fields: - name: Current diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/AnswerSpanResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/AnswerSpanResponse.yml index 72fb91cc..dc3a1b91 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/AnswerSpanResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/AnswerSpanResponse.yml @@ -7,7 +7,6 @@ summary: >- QnA Maker Service. fullName: AnswerSpanResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: The end index for the precise answer generated. fullName: endIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endIndex?: number' @@ -30,7 +28,6 @@ properties: summary: The answer score pertaining to the quality of precise answer text. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score: number' @@ -43,7 +40,6 @@ properties: summary: The starting index for the precise answer generated. fullName: startIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'startIndex?: number' @@ -56,7 +52,6 @@ properties: summary: The precise answer text relevant to the user query. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/BindToActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/BindToActivity.yml deleted file mode 100644 index dfe0022a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/BindToActivity.yml +++ /dev/null @@ -1,48 +0,0 @@ -### YamlMime:TSType -name: BindToActivity -uid: botbuilder-ai.BindToActivity -package: botbuilder-ai -summary: Creates a new template to send the user based on the activity. -fullName: BindToActivity -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: BindToActivity(Partial) - uid: botbuilder-ai.BindToActivity.constructor - package: botbuilder-ai - summary: >- - Initializes a new instance of the - [BindToActivity](xref:botbuilder-ai.BindToActivity) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new BindToActivity(activity: Partial)' - parameters: - - id: activity - type: Partial<Activity> - description: The activity to send the user. -methods: - - name: 'bind(DialogContext, object)' - uid: botbuilder-ai.BindToActivity.bind - package: botbuilder-ai - summary: Binds the provided activity. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function bind(_context: DialogContext, _data?: object): - Promise> - parameters: - - id: _context - type: DialogContext - description: The dialog context. - - id: _data - type: object - description: 'Data to bind to. If Null, then dc.State will be used.' - return: - description: The linked activity. - type: Promise<Partial<Activity>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/CustomQuestionAnswering.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/CustomQuestionAnswering.yml index 6afc87be..9842b27c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/CustomQuestionAnswering.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/CustomQuestionAnswering.yml @@ -7,7 +7,6 @@ summary: >- feedbacks. fullName: CustomQuestionAnswering remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: package: botbuilder-ai summary: Creates a new CustomQuestionAnswering instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,7 @@ constructors: description: The BotTelemetryClient used for logging telemetry events. - id: logPersonalInformation type: boolean - description: > + description: >- Set to true to include personally indentifiable information in telemetry events. properties: @@ -49,7 +47,6 @@ properties: information that came from the user. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean logPersonalInformation @@ -64,7 +61,6 @@ properties: summary: Gets the currently configured BotTelemetryClient that logs the events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -77,7 +73,6 @@ methods: package: botbuilder-ai summary: Send feedback to the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function callTrain(feedbackRecords: FeedbackRecords): Promise' @@ -89,19 +84,18 @@ methods: description: A promise representing the async operation. type: Promise<void> - name: >- - getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: - string]: number) + getAnswers(TurnContext, QnAMakerOptions, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-ai.CustomQuestionAnswering.getAnswers package: botbuilder-ai summary: Calls the Language service to generate answer(s) for a question. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAnswers(context: TurnContext, options?: QnAMakerOptions, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: context type: TurnContext @@ -114,32 +108,31 @@ methods: (Optional) The options for the Custom Question Answering knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Additional metrics to be logged to telemetry with the QnaMessage event. return: description: A promise resolving to the QnAMaker result - type: 'Promise<[]>' + type: Promise<[]> - name: >- - getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: - string]: number) + getAnswersRaw(TurnContext, QnAMakerOptions, {[key: string]: string}, + {[key: string]: number}) uid: botbuilder-ai.CustomQuestionAnswering.getAnswersRaw package: botbuilder-ai summary: Generates an answer from the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAnswersRaw(context: TurnContext, options: QnAMakerOptions, - telemetryProperties: [key: string]: string, telemetryMetrics: [key: - string]: number): Promise + telemetryProperties: {[key: string]: string}, telemetryMetrics: {[key: + string]: number}): Promise parameters: - id: context type: TurnContext @@ -153,12 +146,12 @@ methods: for the Custom Question Answering knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional. Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional. Additional metrics to be logged to telemetry with the QnaMessage event. @@ -168,19 +161,18 @@ methods: ranking score. type: Promise<> - name: >- - getKnowledgebaseAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: - string, [key: string]: number) + getKnowledgebaseAnswersRaw(TurnContext, QnAMakerOptions, {[key: string]: + string}, {[key: string]: number}) uid: botbuilder-ai.CustomQuestionAnswering.getKnowledgebaseAnswersRaw package: botbuilder-ai summary: Queries for answers from the Language Service project's knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getKnowledgebaseAnswersRaw(context: TurnContext, options: - QnAMakerOptions, telemetryProperties: [key: string]: string, - telemetryMetrics: [key: string]: number): Promise + QnAMakerOptions, telemetryProperties: {[key: string]: string}, + telemetryMetrics: {[key: string]: number}): Promise parameters: - id: context type: TurnContext @@ -194,12 +186,12 @@ methods: for the Language Service project's knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional. Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional. Additional metrics to be logged to telemetry with the QnaMessage event. @@ -208,12 +200,11 @@ methods: A list of answers for the user query, sorted in decreasing order of ranking score. type: Promise<> - - name: 'getLowScoreVariation(QnAMakerResult[])' + - name: getLowScoreVariation(QnAMakerResult[]) uid: botbuilder-ai.CustomQuestionAnswering.getLowScoreVariation package: botbuilder-ai summary: Filters the ambiguous question for active learning. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -221,8 +212,8 @@ methods: QnAMakerResult[] parameters: - id: queryResult - type: '[]' + type: [] description: User query output. return: description: the filtered results - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DateTimeSpec.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DateTimeSpec.yml index 84888f93..a931f46b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DateTimeSpec.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DateTimeSpec.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: The date time recognizer can recognize a wide variety of time expressions. fullName: DateTimeSpec remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: Timex expressions fullName: timex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timex: string[]' return: description: '' - type: 'string[]' + type: string[] - name: type uid: botbuilder-ai.DateTimeSpec.type package: botbuilder-ai summary: Type of expression. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DynamicList.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DynamicList.yml index d6d4440a..c58c0bba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DynamicList.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/DynamicList.yml @@ -1,11 +1,34 @@ -### YamlMime:TSTypeAlias +### YamlMime:TSType name: DynamicList uid: botbuilder-ai.DynamicList package: botbuilder-ai summary: Defines an extension for a list entity. fullName: DynamicList remarks: '' -isPreview: false isDeprecated: false -syntax: | - type DynamicList = { entity: string, list: ListElement[] } +type: interface +properties: + - name: listEntityName + uid: botbuilder-ai.DynamicList.listEntityName + package: botbuilder-ai + summary: The name of the list entity to extend. + fullName: listEntityName + remarks: '' + isDeprecated: false + syntax: + content: 'listEntityName?: string' + return: + description: '' + type: string + - name: requestLists + uid: botbuilder-ai.DynamicList.requestLists + package: botbuilder-ai + summary: The lists to append on the extended list entity. + fullName: requestLists + remarks: '' + isDeprecated: false + syntax: + content: 'requestLists?: ListElement[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ExternalEntity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ExternalEntity.yml index 5c18b84a..be22d4f4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ExternalEntity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ExternalEntity.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines a user predicted entity that extends an already existing one. fullName: ExternalEntity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The length of the predicted entity. fullName: entityLength remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entityLength?: number' @@ -28,7 +26,6 @@ properties: summary: The name of the entity to extend. fullName: entityName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entityName?: string' @@ -41,7 +38,6 @@ properties: summary: A user supplied custom resolution to return as the entity's prediction. fullName: resolution remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resolution?: T' @@ -54,7 +50,6 @@ properties: summary: The start character index of the predicted entity. fullName: startIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'startIndex?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecord.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecord.yml index 2bdcb793..9d3cd3b2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecord.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecord.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines active learning feedback record. fullName: FeedbackRecord remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: QnA id fullName: qnaId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaId: string' @@ -28,7 +26,6 @@ properties: summary: ID of the user. fullName: userId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userId: string' @@ -41,7 +38,6 @@ properties: summary: User question. fullName: userQuestion remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userQuestion: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecords.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecords.yml index 3a09aec3..dc972cf0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecords.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/FeedbackRecords.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines array of active learning feedback records. fullName: FeedbackRecords remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: Array of feedback records. fullName: feedbackRecords remarks: '' - isPreview: false isDeprecated: false syntax: content: 'feedbackRecords: FeedbackRecord[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Filters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Filters.yml index 257e094b..e1844701 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Filters.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/Filters.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines query filters comprising of metadata and sources fullName: Filters remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: logicalOperation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logicalOperation: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: metadataFilter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'metadataFilter: MetadataFilter' @@ -41,10 +38,9 @@ properties: summary: '' fullName: sourceFilter remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'sourceFilter: Array' + content: 'sourceFilter: string[]' return: description: '' - type: Array<string> + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GenerateAnswerUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GenerateAnswerUtils.yml deleted file mode 100644 index 6f29a806..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GenerateAnswerUtils.yml +++ /dev/null @@ -1,140 +0,0 @@ -### YamlMime:TSType -name: GenerateAnswerUtils -uid: botbuilder-ai.GenerateAnswerUtils -package: botbuilder-ai -summary: Generate Answer api utils class. -fullName: GenerateAnswerUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'GenerateAnswerUtils(QnAMakerOptions, QnAMakerEndpoint)' - uid: botbuilder-ai.GenerateAnswerUtils.constructor - package: botbuilder-ai - summary: Creates new Generate answer utils. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new GenerateAnswerUtils(_options: QnAMakerOptions, endpoint: - QnAMakerEndpoint) - parameters: - - id: _options - type: - description: Settings used to configure the instance. - - id: endpoint - type: - description: | - The endpoint of the knowledge base to query. -properties: - - name: httpRequestUtils - uid: botbuilder-ai.GenerateAnswerUtils.httpRequestUtils - package: botbuilder-ai - summary: '' - fullName: httpRequestUtils - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'httpRequestUtils: HttpRequestUtils' - return: - description: '' - type: -methods: - - name: 'emitTraceInfo(TurnContext, QnAMakerResult[], QnAMakerOptions)' - uid: botbuilder-ai.GenerateAnswerUtils.emitTraceInfo - package: botbuilder-ai - summary: Emits a trace event detailing a QnA Maker call and its results. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function emitTraceInfo(turnContext: TurnContext, answers: - QnAMakerResult[], queryOptions?: QnAMakerOptions): Promise - parameters: - - id: turnContext - type: TurnContext - description: Turn Context for the current turn of conversation with the user. - - id: answers - type: '[]' - description: Answers returned by QnA Maker. - - id: queryOptions - type: - description: >- - (Optional) The options for the QnA Maker knowledge base. If null, - constructor option is used for this instance. - return: - description: a promise representing the async operation - type: Promise<any> - - name: 'queryQnaService(QnAMakerEndpoint, string, QnAMakerOptions)' - uid: botbuilder-ai.GenerateAnswerUtils.queryQnaService - package: botbuilder-ai - summary: Called internally to query the QnA Maker service. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function queryQnaService(endpoint: QnAMakerEndpoint, question: string, - options?: QnAMakerOptions): Promise - parameters: - - id: endpoint - type: - description: The endpoint of the knowledge base to query. - - id: question - type: string - description: Question which need to be queried. - - id: options - type: - description: >- - (Optional) The options for the QnA Maker knowledge base. If null, - constructor option is used for this instance. - return: - description: |- - a promise that resolves to the query results. - . - type: 'Promise<[]>' - - name: 'queryQnaServiceRaw(QnAMakerEndpoint, string, QnAMakerOptions)' - uid: botbuilder-ai.GenerateAnswerUtils.queryQnaServiceRaw - package: botbuilder-ai - summary: Called internally to query the QnA Maker service. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function queryQnaServiceRaw(endpoint: QnAMakerEndpoint, question: - string, options?: QnAMakerOptions): Promise - parameters: - - id: endpoint - type: - description: The endpoint of the knowledge base to query. - - id: question - type: string - description: Question which need to be queried. - - id: options - type: - description: >- - (Optional) The options for the QnA Maker knowledge base. If null, - constructor option is used for this instance. - return: - description: a promise that resolves to the raw query results - type: Promise<> - - name: validateOptions(QnAMakerOptions) - uid: botbuilder-ai.GenerateAnswerUtils.validateOptions - package: botbuilder-ai - summary: Validate qna maker options - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateOptions(options: QnAMakerOptions)' - parameters: - - id: options - type: - description: > - The options for the QnA Maker knowledge base. If null, constructor - option is used for this instance. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2.yml index 47d2bbe1..f4b8c107 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2.yml @@ -7,7 +7,6 @@ summary: |- Licensed under the MIT License. fullName: GeographyV2 remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Name of location. fullName: location remarks: '' - isPreview: false isDeprecated: false syntax: content: 'location: string' @@ -30,7 +28,6 @@ properties: summary: Type of location. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: GeographyV2Type' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2Type.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2Type.yml index 9ef04cec..3a9bdef6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2Type.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/GeographyV2Type.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: GeographyV2Type remarks: '' -isPreview: false isDeprecated: false fields: - name: City diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/HttpRequestUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/HttpRequestUtils.yml deleted file mode 100644 index 949aebe3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/HttpRequestUtils.yml +++ /dev/null @@ -1,41 +0,0 @@ -### YamlMime:TSType -name: HttpRequestUtils -uid: botbuilder-ai.HttpRequestUtils -package: botbuilder-ai -summary: Http request utils class. -fullName: HttpRequestUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'executeHttpRequest(string, string, QnAMakerEndpoint, number)' - uid: botbuilder-ai.HttpRequestUtils.executeHttpRequest - package: botbuilder-ai - summary: Execute Http request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function executeHttpRequest(requestUrl: string, payloadBody: string, - endpoint: QnAMakerEndpoint, timeout?: number): Promise - parameters: - - id: requestUrl - type: string - description: Http request url. - - id: payloadBody - type: string - description: Http request body. - - id: endpoint - type: - description: QnA Maker endpoint details. - - id: timeout - type: number - description: (Optional)Timeout for http call - return: - description: a promise that resolves to the QnAMakerResults - type: >- - Promise< | | undefined> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/InstanceData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/InstanceData.yml index 13ff4d82..59162198 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/InstanceData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/InstanceData.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Strongly typed information corresponding to a LUIS `$instance` value. fullName: InstanceData remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: 0-based index of the first character beyond the recognized entity. fullName: endIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endIndex: number' @@ -28,7 +26,6 @@ properties: summary: (Optional) Confidence in the recognition on a scale from 0.0 - 1.0. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score?: number' @@ -43,7 +40,6 @@ properties: recognized entity fullName: startIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'startIndex: number' @@ -56,7 +52,6 @@ properties: summary: Word broken and normalized text for the entity. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/IntentData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/IntentData.yml index a208fef4..abfc35ec 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/IntentData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/IntentData.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Strongly typed information corresponding to a LUIS intent. fullName: IntentData remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Confidence in intent classification on a scale from 0.0 - 1.0. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/JoinOperator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/JoinOperator.yml index 002eed7c..b7ea6818 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/JoinOperator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/JoinOperator.yml @@ -5,14 +5,13 @@ package: botbuilder-ai summary: Join Operator for Strict Filters. fullName: JoinOperator remarks: '' -isPreview: false isDeprecated: false fields: - name: AND uid: botbuilder-ai.JoinOperator.AND package: botbuilder-ai - summary: 'Default Join Operator, AND.' + summary: Default Join Operator, AND. - name: OR uid: botbuilder-ai.JoinOperator.OR package: botbuilder-ai - summary: 'Join Operator, OR.' + summary: Join Operator, OR. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswer.yml index f8c5a056..fc6e44e0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswer.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: KnowledgeBaseAnswer - KB answer to the user query fullName: KnowledgeBaseAnswer remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: answer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'answer: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: answerSpan remarks: '' - isPreview: false isDeprecated: false syntax: content: 'answerSpan: KnowledgeBaseAnswerSpan' @@ -41,7 +38,6 @@ properties: summary: '' fullName: confidenceScore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'confidenceScore: number' @@ -54,7 +50,6 @@ properties: summary: '' fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog: QnAResponseContext' @@ -67,7 +62,6 @@ properties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: number' @@ -80,33 +74,30 @@ properties: summary: '' fullName: metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'metadata: Map' return: description: '' - type: 'Map<string, string>' + type: Map<string, string> - name: questions uid: botbuilder-ai.KnowledgeBaseAnswer.questions package: botbuilder-ai summary: '' fullName: questions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'questions: string[]' return: description: '' - type: 'string[]' + type: string[] - name: source uid: botbuilder-ai.KnowledgeBaseAnswer.source package: botbuilder-ai summary: '' fullName: source remarks: '' - isPreview: false isDeprecated: false syntax: content: 'source: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswerSpan.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswerSpan.yml index bb29c33f..69b44811 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswerSpan.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswerSpan.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: KnowledgeBaseAnswerSpan - precise answer format fullName: KnowledgeBaseAnswerSpan remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: confidenceScore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'confidenceScore: number' @@ -28,7 +26,6 @@ properties: summary: '' fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: 'length: number' @@ -41,7 +38,6 @@ properties: summary: '' fullName: offset remarks: '' - isPreview: false isDeprecated: false syntax: content: 'offset: number' @@ -54,7 +50,6 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswers.yml index d1097991..6230a181 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswers.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/KnowledgeBaseAnswers.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: KnowledgeBaseAnswers - query knowledgebases response format fullName: KnowledgeBaseAnswers remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: answers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'answers: KnowledgeBaseAnswer[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LanguageServiceUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LanguageServiceUtils.yml deleted file mode 100644 index 9cd785f7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LanguageServiceUtils.yml +++ /dev/null @@ -1,142 +0,0 @@ -### YamlMime:TSType -name: LanguageServiceUtils -uid: botbuilder-ai.LanguageServiceUtils -package: botbuilder-ai -summary: >- - Utilities for using Query Knowledge Base and Add Active Learning feedback APIs - of language service. -fullName: LanguageServiceUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'LanguageServiceUtils(QnAMakerOptions, QnAMakerEndpoint)' - uid: botbuilder-ai.LanguageServiceUtils.constructor - package: botbuilder-ai - summary: Creates new Language Service utils. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new LanguageServiceUtils(_options: QnAMakerOptions, endpoint: - QnAMakerEndpoint) - parameters: - - id: _options - type: - description: Settings used to configure the instance. - - id: endpoint - type: - description: | - The endpoint of the knowledge base to query. -properties: - - name: endpoint - uid: botbuilder-ai.LanguageServiceUtils.endpoint - package: botbuilder-ai - summary: '' - fullName: endpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'endpoint: QnAMakerEndpoint' - return: - description: '' - type: - - name: httpRequestUtils - uid: botbuilder-ai.LanguageServiceUtils.httpRequestUtils - package: botbuilder-ai - summary: '' - fullName: httpRequestUtils - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'httpRequestUtils: HttpRequestUtils' - return: - description: '' - type: -methods: - - name: addFeedback(FeedbackRecords) - uid: botbuilder-ai.LanguageServiceUtils.addFeedback - package: botbuilder-ai - summary: Adds feedback to the knowledge base. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addFeedback(feedbackRecords: FeedbackRecords): Promise' - parameters: - - id: feedbackRecords - type: - description: A list of Feedback Records for Active Learning. - return: - description: A promise representing the async operation. - type: Promise<void> - - name: 'emitTraceInfo(TurnContext, QnAMakerResult[], QnAMakerOptions)' - uid: botbuilder-ai.LanguageServiceUtils.emitTraceInfo - package: botbuilder-ai - summary: >- - Emits a trace event detailing a Custom Question Answering call and its - results. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function emitTraceInfo(turnContext: TurnContext, answers: - QnAMakerResult[], queryOptions?: QnAMakerOptions): Promise - parameters: - - id: turnContext - type: TurnContext - description: Turn Context for the current turn of conversation with the user. - - id: answers - type: '[]' - description: Answers returned by Language Service. - - id: queryOptions - type: - description: >- - (Optional) The options for the Custom Question Answering knowledge - base. If null, constructor option is used for this instance. - return: - description: a promise representing the async operation - type: Promise<any> - - name: 'queryKnowledgebaseRaw(string, QnAMakerOptions)' - uid: botbuilder-ai.LanguageServiceUtils.queryKnowledgebaseRaw - package: botbuilder-ai - summary: Called to query the Language service. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function queryKnowledgebaseRaw(question: string, options?: - QnAMakerOptions): Promise - parameters: - - id: question - type: string - description: Question which need to be queried. - - id: options - type: - description: >- - (Optional) The options for the QnA Maker knowledge base. If null, - constructor option is used for this instance. - return: - description: a promise that resolves to the raw query results - type: Promise<> - - name: validateOptions(QnAMakerOptions) - uid: botbuilder-ai.LanguageServiceUtils.validateOptions - package: botbuilder-ai - summary: Validate qna maker options - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateOptions(options: QnAMakerOptions)' - parameters: - - id: options - type: - description: > - The options for the Custom Question Answering knowledge base. If - null, constructor option is used for this instance. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ListElement.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ListElement.yml index 5902be2e..5299b1db 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ListElement.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ListElement.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines a sub-list to append to an existing list entity. fullName: ListElement remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The canonical form of the sub-list. fullName: canonicalForm remarks: '' - isPreview: false isDeprecated: false syntax: content: 'canonicalForm?: string' @@ -28,10 +26,9 @@ properties: summary: The synonyms of the canonical form. fullName: synonyms remarks: '' - isPreview: false isDeprecated: false syntax: content: 'synonyms?: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptions.yml deleted file mode 100644 index 23dacd5f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptions.yml +++ /dev/null @@ -1,123 +0,0 @@ -### YamlMime:TSType -name: LuisAdaptivePredictionOptions -uid: botbuilder-ai.LuisAdaptivePredictionOptions -package: botbuilder-ai -summary: Optional parameters for a LUIS prediction request. -fullName: LuisAdaptivePredictionOptions -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dateTimeReference - uid: botbuilder-ai.LuisAdaptivePredictionOptions.dateTimeReference - package: botbuilder-ai - summary: >- - Gets or sets datetimeV2 offset. The format for the datetimeReference is - ISO 8601. - fullName: dateTimeReference - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dateTimeReference?: StringExpression' - return: - description: '' - type: StringExpression - - name: externalEntities - uid: botbuilder-ai.LuisAdaptivePredictionOptions.externalEntities - package: botbuilder-ai - summary: Gets or sets external entities recognized in the query. - fullName: externalEntities - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'externalEntities?: ArrayExpression' - return: - description: '' - type: ArrayExpression<> - - name: includeAllIntents - uid: botbuilder-ai.LuisAdaptivePredictionOptions.includeAllIntents - package: botbuilder-ai - summary: >- - Gets or sets a value indicating whether all intents come back or only the - top one. - fullName: includeAllIntents - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeAllIntents?: BoolExpression' - return: - description: '' - type: BoolExpression - - name: includeAPIResults - uid: botbuilder-ai.LuisAdaptivePredictionOptions.includeAPIResults - package: botbuilder-ai - summary: Gets or sets a value indicating whether API results should be included. - fullName: includeAPIResults - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeAPIResults?: BoolExpression' - return: - description: '' - type: BoolExpression - - name: includeInstanceData - uid: botbuilder-ai.LuisAdaptivePredictionOptions.includeInstanceData - package: botbuilder-ai - summary: >- - Gets or sets a value indicating whether or not instance data should be - included in response. - fullName: includeInstanceData - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeInstanceData?: BoolExpression' - return: - description: '' - type: BoolExpression - - name: log - uid: botbuilder-ai.LuisAdaptivePredictionOptions.log - package: botbuilder-ai - summary: Gets or sets a value indicating whether queries should be logged in LUIS. - fullName: log - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'log?: BoolExpression' - return: - description: '' - type: BoolExpression - - name: preferExternalEntities - uid: botbuilder-ai.LuisAdaptivePredictionOptions.preferExternalEntities - package: botbuilder-ai - summary: >- - Gets or sets a value indicating whether external entities should override - other means of recognizing entities. - fullName: preferExternalEntities - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'preferExternalEntities?: BoolExpression' - return: - description: '' - type: BoolExpression - - name: slot - uid: botbuilder-ai.LuisAdaptivePredictionOptions.slot - package: botbuilder-ai - summary: Gets or sets the LUIS slot to use for the application. - fullName: slot - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'slot?: StringExpression' - return: - description: '' - type: StringExpression diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConfiguration.yml deleted file mode 100644 index f02b54c4..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConfiguration.yml +++ /dev/null @@ -1,129 +0,0 @@ -### YamlMime:TSType -name: LuisAdaptivePredictionOptionsConfiguration -uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration -package: botbuilder-ai -summary: '' -fullName: LuisAdaptivePredictionOptionsConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dateTimeReference - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.dateTimeReference - package: botbuilder-ai - summary: >- - Gets or sets datetimeV2 offset. The format for the datetimeReference is - ISO 8601. - fullName: dateTimeReference - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dateTimeReference?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: externalEntities - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.externalEntities - package: botbuilder-ai - summary: Gets or sets external entities recognized in the query. - fullName: externalEntities - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - externalEntities?: ExternalEntity[] | string | Expression | - ArrayExpression - return: - description: '' - type: >- - [] | string | Expression | - ArrayExpression<> - - name: includeAllIntents - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.includeAllIntents - package: botbuilder-ai - summary: >- - Gets or sets a value indicating whether all intents come back or only the - top one. - fullName: includeAllIntents - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeAllIntents?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: includeAPIResults - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.includeAPIResults - package: botbuilder-ai - summary: Gets or sets a value indicating whether API results should be included. - fullName: includeAPIResults - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeAPIResults?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: includeInstanceData - uid: >- - botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.includeInstanceData - package: botbuilder-ai - summary: >- - Gets or sets a value indicating whether or not instance data should be - included in response. - fullName: includeInstanceData - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeInstanceData?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: log - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.log - package: botbuilder-ai - summary: Gets or sets a value indicating whether queries should be logged in LUIS. - fullName: log - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'log?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: preferExternalEntities - uid: >- - botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.preferExternalEntities - package: botbuilder-ai - summary: >- - Gets or sets a value indicating whether external entities should override - other means of recognizing entities. - fullName: preferExternalEntities - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'preferExternalEntities?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: slot - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration.slot - package: botbuilder-ai - summary: Gets or sets the LUIS slot to use for the application. - fullName: slot - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'slot?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConverter.yml deleted file mode 100644 index 05a73319..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptivePredictionOptionsConverter.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: LuisAdaptivePredictionOptionsConverter -uid: botbuilder-ai.LuisAdaptivePredictionOptionsConverter -package: botbuilder-ai -summary: Converts optional parameters for a LUIS prediction request. -fullName: LuisAdaptivePredictionOptionsConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: convert(LuisAdaptivePredictionOptionsConfiguration) - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConverter.convert - package: botbuilder-ai - summary: >- - Converts the provided options configuration into an object of - [LuisAdaptivePredictionOptions](xref:botbuilder-ai.LuisAdaptivePredictionOptions) - type. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function convert(config: LuisAdaptivePredictionOptionsConfiguration): - LuisAdaptivePredictionOptions - parameters: - - id: config - type: >- - - description: Options configuration for LuisAdaptivePredictionOptions. - return: - description: >- - The converted options configuration to the - [LuisAdaptivePredictionOptions](xref:botbuilder-ai.LuisAdaptivePredictionOptions) - interface. - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizer.yml index 8b7627eb..a04f421b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Class that represents an adaptive LUIS recognizer. fullName: LuisAdaptiveRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: LUIS application ID. fullName: applicationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationId: StringExpression' @@ -41,20 +38,18 @@ properties: summary: LUIS dynamic list. fullName: dynamicLists remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dynamicLists: ArrayExpression' return: description: '' - type: ArrayExpression<> + type: ArrayExpression<DynamicList> - name: endpoint uid: botbuilder-ai.LuisAdaptiveRecognizer.endpoint package: botbuilder-ai summary: LUIS endpoint to query. fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpoint: StringExpression' @@ -67,7 +62,6 @@ properties: summary: Key used to talk to a LUIS endpoint. fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: StringExpression' @@ -80,7 +74,6 @@ properties: summary: External entity recognizer. fullName: externalEntityRecognizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'externalEntityRecognizer: Recognizer' @@ -95,7 +88,6 @@ properties: telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -108,20 +100,18 @@ properties: summary: LUIS prediction options. fullName: predictionOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'predictionOptions: LuisAdaptivePredictionOptions' return: description: '' - type: + type: LuisAdaptivePredictionOptions - name: version uid: botbuilder-ai.LuisAdaptiveRecognizer.version package: botbuilder-ai summary: LUIS application version. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: StringExpression' @@ -135,7 +125,6 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -151,7 +140,6 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -160,42 +148,47 @@ inheritedProperties: type: BotTelemetryClient inheritanceDescription: Inherited From Recognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-ai.LuisAdaptiveRecognizer.configure package: botbuilder-ai summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + LuisAdaptiveRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Recognizer.configure methods: - - name: getConverter(Object) + - name: getConverter(keyof LuisAdaptiveRecognizerConfiguration) uid: botbuilder-ai.LuisAdaptiveRecognizer.getConverter package: botbuilder-ai summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + LuisAdaptiveRecognizerConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof LuisAdaptiveRecognizerConfiguration description: Properties that extend RecognizerConfiguration. return: description: Expression converter. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- recognize(DialogContext, Activity, Record, Record) @@ -203,7 +196,6 @@ methods: package: botbuilder-ai summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -213,17 +205,17 @@ methods: parameters: - id: dialogContext type: DialogContext - description: 'The [DialogContext](xref:botbuilder-dialogs.DialogContext).' + description: The [DialogContext](xref:botbuilder-dialogs.DialogContext). - id: activity type: Activity - description: 'The [Activity](xref:botbuilder-core.Activity).' + description: The [Activity](xref:botbuilder-core.Activity). - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: >- Optional. Additional properties to be logged to telemetry with event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Optional. Additional metrics to be logged to telemetry with event. return: description: A promise resolving to the recognizer result. @@ -233,7 +225,6 @@ methods: package: botbuilder-ai summary: Construct V3 recognizer options from the current dialog context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizerConfiguration.yml index 60068e7c..350f6cb7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisAdaptiveRecognizerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: LuisAdaptiveRecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,61 +14,56 @@ properties: summary: '' fullName: applicationId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'applicationId?: string | Expression | StringExpression' + content: 'applicationId?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: dynamicLists uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.dynamicLists package: botbuilder-ai summary: '' fullName: dynamicLists remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - dynamicLists?: unknown[] | string | Expression | + dynamicLists?: string | Expression | unknown[] | ArrayExpression return: description: '' - type: 'unknown[] | string | Expression | ArrayExpression<unknown>' + type: string | Expression | unknown[] | ArrayExpression<unknown> - name: endpoint uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.endpoint package: botbuilder-ai summary: '' fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'endpoint?: string | Expression | StringExpression' + content: 'endpoint?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: endpointKey uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.endpointKey package: botbuilder-ai summary: '' fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'endpointKey?: string | Expression | StringExpression' + content: 'endpointKey?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: externalEntityRecognizer uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.externalEntityRecognizer package: botbuilder-ai summary: '' fullName: externalEntityRecognizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'externalEntityRecognizer?: string | Recognizer' @@ -82,20 +76,18 @@ properties: summary: '' fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'logPersonalInformation?: boolean | string | Expression | BoolExpression' + content: 'logPersonalInformation?: string | boolean | BoolExpression | Expression' return: description: '' - type: boolean | string | Expression | BoolExpression + type: string | boolean | BoolExpression | Expression - name: predictionOptions uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.predictionOptions package: botbuilder-ai summary: '' fullName: predictionOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -104,21 +96,20 @@ properties: return: description: '' type: >- - | + LuisAdaptivePredictionOptionsConfiguration | + LuisAdaptivePredictionOptions - name: version uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.version package: botbuilder-ai summary: '' fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'version?: string | Expression | StringExpression' + content: 'version?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression inheritedProperties: - name: id uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration.id @@ -126,7 +117,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -140,7 +130,6 @@ inheritedProperties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisApplication.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisApplication.yml index 71ff91e7..254269da 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisApplication.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisApplication.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Description of a LUIS application used for initializing a LuisRecognizer. fullName: LuisApplication remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Your models application Id from LUIS fullName: applicationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationId: string' @@ -30,7 +28,6 @@ properties: https://westus.api.cognitive.microsoft.com fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpoint?: string' @@ -43,7 +40,6 @@ properties: summary: Endpoint key for talking to LUIS fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisBotComponent.yml index 00c2ac2c..3e2bbe93 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisBotComponent.yml @@ -2,10 +2,12 @@ name: LuisBotComponent uid: botbuilder-ai.LuisBotComponent package: botbuilder-ai -summary: LUIS @see cref="BotComponent" definition. +summary: |- + LUIS + + See cref="BotComponent" definition. fullName: LuisBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,21 +17,19 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: botbuilder-ai.LuisBotComponent.configureServices package: botbuilder-ai summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,6 +41,5 @@ methods: description: Services collection to register dependency injection. - id: _configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisComponentRegistration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisComponentRegistration.yml index 3dfe10c3..c070d080 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisComponentRegistration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisComponentRegistration.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Define component assets for Luis. fullName: LuisComponentRegistration remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,40 +13,35 @@ constructors: package: botbuilder-ai summary: Define component assets for Luis. remarks: '' - isPreview: false isDeprecated: false syntax: content: new LuisComponentRegistration() -inheritedProperties: +properties: - name: components uid: botbuilder-ai.LuisComponentRegistration.components package: botbuilder-ai - summary: '' + summary: Gets list of all ComponentRegistration objects registered. fullName: components remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static components: ComponentRegistration[]' + content: static ComponentRegistration[] components return: - description: '' - type: 'ComponentRegistration[]' - inheritanceDescription: Inherited From ComponentRegistration.components + description: A list of ComponentRegistration objects. + type: ComponentRegistration[] inheritedMethods: - name: add(ComponentRegistration) uid: botbuilder-ai.LuisComponentRegistration.add package: botbuilder-ai - summary: 'Add a component, only one instance per type is allowed for components.' + summary: Add a component, only one instance per type is allowed for components. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function add(componentRegistration: ComponentRegistration)' parameters: - id: componentRegistration type: ComponentRegistration - description: | - The component to be registered. + description: The component to be registered. inheritanceDescription: Inherited From ComponentRegistration.add methods: - name: getDeclarativeTypes(unknown) @@ -55,7 +49,6 @@ methods: package: botbuilder-ai summary: Get declarative types for LUIS component registration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -67,5 +60,5 @@ methods: description: resource explorer return: description: component registrations - type: 'ComponentDeclarativeTypes[]' + type: ComponentDeclarativeTypes[] extends: ComponentRegistration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisPredictionOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisPredictionOptions.yml index 2e2011b1..71770c30 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisPredictionOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisPredictionOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Options per LUIS prediction. fullName: LuisPredictionOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: (Optional) Bing Spell Check subscription key. fullName: bingSpellCheckSubscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bingSpellCheckSubscriptionKey?: string' @@ -28,7 +26,6 @@ properties: summary: (Optional) Determine if all intents come back or only the top one. fullName: includeAllIntents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeAllIntents?: boolean' @@ -43,7 +40,6 @@ properties: included in response. fullName: includeInstanceData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInstanceData?: boolean' @@ -56,7 +52,6 @@ properties: summary: (Optional) If queries should be logged in LUIS. fullName: log remarks: '' - isPreview: false isDeprecated: false syntax: content: 'log?: boolean' @@ -71,7 +66,6 @@ properties: telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation?: boolean' @@ -84,7 +78,6 @@ properties: summary: (Optional) Whether to spell check query. fullName: spellCheck remarks: '' - isPreview: false isDeprecated: false syntax: content: 'spellCheck?: boolean' @@ -97,7 +90,6 @@ properties: summary: (Optional) Whether to use the staging endpoint. fullName: staging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'staging?: boolean' @@ -110,7 +102,6 @@ properties: summary: (Optional) Telemetry Client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' @@ -123,43 +114,52 @@ properties: summary: (Optional) The time zone offset for resolving datetimes. fullName: timezoneOffset remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timezoneOffset?: number' return: description: '' type: number + - name: verbose + uid: botbuilder-ai.LuisPredictionOptions.verbose + package: botbuilder-ai + summary: If true, return all intents instead of just the top scoring intent. + fullName: verbose + remarks: '' + isDeprecated: false + syntax: + content: 'verbose?: boolean' + return: + description: '' + type: boolean inheritedProperties: - name: abortSignal uid: botbuilder-ai.LuisPredictionOptions.abortSignal package: botbuilder-ai - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: botbuilder-ai.LuisPredictionOptions.customHeaders package: botbuilder-ai - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: botbuilder-ai.LuisPredictionOptions.onDownloadProgress @@ -167,7 +167,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -181,7 +180,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -189,15 +187,48 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: botbuilder-ai.LuisPredictionOptions.serializerOptions + package: botbuilder-ai + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: botbuilder-ai.LuisPredictionOptions.shouldDeserialize + package: botbuilder-ai + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botbuilder-ai.LuisPredictionOptions.timeout package: botbuilder-ai summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -205,18 +236,17 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout - - name: verbose - uid: botbuilder-ai.LuisPredictionOptions.verbose + - name: tracingContext + uid: botbuilder-ai.LuisPredictionOptions.tracingContext package: botbuilder-ai - summary: 'If true, return all intents instead of just the top scoring intent.' - fullName: verbose + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'verbose?: boolean' + content: 'tracingContext?: Context' return: description: '' - type: boolean - inheritanceDescription: Inherited From PredictionResolveOptionalParams.verbose -extends: PredictionResolveOptionalParams + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizer.yml index 728839ac..0b93cfc9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizer.yml @@ -5,81 +5,81 @@ package: botbuilder-ai summary: Recognize intents in a user utterance using a configured LUIS model. fullName: LuisRecognizer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: >- - LuisRecognizer(LuisApplication | string, LuisRecognizerOptionsV3 | - LuisRecognizerOptionsV2) - uid: botbuilder-ai.LuisRecognizer.constructor_2 + - name: LuisRecognizer(LuisApplication, LuisPredictionOptions, boolean) + uid: botbuilder-ai.LuisRecognizer.constructor_1 package: botbuilder-ai summary: >- Creates a new [LuisRecognizer](xref:botbuilder-ai.LuisRecognizer) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new LuisRecognizer(application: LuisApplication | string, options?: - LuisRecognizerOptionsV3 | LuisRecognizerOptionsV2) + new LuisRecognizer(application: LuisApplication, options?: + LuisPredictionOptions, includeApiResults?: boolean) parameters: - id: application - type: | string + type: description: >- - The LUIS application endpoint, usually retrieved from - https://luis.ai. + An object conforming to the + [LuisApplication](xref:botbuilder-ai.LuisApplication) definition. - id: options - type: >- - | + type: description: >- Optional. Options object used to control predictions. Should conform to the [LuisPredictionOptions](xref:botbuilder-ai.LuisPredictionOptions) definition. - - name: 'LuisRecognizer(LuisApplication, LuisPredictionOptions, boolean)' - uid: botbuilder-ai.LuisRecognizer.constructor_1 + - id: includeApiResults + type: boolean + description: >- + (Deprecated) Flag that if set to `true` will force the inclusion of + LUIS Api call in results returned by the + [LuisRecognizer.recognize](xref:botbuilder-ai.LuisRecognizer.recognize) + method. Defaults to a value of `false`. + - name: >- + LuisRecognizer(string | LuisApplication, LuisRecognizerOptionsV3 | + LuisRecognizerOptionsV2) + uid: botbuilder-ai.LuisRecognizer.constructor_2 package: botbuilder-ai summary: >- Creates a new [LuisRecognizer](xref:botbuilder-ai.LuisRecognizer) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new LuisRecognizer(application: LuisApplication, options?: - LuisPredictionOptions, includeApiResults?: boolean) + new LuisRecognizer(application: string | LuisApplication, options?: + LuisRecognizerOptionsV3 | LuisRecognizerOptionsV2) parameters: - id: application - type: + type: string | description: >- - The LUIS application endpoint, usually retrieved from - https://luis.ai. + An object conforming to the + [LuisApplication](xref:botbuilder-ai.LuisApplication) definition or + a string representing a LUIS application endpoint, usually retrieved + from https://luis.ai. - id: options - type: + type: >- + | description: >- Optional. Options object used to control predictions. Should conform to the - [LuisPredictionOptions](xref:botbuilder-ai.LuisPredictionOptions) + [LuisRecognizerOptionsV3](xref:botbuilder-ai.LuisRecognizerOptionsV3) + or + [LuisRecognizerOptionsV2](xref:botbuilder-ai.LuisRecognizerOptionsV2) definition. - - id: includeApiResults - type: boolean - description: > - (Deprecated) Flag that if set to `true` will force the inclusion of - LUIS Api call in results returned by the - [LuisRecognizer.recognize](xref:botbuilder-ai.LuisRecognizer.recognize) - method. Defaults to a value of `false`. - - name: 'LuisRecognizer(string, LuisPredictionOptions, boolean)' + - name: LuisRecognizer(string, LuisPredictionOptions, boolean) uid: botbuilder-ai.LuisRecognizer.constructor package: botbuilder-ai summary: >- Creates a new [LuisRecognizer](xref:botbuilder-ai.LuisRecognizer) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -100,7 +100,7 @@ constructors: definition. - id: includeApiResults type: boolean - description: > + description: >- (Deprecated) Flag that if set to `true` will force the inclusion of LUIS Api call in results returned by the [LuisRecognizer.recognize](xref:botbuilder-ai.LuisRecognizer.recognize) @@ -114,7 +114,6 @@ properties: information that came from the user. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean logPersonalInformation @@ -130,7 +129,6 @@ properties: summary: Gets the currently configured BotTelemetryClient that logs the events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -142,40 +140,39 @@ properties: methods: - name: >- recognize(DialogContext | TurnContext, Record, - Record, LuisRecognizerOptionsV2 | LuisRecognizerOptionsV3 - | LuisPredictionOptions) + Record, LuisRecognizerOptionsV3 | LuisPredictionOptions | + LuisRecognizerOptionsV2) uid: botbuilder-ai.LuisRecognizer.recognize package: botbuilder-ai summary: Calls LUIS to recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function recognize(context: DialogContext | TurnContext, telemetryProperties?: Record, telemetryMetrics?: - Record, options?: LuisRecognizerOptionsV2 | - LuisRecognizerOptionsV3 | LuisPredictionOptions): + Record, options?: LuisRecognizerOptionsV3 | + LuisPredictionOptions | LuisRecognizerOptionsV2): Promise parameters: - id: context type: DialogContext | TurnContext description: Context for the current turn of conversation with the use. - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: >- Additional properties to be logged to telemetry with the LuisResult event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: >- Additional metrics to be logged to telemetry with the LuisResult event. - id: options type: >- - | | + | | description: >- (Optional) options object used to override control predictions. Should conform to the [LuisRecognizerOptionsV2] or @@ -184,18 +181,17 @@ methods: description: A promise that resolved to the recognizer result. type: Promise<RecognizerResult> - name: >- - recognize(string, LuisRecognizerOptionsV2 | LuisRecognizerOptionsV3 | - LuisPredictionOptions) + recognize(string, LuisRecognizerOptionsV3 | LuisPredictionOptions | + LuisRecognizerOptionsV2) uid: botbuilder-ai.LuisRecognizer.recognize_1 package: botbuilder-ai summary: Calls LUIS to recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function recognize(utterance: string, options?: LuisRecognizerOptionsV2 - | LuisRecognizerOptionsV3 | LuisPredictionOptions): + function recognize(utterance: string, options?: LuisRecognizerOptionsV3 + | LuisPredictionOptions | LuisRecognizerOptionsV2): Promise parameters: - id: utterance @@ -203,17 +199,17 @@ methods: description: The utterance to be recognized. - id: options type: >- - | | - description: > + | | + description: >- (Optional) options object used to override control predictions. Should conform to the [LuisRecognizerOptionsV2] or [LuisRecognizerOptionsV3] definition. return: description: '' type: Promise<RecognizerResult> - - name: 'sortedIntents(RecognizerResult, number)' + - name: sortedIntents(RecognizerResult, number) uid: botbuilder-ai.LuisRecognizer.sortedIntents package: botbuilder-ai summary: >- @@ -222,28 +218,26 @@ methods: have scores less that `minScore`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function sortedIntents(result?: RecognizerResult, minScore?: - number): Array<{ intent: string, score: number }> + number): { intent: string, score: number }[] parameters: - id: result type: RecognizerResult description: recognizer result to be sorted and filtered - id: minScore type: number - description: 'minimum score threshold, lower score results will be filtered' + description: minimum score threshold, lower score results will be filtered return: - description: '>} sorted result intents' - type: 'Array<{ intent: string, score: number }>' - - name: 'topIntent(RecognizerResult, string, number)' + description: sorted result intents + type: '{ intent: string, score: number }[]' + - name: topIntent(RecognizerResult, string, number) uid: botbuilder-ai.LuisRecognizer.topIntent package: botbuilder-ai summary: Returns the name of the top scoring intent from a set of LUIS results. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerInternal.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerInternal.yml deleted file mode 100644 index 6d444f87..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerInternal.yml +++ /dev/null @@ -1,71 +0,0 @@ -### YamlMime:TSType -name: LuisRecognizerInternal -uid: botbuilder-ai.LuisRecognizerInternal -package: botbuilder-ai -summary: Abstract class for Luis Recognizer. -fullName: LuisRecognizerInternal -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'LuisRecognizerInternal(LuisApplication, LuisRecognizerOptions)' - uid: botbuilder-ai.LuisRecognizerInternal.constructor - package: botbuilder-ai - summary: >- - Creates a new - [LuisRecognizerInternal](xref:botbuilder-ai.LuisRecognizerInternal) - instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new LuisRecognizerInternal(application: LuisApplication, _options?: - LuisRecognizerOptions) - parameters: - - id: application - type: - description: >- - An object conforming to the - [LuisApplication](xref:botbuilder-ai.LuisApplication) definition. - - id: _options - type: - description: > - Optional. Options object used to control predictions. Should conform - to the - [LuisRecognizerOptions](xref:botbuilder-ai.LuisRecognizerOptions) - definition. -properties: - - name: application - uid: botbuilder-ai.LuisRecognizerInternal.application - package: botbuilder-ai - summary: '' - fullName: application - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'application: LuisApplication' - return: - description: '' - type: -methods: - - name: recognizeInternal(DialogContext | TurnContext) - uid: botbuilder-ai.LuisRecognizerInternal.recognizeInternal - package: botbuilder-ai - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function recognizeInternal(context: DialogContext | TurnContext): - Promise - parameters: - - id: context - type: DialogContext | TurnContext - description: '' - return: - description: '' - type: Promise<RecognizerResult> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptions.yml index b4b1a2e5..b594fd2b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: LuisRecognizerOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: [recognize()](#recognize). Defaults to a value of `false` fullName: includeAPIResults remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeAPIResults?: boolean' @@ -32,7 +30,6 @@ properties: telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation?: boolean' @@ -45,7 +42,6 @@ properties: summary: (Optional) Telemetry Client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV2.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV2.yml index c3e73199..5a399ffb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV2.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV2.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: LuisRecognizerOptionsV2 remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Luis Api endpoint version. fullName: apiVersion remarks: '' - isPreview: false isDeprecated: false syntax: content: 'apiVersion: "v2"' @@ -28,7 +26,6 @@ properties: summary: (Optional) Bing Spell Check subscription key. fullName: bingSpellCheckSubscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bingSpellCheckSubscriptionKey?: string' @@ -41,7 +38,6 @@ properties: summary: (Optional) Determine if all intents come back or only the top one. fullName: includeAllIntents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeAllIntents?: boolean' @@ -56,7 +52,6 @@ properties: included in response. fullName: includeInstanceData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInstanceData?: boolean' @@ -69,7 +64,6 @@ properties: summary: (Optional) If queries should be logged in LUIS. fullName: log remarks: '' - isPreview: false isDeprecated: false syntax: content: 'log?: boolean' @@ -82,7 +76,6 @@ properties: summary: (Optional) Whether to spell check query. fullName: spellCheck remarks: '' - isPreview: false isDeprecated: false syntax: content: 'spellCheck?: boolean' @@ -95,7 +88,6 @@ properties: summary: (Optional) Whether to use the staging endpoint. fullName: staging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'staging?: boolean' @@ -108,7 +100,6 @@ properties: summary: (Optional) The time zone offset for resolving datetimes. fullName: timezoneOffset remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timezoneOffset?: number' @@ -124,7 +115,6 @@ inheritedProperties: [recognize()](#recognize). Defaults to a value of `false` fullName: includeAPIResults remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeAPIResults?: boolean' @@ -142,7 +132,6 @@ inheritedProperties: telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation?: boolean' @@ -158,7 +147,6 @@ inheritedProperties: summary: (Optional) Telemetry Client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV3.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV3.yml index 7422a2f5..1d3fe845 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV3.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerOptionsV3.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: LuisRecognizerOptionsV3 remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: (Optional) Luis Api endpoint version. fullName: apiVersion remarks: '' - isPreview: false isDeprecated: false syntax: content: 'apiVersion: "v3"' @@ -28,7 +26,6 @@ properties: summary: (Optional) Timezone applied to datetimeV2 entities. fullName: datetimeReference remarks: '' - isPreview: false isDeprecated: false syntax: content: 'datetimeReference?: string' @@ -43,26 +40,24 @@ properties: query time.. fullName: dynamicLists remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'dynamicLists?: Array' + content: 'dynamicLists?: DynamicList[]' return: description: '' - type: Array<> + type: [] - name: externalEntities uid: botbuilder-ai.LuisRecognizerOptionsV3.externalEntities package: botbuilder-ai summary: (Optional) External entities recognized in query. fullName: externalEntities remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'externalEntities?: Array' + content: 'externalEntities?: ExternalEntity[]' return: description: '' - type: Array<> + type: <unknown>[] - name: externalEntityRecognizer uid: botbuilder-ai.LuisRecognizerOptionsV3.externalEntityRecognizer package: botbuilder-ai @@ -71,7 +66,6 @@ properties: LUIS. fullName: externalEntityRecognizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'externalEntityRecognizer?: Recognizer' @@ -84,7 +78,6 @@ properties: summary: (Optional) Determine if all intents come back or only the top one. fullName: includeAllIntents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeAllIntents?: boolean' @@ -99,7 +92,6 @@ properties: included in response. fullName: includeInstanceData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInstanceData?: boolean' @@ -112,7 +104,6 @@ properties: summary: (Optional) If queries should be logged in LUIS. fullName: log remarks: '' - isPreview: false isDeprecated: false syntax: content: 'log?: boolean' @@ -127,7 +118,6 @@ properties: results from LUIS models. fullName: preferExternalEntities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'preferExternalEntities?: boolean' @@ -143,7 +133,6 @@ properties: If you specify a Version, then a private version of the application is used instead of a slot. fullName: slot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'slot?: "production" | "staging"' @@ -160,7 +149,6 @@ properties: If this is specified, then the is ignored.. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version?: string' @@ -176,7 +164,6 @@ inheritedProperties: [recognize()](#recognize). Defaults to a value of `false` fullName: includeAPIResults remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeAPIResults?: boolean' @@ -194,7 +181,6 @@ inheritedProperties: telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation?: boolean' @@ -210,7 +196,6 @@ inheritedProperties: summary: (Optional) Telemetry Client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerTelemetryClient.yml index a5984746..7e53e842 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerTelemetryClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerTelemetryClient.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: LuisRecognizerTelemetryClient remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: information that came from the user. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: boolean' @@ -30,7 +28,6 @@ properties: summary: Gets the currently configured botTelemetryClient that logs the events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -38,29 +35,28 @@ properties: description: '' type: BotTelemetryClient methods: - - name: 'recognize(TurnContext, [key: string]: string, [key: string]: number)' + - name: 'recognize(TurnContext, {[key: string]: string}, {[key: string]: number})' uid: botbuilder-ai.LuisRecognizerTelemetryClient.recognize package: botbuilder-ai summary: Calls LUIS to recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function recognize(context: TurnContext, telemetryProperties?: [key: - string]: string, telemetryMetrics?: [key: string]: number): + function recognize(context: TurnContext, telemetryProperties?: {[key: + string]: string}, telemetryMetrics?: {[key: string]: number}): Promise parameters: - id: context type: TurnContext description: Context for the current turn of conversation with the use. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Additional properties to be logged to telemetry with the LuisResult event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Additional metrics to be logged to telemetry with the LuisResult event. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV2.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV2.yml deleted file mode 100644 index cf2b6aac..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV2.yml +++ /dev/null @@ -1,110 +0,0 @@ -### YamlMime:TSType -name: LuisRecognizerV2 -uid: botbuilder-ai.LuisRecognizerV2 -package: botbuilder-ai -summary: Recognize intents in a user utterance using a configured LUIS model. -fullName: LuisRecognizerV2 -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'LuisRecognizerV2(LuisApplication, LuisRecognizerOptionsV2)' - uid: botbuilder-ai.LuisRecognizerV2.constructor - package: botbuilder-ai - summary: >- - Creates a new [LuisRecognizerV2](xref:botbuilder-ai.LuisRecognizerV2) - instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new LuisRecognizerV2(application: LuisApplication, options?: - LuisRecognizerOptionsV2) - parameters: - - id: application - type: - description: >- - An object conforming to the - [LuisApplication](xref:botbuilder-ai.LuisApplication) definition or - a string representing a LUIS application endpoint, usually retrieved - from https://luis.ai. - - id: options - type: - description: > - Optional. Options object used to control predictions. Should conform - to the - [LuisRecognizerOptionsV2](xref:botbuilder-ai.LuisRecognizerOptionsV2) - definition. -properties: - - name: options - uid: botbuilder-ai.LuisRecognizerV2.options - package: botbuilder-ai - summary: '' - fullName: options - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'options: LuisRecognizerOptionsV2' - return: - description: '' - type: -inheritedProperties: - - name: application - uid: botbuilder-ai.LuisRecognizerV2.application - package: botbuilder-ai - summary: '' - fullName: application - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'application: LuisApplication' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [LuisRecognizerInternal.application](xref:botbuilder-ai.LuisRecognizerInternal.application) -methods: - - name: recognizeInternal(DialogContext | TurnContext) - uid: botbuilder-ai.LuisRecognizerV2.recognizeInternal - package: botbuilder-ai - summary: Calls LUIS to recognize intents and entities in a users utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function recognizeInternal(context: DialogContext | TurnContext): - Promise - parameters: - - id: context - type: DialogContext | TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext).' - return: - description: >- - Analysis of utterance in form of - [RecognizerResult](xref:botbuilder-core.RecognizerResult). - type: Promise<RecognizerResult> - - name: recognizeInternal(string) - uid: botbuilder-ai.LuisRecognizerV2.recognizeInternal_1 - package: botbuilder-ai - summary: Calls LUIS to recognize intents and entities in a users utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function recognizeInternal(utterance: string): Promise' - parameters: - - id: utterance - type: string - description: The utterance to be recognized. - return: - description: >- - Analysis of utterance in form of - [RecognizerResult](xref:botbuilder-core.RecognizerResult). - type: Promise<RecognizerResult> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV3.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV3.yml deleted file mode 100644 index a0033ac3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisRecognizerV3.yml +++ /dev/null @@ -1,109 +0,0 @@ -### YamlMime:TSType -name: LuisRecognizerV3 -uid: botbuilder-ai.LuisRecognizerV3 -package: botbuilder-ai -summary: Recognize intents in a user utterance using a configured LUIS model. -fullName: LuisRecognizerV3 -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'LuisRecognizerV3(LuisApplication, LuisRecognizerOptionsV3)' - uid: botbuilder-ai.LuisRecognizerV3.constructor - package: botbuilder-ai - summary: >- - Creates a new [LuisRecognizerV3](xref:botbuilder-ai.LuisRecognizerV3) - instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new LuisRecognizerV3(application: LuisApplication, options?: - LuisRecognizerOptionsV3) - parameters: - - id: application - type: - description: >- - An object conforming to the - [LuisApplication](xref:botbuilder-ai.LuisApplication) definition or - a string representing a LUIS application endpoint, usually retrieved - from https://luis.ai. - - id: options - type: - description: > - Optional. Options object used to control predictions. Should conform - to the - [LuisRecognizerOptionsV3](xref:botbuilder-ai.LuisRecognizerOptionsV3) - definition. -properties: - - name: predictionOptions - uid: botbuilder-ai.LuisRecognizerV3.predictionOptions - package: botbuilder-ai - summary: '' - fullName: predictionOptions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'predictionOptions: LuisRecognizerOptionsV3' - return: - description: '' - type: -inheritedProperties: - - name: application - uid: botbuilder-ai.LuisRecognizerV3.application - package: botbuilder-ai - summary: '' - fullName: application - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'application: LuisApplication' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [LuisRecognizerInternal.application](xref:botbuilder-ai.LuisRecognizerInternal.application) -methods: - - name: recognizeInternal(DialogContext | TurnContext) - uid: botbuilder-ai.LuisRecognizerV3.recognizeInternal - package: botbuilder-ai - summary: Calls LUIS to recognize intents and entities in a users utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function recognizeInternal(context: DialogContext | TurnContext): - Promise - parameters: - - id: context - type: DialogContext | TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext).' - return: - description: >- - Analysis of utterance in form of - [RecognizerResult](xref:botbuilder-core.RecognizerResult). - type: Promise<RecognizerResult> - - name: recognizeInternal(string) - uid: botbuilder-ai.LuisRecognizerV3.recognizeInternal_1 - package: botbuilder-ai - summary: Calls LUIS to recognize intents and entities in a users utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function recognizeInternal(utterance: string): Promise' - parameters: - - id: utterance - type: string - description: | - The utterance to be recognized. - return: - description: '' - type: Promise<RecognizerResult> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisTelemetryConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisTelemetryConstants.yml index 417f4973..406a9cf7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisTelemetryConstants.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/LuisTelemetryConstants.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: The BotTelemetryClient event and property names that logged by default. fullName: LuisTelemetryConstants remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activityIdProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static activityIdProperty: "activityId" = "activityId"' @@ -28,7 +26,6 @@ properties: summary: '' fullName: applicationIdProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static applicationIdProperty: "applicationId" = "applicationId"' @@ -41,7 +38,6 @@ properties: summary: '' fullName: entitiesProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static entitiesProperty: "entities" = "entities"' @@ -54,7 +50,6 @@ properties: summary: '' fullName: fromIdProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static fromIdProperty: "fromId" = "fromId"' @@ -67,7 +62,6 @@ properties: summary: '' fullName: intent2Property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static intent2Property: "intent2" = "intent2"' @@ -80,7 +74,6 @@ properties: summary: '' fullName: intentProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static intentProperty: "intent" = "intent"' @@ -93,7 +86,6 @@ properties: summary: '' fullName: intentScore2Property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static intentScore2Property: "intentScore2" = "intentScore2"' @@ -106,7 +98,6 @@ properties: summary: '' fullName: intentScoreProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static intentScoreProperty: "intentScore" = "intentScore"' @@ -119,7 +110,6 @@ properties: summary: '' fullName: luisResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static luisResultEvent: "LuisResult" = "LuisResult"' @@ -132,7 +122,6 @@ properties: summary: '' fullName: questionProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static questionProperty: "question" = "question"' @@ -145,7 +134,6 @@ properties: summary: '' fullName: sentimentLabelProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static sentimentLabelProperty: "sentimentLabel" = "sentimentLabel"' @@ -158,7 +146,6 @@ properties: summary: '' fullName: sentimentScoreProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static sentimentScoreProperty: "sentimentScore" = "sentimentScore"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/MetadataFilter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/MetadataFilter.yml index 2c155655..eb89a994 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/MetadataFilter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/MetadataFilter.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines metadata filters and corresponding logical operation. fullName: MetadataFilter remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: logicalOperation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logicalOperation: string' @@ -28,10 +26,9 @@ properties: summary: '' fullName: metadata remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'metadata: Array<{ key: string, value: string }>' + content: 'metadata: { key: string, value: string }[]' return: description: '' - type: 'Array<{ key: string, value: string }>' + type: '{ key: string, value: string }[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/NumberWithUnits.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/NumberWithUnits.yml index 3b3495b9..5d16fe63 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/NumberWithUnits.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/NumberWithUnits.yml @@ -7,7 +7,6 @@ summary: |- Licensed under the MIT License. fullName: NumberWithUnits remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: A recognized number if any. fullName: number remarks: '' - isPreview: false isDeprecated: false syntax: content: 'number?: number' @@ -30,7 +28,6 @@ properties: summary: Units for the number. fullName: units remarks: '' - isPreview: false isDeprecated: false syntax: content: 'units: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/OrdinalV2.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/OrdinalV2.yml index 03b80be0..32426e4e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/OrdinalV2.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/OrdinalV2.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Position in a sequence relative to another position. fullName: OrdinalV2 remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Offset relative to position in sequence. fullName: offset remarks: '' - isPreview: false isDeprecated: false syntax: content: 'offset: number' @@ -28,7 +26,6 @@ properties: summary: Anchor for the offset. fullName: relativeTo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'relativeTo: Anchor' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnACardBuilder.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnACardBuilder.yml index b58a364e..2fdbb112 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnACardBuilder.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnACardBuilder.yml @@ -7,23 +7,46 @@ summary: >- learning or multi-turn prompt options for the QnAMakerDialog. fullName: QnACardBuilder remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'getQnAAnswerCard(QnAMakerResult, boolean)' + - name: getHeroCard(string, any[]) + uid: botbuilder-ai.QnACardBuilder.getHeroCard + package: botbuilder-ai + summary: >- + Returns a Hero Card attachment containing the text for the card and a + button list + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getHeroCard(cardText: string, buttonList: any[]): + Attachment + parameters: + - id: cardText + type: string + description: The string to be placed in the card's text field + - id: buttonList + type: any[] + description: >- + The list of buttons to be converted to imBack buttons and attached + to the card + return: + description: An attachment representing the Hero Card + type: Attachment + - name: getQnAAnswerCard(QnAMakerResult, boolean, boolean) uid: botbuilder-ai.QnACardBuilder.getQnAAnswerCard package: botbuilder-ai summary: >- Returns an [activity](xref:botframework-schema.Activity) with answer text - and a hero card attachment, containing buttons for multi turn prompts. + and a card attachment, containing buttons for multi turn prompts. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function getQnAAnswerCard(result: QnAMakerResult, - displayPreciseAnswerOnly: boolean): Partial + displayPreciseAnswerOnly: boolean, useTeamsAdaptiveCard?: boolean): + Partial parameters: - id: result type: @@ -34,7 +57,13 @@ methods: type: boolean description: >- whether to display PreciseAnswer Only or along with source Answer - text. . + text. + - id: useTeamsAdaptiveCard + type: boolean + description: >- + whether to use a Microsoft Teams formatted adaptive card instead of + a hero card. Defaults to false. + Card width is limited by Teams and long CQA responses should be formatted in the Language Studio to add line breaks. Card payload is specific to MS Teams. return: description: Activity representing the prompts as a card type: Partial<Activity> @@ -45,7 +74,6 @@ methods: Returns an [activity](xref:botframework-schema.Activity) with answer text and a hero card attachment, containing buttons for multi turn prompts. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,22 +88,22 @@ methods: return: description: Activity representing the prompts as a card type: Partial<Activity> - - name: 'getSuggestionsCard(string[], string, string)' + - name: getSuggestionsCard(string[], string, string, boolean) uid: botbuilder-ai.QnACardBuilder.getSuggestionsCard package: botbuilder-ai summary: >- Returns an [activity](xref:botframework-schema.Activity) with a hero card attachment, containing buttons for active learning suggestions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function getSuggestionsCard(suggestionsList: string[], cardTitle: - string, cardNoMatchText: string): Partial + string, cardNoMatchText: string, useTeamsAdaptiveCard?: boolean): + Partial parameters: - id: suggestionsList - type: 'string[]' + type: string[] description: List of suggestions to be displayed on hero card. - id: cardTitle type: string @@ -85,6 +113,36 @@ methods: description: >- Text for button to be added to card to allow user to select 'no match'. + - id: useTeamsAdaptiveCard + type: boolean + description: >- + whether to use a Microsoft Teams formatted adaptive card instead of + a hero card. Defaults to false. + Card width is limited by Teams and long CQA responses should be formatted in the Language Studio to add line breaks. Card payload is specific to MS Teams. return: description: Activity representing the suggestions as a card type: Partial<Activity> + - name: getTeamsAdaptiveCard(string, any[]) + uid: botbuilder-ai.QnACardBuilder.getTeamsAdaptiveCard + package: botbuilder-ai + summary: >- + Returns an Adaptive Card attachment containing the text for the card and a + button list formatted for MS Teams + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getTeamsAdaptiveCard(cardText: string, buttonList: + any[]): Attachment + parameters: + - id: cardText + type: string + description: The string to be placed in the card's text field + - id: buttonList + type: any[] + description: >- + The list of buttons to be converted to MS Teams messageBack buttons + and placed in the card's actions field + return: + description: An attachment representing the MS Teams-formatted Adaptive Card + type: Attachment diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMaker.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMaker.yml index b23407b2..d3c837a6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMaker.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMaker.yml @@ -5,16 +5,14 @@ package: botbuilder-ai summary: Query a QnA Maker knowledge base for answers and provide feedbacks. fullName: QnAMaker remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)' + - name: QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean) uid: botbuilder-ai.QnAMaker.constructor package: botbuilder-ai summary: Creates a new QnAMaker instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,7 +30,7 @@ constructors: description: The BotTelemetryClient used for logging telemetry events. - id: logPersonalInformation type: boolean - description: > + description: >- Set to true to include personally identifiable information in telemetry events. properties: @@ -44,7 +42,6 @@ properties: information that came from the user. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean logPersonalInformation @@ -60,7 +57,6 @@ properties: summary: Gets the currently configured BotTelemetryClient that logs the events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -77,7 +73,6 @@ methods: Calls [generateAnswer()](#generateanswer) and sends the resulting answer as a reply to the user. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: >- Instead, favor using [QnAMaker.getAnswers()](#getAnswers) to generate @@ -96,7 +91,6 @@ methods: package: botbuilder-ai summary: Send feedback to the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function callTrain(feedbackRecords: FeedbackRecords): Promise' @@ -107,23 +101,22 @@ methods: return: description: A promise representing the async operation type: Promise<void> - - name: 'generateAnswer(string | undefined, number, number)' + - name: generateAnswer(undefined | string, number, number) uid: botbuilder-ai.QnAMaker.generateAnswer package: botbuilder-ai summary: Calls the QnA Maker service to generate answer(s) for a question. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: >- Instead, favor using [QnAMaker.getAnswers()](#getAnswers) to generate answers for a question. syntax: content: >- - function generateAnswer(question: string | undefined, top?: number, + function generateAnswer(question: undefined | string, top?: number, _scoreThreshold?: number): Promise parameters: - id: question - type: string | undefined + type: undefined | string description: The question to answer. - id: top type: number @@ -135,21 +128,20 @@ methods: questions. Defaults to a value of `0.001`. return: description: A promise resolving to the QnAMaker results - type: 'Promise<[]>' + type: Promise<[]> - name: >- - getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: - string]: number) + getAnswers(TurnContext, QnAMakerOptions, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-ai.QnAMaker.getAnswers package: botbuilder-ai summary: Calls the QnA Maker service to generate answer(s) for a question. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAnswers(context: TurnContext, options?: QnAMakerOptions, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: context type: TurnContext @@ -162,32 +154,31 @@ methods: (Optional) The options for the QnA Maker knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Additional metrics to be logged to telemetry with the QnaMessage event. return: description: A promise resolving to the QnAMaker result - type: 'Promise<[]>' + type: Promise<[]> - name: >- - getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: - string]: number) + getAnswersRaw(TurnContext, QnAMakerOptions, {[key: string]: string}, + {[key: string]: number}) uid: botbuilder-ai.QnAMaker.getAnswersRaw package: botbuilder-ai summary: Generates an answer from the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAnswersRaw(context: TurnContext, options: QnAMakerOptions, - telemetryProperties: [key: string]: string, telemetryMetrics: [key: - string]: number): Promise + telemetryProperties: {[key: string]: string}, telemetryMetrics: {[key: + string]: number}): Promise parameters: - id: context type: TurnContext @@ -201,12 +192,12 @@ methods: for the QnA Maker knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional. Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional. Additional metrics to be logged to telemetry with the QnaMessage event. @@ -216,19 +207,18 @@ methods: ranking score. type: Promise<> - name: >- - getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, - [key: string]: number) + getLegacyAnswersRaw(TurnContext, QnAMakerOptions, {[key: string]: string}, + {[key: string]: number}) uid: botbuilder-ai.QnAMaker.getLegacyAnswersRaw package: botbuilder-ai summary: Generates an answer from the QnA Maker knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getLegacyAnswersRaw(context: TurnContext, options?: - QnAMakerOptions, telemetryProperties?: [key: string]: string, - telemetryMetrics?: [key: string]: number): Promise + QnAMakerOptions, telemetryProperties?: {[key: string]: string}, + telemetryMetrics?: {[key: string]: number}): Promise parameters: - id: context type: TurnContext @@ -242,12 +232,12 @@ methods: for the QnA Maker knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional. Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional. Additional metrics to be logged to telemetry with the QnaMessage event. @@ -256,12 +246,11 @@ methods: A list of answers for the user query, sorted in decreasing order of ranking score. type: Promise<> - - name: 'getLowScoreVariation(QnAMakerResult[])' + - name: getLowScoreVariation(QnAMakerResult[]) uid: botbuilder-ai.QnAMaker.getLowScoreVariation package: botbuilder-ai summary: Filters the ambiguous question for active learning. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -269,8 +258,8 @@ methods: QnAMakerResult[] parameters: - id: queryResult - type: '[]' + type: [] description: User query output. return: description: the filtered results - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerBotComponent.yml index ab4525e7..90f1921e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerBotComponent.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Class which contains registration of components for QnAMaker. fullName: QnAMakerBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,21 +14,19 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: botbuilder-ai.QnAMakerBotComponent.configureServices package: botbuilder-ai summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,6 +38,5 @@ methods: description: Services collection to mimic dependency injection. - id: _configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerClient.yml index f74d63cb..16fd782a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerClient.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Client to access a QnA Maker knowledge base. fullName: QnAMakerClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,15 +13,13 @@ methods: package: botbuilder-ai summary: Send feedback to the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function callTrain(feedbackRecords: FeedbackRecords): Promise' parameters: - id: feedbackRecords type: - description: | - Feedback records. + description: Feedback records. return: description: '' type: Promise<void> @@ -33,7 +30,6 @@ methods: package: botbuilder-ai summary: Generates an answer from the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -52,12 +48,12 @@ methods: The options for the QnA Maker knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: >- Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: >- Additional metrics to be logged to telemetry with the QnaMessage event. @@ -65,7 +61,7 @@ methods: description: >- A list of answers for the user query, sorted in decreasing order of ranking score. - type: 'Promise<[]>' + type: Promise<[]> - name: >- getAnswersRaw(TurnContext, QnAMakerOptions, Record, Record) @@ -73,7 +69,6 @@ methods: package: botbuilder-ai summary: Generates an answer from the knowledge base. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -92,12 +87,12 @@ methods: The options for the QnA Maker knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: >- Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: >- Additional metrics to be logged to telemetry with the QnaMessage event. @@ -106,12 +101,11 @@ methods: A list of answers for the user query, sorted in decreasing order of ranking score. type: Promise<> - - name: 'getLowScoreVariation(QnAMakerResult[])' + - name: getLowScoreVariation(QnAMakerResult[]) uid: botbuilder-ai.QnAMakerClient.getLowScoreVariation package: botbuilder-ai summary: Filters the ambiguous question for active learning. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -119,8 +113,8 @@ methods: QnAMakerResult[] parameters: - id: queryResult - type: '[]' + type: [] description: User query output. return: description: Filtered array of ambiguous question. - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerComponentRegistration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerComponentRegistration.yml index 494008e6..8da06b97 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerComponentRegistration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerComponentRegistration.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Define component assets for QnAMaker. fullName: QnAMakerComponentRegistration remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,40 +13,35 @@ constructors: package: botbuilder-ai summary: Create an instance of QnAMakerComponentRegistration. remarks: '' - isPreview: false isDeprecated: false syntax: content: new QnAMakerComponentRegistration() -inheritedProperties: +properties: - name: components uid: botbuilder-ai.QnAMakerComponentRegistration.components package: botbuilder-ai - summary: '' + summary: Gets list of all ComponentRegistration objects registered. fullName: components remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static components: ComponentRegistration[]' + content: static ComponentRegistration[] components return: - description: '' - type: 'ComponentRegistration[]' - inheritanceDescription: Inherited From ComponentRegistration.components + description: A list of ComponentRegistration objects. + type: ComponentRegistration[] inheritedMethods: - name: add(ComponentRegistration) uid: botbuilder-ai.QnAMakerComponentRegistration.add package: botbuilder-ai - summary: 'Add a component, only one instance per type is allowed for components.' + summary: Add a component, only one instance per type is allowed for components. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function add(componentRegistration: ComponentRegistration)' parameters: - id: componentRegistration type: ComponentRegistration - description: | - The component to be registered. + description: The component to be registered. inheritanceDescription: Inherited From ComponentRegistration.add methods: - name: getDeclarativeTypes(unknown) @@ -55,7 +49,6 @@ methods: package: botbuilder-ai summary: Get declarative types for QnAMaker component registration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -67,5 +60,5 @@ methods: description: resource explorer return: description: component registrations - type: 'ComponentDeclarativeTypes[]' + type: ComponentDeclarativeTypes[] extends: ComponentRegistration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialog.yml index cdcba6dc..34987be6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialog.yml @@ -3,23 +3,22 @@ name: QnAMakerDialog uid: botbuilder-ai.QnAMakerDialog package: botbuilder-ai summary: A dialog that supports multi-step and adaptive-learning QnA Maker services. -fullName: QnAMakerDialog +fullName: QnAMakerDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, - QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType) + QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType, + boolean) uid: botbuilder-ai.QnAMakerDialog.constructor_1 package: botbuilder-ai summary: >- Initializes a new instance of the [QnAMakerDialog](xref:botbuilder-ai.QnAMakerDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +29,7 @@ constructors: rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: - ServiceType) + ServiceType, useTeamsAdaptiveCard?: boolean) parameters: - id: knowledgeBaseId type: string @@ -56,13 +55,13 @@ constructors: - id: suggestionsActivityFactory type: description: >- - (xref:botbuilder-ai.QnASuggestionsActivityFactory) used for custom - Activity formatting. + [QnASuggestionsActivityFactory](xref:botbuilder-ai.QnASuggestionsActivityFactory) + used for custom Activity formatting. - id: cardNoMatchText type: string description: >- - (Optional) The button text to use with active learning options, - allowing a user to indicate none of the options are applicable. + The text to use with the active learning options, allowing a user to + indicate none of the options are applicable. - id: top type: number description: >- @@ -77,7 +76,7 @@ constructors: type: description: '' - id: strictFilters - type: '[]' + type: [] description: >- (Optional) QnA Maker metadata with which to filter or boost queries to the knowledge base; or null to apply none. @@ -86,8 +85,7 @@ constructors: description: (Optional) Id of the created dialog. Default is 'QnAMakerDialog'. - id: strictFiltersJoinOperator type: - description: | - join operator for strict filters + description: join operator for strict filters - id: enablePreciseAnswer type: boolean description: '' @@ -97,17 +95,19 @@ constructors: - id: qnaServiceType type: description: '' + - id: useTeamsAdaptiveCard + type: boolean + description: boolean setting for using Teams Adaptive Cards instead of Hero Cards - name: >- QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, - boolean, boolean, ServiceType) + boolean, boolean, ServiceType, boolean) uid: botbuilder-ai.QnAMakerDialog.constructor package: botbuilder-ai summary: >- Initializes a new instance of the [QnAMakerDialog](xref:botbuilder-ai.QnAMakerDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -117,7 +117,8 @@ constructors: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, - displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType) + displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType, + useTeamsAdaptiveCard?: boolean) parameters: - id: knowledgeBaseId type: string @@ -164,7 +165,7 @@ constructors: type: description: '' - id: strictFilters - type: '[]' + type: [] description: >- (Optional) QnA Maker metadata with which to filter or boost queries to the knowledge base; or null to apply none. @@ -173,8 +174,7 @@ constructors: description: (Optional) Id of the created dialog. Default is 'QnAMakerDialog'. - id: strictFiltersJoinOperator type: - description: | - join operator for strict filters + description: join operator for strict filters - id: enablePreciseAnswer type: boolean description: '' @@ -184,6 +184,9 @@ constructors: - id: qnaServiceType type: description: '' + - id: useTeamsAdaptiveCard + type: boolean + description: boolean setting for using Teams Adaptive Cards instead of Hero Cards properties: - name: $kind uid: botbuilder-ai.QnAMakerDialog.$kind @@ -191,7 +194,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -201,14 +203,14 @@ properties: - name: activeLearningCardTitle uid: botbuilder-ai.QnAMakerDialog.activeLearningCardTitle package: botbuilder-ai - summary: > + summary: >- Gets or sets the card title to use when showing active learning options to the user. + _Note: If suggestionsActivityFactory is passed in, this member is unused._ fullName: activeLearningCardTitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activeLearningCardTitle: StringExpression' @@ -225,7 +227,6 @@ properties: active learning card. fullName: cardNoMatchResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -233,21 +234,21 @@ properties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: cardNoMatchText uid: botbuilder-ai.QnAMakerDialog.cardNoMatchText package: botbuilder-ai - summary: > + summary: >- Gets or sets the button text to use with active learning options, allowing a user to indicate non of the options are applicable. + _Note: If suggestionsActivityFactory is passed in, this member is required._ fullName: cardNoMatchText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cardNoMatchText: StringExpression' @@ -262,7 +263,6 @@ properties: only precise answers. fullName: displayPreciseAnswerOnly remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayPreciseAnswerOnly: boolean' @@ -277,7 +277,6 @@ properties: response. fullName: enablePreciseAnswer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enablePreciseAnswer: boolean' @@ -292,7 +291,6 @@ properties: base. fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: StringExpression' @@ -305,7 +303,6 @@ properties: summary: Gets or sets the metadata and sources used to filter results. fullName: filters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'filters: Filters' @@ -318,13 +315,24 @@ properties: summary: Gets or sets the QnA Maker host URL for the knowledge base. fullName: hostname remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hostname: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-ai.QnAMakerDialog.id + package: botbuilder-ai + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: includeUnstructuredSources uid: botbuilder-ai.QnAMakerDialog.includeUnstructuredSources package: botbuilder-ai @@ -333,7 +341,6 @@ properties: search for answers. fullName: includeUnstructuredSources remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeUnstructuredSources: boolean' @@ -348,7 +355,6 @@ properties: knowledgebase to be called. fullName: isTest remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTest: boolean' @@ -361,7 +367,6 @@ properties: summary: Gets or sets the QnA Maker knowledge base ID to query. fullName: knowledgeBaseId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'knowledgeBaseId: StringExpression' @@ -376,7 +381,6 @@ properties: logged in telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -391,20 +395,18 @@ properties: an answer. fullName: noAnswer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noAnswer: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: qnaServiceType uid: botbuilder-ai.QnAMakerDialog.qnaServiceType package: botbuilder-ai summary: Question answering service type - qnaMaker or language fullName: qnaServiceType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaServiceType: ServiceType' @@ -417,7 +419,6 @@ properties: summary: Gets or sets the QnA Maker ranker type to use. fullName: rankerType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rankerType: EnumExpression' @@ -434,33 +435,44 @@ properties: or null to apply none. fullName: strictFilters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFilters: QnAMakerMetadata[]' return: description: '' - type: '[]' + type: [] - name: strictFiltersJoinOperator uid: botbuilder-ai.QnAMakerDialog.strictFiltersJoinOperator package: botbuilder-ai summary: Gets or sets a value - AND or OR - logical operation on list of metadata fullName: strictFiltersJoinOperator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFiltersJoinOperator: JoinOperator' return: description: '' type: + - name: telemetryClient + uid: botbuilder-ai.QnAMakerDialog.telemetryClient + package: botbuilder-ai + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: threshold uid: botbuilder-ai.QnAMakerDialog.threshold package: botbuilder-ai - summary: 'Gets or sets the threshold for answers returned, based on score.' + summary: Gets or sets the threshold for answers returned, based on score. fullName: threshold remarks: '' - isPreview: false isDeprecated: false syntax: content: 'threshold: NumberExpression' @@ -475,13 +487,26 @@ properties: base. fullName: top remarks: '' - isPreview: false isDeprecated: false syntax: content: 'top: IntExpression' return: description: '' type: IntExpression + - name: useTeamsAdaptiveCard + uid: botbuilder-ai.QnAMakerDialog.useTeamsAdaptiveCard + package: botbuilder-ai + summary: >- + Gets or sets a value indicating whether to use a Teams-formatted Adaptive + Card in responses instead of a generic Hero Card. + fullName: useTeamsAdaptiveCard + remarks: '' + isDeprecated: false + syntax: + content: 'useTeamsAdaptiveCard: boolean' + return: + description: '' + type: boolean inheritedProperties: - name: EndOfTurn uid: botbuilder-ai.QnAMakerDialog.EndOfTurn @@ -494,44 +519,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-ai.QnAMakerDialog.id - package: botbuilder-ai - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-ai.QnAMakerDialog.telemetryClient - package: botbuilder-ai - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: Inherited From WaterfallDialog.EndOfTurn inheritedMethods: - - name: addStep(WaterfallStep) + - name: addStep(WaterfallStep<{}>) uid: botbuilder-ai.QnAMakerDialog.addStep package: botbuilder-ai summary: Adds a new step to the waterfall. @@ -588,59 +584,55 @@ inheritedMethods: helloDialog.addStep(this.helloWorldStep.bind(this)); ``` - isPreview: false isDeprecated: false syntax: - content: 'function addStep(step: WaterfallStep): this' + content: 'function addStep(step: WaterfallStep<{}>): QnAMakerDialog' parameters: - id: step - type: WaterfallStep<O> + type: WaterfallStep<{}> description: Asynchronous step function to call. return: description: Waterfall dialog for fluent calls to `addStep()`. - type: this + type: inheritanceDescription: Inherited From WaterfallDialog.addStep - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-ai.QnAMakerDialog.configure package: botbuilder-ai summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): QnAMakerDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: + inheritanceDescription: Inherited From WaterfallDialog.configure + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-ai.QnAMakerDialog.endDialog package: botbuilder-ai summary: Called when the dialog is ending. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(context: TurnContext, instance: DialogInstance, + function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise parameters: - id: context type: TurnContext description: Context for the current turn of conversation. - id: instance - type: DialogInstance + type: DialogInstance<any> description: The instance of the current dialog. - id: reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -648,24 +640,22 @@ inheritedMethods: - name: getVersion() uid: botbuilder-ai.QnAMakerDialog.getVersion package: botbuilder-ai - summary: 'Gets the dialog version, composed of the ID and number of steps.' + summary: Gets the dialog version, composed of the ID and number of steps. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' return: - description: 'Dialog version, composed of the ID and number of steps.' + description: Dialog version, composed of the ID and number of steps. type: string inheritanceDescription: Inherited From WaterfallDialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-ai.QnAMakerDialog.onDialogEvent package: botbuilder-ai summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -683,11 +673,11 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: Inherited From WaterfallDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-ai.QnAMakerDialog.repromptDialog package: botbuilder-ai - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -708,25 +698,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: Inherited From WaterfallDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-ai.QnAMakerDialog.resumeDialog package: botbuilder-ai summary: >- @@ -734,12 +722,11 @@ inheritedMethods: [WaterfallDialog](xref:botbuilder-dialogs.WaterfallDialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -748,7 +735,9 @@ inheritedMethods: current turn of the conversation. - id: reason type: DialogReason - description: '(xref:botbuilder-dialogs.DialogReason) why the dialog resumed.' + description: >- + [Reason](xref:botbuilder-dialogs.DialogReason) why the dialog + resumed. - id: result type: any description: |- @@ -756,20 +745,19 @@ inheritedMethods: of the value returned is dependent on the child dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From WaterfallDialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, object)' + - name: beginDialog(DialogContext, object) uid: botbuilder-ai.QnAMakerDialog.beginDialog package: botbuilder-ai summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: object): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -781,7 +769,7 @@ methods: description: (Optional) Initial information to pass to the dialog. return: description: A promise resolving to the turn result - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-ai.QnAMakerDialog.continueDialog package: botbuilder-ai @@ -791,10 +779,11 @@ methods: user replies with a new [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -803,21 +792,24 @@ methods: current turn of conversation. return: description: A Promise representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof QnAMakerDialogConfiguration) uid: botbuilder-ai.QnAMakerDialog.getConverter package: botbuilder-ai summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof QnAMakerDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof QnAMakerDialogConfiguration description: Properties that extend QnAMakerDialogConfiguration. return: description: The expression converter. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: WaterfallDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogConfiguration.yml deleted file mode 100644 index e1fcce1c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogConfiguration.yml +++ /dev/null @@ -1,265 +0,0 @@ -### YamlMime:TSType -name: QnAMakerDialogConfiguration -uid: botbuilder-ai.QnAMakerDialogConfiguration -package: botbuilder-ai -summary: '' -fullName: QnAMakerDialogConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: activeLearningCardTitle - uid: botbuilder-ai.QnAMakerDialogConfiguration.activeLearningCardTitle - package: botbuilder-ai - summary: '' - fullName: activeLearningCardTitle - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'activeLearningCardTitle?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: cardNoMatchResponse - uid: botbuilder-ai.QnAMakerDialogConfiguration.cardNoMatchResponse - package: botbuilder-ai - summary: '' - fullName: cardNoMatchResponse - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - cardNoMatchResponse?: string | Partial | - TemplateInterface, DialogStateManager> - return: - description: '' - type: >- - string | Partial<Activity> | - TemplateInterface<Partial<Activity>, DialogStateManager> - - name: cardNoMatchText - uid: botbuilder-ai.QnAMakerDialogConfiguration.cardNoMatchText - package: botbuilder-ai - summary: '' - fullName: cardNoMatchText - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'cardNoMatchText?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: displayPreciseAnswerOnly - uid: botbuilder-ai.QnAMakerDialogConfiguration.displayPreciseAnswerOnly - package: botbuilder-ai - summary: '' - fullName: displayPreciseAnswerOnly - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'displayPreciseAnswerOnly?: boolean' - return: - description: '' - type: boolean - - name: endpointKey - uid: botbuilder-ai.QnAMakerDialogConfiguration.endpointKey - package: botbuilder-ai - summary: '' - fullName: endpointKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'endpointKey?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: hostname - uid: botbuilder-ai.QnAMakerDialogConfiguration.hostname - package: botbuilder-ai - summary: '' - fullName: hostname - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'hostname?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: includeUnstructuredSources - uid: botbuilder-ai.QnAMakerDialogConfiguration.includeUnstructuredSources - package: botbuilder-ai - summary: '' - fullName: includeUnstructuredSources - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'includeUnstructuredSources?: boolean' - return: - description: '' - type: boolean - - name: isTest - uid: botbuilder-ai.QnAMakerDialogConfiguration.isTest - package: botbuilder-ai - summary: '' - fullName: isTest - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isTest?: boolean' - return: - description: '' - type: boolean - - name: knowledgeBaseId - uid: botbuilder-ai.QnAMakerDialogConfiguration.knowledgeBaseId - package: botbuilder-ai - summary: '' - fullName: knowledgeBaseId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'knowledgeBaseId?: string | Expression | StringExpression' - return: - description: '' - type: string | Expression | StringExpression - - name: logPersonalInformation - uid: botbuilder-ai.QnAMakerDialogConfiguration.logPersonalInformation - package: botbuilder-ai - summary: '' - fullName: logPersonalInformation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logPersonalInformation?: boolean | string | Expression | BoolExpression' - return: - description: '' - type: boolean | string | Expression | BoolExpression - - name: noAnswer - uid: botbuilder-ai.QnAMakerDialogConfiguration.noAnswer - package: botbuilder-ai - summary: '' - fullName: noAnswer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - noAnswer?: string | Partial | - TemplateInterface, DialogStateManager> - return: - description: '' - type: >- - string | Partial<Activity> | - TemplateInterface<Partial<Activity>, DialogStateManager> - - name: rankerType - uid: botbuilder-ai.QnAMakerDialogConfiguration.rankerType - package: botbuilder-ai - summary: '' - fullName: rankerType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - rankerType?: RankerTypes | string | Expression | - EnumExpression - return: - description: '' - type: >- - | string | Expression | - EnumExpression<> - - name: strictFilters - uid: botbuilder-ai.QnAMakerDialogConfiguration.strictFilters - package: botbuilder-ai - summary: '' - fullName: strictFilters - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - strictFilters?: QnAMakerMetadata[] | string | Expression | - ArrayExpression - return: - description: '' - type: >- - [] | string | Expression - | ArrayExpression<> - - name: strictFiltersJoinOperator - uid: botbuilder-ai.QnAMakerDialogConfiguration.strictFiltersJoinOperator - package: botbuilder-ai - summary: '' - fullName: strictFiltersJoinOperator - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'strictFiltersJoinOperator?: JoinOperator' - return: - description: '' - type: - - name: threshold - uid: botbuilder-ai.QnAMakerDialogConfiguration.threshold - package: botbuilder-ai - summary: '' - fullName: threshold - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'threshold?: number | string | Expression | NumberExpression' - return: - description: '' - type: number | string | Expression | NumberExpression - - name: top - uid: botbuilder-ai.QnAMakerDialogConfiguration.top - package: botbuilder-ai - summary: '' - fullName: top - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'top?: number | string | Expression | IntExpression' - return: - description: '' - type: number | string | Expression | IntExpression -inheritedProperties: - - name: id - uid: botbuilder-ai.QnAMakerDialogConfiguration.id - package: botbuilder-ai - summary: Static id of the dialog. - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From DialogConfiguration.id - - name: telemetryClient - uid: botbuilder-ai.QnAMakerDialogConfiguration.telemetryClient - package: botbuilder-ai - summary: Telemetry client the dialog should use. - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient?: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient -extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogOptions.yml index 2bdb8e56..beeda592 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Options for QnAMakerDialog. fullName: QnAMakerDialogOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: QnAMakerDialog response options. fullName: qnaDialogResponseOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaDialogResponseOptions: QnAMakerDialogResponseOptions' @@ -28,7 +26,6 @@ properties: summary: Options for QnAMaker knowledgebase. fullName: qnaMakerOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaMakerOptions: QnAMakerOptions' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogResponseOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogResponseOptions.yml index 692751d4..3f6ee099 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogResponseOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerDialogResponseOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: QnAMakerDialog response options. fullName: QnAMakerDialogResponseOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Title for active learning card. fullName: activeLearningCardTitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activeLearningCardTitle: string' @@ -30,7 +28,6 @@ properties: active learning card. fullName: cardNoMatchResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cardNoMatchResponse: Partial' @@ -43,7 +40,6 @@ properties: summary: Text shown for 'no match' option on active learning card. fullName: cardNoMatchText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cardNoMatchText: string' @@ -56,7 +52,6 @@ properties: summary: Indicates whether the dialog response should display only precise answers. fullName: displayPreciseAnswerOnly remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayPreciseAnswerOnly: boolean' @@ -69,7 +64,6 @@ properties: summary: Activity to be sent in the event of no answer found in KB. fullName: noAnswer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noAnswer: Partial' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerEndpoint.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerEndpoint.yml index 177e3c76..658e0853 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerEndpoint.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerEndpoint.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Defines an endpoint used to connect to a QnA Maker Knowledge base. fullName: QnAMakerEndpoint remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: For example: `4cb65a02697745eca369XXXXXXXXXXXX` fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: string' @@ -34,7 +32,6 @@ properties: `https://testqnamaker.azurewebsites.net/qnamaker` fullName: host remarks: '' - isPreview: false isDeprecated: false syntax: content: 'host: string' @@ -49,7 +46,6 @@ properties: `98185f59-3b6f-4d23-8ebb-XXXXXXXXXXXX` fullName: knowledgeBaseId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'knowledgeBaseId: string' @@ -59,10 +55,9 @@ properties: - name: qnaServiceType uid: botbuilder-ai.QnAMakerEndpoint.qnaServiceType package: botbuilder-ai - summary: 'QnA service type '''' - qnamaker, language' + summary: QnA service type '' - qnamaker, language fullName: qnaServiceType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaServiceType?: ServiceType' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerMetadata.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerMetadata.yml index 71f9f6be..6bb7d232 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerMetadata.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerMetadata.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Metadata associated with the answer. fullName: QnAMakerMetadata remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: 'Metadata name. Max length: 100.' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: 'Metadata value. Max length: 100.' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerOptions.yml index 6f35a6b7..cd2f238f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Additional settings used to configure a `QnAMaker` instance. fullName: QnAMakerOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The context of the previous turn. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: QnARequestContext' @@ -28,7 +26,6 @@ properties: summary: A value indicating user's choice to receive PreciseAnswer or not. fullName: enablePreciseAnswer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enablePreciseAnswer?: boolean' @@ -41,7 +38,6 @@ properties: summary: '' fullName: filters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'filters?: Filters' @@ -56,7 +52,6 @@ properties: sources fullName: includeUnstructuredSources remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeUnstructuredSources?: boolean' @@ -71,7 +66,6 @@ properties: knowledgebase. fullName: isTest remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTest?: boolean' @@ -84,20 +78,18 @@ properties: summary: (Optional) Metadata related to query. fullName: metadataBoost remarks: '' - isPreview: false isDeprecated: false syntax: content: 'metadataBoost?: QnAMakerMetadata[]' return: description: '' - type: '[]' + type: [] - name: qnaId uid: botbuilder-ai.QnAMakerOptions.qnaId package: botbuilder-ai summary: Id of the current question asked. fullName: qnaId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaId?: number' @@ -110,7 +102,6 @@ properties: summary: Ranker types. fullName: rankerType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rankerType?: string' @@ -125,7 +116,6 @@ properties: Values range from score of 0.0 to 1.0. fullName: scoreThreshold remarks: '' - isPreview: false isDeprecated: false syntax: content: 'scoreThreshold?: number' @@ -138,20 +128,18 @@ properties: summary: (Optional) Filters used on query. fullName: strictFilters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFilters?: QnAMakerMetadata[]' return: description: '' - type: '[]' + type: [] - name: strictFiltersJoinOperator uid: botbuilder-ai.QnAMakerOptions.strictFiltersJoinOperator package: botbuilder-ai summary: A value indicating choice for Strict Filters Join Operation. fullName: strictFiltersJoinOperator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFiltersJoinOperator?: JoinOperator' @@ -164,7 +152,6 @@ properties: summary: (Optional) The time in milliseconds to wait before the request times out. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -177,10 +164,21 @@ properties: summary: (Optional) number of results to return. fullName: top remarks: '' - isPreview: false isDeprecated: false syntax: content: 'top?: number' return: description: '' type: number + - name: userId + uid: botbuilder-ai.QnAMakerOptions.userId + package: botbuilder-ai + summary: Channel id for the user or bot on this channel + fullName: userId + remarks: '' + isDeprecated: false + syntax: + content: 'userId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerPrompt.yml index 275d1790..b7c8eed9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerPrompt.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: QnAMaker Prompt Object. fullName: QnAMakerPrompt remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Display Order - index of the prompt - used in ordering of the prompts. fullName: displayOrder remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayOrder: number' @@ -28,7 +26,6 @@ properties: summary: Display Text - Text displayed to represent a follow up question prompt. fullName: displayText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayText: string' @@ -41,7 +38,6 @@ properties: summary: The QnA object returned from the API (Optional parameter). fullName: qna remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qna?: object' @@ -56,7 +52,6 @@ properties: ignored. fullName: qnaId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaId: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizer.yml index 7e0a383b..ef3fb1d7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizer.yml @@ -5,16 +5,14 @@ package: botbuilder-ai summary: A recognizer which uses QnAMaker KB to recognize intents. fullName: QnAMakerRecognizer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'QnAMakerRecognizer(string, string, string)' + - name: QnAMakerRecognizer(string, string, string) uid: botbuilder-ai.QnAMakerRecognizer.constructor package: botbuilder-ai summary: Initializes a new instance of `QnAMakerRecognizer`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,8 +27,7 @@ constructors: description: Id of QnAMaker KB. - id: endpointKey type: string - description: | - Endpoint key of QnAMaker KB. + description: Endpoint key of QnAMaker KB. properties: - name: $kind uid: botbuilder-ai.QnAMakerRecognizer.$kind @@ -38,7 +35,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -51,7 +47,6 @@ properties: summary: An expression to evaluate to set the context. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: ObjectExpression' @@ -64,7 +59,6 @@ properties: summary: Endpoint key for the QnA service. fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: StringExpression' @@ -77,7 +71,6 @@ properties: summary: Host name of the QnA maker knowledgebase. fullName: hostname remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hostname: StringExpression' @@ -90,7 +83,6 @@ properties: summary: Whether to include the dialog name metadata for QnA context. fullName: includeDialogNameInMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeDialogNameInMetadata: BoolExpression' @@ -105,7 +97,6 @@ properties: knowledgebase. fullName: isTest remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTest: boolean' @@ -118,7 +109,6 @@ properties: summary: Knowledgebase id of your QnA maker knowledgebase. fullName: knowledgeBaseId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'knowledgeBaseId: StringExpression' @@ -133,7 +123,6 @@ properties: telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -146,7 +135,6 @@ properties: summary: An expression to evaluate to set additional metadata name value pairs. fullName: metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'metadata: ArrayExpression' @@ -159,7 +147,6 @@ properties: summary: An expression to evaluate to set QnAId parameter. fullName: qnaId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaId: IntExpression' @@ -172,7 +159,6 @@ properties: summary: '' fullName: qnaMatchIntent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static qnaMatchIntent: "QnAMatch" = "QnAMatch"' @@ -185,7 +171,6 @@ properties: summary: Desired RankerType. fullName: rankerType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rankerType: StringExpression' @@ -198,7 +183,6 @@ properties: summary: A value used for Join operation of Metadata. fullName: strictFiltersJoinOperator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFiltersJoinOperator: JoinOperator' @@ -211,7 +195,6 @@ properties: summary: Threshold for the results. fullName: threshold remarks: '' - isPreview: false isDeprecated: false syntax: content: 'threshold: NumberExpression' @@ -224,7 +207,6 @@ properties: summary: Number of results you want. fullName: top remarks: '' - isPreview: false isDeprecated: false syntax: content: 'top: IntExpression' @@ -238,7 +220,6 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -254,7 +235,6 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -263,56 +243,57 @@ inheritedProperties: type: BotTelemetryClient inheritanceDescription: Inherited From Recognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-ai.QnAMakerRecognizer.configure package: botbuilder-ai summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): QnAMakerRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Recognizer.configure methods: - - name: getConverter(Object) + - name: getConverter(keyof QnAMakerRecognizerConfiguration) uid: botbuilder-ai.QnAMakerRecognizer.getConverter package: botbuilder-ai summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof QnAMakerRecognizerConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof QnAMakerRecognizerConfiguration description: Properties that extend QnAMakerRecognizerConfiguration. return: description: The expression converter. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- - recognize(DialogContext, Activity, [key: string]: string, [key: string]: - number) + recognize(DialogContext, Activity, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-ai.QnAMakerRecognizer.recognize package: botbuilder-ai summary: Gets results of the call to QnA maker KB. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function recognize(dc: DialogContext, activity: Activity, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: dc type: DialogContext @@ -325,10 +306,10 @@ methods: The incoming activity received from the user. The text value is used as the query to QnA Maker. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: Additional properties to be logged to telemetry. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: Additional metrics to be logged to telemetry. return: description: A promise resolving to the recognizer result diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizerConfiguration.yml index dd17696f..a5e3d0b4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerRecognizerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: '' fullName: QnAMakerRecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,16 +14,15 @@ properties: summary: '' fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - context?: QnARequestContext | string | Expression | + context?: string | QnARequestContext | Expression | ObjectExpression return: description: '' type: >- - | string | Expression | + string | | Expression | ObjectExpression<> - name: endpointKey uid: botbuilder-ai.QnAMakerRecognizerConfiguration.endpointKey @@ -32,48 +30,44 @@ properties: summary: '' fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'endpointKey?: string | Expression | StringExpression' + content: 'endpointKey?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: hostname uid: botbuilder-ai.QnAMakerRecognizerConfiguration.hostname package: botbuilder-ai summary: '' fullName: hostname remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'hostname?: string | Expression | StringExpression' + content: 'hostname?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: includeDialogNameInMetadata uid: botbuilder-ai.QnAMakerRecognizerConfiguration.includeDialogNameInMetadata package: botbuilder-ai summary: '' fullName: includeDialogNameInMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - includeDialogNameInMetadata?: boolean | string | Expression | - BoolExpression + includeDialogNameInMetadata?: string | boolean | BoolExpression | + Expression return: description: '' - type: boolean | string | Expression | BoolExpression + type: string | boolean | BoolExpression | Expression - name: isTest uid: botbuilder-ai.QnAMakerRecognizerConfiguration.isTest package: botbuilder-ai summary: '' fullName: isTest remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTest?: boolean' @@ -86,42 +80,39 @@ properties: summary: '' fullName: knowledgeBaseId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'knowledgeBaseId?: string | Expression | StringExpression' + content: 'knowledgeBaseId?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: logPersonalInformation uid: botbuilder-ai.QnAMakerRecognizerConfiguration.logPersonalInformation package: botbuilder-ai summary: '' fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'logPersonalInformation?: boolean | string | Expression | BoolExpression' + content: 'logPersonalInformation?: string | boolean | BoolExpression | Expression' return: description: '' - type: boolean | string | Expression | BoolExpression + type: string | boolean | BoolExpression | Expression - name: metadata uid: botbuilder-ai.QnAMakerRecognizerConfiguration.metadata package: botbuilder-ai summary: '' fullName: metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - metadata?: QnAMakerMetadata[] | string | Expression | + metadata?: string | QnAMakerMetadata[] | Expression | ArrayExpression return: description: '' type: >- - [] | string | Expression + string | [] | Expression | ArrayExpression<> - name: qnaId uid: botbuilder-ai.QnAMakerRecognizerConfiguration.qnaId @@ -129,33 +120,30 @@ properties: summary: '' fullName: qnaId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'qnaId?: number | string | Expression | IntExpression' + content: 'qnaId?: string | number | IntExpression | Expression' return: description: '' - type: number | string | Expression | IntExpression + type: string | number | IntExpression | Expression - name: rankerType uid: botbuilder-ai.QnAMakerRecognizerConfiguration.rankerType package: botbuilder-ai summary: '' fullName: rankerType remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'rankerType?: string | Expression | StringExpression' + content: 'rankerType?: string | StringExpression | Expression' return: description: '' - type: string | Expression | StringExpression + type: string | StringExpression | Expression - name: strictFiltersJoinOperator uid: botbuilder-ai.QnAMakerRecognizerConfiguration.strictFiltersJoinOperator package: botbuilder-ai summary: '' fullName: strictFiltersJoinOperator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFiltersJoinOperator?: JoinOperator' @@ -168,26 +156,24 @@ properties: summary: '' fullName: threshold remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'threshold?: number | string | Expression | NumberExpression' + content: 'threshold?: string | number | NumberExpression | Expression' return: description: '' - type: number | string | Expression | NumberExpression + type: string | number | NumberExpression | Expression - name: top uid: botbuilder-ai.QnAMakerRecognizerConfiguration.top package: botbuilder-ai summary: '' fullName: top remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'top?: number | string | Expression | IntExpression' + content: 'top?: string | number | IntExpression | Expression' return: description: '' - type: number | string | Expression | IntExpression + type: string | number | IntExpression | Expression inheritedProperties: - name: id uid: botbuilder-ai.QnAMakerRecognizerConfiguration.id @@ -195,7 +181,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -209,7 +194,6 @@ inheritedProperties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResult.yml index 7cc20986..2053bac5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResult.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: An individual answer returned by a call to the QnA Maker Service. fullName: QnAMakerResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Answer from the knowledge base. fullName: answer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'answer: string' @@ -28,7 +26,6 @@ properties: summary: The PreciseAnswer related information in the Answer Text. fullName: answerSpan remarks: '' - isPreview: false isDeprecated: false syntax: content: 'answerSpan?: AnswerSpanResponse' @@ -41,7 +38,6 @@ properties: summary: Context for multi-turn responses. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: QnAResponseContext' @@ -56,7 +52,6 @@ properties: 'id'. (If any) fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: number' @@ -69,7 +64,6 @@ properties: summary: Metadata associated with the answer (If any) fullName: metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'metadata?: any' @@ -84,13 +78,12 @@ properties: any) fullName: questions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'questions?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: score uid: botbuilder-ai.QnAMakerResult.score package: botbuilder-ai @@ -99,7 +92,6 @@ properties: intent. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score: number' @@ -112,7 +104,6 @@ properties: summary: The source from which the QnA was extracted (If any) fullName: source remarks: '' - isPreview: false isDeprecated: false syntax: content: 'source?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResults.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResults.yml index cf6700d6..e816fc53 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResults.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerResults.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: An object returned by a call to the QnA Maker Service. fullName: QnAMakerResults remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The active learning enable flag. fullName: activeLearningEnabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activeLearningEnabled?: boolean' @@ -25,13 +23,12 @@ properties: - name: answers uid: botbuilder-ai.QnAMakerResults.answers package: botbuilder-ai - summary: 'The answers for a user query, sorted in decreasing order of ranking score.' + summary: The answers for a user query, sorted in decreasing order of ranking score. fullName: answers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'answers?: QnAMakerResult[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTelemetryClient.yml index 6561a875..84ba8812 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTelemetryClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTelemetryClient.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Interface for adding telemetry logging capabilities to QnAMaker. fullName: QnAMakerTelemetryClient remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: information that came from the user. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: boolean' @@ -30,7 +28,6 @@ properties: summary: Gets the currently configured botTelemetryClient that logs the events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -39,19 +36,18 @@ properties: type: BotTelemetryClient methods: - name: >- - getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: - string]: number) + getAnswers(TurnContext, QnAMakerOptions, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-ai.QnAMakerTelemetryClient.getAnswers package: botbuilder-ai summary: Calls the QnA Maker service to generate answer(s) for a question. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAnswers(context: TurnContext, options?: QnAMakerOptions, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: context type: TurnContext @@ -64,15 +60,15 @@ methods: (Optional) The options for the QnA Maker knowledge base. If null, constructor option is used for this instance. - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Additional properties to be logged to telemetry with the QnaMessage event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Additional metrics to be logged to telemetry with the QnaMessage event. return: description: A promise resolving to the QnAMaker result - type: 'Promise<[]>' + type: Promise<[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTraceInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTraceInfo.yml index 404cad97..825a6ba4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTraceInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAMakerTraceInfo.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Trace info that we collect and emit from a QnA Maker query fullName: QnAMakerTraceInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The context for multi-turn responses. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: QnARequestContext' @@ -28,7 +26,6 @@ properties: summary: ID of the knowledge base that is being queried. fullName: knowledgeBaseId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'knowledgeBaseId: string' @@ -41,7 +38,6 @@ properties: summary: Message which instigated the query to QnA Maker. fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: Activity' @@ -54,20 +50,18 @@ properties: summary: Metadata related to query. Not used in JavaScript SDK v4 yet. fullName: metadataBoost remarks: '' - isPreview: false isDeprecated: false syntax: content: 'metadataBoost: any[]' return: description: '' - type: 'any[]' + type: any[] - name: qnaId uid: botbuilder-ai.QnAMakerTraceInfo.qnaId package: botbuilder-ai summary: Id of the current question asked. fullName: qnaId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'qnaId?: number' @@ -80,20 +74,18 @@ properties: summary: Results that QnA Maker returned. fullName: queryResults remarks: '' - isPreview: false isDeprecated: false syntax: content: 'queryResults: QnAMakerResult[]' return: description: '' - type: '[]' + type: [] - name: scoreThreshold uid: botbuilder-ai.QnAMakerTraceInfo.scoreThreshold package: botbuilder-ai - summary: 'The minimum score threshold, used to filter returned results.' + summary: The minimum score threshold, used to filter returned results. fullName: scoreThreshold remarks: '' - isPreview: false isDeprecated: false syntax: content: 'scoreThreshold: number' @@ -106,20 +98,18 @@ properties: summary: Filters used on query. Not used in JavaScript SDK v4 yet. fullName: strictFilters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'strictFilters: any[]' return: description: '' - type: 'any[]' + type: any[] - name: top uid: botbuilder-ai.QnAMakerTraceInfo.top package: botbuilder-ai summary: Number of ranked results that are asked to be returned. fullName: top remarks: '' - isPreview: false isDeprecated: false syntax: content: 'top: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnARequestContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnARequestContext.yml index 763c5186..388b0a0f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnARequestContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnARequestContext.yml @@ -7,7 +7,6 @@ summary: >- relevant with a previous question or not. fullName: QnARequestContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: The previous QnA Id that was returned. fullName: previousQnAId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'previousQnAId: number' @@ -30,7 +28,6 @@ properties: summary: The previous user query/question. fullName: previousUserQuery remarks: '' - isPreview: false isDeprecated: false syntax: content: 'previousUserQuery: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAResponseContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAResponseContext.yml index 4105ce42..f5062ef4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAResponseContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnAResponseContext.yml @@ -7,7 +7,6 @@ summary: >- prompts. fullName: QnAResponseContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,10 +16,9 @@ properties: summary: The prompts collection of related prompts. fullName: prompts remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompts: QnAMakerPrompt[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnASuggestionsActivityFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnASuggestionsActivityFactory.yml index 38bfbed5..84ee6542 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnASuggestionsActivityFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnASuggestionsActivityFactory.yml @@ -2,14 +2,14 @@ name: QnASuggestionsActivityFactory uid: botbuilder-ai.QnASuggestionsActivityFactory package: botbuilder-ai -summary: > +summary: >- Returns an activity with active learning suggestions. + Important: The activity returned should relay the noMatchesText as an option to the end user. fullName: QnASuggestionsActivityFactory remarks: '' -isPreview: false isDeprecated: false syntax: | type QnASuggestionsActivityFactory = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnATelemetryConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnATelemetryConstants.yml deleted file mode 100644 index 0040e3da..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/QnATelemetryConstants.yml +++ /dev/null @@ -1,156 +0,0 @@ -### YamlMime:TSType -name: QnATelemetryConstants -uid: botbuilder-ai.QnATelemetryConstants -package: botbuilder-ai -summary: >- - The BotTelemetryClient event, property and metric names that logged by - default. -fullName: QnATelemetryConstants -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: answerProperty - uid: botbuilder-ai.QnATelemetryConstants.answerProperty - package: botbuilder-ai - summary: '' - fullName: answerProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static answerProperty: string' - return: - description: '' - type: string - - name: articleFoundProperty - uid: botbuilder-ai.QnATelemetryConstants.articleFoundProperty - package: botbuilder-ai - summary: '' - fullName: articleFoundProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static articleFoundProperty: string' - return: - description: '' - type: string - - name: channelIdProperty - uid: botbuilder-ai.QnATelemetryConstants.channelIdProperty - package: botbuilder-ai - summary: '' - fullName: channelIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static channelIdProperty: string' - return: - description: '' - type: string - - name: conversationIdProperty - uid: botbuilder-ai.QnATelemetryConstants.conversationIdProperty - package: botbuilder-ai - summary: '' - fullName: conversationIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static conversationIdProperty: string' - return: - description: '' - type: string - - name: knowledgeBaseIdProperty - uid: botbuilder-ai.QnATelemetryConstants.knowledgeBaseIdProperty - package: botbuilder-ai - summary: '' - fullName: knowledgeBaseIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static knowledgeBaseIdProperty: string' - return: - description: '' - type: string - - name: matchedQuestionProperty - uid: botbuilder-ai.QnATelemetryConstants.matchedQuestionProperty - package: botbuilder-ai - summary: '' - fullName: matchedQuestionProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static matchedQuestionProperty: string' - return: - description: '' - type: string - - name: qnaMessageEvent - uid: botbuilder-ai.QnATelemetryConstants.qnaMessageEvent - package: botbuilder-ai - summary: '' - fullName: qnaMessageEvent - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static qnaMessageEvent: string' - return: - description: '' - type: string - - name: questionIdProperty - uid: botbuilder-ai.QnATelemetryConstants.questionIdProperty - package: botbuilder-ai - summary: '' - fullName: questionIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static questionIdProperty: string' - return: - description: '' - type: string - - name: questionProperty - uid: botbuilder-ai.QnATelemetryConstants.questionProperty - package: botbuilder-ai - summary: '' - fullName: questionProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static questionProperty: string' - return: - description: '' - type: string - - name: scoreMetric - uid: botbuilder-ai.QnATelemetryConstants.scoreMetric - package: botbuilder-ai - summary: '' - fullName: scoreMetric - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static scoreMetric: string' - return: - description: '' - type: string - - name: usernameProperty - uid: botbuilder-ai.QnATelemetryConstants.usernameProperty - package: botbuilder-ai - summary: '' - fullName: usernameProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static usernameProperty: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/RankerTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/RankerTypes.yml index 0741c1e7..8ffefc31 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/RankerTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/RankerTypes.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Enumeration of types of ranking. fullName: RankerTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: autoSuggestQuestion diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ServiceType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ServiceType.yml index 8a7d6b57..0aacb02f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ServiceType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/ServiceType.yml @@ -5,7 +5,6 @@ package: botbuilder-ai summary: Enumeration of types of services. fullName: ServiceType remarks: '' -isPreview: false isDeprecated: false fields: - name: language diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/TrainUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/TrainUtils.yml deleted file mode 100644 index 2c746080..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/TrainUtils.yml +++ /dev/null @@ -1,57 +0,0 @@ -### YamlMime:TSType -name: TrainUtils -uid: botbuilder-ai.TrainUtils -package: botbuilder-ai -summary: Generate Answer api utils class. -fullName: TrainUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TrainUtils(QnAMakerEndpoint) - uid: botbuilder-ai.TrainUtils.constructor - package: botbuilder-ai - summary: Creates new instance for active learning train utils. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new TrainUtils(endpoint: QnAMakerEndpoint)' - parameters: - - id: endpoint - type: - description: | - The endpoint of the knowledge base to query. -properties: - - name: httpRequestUtils - uid: botbuilder-ai.TrainUtils.httpRequestUtils - package: botbuilder-ai - summary: '' - fullName: httpRequestUtils - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'httpRequestUtils: HttpRequestUtils' - return: - description: '' - type: -methods: - - name: callTrain(FeedbackRecords) - uid: botbuilder-ai.TrainUtils.callTrain - package: botbuilder-ai - summary: Train API to provide feedback. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function callTrain(feedbackRecords: FeedbackRecords): Promise' - parameters: - - id: feedbackRecords - type: - description: | - Feedback record list. - return: - description: '' - type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/index.yml index bc290d69..c6968c49 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/index.yml @@ -3,20 +3,19 @@ uid: botbuilder-ai name: botbuilder-ai summary: '' type: package -typeAliases: - - botbuilder-ai.window - - botbuilder-ai.DynamicList - - botbuilder-ai.QnASuggestionsActivityFactory +enums: + - botbuilder-ai.Anchor + - botbuilder-ai.GeographyV2Type + - botbuilder-ai.JoinOperator + - botbuilder-ai.RankerTypes + - botbuilder-ai.ServiceType classes: + - botbuilder-ai.ActiveLearningUtils - botbuilder-ai.CustomQuestionAnswering - - botbuilder-ai.LuisAdaptivePredictionOptionsConverter - botbuilder-ai.LuisAdaptiveRecognizer - botbuilder-ai.LuisBotComponent - botbuilder-ai.LuisComponentRegistration - botbuilder-ai.LuisRecognizer - - botbuilder-ai.LuisRecognizerInternal - - botbuilder-ai.LuisRecognizerV2 - - botbuilder-ai.LuisRecognizerV3 - botbuilder-ai.LuisTelemetryConstants - botbuilder-ai.QnACardBuilder - botbuilder-ai.QnAMaker @@ -24,24 +23,21 @@ classes: - botbuilder-ai.QnAMakerComponentRegistration - botbuilder-ai.QnAMakerDialog - botbuilder-ai.QnAMakerRecognizer - - botbuilder-ai.QnATelemetryConstants - - botbuilder-ai.ActiveLearningUtils - - botbuilder-ai.BindToActivity - - botbuilder-ai.GenerateAnswerUtils - - botbuilder-ai.HttpRequestUtils - - botbuilder-ai.LanguageServiceUtils - - botbuilder-ai.TrainUtils interfaces: - - botbuilder-ai.QnAMakerClient - - botbuilder-ai.QnAMakerTelemetryClient + - botbuilder-ai.AnswerSpanResponse - botbuilder-ai.DateTimeSpec + - botbuilder-ai.DynamicList - botbuilder-ai.ExternalEntity + - botbuilder-ai.FeedbackRecord + - botbuilder-ai.FeedbackRecords + - botbuilder-ai.Filters - botbuilder-ai.GeographyV2 - botbuilder-ai.InstanceData - botbuilder-ai.IntentData + - botbuilder-ai.KnowledgeBaseAnswer + - botbuilder-ai.KnowledgeBaseAnswerSpan + - botbuilder-ai.KnowledgeBaseAnswers - botbuilder-ai.ListElement - - botbuilder-ai.LuisAdaptivePredictionOptions - - botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration - botbuilder-ai.LuisAdaptiveRecognizerConfiguration - botbuilder-ai.LuisApplication - botbuilder-ai.LuisPredictionOptions @@ -49,127 +45,59 @@ interfaces: - botbuilder-ai.LuisRecognizerOptionsV2 - botbuilder-ai.LuisRecognizerOptionsV3 - botbuilder-ai.LuisRecognizerTelemetryClient + - botbuilder-ai.MetadataFilter - botbuilder-ai.NumberWithUnits - botbuilder-ai.OrdinalV2 - - botbuilder-ai.QnAMakerDialogConfiguration + - botbuilder-ai.QnAMakerClient - botbuilder-ai.QnAMakerDialogOptions - botbuilder-ai.QnAMakerDialogResponseOptions - - botbuilder-ai.QnAMakerRecognizerConfiguration - - botbuilder-ai.AnswerSpanResponse - - botbuilder-ai.FeedbackRecord - - botbuilder-ai.FeedbackRecords - - botbuilder-ai.Filters - - botbuilder-ai.KnowledgeBaseAnswer - - botbuilder-ai.KnowledgeBaseAnswerSpan - - botbuilder-ai.KnowledgeBaseAnswers - - botbuilder-ai.MetadataFilter - - botbuilder-ai.QnARequestContext - - botbuilder-ai.QnAResponseContext - botbuilder-ai.QnAMakerEndpoint - botbuilder-ai.QnAMakerMetadata - botbuilder-ai.QnAMakerOptions - botbuilder-ai.QnAMakerPrompt + - botbuilder-ai.QnAMakerRecognizerConfiguration - botbuilder-ai.QnAMakerResult - botbuilder-ai.QnAMakerResults + - botbuilder-ai.QnAMakerTelemetryClient - botbuilder-ai.QnAMakerTraceInfo + - botbuilder-ai.QnARequestContext + - botbuilder-ai.QnAResponseContext +typeAliases: + - botbuilder-ai.QnASuggestionsActivityFactory functions: - name: validateDynamicList(DynamicList) uid: botbuilder-ai.validateDynamicList package: botbuilder-ai - summary: 'Validate the DynamicList object, throw if validation fails.' + summary: Validate the DynamicList object, throw if validation fails. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateDynamicList(dynamicList: DynamicList)' parameters: - id: dynamicList type: - description: | - The DynamicList object to be validated. - - name: validateExternalEntity(ExternalEntity) + description: The DynamicList object to be validated. + - name: validateExternalEntity(ExternalEntity) uid: botbuilder-ai.validateExternalEntity package: botbuilder-ai - summary: 'Validate the ExternalEntity object, throw if validation fails.' + summary: Validate the ExternalEntity object, throw if validation fails. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateExternalEntity(entity: ExternalEntity)' + content: 'function validateExternalEntity(entity: ExternalEntity)' parameters: - id: entity - type: - description: | - The ExternalEntity object to be validated. - - name: getFetch() - uid: botbuilder-ai.getFetch - package: botbuilder-ai - summary: Gets the fetch library. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getFetch(): any' - return: - description: The fetch library. - type: any + type: <unknown> + description: The ExternalEntity object to be validated. - name: validateListElement(ListElement) uid: botbuilder-ai.validateListElement package: botbuilder-ai - summary: 'Validate the ListElement object, throw if validation fails.' + summary: Validate the ListElement object, throw if validation fails. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateListElement(element: ListElement)' parameters: - id: element type: - description: | - The ListElement object to be validated. - - name: isLuisRecognizerOptionsV2(unknown) - uid: botbuilder-ai.isLuisRecognizerOptionsV2 - package: botbuilder-ai - summary: >- - Validates if the options provided are valid - [LuisRecognizerOptionsV2](xref:botbuilder-ai.LuisRecognizerOptionsV2). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isLuisRecognizerOptionsV2(options: unknown): boolean' - parameters: - - id: options - type: unknown - description: options to type test - return: - description: >- - A boolean value that indicates param options is a - [LuisRecognizerOptionsV2](xref:botbuilder-ai.LuisRecognizerOptionsV2). - type: boolean - - name: isLuisRecognizerOptionsV3(unknown) - uid: botbuilder-ai.isLuisRecognizerOptionsV3 - package: botbuilder-ai - summary: >- - Validates if the options provided are valid - [LuisRecognizerOptionsV3](xref:botbuilder-ai.LuisRecognizerOptionsV3). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isLuisRecognizerOptionsV3(options: unknown): boolean' - parameters: - - id: options - type: unknown - description: options to type test - return: - description: >- - A boolean value that indicates param options is a - [LuisRecognizerOptionsV3](xref:botbuilder-ai.LuisRecognizerOptionsV3). - type: boolean -enums: - - botbuilder-ai.GeographyV2Type - - botbuilder-ai.Anchor - - botbuilder-ai.JoinOperator - - botbuilder-ai.RankerTypes - - botbuilder-ai.ServiceType + description: The ListElement object to be validated. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/window.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/window.yml deleted file mode 100644 index 3a4c0c05..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-ai/window.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: window -uid: botbuilder-ai.window -package: botbuilder-ai -summary: '' -fullName: window -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type window = Window diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/ApplicationInsightsTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/ApplicationInsightsTelemetryClient.yml index 94492f67..c9d30614 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/ApplicationInsightsTelemetryClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/ApplicationInsightsTelemetryClient.yml @@ -2,7 +2,7 @@ name: ApplicationInsightsTelemetryClient uid: botbuilder-applicationinsights.ApplicationInsightsTelemetryClient package: botbuilder-applicationinsights -summary: > +summary: >- This is a wrapper class around the Application Insights node client. This is primarily designed to be used alongside the WaterfallDialog telemetry @@ -15,6 +15,7 @@ summary: > To use it, create pass in an instrumentation key: + ``` const myDialog = new WaterfallDialog('my_dialog', steps); @@ -27,7 +28,6 @@ summary: > ``` fullName: ApplicationInsightsTelemetryClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -44,15 +44,13 @@ constructors: remarks: |- The settings parameter is passed directly into appInsights.setup(). https://www.npmjs.com/package/applicationinsights#basic-usage - isPreview: false isDeprecated: false syntax: content: 'new ApplicationInsightsTelemetryClient(connectionString: string)' parameters: - id: connectionString type: string - description: | - The ApplicationInsights connection string. + description: The ApplicationInsights connection string. - name: ApplicationInsightsTelemetryClient(string) uid: >- botbuilder-applicationinsights.ApplicationInsightsTelemetryClient.constructor_1 @@ -66,15 +64,13 @@ constructors: remarks: |- The settings parameter is passed directly into appInsights.setup(). https://www.npmjs.com/package/applicationinsights#basic-usage - isPreview: false isDeprecated: false syntax: content: 'new ApplicationInsightsTelemetryClient(instrumentationKey: string)' parameters: - id: instrumentationKey type: string - description: | - The ApplicationInsights instrumentation key. + description: The ApplicationInsights instrumentation key. properties: - name: configuration uid: >- @@ -89,7 +85,6 @@ properties: `appInsightsClient.configuration.setAutoCollectDependencies(false)` fullName: configuration remarks: '' - isPreview: false isDeprecated: false syntax: content: Configuration configuration @@ -105,20 +100,18 @@ properties: necessary for some operations. fullName: defaultClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: appInsights.TelemetryClient defaultClient + content: NodeClient defaultClient return: description: app insights telemetry client - type: + type: NodeClient methods: - name: flush() uid: botbuilder-applicationinsights.ApplicationInsightsTelemetryClient.flush package: botbuilder-applicationinsights summary: Flushes the in-memory buffer and any metrics being pre-aggregated. remarks: '' - isPreview: false isDeprecated: false syntax: content: function flush() @@ -130,14 +123,13 @@ methods: Sends information about an external dependency (outgoing call) in the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackDependency(telemetry: TelemetryDependency)' parameters: - id: telemetry type: TelemetryDependency - description: > + description: >- The [TelemetryDependency](xref:botbuilder-core.TelemetryDependency) to track. - name: trackEvent(TelemetryEvent) @@ -146,29 +138,26 @@ methods: package: botbuilder-applicationinsights summary: Logs custom events with extensible named fields. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackEvent(telemetry: TelemetryEvent)' parameters: - id: telemetry type: TelemetryEvent - description: | - The [TelemetryEvent](xref:botbuilder-core.TelemetryEvent) to track. + description: The [TelemetryEvent](xref:botbuilder-core.TelemetryEvent) to track. - name: trackException(TelemetryException) uid: >- botbuilder-applicationinsights.ApplicationInsightsTelemetryClient.trackException package: botbuilder-applicationinsights summary: Logs a system exception. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackException(telemetry: TelemetryException)' parameters: - id: telemetry type: TelemetryException - description: > + description: >- The [TelemetryException](xref:botbuilder-core.TelemetryException) to track. - name: trackPageView(TelemetryPageView) @@ -177,14 +166,13 @@ methods: package: botbuilder-applicationinsights summary: Logs a dialog entry as an Application Insights page view. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackPageView(telemetry: TelemetryPageView)' parameters: - id: telemetry type: TelemetryPageView - description: > + description: >- The [TelemetryPageView](xref:botbuilder-core.TelemetryPageView) to track. - name: trackTrace(TelemetryTrace) @@ -193,12 +181,10 @@ methods: package: botbuilder-applicationinsights summary: Sends a trace message. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackTrace(telemetry: TelemetryTrace)' parameters: - id: telemetry type: TelemetryTrace - description: | - The [TelemetryTrace](xref:botbuilder-core.TelemetryTrace) to track. + description: The [TelemetryTrace](xref:botbuilder-core.TelemetryTrace) to track. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/TelemetryInitializerMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/TelemetryInitializerMiddleware.yml index 52d8547e..7ea489c7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/TelemetryInitializerMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-applicationinsights/TelemetryInitializerMiddleware.yml @@ -9,16 +9,14 @@ summary: >- Uses the botTelemetryClient interface. fullName: TelemetryInitializerMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TelemetryInitializerMiddleware(TelemetryLoggerMiddleware, boolean)' + - name: TelemetryInitializerMiddleware(TelemetryLoggerMiddleware, boolean) uid: botbuilder-applicationinsights.TelemetryInitializerMiddleware.constructor package: botbuilder-applicationinsights summary: Initializes a new instance of the TelemetryInitializerMiddleware class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,8 +28,7 @@ constructors: description: The TelemetryLoggerMiddleware used for logging activity telemetry. - id: logActivityTelemetry type: boolean - description: | - (Optional) Enable/Disable logging of activity telemetry. + description: (Optional) Enable/Disable logging of activity telemetry. properties: - name: logActivityTelemetry uid: >- @@ -42,7 +39,6 @@ properties: logging middleware to log activity events. fullName: logActivityTelemetry remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean logActivityTelemetry @@ -58,7 +54,6 @@ properties: events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: TelemetryLoggerMiddleware telemetryClient @@ -66,14 +61,13 @@ properties: description: telemetry logger middleware type: TelemetryLoggerMiddleware methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-applicationinsights.TelemetryInitializerMiddleware.onTurn package: botbuilder-applicationinsights summary: >- Store the incoming activity on the App Insights Correlation Context and optionally calls the TelemetryLoggerMiddleware remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -85,8 +79,7 @@ methods: description: The context object for this turn. - id: next type: () => Promise<void> - description: | - The delegate to call to continue the bot middleware pipeline + description: The delegate to call to continue the bot middleware pipeline return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorage.yml index 5862f25e..bd35b983 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorage.yml @@ -7,21 +7,22 @@ summary: >- backed by Azure Blob Storage fullName: BlobsStorage remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BlobsStorage(string, string, BlobsStorageOptions)' + - name: >- + BlobsStorage(string, string, BlobsStorageOptions, string, + StorageSharedKeyCredential | AnonymousCredential | TokenCredential) uid: botbuilder-azure-blobs.BlobsStorage.constructor package: botbuilder-azure-blobs summary: Constructs a BlobsStorage instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new BlobsStorage(connectionString: string, containerName: string, - options?: BlobsStorageOptions) + options?: BlobsStorageOptions, url?: string, credential?: + StorageSharedKeyCredential | AnonymousCredential | TokenCredential) parameters: - id: connectionString type: string @@ -31,47 +32,52 @@ constructors: description: Azure Blob Storage container name - id: options type: - description: | - Other options for BlobsStorage + description: Other options for BlobsStorage + - id: url + type: string + description: Azure Blob Storage container url + - id: credential + type: >- + | + | + description: Azure credential to access the resource methods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-azure-blobs.BlobsStorage.delete package: botbuilder-azure-blobs summary: Removes store items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: Array of item keys to remove from the store return: description: A promise representing the async operation type: Promise<void> - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-azure-blobs.BlobsStorage.read package: botbuilder-azure-blobs summary: Loads store items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: Array of item keys to read return: - description: 'The fetched [StoreItems](xref:botbuilder-core.StoreItems)' + description: The fetched [StoreItems](xref:botbuilder-core.StoreItems) type: Promise<StoreItems> - name: write(StoreItems) uid: botbuilder-azure-blobs.BlobsStorage.write package: botbuilder-azure-blobs summary: Saves store items to storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorageOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorageOptions.yml index 04c6fe5c..bc631fda 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorageOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsStorageOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-azure-blobs summary: Optional settings for BlobsStorage fullName: BlobsStorageOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,10 +18,9 @@ properties: storage client fullName: storagePipelineOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'storagePipelineOptions?: StoragePipelineOptions' return: description: '' - type: StoragePipelineOptions + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStore.yml index 427dbd21..5d7b38e1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStore.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStore.yml @@ -9,16 +9,14 @@ summary: >- transcripts in Azure Blob Storage fullName: BlobsTranscriptStore remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BlobsTranscriptStore(string, string, BlobsTranscriptStoreOptions)' + - name: BlobsTranscriptStore(string, string, BlobsTranscriptStoreOptions) uid: botbuilder-azure-blobs.BlobsTranscriptStore.constructor package: botbuilder-azure-blobs summary: Constructs a BlobsTranscriptStore instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -33,15 +31,13 @@ constructors: description: Azure Blob Storage container name - id: options type: - description: | - Other options for BlobsTranscriptStore + description: Other options for BlobsTranscriptStore methods: - - name: 'deleteTranscript(string, string)' + - name: deleteTranscript(string, string) uid: botbuilder-azure-blobs.BlobsTranscriptStore.deleteTranscript package: botbuilder-azure-blobs summary: Delete a specific conversation and all of its activities. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -57,12 +53,11 @@ methods: return: description: A promise representing the async operation. type: Promise<void> - - name: 'getTranscriptActivities(string, string, string, Date)' + - name: getTranscriptActivities(string, string, string, Date) uid: botbuilder-azure-blobs.BlobsTranscriptStore.getTranscriptActivities package: botbuilder-azure-blobs summary: Get activities for a conversation (aka the transcript). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -89,12 +84,11 @@ methods: [PagedResult](xref:botbuilder-core.PagedResult) of [Activity](xref:botbuilder-core.Activity) items type: Promise<PagedResult<Activity>> - - name: 'listTranscripts(string, string)' + - name: listTranscripts(string, string) uid: botbuilder-azure-blobs.BlobsTranscriptStore.listTranscripts package: botbuilder-azure-blobs summary: List conversations in the channelId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,12 +108,11 @@ methods: [PagedResult](xref:botbuilder-core.PagedResult) of [Activity](xref:botbuilder-core.Activity) items type: Promise<PagedResult<TranscriptInfo>> - - name: 'logActivity(Activity, BlobsTranscriptStoreOptions)' + - name: logActivity(Activity, BlobsTranscriptStoreOptions) uid: botbuilder-azure-blobs.BlobsTranscriptStore.logActivity package: botbuilder-azure-blobs summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStoreOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStoreOptions.yml index 80fe0d30..1a8dd2f4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStoreOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/BlobsTranscriptStoreOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-azure-blobs summary: Optional settings for BlobsTranscriptStore fullName: BlobsTranscriptStoreOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -20,7 +19,6 @@ properties: setting decodeTranscriptKey to true. fullName: decodeTranscriptKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'decodeTranscriptKey?: boolean' @@ -37,10 +35,9 @@ properties: storage client fullName: storagePipelineOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'storagePipelineOptions?: StoragePipelineOptions' return: description: '' - type: StoragePipelineOptions + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/IgnoreError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/IgnoreError.yml deleted file mode 100644 index 5ba2363a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/IgnoreError.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: IgnoreError -uid: botbuilder-azure-blobs.IgnoreError -package: botbuilder-azure-blobs -summary: Describes an ignore error function -fullName: IgnoreError -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type IgnoreError = (err: Error) => boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/index.yml index 453a41b6..85d0d2b0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-blobs/index.yml @@ -9,75 +9,3 @@ classes: interfaces: - botbuilder-azure-blobs.BlobsStorageOptions - botbuilder-azure-blobs.BlobsTranscriptStoreOptions -typeAliases: - - botbuilder-azure-blobs.IgnoreError -functions: - - name: 'ignoreError(Promise, IgnoreError)' - uid: botbuilder-azure-blobs.ignoreError - package: botbuilder-azure-blobs - summary: >- - Wrap a promise and provide a function to decide whether to ignore a type - of error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function ignoreError(promise: Promise, ignore: IgnoreError): - Promise - parameters: - - id: promise - type: Promise<T> - description: a promise to await - - id: ignore - type: - description: method that returns true if an error should be ignored - return: - description: >- - a promise that resolves to `T` or `null` after ignoring any matched - errors - type: Promise<T | null> - - name: 'isStatusCodeError(number[])' - uid: botbuilder-azure-blobs.isStatusCodeError - package: botbuilder-azure-blobs - summary: Ignore RestErrors that match a set of status codes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isStatusCodeError(codes: number[]): IgnoreError' - parameters: - - id: codes - type: 'number[]' - description: HTTP status codes that should not be considered errors - return: - description: >- - a function that accepts an error and returns true if it represents one - of the ignored status codes - type: - - name: 'sanitizeBlobKey(string, BlobsTranscriptStoreOptions)' - uid: botbuilder-azure-blobs.sanitizeBlobKey - package: botbuilder-azure-blobs - summary: >- - Ensures that `key` is a properly sanitized Azure Blob Storage key. It - should be URI encoded, - - no longer than 1024 characters, and contain no more than 254 slash ("/") - chars. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sanitizeBlobKey(key: string, options?: - BlobsTranscriptStoreOptions): string - parameters: - - id: key - type: string - description: string blob key to sanitize - - id: options - type: - description: Optional settings for BlobsTranscriptStore - return: - description: sanitized blob key - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-queues/AzureQueueStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-queues/AzureQueueStorage.yml index a50798df..66ed0c5e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-queues/AzureQueueStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure-queues/AzureQueueStorage.yml @@ -5,16 +5,14 @@ package: botbuilder-azure-queues summary: Service used to add messages to an Azure Storage Queues. fullName: AzureQueueStorage remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AzureQueueStorage(string, string)' + - name: AzureQueueStorage(string, string) uid: botbuilder-azure-queues.AzureQueueStorage.constructor package: botbuilder-azure-queues summary: Initializes a new instance of the AzureQueueStorage class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -26,10 +24,9 @@ constructors: description: Azure storage connection string. - id: queueName type: string - description: | - Name of the storage queue where entities will be queued. + description: Name of the storage queue where entities will be queued. methods: - - name: 'queueActivity(Partial, number, number)' + - name: queueActivity(Partial, number, number) uid: botbuilder-azure-queues.AzureQueueStorage.queueActivity package: botbuilder-azure-queues summary: >- @@ -39,7 +36,6 @@ methods: to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/AzureBlobTranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/AzureBlobTranscriptStore.yml index 00d8d9c7..f09ab620 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/AzureBlobTranscriptStore.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/AzureBlobTranscriptStore.yml @@ -7,7 +7,6 @@ fullName: AzureBlobTranscriptStore remarks: |- Each activity is stored as JSON blob with a structure of `container/{channelId]/{conversationId}/{Timestamp.ticks}-{activity.id}.json`. -isPreview: false isDeprecated: true customDeprecatedMessage: >- This class is deprecated in favor of @@ -19,22 +18,19 @@ constructors: package: botbuilder-azure summary: Creates a new AzureBlobTranscriptStore instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AzureBlobTranscriptStore(settings: BlobStorageSettings)' parameters: - id: settings type: - description: | - Settings required for configuring an instance of BlobStorage + description: Settings required for configuring an instance of BlobStorage methods: - - name: 'deleteTranscript(string, string)' + - name: deleteTranscript(string, string) uid: botbuilder-azure.AzureBlobTranscriptStore.deleteTranscript package: botbuilder-azure summary: Delete a specific conversation and all of it's activities. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -46,17 +42,15 @@ methods: description: Channel Id where conversation took place. - id: conversationId type: string - description: | - Id of the conversation to delete. + description: Id of the conversation to delete. return: description: '' type: Promise<void> - - name: 'getTranscriptActivities(string, string, string, Date)' + - name: getTranscriptActivities(string, string, string, Date) uid: botbuilder-azure.AzureBlobTranscriptStore.getTranscriptActivities package: botbuilder-azure summary: Get activities for a conversation (Aka the transcript) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -79,12 +73,11 @@ methods: return: description: The PagedResult of activities. type: Promise<PagedResult<Activity>> - - name: 'listTranscripts(string, string)' + - name: listTranscripts(string, string) uid: botbuilder-azure.AzureBlobTranscriptStore.listTranscripts package: botbuilder-azure summary: List conversations in the channelId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -107,15 +100,13 @@ methods: package: botbuilder-azure summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logActivity(activity: Activity): Promise' parameters: - id: activity type: Activity - description: | - Activity being logged. + description: Activity being logged. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorage.yml index fd703f82..01fc04ac 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorage.yml @@ -13,7 +13,6 @@ remarks: >- is named after the key which is encoded and ensure it conforms a valid blob name. -isPreview: false isDeprecated: true customDeprecatedMessage: >- This class is deprecated in favor of @@ -25,44 +24,40 @@ constructors: package: botbuilder-azure summary: Creates a new BlobStorage instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BlobStorage(settings: BlobStorageSettings)' parameters: - id: settings type: - description: | - Settings for configuring an instance of BlobStorage. + description: Settings for configuring an instance of BlobStorage. methods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-azure.BlobStorage.delete package: botbuilder-azure summary: Delete entity blobs from the configured container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: An array of entity keys. return: description: A promise representing the asynchronous operation. type: Promise<void> - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-azure.BlobStorage.read package: botbuilder-azure summary: Retrieve entities from the configured blob container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: An array of entity keys. return: description: The read items. @@ -72,7 +67,6 @@ methods: package: botbuilder-azure summary: Store a new entity in the configured blob container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorageSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorageSettings.yml index 07acd4a7..2b42fc39 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorageSettings.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/BlobStorageSettings.yml @@ -5,7 +5,6 @@ package: botbuilder-azure summary: Settings for configuring an instance of `BlobStorage`. fullName: BlobStorageSettings remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Root container name to use. fullName: containerName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'containerName: string' @@ -28,7 +26,6 @@ properties: summary: (Optional) azure storage host. fullName: host remarks: '' - isPreview: false isDeprecated: false syntax: content: 'host?: string | Host' @@ -41,7 +38,6 @@ properties: summary: The storage access key. fullName: storageAccessKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'storageAccessKey?: string' @@ -56,7 +52,6 @@ properties: account, the storage access key must be provided. fullName: storageAccountOrConnectionString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'storageAccountOrConnectionString: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbKeyEscape.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbKeyEscape.yml index 628bb446..1c324673 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbKeyEscape.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbKeyEscape.yml @@ -5,7 +5,7 @@ type: module package: botbuilder-azure summary: '' functions: - - name: 'escapeKey(string, string, boolean)' + - name: escapeKey(string, string, boolean) uid: botbuilder-azure.CosmosDbKeyEscape.escapeKey package: botbuilder-azure summary: >- @@ -17,7 +17,6 @@ functions: More information at https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.documents.resource.id?view=azure-dotnet#remarks remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorage.yml index 44b7bfb0..974ec90e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorage.yml @@ -5,7 +5,6 @@ package: botbuilder-azure summary: Implements a CosmosDB based storage provider using partitioning for a bot. fullName: CosmosDbPartitionedStorage remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: using the provided CosmosDB credentials, database ID, and container ID. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,23 +25,20 @@ constructors: parameters: - id: cosmosDbStorageOptions type: - description: | - Cosmos DB partitioned storage configuration options. + description: Cosmos DB partitioned storage configuration options. methods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-azure.CosmosDbPartitionedStorage.delete package: botbuilder-azure summary: Delete one or more items from the Cosmos DB container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' - description: | - Array of Ids for the items to be deleted. + type: string[] + description: Array of Ids for the items to be deleted. return: description: '' type: Promise<void> @@ -52,25 +47,23 @@ methods: package: botbuilder-azure summary: Connects to the CosmosDB database and creates / gets the container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Promise' return: description: '' type: Promise<void> - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-azure.CosmosDbPartitionedStorage.read package: botbuilder-azure summary: Read one or more items with matching keys from the Cosmos DB container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: A collection of Ids for each item to be retrieved. return: description: The read items. @@ -80,15 +73,13 @@ methods: package: botbuilder-azure summary: Insert or update one or more items into the Cosmos DB container. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' parameters: - id: changes type: StoreItems - description: | - Dictionary of items to be inserted or updated indexed by key. + description: Dictionary of items to be inserted or updated indexed by key. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorageOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorageOptions.yml index ded2b379..83a11d1e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorageOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/CosmosDbPartitionedStorageOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-azure summary: Cosmos DB Partitioned Storage Options. fullName: CosmosDbPartitionedStorageOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The authentication key for Cosmos DB. fullName: authKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authKey?: string' @@ -25,7 +23,7 @@ properties: - name: compatibilityMode uid: botbuilder-azure.CosmosDbPartitionedStorageOptions.compatibilityMode package: botbuilder-azure - summary: > + summary: >- Early version of CosmosDb had a max key length of 255. Keys longer than this were truncated in cosmosDbKeyEscape.escapeKey. This remains the @@ -35,10 +33,10 @@ properties: compatibilityMode to false. + compatibilityMode cannot be true if keySuffix is used. fullName: compatibilityMode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'compatibilityMode?: boolean' @@ -51,7 +49,6 @@ properties: summary: The container identifier. fullName: containerId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'containerId: string' @@ -64,7 +61,6 @@ properties: summary: The throughput set when creating the Container. Defaults to 400. fullName: containerThroughput remarks: '' - isPreview: false isDeprecated: false syntax: content: 'containerThroughput?: number' @@ -77,20 +73,18 @@ properties: summary: The options for the CosmosClient. fullName: cosmosClientOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cosmosClientOptions?: CosmosClientOptions' return: description: '' - type: CosmosClientOptions + type: - name: cosmosDbEndpoint uid: botbuilder-azure.CosmosDbPartitionedStorageOptions.cosmosDbEndpoint package: botbuilder-azure summary: The CosmosDB endpoint. fullName: cosmosDbEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cosmosDbEndpoint?: string' @@ -103,7 +97,6 @@ properties: summary: The database identifier for Cosmos DB instance. fullName: databaseId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'databaseId: string' @@ -113,8 +106,9 @@ properties: - name: keySuffix uid: botbuilder-azure.CosmosDbPartitionedStorageOptions.keySuffix package: botbuilder-azure - summary: | + summary: |- The suffix to be added to every key. See cosmosDbKeyEscape.escapeKey + Note: compatibilityMode must be set to 'false' to use a KeySuffix. When KeySuffix is used, keys will NOT be truncated but an exception will be thrown if the key length is longer than allowed by CosmosDb. @@ -123,10 +117,21 @@ properties: (e.g. not: '\\', '?', '/', '#', '*') fullName: keySuffix remarks: '' - isPreview: false isDeprecated: false syntax: content: 'keySuffix?: string' return: description: '' type: string + - name: tokenCredential + uid: botbuilder-azure.CosmosDbPartitionedStorageOptions.tokenCredential + package: botbuilder-azure + summary: The authentication tokenCredential for Cosmos DB. + fullName: tokenCredential + remarks: '' + isDeprecated: false + syntax: + content: 'tokenCredential?: TokenCredential' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/DoOnce.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/DoOnce.yml deleted file mode 100644 index 5dd8913a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/DoOnce.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSType -name: DoOnce -uid: botbuilder-azure.DoOnce -package: botbuilder-azure -summary: Task to perform only one time. -fullName: DoOnce -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'waitFor(string, () => Promise)' - uid: botbuilder-azure.DoOnce.waitFor - package: botbuilder-azure - summary: Wait for the task to be executed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function waitFor(key: string, fn: () => Promise): Promise' - parameters: - - id: key - type: string - description: Key of the task. - - id: fn - type: () => Promise<T> - description: Function to perform. - return: - description: A promise representing the asynchronous operation. - type: Promise<T> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/Host.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/Host.yml index d39e24b4..192c0cd2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/Host.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/Host.yml @@ -5,7 +5,6 @@ package: botbuilder-azure summary: '' fullName: Host remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Primary host address. fullName: primaryHost remarks: '' - isPreview: false isDeprecated: false syntax: content: 'primaryHost: string' @@ -28,7 +26,6 @@ properties: summary: Secondary host address. fullName: secondaryHost remarks: '' - isPreview: false isDeprecated: false syntax: content: 'secondaryHost: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/index.yml index ac390e4b..a637f901 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-azure/index.yml @@ -7,8 +7,7 @@ classes: - botbuilder-azure.AzureBlobTranscriptStore - botbuilder-azure.BlobStorage - botbuilder-azure.CosmosDbPartitionedStorage - - botbuilder-azure.DoOnce interfaces: - botbuilder-azure.BlobStorageSettings - - botbuilder-azure.Host - botbuilder-azure.CosmosDbPartitionedStorageOptions + - botbuilder-azure.Host diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceCardSize.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceCardSize.yml new file mode 100644 index 00000000..12e1f5ce --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceCardSize.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: AceCardSize +uid: botbuilder-core.AceCardSize +package: botbuilder-core +summary: SharePoint ACE Card Size +fullName: AceCardSize +remarks: '' +isDeprecated: false +syntax: | + type AceCardSize = "Medium" | "Large" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceData.yml new file mode 100644 index 00000000..cbb619e8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceData.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: AceData +uid: botbuilder-core.AceData +package: botbuilder-core +summary: SharePoint ACE Data object +fullName: AceData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardSize + uid: botbuilder-core.AceData.cardSize + package: botbuilder-core + summary: The card size. + fullName: cardSize + remarks: '' + isDeprecated: false + syntax: + content: 'cardSize: AceCardSize' + return: + description: '' + type: + - name: dataVersion + uid: botbuilder-core.AceData.dataVersion + package: botbuilder-core + summary: >- + The value of this property is stored in the serialized data of the + Adaptive Card Extension. + + It can be used to manage versioning of the Adaptive Card Extension. + fullName: dataVersion + remarks: >- + - although there is no restriction on the format of this property, it is + recommended to use semantic versioning. + isDeprecated: false + syntax: + content: 'dataVersion: string' + return: + description: '' + type: string + - name: description + uid: botbuilder-core.AceData.description + package: botbuilder-core + summary: The description of the ACE. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description: string' + return: + description: '' + type: string + - name: iconProperty + uid: botbuilder-core.AceData.iconProperty + package: botbuilder-core + summary: The icon of the ACE. + fullName: iconProperty + remarks: '' + isDeprecated: false + syntax: + content: 'iconProperty: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.AceData.id + package: botbuilder-core + summary: The unique id (Guid) of the ACE. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: isVisible + uid: botbuilder-core.AceData.isVisible + package: botbuilder-core + summary: |- + The visibility of the Adaptive Card Extension. + true if not specified. + fullName: isVisible + remarks: '' + isDeprecated: false + syntax: + content: 'isVisible?: boolean' + return: + description: '' + type: boolean + - name: properties + uid: botbuilder-core.AceData.properties + package: botbuilder-core + summary: The properties of the ACE. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties: any' + return: + description: '' + type: any + - name: title + uid: botbuilder-core.AceData.title + package: botbuilder-core + summary: The title of the ACE. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceRequest.yml new file mode 100644 index 00000000..4c94f000 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AceRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AceRequest +uid: botbuilder-core.AceRequest +package: botbuilder-core +summary: ACE invoke request payload. +fullName: AceRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder-core.AceRequest.data + package: botbuilder-core + summary: User ACE request data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + - name: properties + uid: botbuilder-core.AceRequest.properties + package: botbuilder-core + summary: ACE properties data. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Action.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Action.yml new file mode 100644 index 00000000..8d199bd1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Action.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Action +uid: botbuilder-core.Action +package: botbuilder-core +summary: |- + Defines values for Action. + Possible values include: 'accept', 'decline' +fullName: Action +remarks: '' +isDeprecated: false +syntax: | + type Action = "accept" | "decline" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActionTypes.yml new file mode 100644 index 00000000..6b60817f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActionTypes.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: ActionTypes +uid: botbuilder-core.ActionTypes +package: botbuilder-core +summary: >- + Defines values for ActionTypes. + + Possible values include: 'openUrl', 'imBack', 'postBack', 'playAudio', + 'playVideo', 'showImage', + + 'downloadFile', 'signin', 'call', messageBack', 'openApp' +fullName: ActionTypes +remarks: '' +isDeprecated: false +fields: + - name: Call + uid: botbuilder-core.ActionTypes.Call + package: botbuilder-core + summary: '' + - name: DownloadFile + uid: botbuilder-core.ActionTypes.DownloadFile + package: botbuilder-core + summary: '' + - name: ImBack + uid: botbuilder-core.ActionTypes.ImBack + package: botbuilder-core + summary: '' + - name: MessageBack + uid: botbuilder-core.ActionTypes.MessageBack + package: botbuilder-core + summary: '' + - name: OpenApp + uid: botbuilder-core.ActionTypes.OpenApp + package: botbuilder-core + summary: '' + - name: OpenUrl + uid: botbuilder-core.ActionTypes.OpenUrl + package: botbuilder-core + summary: '' + - name: Payment + uid: botbuilder-core.ActionTypes.Payment + package: botbuilder-core + summary: '' + - name: PlayAudio + uid: botbuilder-core.ActionTypes.PlayAudio + package: botbuilder-core + summary: '' + - name: PlayVideo + uid: botbuilder-core.ActionTypes.PlayVideo + package: botbuilder-core + summary: '' + - name: PostBack + uid: botbuilder-core.ActionTypes.PostBack + package: botbuilder-core + summary: '' + - name: ShowImage + uid: botbuilder-core.ActionTypes.ShowImage + package: botbuilder-core + summary: '' + - name: Signin + uid: botbuilder-core.ActionTypes.Signin + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Activity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Activity.yml new file mode 100644 index 00000000..32a02fba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Activity.yml @@ -0,0 +1,594 @@ +### YamlMime:TSType +name: Activity +uid: botbuilder-core.Activity +package: botbuilder-core +summary: >- + An Activity is the basic communication type for the Bot Framework 3.0 + protocol. +fullName: Activity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder-core.Activity.action + package: botbuilder-core + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string + - name: attachmentLayout + uid: botbuilder-core.Activity.attachmentLayout + package: botbuilder-core + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + - name: attachments + uid: botbuilder-core.Activity.attachments + package: botbuilder-core + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + - name: callerId + uid: botbuilder-core.Activity.callerId + package: botbuilder-core + summary: >- + A string containing a URI identifying the caller of a bot. This field is + not intended to be transmitted over + + the wire, but is instead populated by bots and clients based on + cryptographically verifiable data that asserts + + the identity of the callers (e.g. tokens). + fullName: callerId + remarks: '' + isDeprecated: false + syntax: + content: 'callerId: string' + return: + description: '' + type: string + - name: channelData + uid: botbuilder-core.Activity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + - name: channelId + uid: botbuilder-core.Activity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: code + uid: botbuilder-core.Activity.code + package: botbuilder-core + summary: >- + The a code for endOfConversation activities that indicates why the + conversation ended. + + Possible values include: 'unknown', 'completedSuccessfully', + 'userCancelled', 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + - name: conversation + uid: botbuilder-core.Activity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: deliveryMode + uid: botbuilder-core.Activity.deliveryMode + package: botbuilder-core + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification', 'expectReplies', 'ephemeral' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + - name: entities + uid: botbuilder-core.Activity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + - name: expiration + uid: botbuilder-core.Activity.expiration + package: botbuilder-core + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + - name: from + uid: botbuilder-core.Activity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + - name: historyDisclosed + uid: botbuilder-core.Activity.historyDisclosed + package: botbuilder-core + summary: Indicates whether the prior history of the channel is disclosed. + fullName: historyDisclosed + remarks: '' + isDeprecated: false + syntax: + content: 'historyDisclosed?: boolean' + return: + description: '' + type: boolean + - name: id + uid: botbuilder-core.Activity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: importance + uid: botbuilder-core.Activity.importance + package: botbuilder-core + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + - name: inputHint + uid: botbuilder-core.Activity.inputHint + package: botbuilder-core + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder-core.Activity.label + package: botbuilder-core + summary: A descriptive label for the activity. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: listenFor + uid: botbuilder-core.Activity.listenFor + package: botbuilder-core + summary: >- + List of phrases and references that speech and language priming systems + should listen for + fullName: listenFor + remarks: '' + isDeprecated: false + syntax: + content: 'listenFor: string[]' + return: + description: '' + type: string[] + - name: locale + uid: botbuilder-core.Activity.locale + package: botbuilder-core + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: localTimestamp + uid: botbuilder-core.Activity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + - name: localTimezone + uid: botbuilder-core.Activity.localTimezone + package: botbuilder-core + summary: >- + Contains the name of the local timezone of the message, expressed in IANA + Time Zone database format. + + For example, America/Los_Angeles. + fullName: localTimezone + remarks: '' + isDeprecated: false + syntax: + content: 'localTimezone: string' + return: + description: '' + type: string + - name: membersAdded + uid: botbuilder-core.Activity.membersAdded + package: botbuilder-core + summary: The collection of members added to the conversation. + fullName: membersAdded + remarks: '' + isDeprecated: false + syntax: + content: 'membersAdded?: ChannelAccount[]' + return: + description: '' + type: [] + - name: membersRemoved + uid: botbuilder-core.Activity.membersRemoved + package: botbuilder-core + summary: The collection of members removed from the conversation. + fullName: membersRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'membersRemoved?: ChannelAccount[]' + return: + description: '' + type: [] + - name: name + uid: botbuilder-core.Activity.name + package: botbuilder-core + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: reactionsAdded + uid: botbuilder-core.Activity.reactionsAdded + package: botbuilder-core + summary: The collection of reactions added to the conversation. + fullName: reactionsAdded + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsAdded?: MessageReaction[]' + return: + description: '' + type: [] + - name: reactionsRemoved + uid: botbuilder-core.Activity.reactionsRemoved + package: botbuilder-core + summary: The collection of reactions removed from the conversation. + fullName: reactionsRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsRemoved?: MessageReaction[]' + return: + description: '' + type: [] + - name: recipient + uid: botbuilder-core.Activity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + - name: relatesTo + uid: botbuilder-core.Activity.relatesTo + package: botbuilder-core + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: replyToId + uid: botbuilder-core.Activity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + - name: semanticAction + uid: botbuilder-core.Activity.semanticAction + package: botbuilder-core + summary: An optional programmatic action accompanying this request + fullName: semanticAction + remarks: '' + isDeprecated: false + syntax: + content: 'semanticAction?: SemanticAction' + return: + description: '' + type: + - name: serviceUrl + uid: botbuilder-core.Activity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + - name: speak + uid: botbuilder-core.Activity.speak + package: botbuilder-core + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + - name: suggestedActions + uid: botbuilder-core.Activity.suggestedActions + package: botbuilder-core + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: summary + uid: botbuilder-core.Activity.summary + package: botbuilder-core + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.Activity.text + package: botbuilder-core + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: textFormat + uid: botbuilder-core.Activity.textFormat + package: botbuilder-core + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + - name: textHighlights + uid: botbuilder-core.Activity.textHighlights + package: botbuilder-core + summary: >- + The collection of text fragments to highlight when the activity contains a + ReplyToId value. + fullName: textHighlights + remarks: '' + isDeprecated: false + syntax: + content: 'textHighlights?: TextHighlight[]' + return: + description: '' + type: [] + - name: timestamp + uid: botbuilder-core.Activity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + - name: topicName + uid: botbuilder-core.Activity.topicName + package: botbuilder-core + summary: The updated topic name of the conversation. + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.Activity.type + package: botbuilder-core + summary: >- + Contains the activity type. Possible values include: 'message', + 'contactRelationUpdate', + + 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', + 'deleteUserData', + + 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', + 'suggestion', + + 'trace', 'handoff' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.Activity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + - name: valueType + uid: botbuilder-core.Activity.valueType + package: botbuilder-core + summary: The type of the activity's value object. + fullName: valueType + remarks: '' + isDeprecated: false + syntax: + content: 'valueType: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEventNames.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEventNames.yml new file mode 100644 index 00000000..b49e146b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEventNames.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: ActivityEventNames +uid: botbuilder-core.ActivityEventNames +package: botbuilder-core +summary: |- + Defines values for ActivityEventNames. + Possible values include: 'continueConversation', 'createConversation' +fullName: ActivityEventNames +remarks: '' +isDeprecated: false +fields: + - name: ContinueConversation + uid: botbuilder-core.ActivityEventNames.ContinueConversation + package: botbuilder-core + summary: '' + - name: CreateConversation + uid: botbuilder-core.ActivityEventNames.CreateConversation + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEx.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEx.yml new file mode 100644 index 00000000..810444f0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityEx.yml @@ -0,0 +1,621 @@ +### YamlMime:TSPackage +uid: botbuilder-core.ActivityEx +name: ActivityEx +type: module +package: botbuilder-core +summary: '' +functions: + - name: asCommandActivity(Partial) + uid: botbuilder-core.ActivityEx.asCommandActivity + package: botbuilder-core + summary: >- + Returns the source activity as an ICommandActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asCommandActivity(source: Partial): + Partial> + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a command activity; or null. + type: >- + Partial<<T>> + - name: asCommandResultActivity(Partial) + uid: botbuilder-core.ActivityEx.asCommandResultActivity + package: botbuilder-core + summary: >- + Returns the source activity as an ICommandResultActivity object; or null, + if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asCommandResultActivity(source: Partial): + Partial> + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a command result activity; or null. + type: >- + Partial<<T>> + - name: asContactRelationUpdateActivity(Partial) + uid: botbuilder-core.ActivityEx.asContactRelationUpdateActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IContactRelationUpdateActivity object; + or null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asContactRelationUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a contact relation update activity; or null. + type: >- + Partial<> + - name: asConversationUpdateActivity(Partial) + uid: botbuilder-core.ActivityEx.asConversationUpdateActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IConversationUpdateActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asConversationUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an conversation update activity; or null. + type: >- + Partial<> + - name: asEndOfConversationActivity(Partial) + uid: botbuilder-core.ActivityEx.asEndOfConversationActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IEndOfConversationActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asEndOfConversationActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an end of conversation activity; or null. + type: >- + Partial<> + - name: asEventActivity(Partial) + uid: botbuilder-core.ActivityEx.asEventActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IEventActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asEventActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an event activity; or null. + type: Partial<> + - name: asHandoffActivity(Partial) + uid: botbuilder-core.ActivityEx.asHandoffActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IHandoffActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asHandoffActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a handoff activity; or null. + type: Partial<> + - name: asInstallationUpdateActivity(Partial) + uid: botbuilder-core.ActivityEx.asInstallationUpdateActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IInstallationUpdateActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asInstallationUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an installation update activity; or null. + type: >- + Partial<> + - name: asInvokeActivity(Partial) + uid: botbuilder-core.ActivityEx.asInvokeActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IInvokeActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asInvokeActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an invoke activity; or null. + type: Partial<> + - name: asMessageActivity(Partial) + uid: botbuilder-core.ActivityEx.asMessageActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IMessageActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message activity; or null. + type: Partial<> + - name: asMessageDeleteActivity(Partial) + uid: botbuilder-core.ActivityEx.asMessageDeleteActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IMessageDeleteActivity object; or null, + if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageDeleteActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message delete request; or null. + type: Partial<> + - name: asMessageReactionActivity(Partial) + uid: botbuilder-core.ActivityEx.asMessageReactionActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IMessageReactionActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageReactionActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message reaction activity; or null. + type: Partial<> + - name: asMessageUpdateActivity(Partial) + uid: botbuilder-core.ActivityEx.asMessageUpdateActivity + package: botbuilder-core + summary: >- + Returns the source activity as an IMessageUpdateActivity object; or null, + if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message update request; or null. + type: Partial<> + - name: asSuggestionActivity(Partial) + uid: botbuilder-core.ActivityEx.asSuggestionActivity + package: botbuilder-core + summary: >- + Returns the source activity as an ISuggestionActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asSuggestionActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a suggestion activity; or null. + type: Partial<> + - name: asTraceActivity(Partial) + uid: botbuilder-core.ActivityEx.asTraceActivity + package: botbuilder-core + summary: >- + Returns the source activity as an ITraceActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asTraceActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a trace activity; or null. + type: Partial<> + - name: asTypingActivity(Partial) + uid: botbuilder-core.ActivityEx.asTypingActivity + package: botbuilder-core + summary: >- + Returns the source activity as an ITypingActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asTypingActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a typing activity; or null. + type: Partial<> + - name: createContactRelationUpdateActivity() + uid: botbuilder-core.ActivityEx.createContactRelationUpdateActivity + package: botbuilder-core + summary: Creates an Activity as an IContactRelationUpdateActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createContactRelationUpdateActivity(): + Partial + return: + description: The new contact relation update activity. + type: >- + Partial<> + - name: createConversationUpdateActivity() + uid: botbuilder-core.ActivityEx.createConversationUpdateActivity + package: botbuilder-core + summary: Creates an Activity as an IConversationUpdateActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createConversationUpdateActivity(): + Partial + return: + description: The new conversation update activity. + type: >- + Partial<> + - name: createEndOfConversationActivity() + uid: botbuilder-core.ActivityEx.createEndOfConversationActivity + package: botbuilder-core + summary: Creates an Activity as an IEndOfConversationActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createEndOfConversationActivity(): + Partial + return: + description: The new end of conversation activity. + type: >- + Partial<> + - name: createEventActivity() + uid: botbuilder-core.ActivityEx.createEventActivity + package: botbuilder-core + summary: Creates an Activity as an IEventActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createEventActivity(): Partial' + return: + description: The new event activity. + type: Partial<> + - name: createHandoffActivity() + uid: botbuilder-core.ActivityEx.createHandoffActivity + package: botbuilder-core + summary: Creates an Activity as an IHandoffActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createHandoffActivity(): Partial' + return: + description: The new handoff activity. + type: Partial<> + - name: createInvokeActivity() + uid: botbuilder-core.ActivityEx.createInvokeActivity + package: botbuilder-core + summary: Creates an Activity as an IInvokeActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createInvokeActivity(): Partial' + return: + description: The new invoke activity. + type: Partial<> + - name: createMessageActivity() + uid: botbuilder-core.ActivityEx.createMessageActivity + package: botbuilder-core + summary: Creates an Activity as an IMessageActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createMessageActivity(): Partial' + return: + description: The new message activity. + type: Partial<> + - name: createReply(Activity, string, string) + uid: botbuilder-core.ActivityEx.createReply + package: botbuilder-core + summary: Creates a new message activity as a response to this activity. + remarks: The new activity sets up routing information based on this activity. + isDeprecated: false + syntax: + content: >- + function createReply(source: Activity, text?: string, locale?: string): + Activity + parameters: + - id: source + type: + description: The activity to respond. + - id: text + type: string + description: The text of the reply. + - id: locale + type: string + description: The language code for the + return: + description: The new message activity. + type: + - name: createTrace(Activity, string, unknown, string, string) + uid: botbuilder-core.ActivityEx.createTrace + package: botbuilder-core + summary: Creates a new trace activity based on the source activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTrace(source: Activity, name: string, value?: unknown, + valueType?: string, label?: string): ITraceActivity + parameters: + - id: source + type: + description: The activity to base the trace. + - id: name + type: string + description: The name of the trace operation to create. + - id: value + type: unknown + description: Optional, the content for this trace operation. + - id: valueType + type: string + description: Optional, identifier for the format of the + - id: label + type: string + description: Optional, a descriptive label for this trace operation. + return: + description: The new trace activity. + type: + - name: createTraceActivity(string, string, unknown, string) + uid: botbuilder-core.ActivityEx.createTraceActivity + package: botbuilder-core + summary: Creates an Activity as an ITraceActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTraceActivity(name: string, valueType?: string, value?: + unknown, label?: string): Partial + parameters: + - id: name + type: string + description: The name of the trace operation to create. + - id: valueType + type: string + description: Optional, identifier for the format of the + - id: value + type: unknown + description: . Default is the name of type of the + - id: label + type: string + description: Optional, a descriptive label for this trace operation. + return: + description: The new trace activity. + type: Partial<> + - name: createTypingActivity() + uid: botbuilder-core.ActivityEx.createTypingActivity + package: botbuilder-core + summary: Creates an Activity as an ITypingActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createTypingActivity(): Partial' + return: + description: The new typing activity. + type: Partial<> + - name: getContinuationActivity(Partial) + uid: botbuilder-core.ActivityEx.getContinuationActivity + package: botbuilder-core + summary: Creates an Activity from conversation reference as it is posted to bot. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getContinuationActivity(reference: + Partial): Partial + parameters: + - id: reference + type: Partial<> + description: the conversation reference + return: + description: the activity + type: Partial<> + - name: getConversationReference(Partial) + uid: botbuilder-core.ActivityEx.getConversationReference + package: botbuilder-core + summary: Creates a ConversationReference based on the source activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConversationReference(source: Partial): + ConversationReference + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: >- + A conversation reference for the conversation that contains the + activity. + type: + - name: getMentions(Partial) + uid: botbuilder-core.ActivityEx.getMentions + package: botbuilder-core + summary: |- + Resolves the mentions from the entities of the source activity. + + See cref="entities" . + See cref="mention" . + remarks: >- + This method is only intended for use with a message activity, where the + Activity Type is set to Message. + isDeprecated: false + syntax: + content: 'function getMentions(source: Partial): Mention[]' + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: The array of mentions; or an empty array, if none are found. + type: [] + - name: hasContent(Partial) + uid: botbuilder-core.ActivityEx.hasContent + package: botbuilder-core + summary: Indicates whether the source activity has content. + remarks: >- + This method is only intended for use with a message activity, where the + Activity Type is set to Message. + isDeprecated: false + syntax: + content: 'function hasContent(source: Partial): boolean' + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: True, if this activity has any content to send; otherwise, false. + type: boolean + - name: isActivity(Partial, string) + uid: botbuilder-core.ActivityEx.isActivity + package: botbuilder-core + summary: Indicates whether this activity is of a specified activity type. + remarks: '' + isDeprecated: false + syntax: + content: >- + function isActivity(source: Partial, activityType: string): + boolean + parameters: + - id: source + type: Partial<> + description: The source activity. + - id: activityType + type: string + description: The activity type to check for. + return: + description: >- + True if the activity is of the specified activity type; otherwise, + false. + type: boolean + - name: isFromStreamingConnection(Partial) + uid: botbuilder-core.ActivityEx.isFromStreamingConnection + package: botbuilder-core + summary: >- + Determines if the Activity was sent via an Http/Https connection or + Streaming. + + This can be determined by looking at the ServiceUrl property: + + (1) All channels that send messages via http/https are not streaming + + (2) Channels that send messages via streaming have a ServiceUrl that does + not begin with http/https. + remarks: '' + isDeprecated: false + syntax: + content: 'function isFromStreamingConnection(source: Partial): boolean' + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: True if the Activity was originate from a streaming connection. + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityFactory.yml index 717ddc16..cce8c9e9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityFactory.yml @@ -9,7 +9,6 @@ summary: >- create Activity. fullName: ActivityFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -18,7 +17,6 @@ methods: package: botbuilder-core summary: Generate the activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function fromObject(lgResult: any): Partial' @@ -28,4 +26,4 @@ methods: description: string result from languageGenerator. return: description: The generated MessageActivity. - type: Partial<Activity> + type: Partial<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandler.yml index 5fa0aa99..d100e180 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandler.yml @@ -75,7 +75,6 @@ remarks: >- **See also** - The [Bot Framework Activity schema](https://aka.ms/botSpecs-activitySchema) -isPreview: false isDeprecated: false type: class methods: @@ -88,10 +87,9 @@ methods: [onCommand](xref:botbuilder-core.ActivityHandler.onCommand) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onCommand(handler: BotHandler): this' + content: 'function onCommand(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -100,7 +98,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onCommandResult(BotHandler) uid: botbuilder-core.ActivityHandler.onCommandResult package: botbuilder-core @@ -110,10 +108,9 @@ methods: [onCommandResult](xref:botbuilder-core.ActivityHandler.onCommandResult) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onCommandResult(handler: BotHandler): this' + content: 'function onCommandResult(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -122,7 +119,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onConversationUpdate(BotHandler) uid: botbuilder-core.ActivityHandler.onConversationUpdate package: botbuilder-core @@ -145,10 +142,9 @@ methods: [onMembersRemoved](xref:botbuilder-core.ActivityHandler.onMembersRemoved) sub-type event handlers. - isPreview: false isDeprecated: false syntax: - content: 'function onConversationUpdate(handler: BotHandler): this' + content: 'function onConversationUpdate(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -157,7 +153,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onDialog(BotHandler) uid: botbuilder-core.ActivityHandler.onDialog package: botbuilder-core @@ -165,10 +161,9 @@ methods: Registers an activity event handler for the _dialog_ event, emitted as the last event for an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onDialog(handler: BotHandler): this' + content: 'function onDialog(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -177,7 +172,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onEndOfConversation(BotHandler) uid: botbuilder-core.ActivityHandler.onEndOfConversation package: botbuilder-core @@ -193,10 +188,9 @@ methods: [onEndOfConversation](xref:botbuilder-core.ActivityHandler.onEndOfConversation) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onEndOfConversation(handler: BotHandler): this' + content: 'function onEndOfConversation(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -205,7 +199,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onEvent(BotHandler) uid: botbuilder-core.ActivityHandler.onEvent package: botbuilder-core @@ -236,10 +230,9 @@ methods: sub-type event handler. To handle other named events, add logic to this handler. - isPreview: false isDeprecated: false syntax: - content: 'function onEvent(handler: BotHandler): this' + content: 'function onEvent(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -248,7 +241,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onInstallationUpdate(BotHandler) uid: botbuilder-core.ActivityHandler.onInstallationUpdate package: botbuilder-core @@ -258,10 +251,9 @@ methods: [onInstallationUpdate](xref:botbuilder-core.ActivityHandler.onInstallationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdate(handler: BotHandler): this' + content: 'function onInstallationUpdate(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -270,7 +262,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onInstallationUpdateAdd(BotHandler) uid: botbuilder-core.ActivityHandler.onInstallationUpdateAdd package: botbuilder-core @@ -278,10 +270,9 @@ methods: Registers an activity event handler for the _installationupdate add_ activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdateAdd(handler: BotHandler): this' + content: 'function onInstallationUpdateAdd(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -295,7 +286,7 @@ methods: [onInstallationUpdateAdd](xref:botbuilder-core.ActivityHandler.onInstallationUpdateAdd) type-specific event handler. - type: this + type: - name: onInstallationUpdateRemove(BotHandler) uid: botbuilder-core.ActivityHandler.onInstallationUpdateRemove package: botbuilder-core @@ -307,10 +298,11 @@ methods: [onInstallationUpdateRemove](xref:botbuilder-core.ActivityHandler.onInstallationUpdateRemove) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdateRemove(handler: BotHandler): this' + content: >- + function onInstallationUpdateRemove(handler: BotHandler): + ActivityHandler parameters: - id: handler type: @@ -319,7 +311,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onMembersAdded(BotHandler) uid: botbuilder-core.ActivityHandler.onMembersAdded package: botbuilder-core @@ -340,10 +332,9 @@ methods: [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onMembersAdded(handler: BotHandler): this' + content: 'function onMembersAdded(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -352,7 +343,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onMembersRemoved(BotHandler) uid: botbuilder-core.ActivityHandler.onMembersRemoved package: botbuilder-core @@ -375,10 +366,9 @@ methods: [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onMembersRemoved(handler: BotHandler): this' + content: 'function onMembersRemoved(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -387,7 +377,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onMessage(BotHandler) uid: botbuilder-core.ActivityHandler.onMessage package: botbuilder-core @@ -405,10 +395,9 @@ methods: [text](xref:botframework-schema.Activity.text) property can be `null` or `undefined`. - isPreview: false isDeprecated: false syntax: - content: 'function onMessage(handler: BotHandler): this' + content: 'function onMessage(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -417,7 +406,39 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: + - name: onMessageDelete(BotHandler) + uid: botbuilder-core.ActivityHandler.onMessageDelete + package: botbuilder-core + summary: >- + Registers an activity event handler for the _message delete_ event, + emitted for every incoming message activity. + remarks: >- + Message delete activities represent a deletion of an existing message + activity within a conversation. + + The deleted activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity. + + Message delete activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageDelete`. + isDeprecated: false + syntax: + content: 'function onMessageDelete(handler: BotHandler): ActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: - name: onMessageReaction(BotHandler) uid: botbuilder-core.ActivityHandler.onMessageReaction package: botbuilder-core @@ -449,10 +470,44 @@ methods: [onReactionsRemoved](xref:botbuilder-core.ActivityHandler.onReactionsRemoved) sub-type event handlers. - isPreview: false isDeprecated: false syntax: - content: 'function onMessageReaction(handler: BotHandler): this' + content: 'function onMessageReaction(handler: BotHandler): ActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + - name: onMessageUpdate(BotHandler) + uid: botbuilder-core.ActivityHandler.onMessageUpdate + package: botbuilder-core + summary: >- + Registers an activity event handler for the _message update_ event, + emitted for every incoming message activity. + remarks: >- + Message update activities represent an update of an existing message + activity within a conversation. + + The updated activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity, and the + + message update activity contains all fields in the revised message + activity. + + Message update activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageUpdate`. + isDeprecated: false + syntax: + content: 'function onMessageUpdate(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -461,7 +516,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onReactionsAdded(BotHandler) uid: botbuilder-core.ActivityHandler.onReactionsAdded package: botbuilder-core @@ -482,10 +537,9 @@ methods: [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onReactionsAdded(handler: BotHandler): this' + content: 'function onReactionsAdded(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -494,7 +548,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onReactionsRemoved(BotHandler) uid: botbuilder-core.ActivityHandler.onReactionsRemoved package: botbuilder-core @@ -515,10 +569,9 @@ methods: [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onReactionsRemoved(handler: BotHandler): this' + content: 'function onReactionsRemoved(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -527,7 +580,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onTokenResponseEvent(BotHandler) uid: botbuilder-core.ActivityHandler.onTokenResponseEvent package: botbuilder-core @@ -553,10 +606,9 @@ methods: [onEvent](xref:botbuilder-core.ActivityHandler.onEvent) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onTokenResponseEvent(handler: BotHandler): this' + content: 'function onTokenResponseEvent(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -565,7 +617,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onTurn(BotHandler) uid: botbuilder-core.ActivityHandler.onTurn package: botbuilder-core @@ -573,10 +625,9 @@ methods: Registers an activity event handler for the _turn_ event, emitted for every incoming activity, regardless of type. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onTurn(handler: BotHandler): this' + content: 'function onTurn(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -585,7 +636,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onTyping(BotHandler) uid: botbuilder-core.ActivityHandler.onTyping package: botbuilder-core @@ -595,10 +646,9 @@ methods: [onTyping](xref:botbuilder-core.ActivityHandler.onTyping) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onTyping(handler: BotHandler): this' + content: 'function onTyping(handler: BotHandler): ActivityHandler' parameters: - id: handler type: @@ -607,7 +657,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: onUnrecognizedActivityType(BotHandler) uid: botbuilder-core.ActivityHandler.onUnrecognizedActivityType package: botbuilder-core @@ -635,10 +685,11 @@ methods: The activity's [type](xref:botframework-schema.Activity.type) property contains the activity type. - isPreview: false isDeprecated: false syntax: - content: 'function onUnrecognizedActivityType(handler: BotHandler): this' + content: >- + function onUnrecognizedActivityType(handler: BotHandler): + ActivityHandler parameters: - id: handler type: @@ -647,7 +698,7 @@ methods: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this + type: - name: run(TurnContext) uid: botbuilder-core.ActivityHandler.run package: botbuilder-core @@ -679,15 +730,13 @@ methods: - [BotFrameworkAdapter.processActivity](xref:botbuilder.BotFrameworkAdapter.processActivity) - isPreview: false isDeprecated: false syntax: content: 'function run(context: TurnContext): Promise' parameters: - id: context type: - description: | - The context object for the current turn. + description: The context object for the current turn. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandlerBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandlerBase.yml index 92b321ba..1da21275 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandlerBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityHandlerBase.yml @@ -38,7 +38,6 @@ remarks: >- **See also** - The [Bot Framework Activity schema](https://aka.ms/botSpecs-activitySchema) -isPreview: false isDeprecated: false type: class methods: @@ -73,15 +72,13 @@ methods: - [BotFrameworkAdapter.processActivity](xref:botbuilder.BotFrameworkAdapter.processActivity) - isPreview: false isDeprecated: false syntax: content: 'function run(context: TurnContext): Promise' parameters: - id: context type: - description: | - The context object for the current turn. + description: The context object for the current turn. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImageType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImageType.yml new file mode 100644 index 00000000..66c797de --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImageType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ActivityImageType +uid: botbuilder-core.ActivityImageType +package: botbuilder-core +summary: |- + Defines values for ActivityImageType. + Possible values include: 'avatar', 'article' +fullName: ActivityImageType +remarks: '' +isDeprecated: false +syntax: | + type ActivityImageType = "avatar" | "article" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImportance.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImportance.yml new file mode 100644 index 00000000..02cf46b8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityImportance.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: ActivityImportance +uid: botbuilder-core.ActivityImportance +package: botbuilder-core +summary: |- + Defines values for ActivityImportance. + Possible values include: 'low', 'normal', 'high' +fullName: ActivityImportance +remarks: '' +isDeprecated: false +fields: + - name: High + uid: botbuilder-core.ActivityImportance.High + package: botbuilder-core + summary: '' + - name: Low + uid: botbuilder-core.ActivityImportance.Low + package: botbuilder-core + summary: '' + - name: Normal + uid: botbuilder-core.ActivityImportance.Normal + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTimestamps.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTimestamps.yml new file mode 100644 index 00000000..d4020ce4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTimestamps.yml @@ -0,0 +1,751 @@ +### YamlMime:TSType +name: ActivityTimestamps +uid: botbuilder-core.ActivityTimestamps +package: botbuilder-core +summary: >- + This interface is used to preserve the original string values of dates on + Activities. + + When an Activity is received, timestamps are converted to Dates. Due to how + Javascript + + Date objects are UTC, timezone offset values are lost. +fullName: ActivityTimestamps +remarks: '' +isDeprecated: false +type: interface +properties: + - name: rawExpiration + uid: botbuilder-core.ActivityTimestamps.rawExpiration + package: botbuilder-core + summary: '' + fullName: rawExpiration + remarks: '' + isDeprecated: false + syntax: + content: 'rawExpiration?: string' + return: + description: '' + type: string + - name: rawLocalTimestamp + uid: botbuilder-core.ActivityTimestamps.rawLocalTimestamp + package: botbuilder-core + summary: '' + fullName: rawLocalTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'rawLocalTimestamp?: string' + return: + description: '' + type: string + - name: rawTimestamp + uid: botbuilder-core.ActivityTimestamps.rawTimestamp + package: botbuilder-core + summary: '' + fullName: rawTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'rawTimestamp?: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botbuilder-core.ActivityTimestamps.action + package: botbuilder-core + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.action](xref:botbuilder-core.Activity.action) + - name: attachmentLayout + uid: botbuilder-core.ActivityTimestamps.attachmentLayout + package: botbuilder-core + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.attachmentLayout](xref:botbuilder-core.Activity.attachmentLayout) + - name: attachments + uid: botbuilder-core.ActivityTimestamps.attachments + package: botbuilder-core + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.attachments](xref:botbuilder-core.Activity.attachments) + - name: callerId + uid: botbuilder-core.ActivityTimestamps.callerId + package: botbuilder-core + summary: >- + A string containing a URI identifying the caller of a bot. This field is + not intended to be transmitted over + + the wire, but is instead populated by bots and clients based on + cryptographically verifiable data that asserts + + the identity of the callers (e.g. tokens). + fullName: callerId + remarks: '' + isDeprecated: false + syntax: + content: 'callerId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.callerId](xref:botbuilder-core.Activity.callerId) + - name: channelData + uid: botbuilder-core.ActivityTimestamps.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [Activity.channelData](xref:botbuilder-core.Activity.channelData) + - name: channelId + uid: botbuilder-core.ActivityTimestamps.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.channelId](xref:botbuilder-core.Activity.channelId) + - name: code + uid: botbuilder-core.ActivityTimestamps.code + package: botbuilder-core + summary: >- + The a code for endOfConversation activities that indicates why the + conversation ended. + + Possible values include: 'unknown', 'completedSuccessfully', + 'userCancelled', 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.code](xref:botbuilder-core.Activity.code) + - name: conversation + uid: botbuilder-core.ActivityTimestamps.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.conversation](xref:botbuilder-core.Activity.conversation) + - name: deliveryMode + uid: botbuilder-core.ActivityTimestamps.deliveryMode + package: botbuilder-core + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification', 'expectReplies', 'ephemeral' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.deliveryMode](xref:botbuilder-core.Activity.deliveryMode) + - name: entities + uid: botbuilder-core.ActivityTimestamps.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.entities](xref:botbuilder-core.Activity.entities) + - name: expiration + uid: botbuilder-core.ActivityTimestamps.expiration + package: botbuilder-core + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [Activity.expiration](xref:botbuilder-core.Activity.expiration) + - name: from + uid: botbuilder-core.ActivityTimestamps.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [Activity.from](xref:botbuilder-core.Activity.from) + - name: historyDisclosed + uid: botbuilder-core.ActivityTimestamps.historyDisclosed + package: botbuilder-core + summary: Indicates whether the prior history of the channel is disclosed. + fullName: historyDisclosed + remarks: '' + isDeprecated: false + syntax: + content: 'historyDisclosed?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [Activity.historyDisclosed](xref:botbuilder-core.Activity.historyDisclosed) + - name: id + uid: botbuilder-core.ActivityTimestamps.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.id](xref:botbuilder-core.Activity.id) + - name: importance + uid: botbuilder-core.ActivityTimestamps.importance + package: botbuilder-core + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.importance](xref:botbuilder-core.Activity.importance) + - name: inputHint + uid: botbuilder-core.ActivityTimestamps.inputHint + package: botbuilder-core + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.inputHint](xref:botbuilder-core.Activity.inputHint) + - name: label + uid: botbuilder-core.ActivityTimestamps.label + package: botbuilder-core + summary: A descriptive label for the activity. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.label](xref:botbuilder-core.Activity.label) + - name: listenFor + uid: botbuilder-core.ActivityTimestamps.listenFor + package: botbuilder-core + summary: >- + List of phrases and references that speech and language priming systems + should listen for + fullName: listenFor + remarks: '' + isDeprecated: false + syntax: + content: 'listenFor: string[]' + return: + description: '' + type: string[] + inheritanceDescription: >- + Inherited From + [Activity.listenFor](xref:botbuilder-core.Activity.listenFor) + - name: locale + uid: botbuilder-core.ActivityTimestamps.locale + package: botbuilder-core + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.locale](xref:botbuilder-core.Activity.locale) + - name: localTimestamp + uid: botbuilder-core.ActivityTimestamps.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [Activity.localTimestamp](xref:botbuilder-core.Activity.localTimestamp) + - name: localTimezone + uid: botbuilder-core.ActivityTimestamps.localTimezone + package: botbuilder-core + summary: >- + Contains the name of the local timezone of the message, expressed in IANA + Time Zone database format. + + For example, America/Los_Angeles. + fullName: localTimezone + remarks: '' + isDeprecated: false + syntax: + content: 'localTimezone: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.localTimezone](xref:botbuilder-core.Activity.localTimezone) + - name: membersAdded + uid: botbuilder-core.ActivityTimestamps.membersAdded + package: botbuilder-core + summary: The collection of members added to the conversation. + fullName: membersAdded + remarks: '' + isDeprecated: false + syntax: + content: 'membersAdded?: ChannelAccount[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.membersAdded](xref:botbuilder-core.Activity.membersAdded) + - name: membersRemoved + uid: botbuilder-core.ActivityTimestamps.membersRemoved + package: botbuilder-core + summary: The collection of members removed from the conversation. + fullName: membersRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'membersRemoved?: ChannelAccount[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.membersRemoved](xref:botbuilder-core.Activity.membersRemoved) + - name: name + uid: botbuilder-core.ActivityTimestamps.name + package: botbuilder-core + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.name](xref:botbuilder-core.Activity.name) + - name: reactionsAdded + uid: botbuilder-core.ActivityTimestamps.reactionsAdded + package: botbuilder-core + summary: The collection of reactions added to the conversation. + fullName: reactionsAdded + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsAdded?: MessageReaction[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.reactionsAdded](xref:botbuilder-core.Activity.reactionsAdded) + - name: reactionsRemoved + uid: botbuilder-core.ActivityTimestamps.reactionsRemoved + package: botbuilder-core + summary: The collection of reactions removed from the conversation. + fullName: reactionsRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsRemoved?: MessageReaction[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.reactionsRemoved](xref:botbuilder-core.Activity.reactionsRemoved) + - name: recipient + uid: botbuilder-core.ActivityTimestamps.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.recipient](xref:botbuilder-core.Activity.recipient) + - name: relatesTo + uid: botbuilder-core.ActivityTimestamps.relatesTo + package: botbuilder-core + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.relatesTo](xref:botbuilder-core.Activity.relatesTo) + - name: replyToId + uid: botbuilder-core.ActivityTimestamps.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.replyToId](xref:botbuilder-core.Activity.replyToId) + - name: semanticAction + uid: botbuilder-core.ActivityTimestamps.semanticAction + package: botbuilder-core + summary: An optional programmatic action accompanying this request + fullName: semanticAction + remarks: '' + isDeprecated: false + syntax: + content: 'semanticAction?: SemanticAction' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.semanticAction](xref:botbuilder-core.Activity.semanticAction) + - name: serviceUrl + uid: botbuilder-core.ActivityTimestamps.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.serviceUrl](xref:botbuilder-core.Activity.serviceUrl) + - name: speak + uid: botbuilder-core.ActivityTimestamps.speak + package: botbuilder-core + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.speak](xref:botbuilder-core.Activity.speak) + - name: suggestedActions + uid: botbuilder-core.ActivityTimestamps.suggestedActions + package: botbuilder-core + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.suggestedActions](xref:botbuilder-core.Activity.suggestedActions) + - name: summary + uid: botbuilder-core.ActivityTimestamps.summary + package: botbuilder-core + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.summary](xref:botbuilder-core.Activity.summary) + - name: text + uid: botbuilder-core.ActivityTimestamps.text + package: botbuilder-core + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.text](xref:botbuilder-core.Activity.text) + - name: textFormat + uid: botbuilder-core.ActivityTimestamps.textFormat + package: botbuilder-core + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.textFormat](xref:botbuilder-core.Activity.textFormat) + - name: textHighlights + uid: botbuilder-core.ActivityTimestamps.textHighlights + package: botbuilder-core + summary: >- + The collection of text fragments to highlight when the activity contains a + ReplyToId value. + fullName: textHighlights + remarks: '' + isDeprecated: false + syntax: + content: 'textHighlights?: TextHighlight[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.textHighlights](xref:botbuilder-core.Activity.textHighlights) + - name: timestamp + uid: botbuilder-core.ActivityTimestamps.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [Activity.timestamp](xref:botbuilder-core.Activity.timestamp) + - name: topicName + uid: botbuilder-core.ActivityTimestamps.topicName + package: botbuilder-core + summary: The updated topic name of the conversation. + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.topicName](xref:botbuilder-core.Activity.topicName) + - name: type + uid: botbuilder-core.ActivityTimestamps.type + package: botbuilder-core + summary: >- + Contains the activity type. Possible values include: 'message', + 'contactRelationUpdate', + + 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', + 'deleteUserData', + + 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', + 'suggestion', + + 'trace', 'handoff' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.type](xref:botbuilder-core.Activity.type) + - name: value + uid: botbuilder-core.ActivityTimestamps.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [Activity.value](xref:botbuilder-core.Activity.value) + - name: valueType + uid: botbuilder-core.ActivityTimestamps.valueType + package: botbuilder-core + summary: The type of the activity's value object. + fullName: valueType + remarks: '' + isDeprecated: false + syntax: + content: 'valueType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.valueType](xref:botbuilder-core.Activity.valueType) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTypes.yml new file mode 100644 index 00000000..fd8a5036 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ActivityTypes.yml @@ -0,0 +1,90 @@ +### YamlMime:TSEnum +name: ActivityTypes +uid: botbuilder-core.ActivityTypes +package: botbuilder-core +summary: >- + Defines values for ActivityTypes. + + Possible values include: 'message', 'contactRelationUpdate', + 'conversationUpdate', 'typing', + + 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', + 'messageDelete', + + 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' +fullName: ActivityTypes +remarks: '' +isDeprecated: false +fields: + - name: Command + uid: botbuilder-core.ActivityTypes.Command + package: botbuilder-core + summary: '' + - name: CommandResult + uid: botbuilder-core.ActivityTypes.CommandResult + package: botbuilder-core + summary: '' + - name: ContactRelationUpdate + uid: botbuilder-core.ActivityTypes.ContactRelationUpdate + package: botbuilder-core + summary: '' + - name: ConversationUpdate + uid: botbuilder-core.ActivityTypes.ConversationUpdate + package: botbuilder-core + summary: '' + - name: DeleteUserData + uid: botbuilder-core.ActivityTypes.DeleteUserData + package: botbuilder-core + summary: '' + - name: EndOfConversation + uid: botbuilder-core.ActivityTypes.EndOfConversation + package: botbuilder-core + summary: '' + - name: Event + uid: botbuilder-core.ActivityTypes.Event + package: botbuilder-core + summary: '' + - name: Handoff + uid: botbuilder-core.ActivityTypes.Handoff + package: botbuilder-core + summary: '' + - name: InstallationUpdate + uid: botbuilder-core.ActivityTypes.InstallationUpdate + package: botbuilder-core + summary: '' + - name: Invoke + uid: botbuilder-core.ActivityTypes.Invoke + package: botbuilder-core + summary: '' + - name: InvokeResponse + uid: botbuilder-core.ActivityTypes.InvokeResponse + package: botbuilder-core + summary: '' + - name: Message + uid: botbuilder-core.ActivityTypes.Message + package: botbuilder-core + summary: '' + - name: MessageDelete + uid: botbuilder-core.ActivityTypes.MessageDelete + package: botbuilder-core + summary: '' + - name: MessageReaction + uid: botbuilder-core.ActivityTypes.MessageReaction + package: botbuilder-core + summary: '' + - name: MessageUpdate + uid: botbuilder-core.ActivityTypes.MessageUpdate + package: botbuilder-core + summary: '' + - name: Suggestion + uid: botbuilder-core.ActivityTypes.Suggestion + package: botbuilder-core + summary: '' + - name: Trace + uid: botbuilder-core.ActivityTypes.Trace + package: botbuilder-core + summary: '' + - name: Typing + uid: botbuilder-core.ActivityTypes.Typing + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardAuthentication.yml new file mode 100644 index 00000000..457c90f3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardAuthentication.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: AdaptiveCardAuthentication +uid: botbuilder-core.AdaptiveCardAuthentication +package: botbuilder-core +summary: >- + Defines the structure that arrives in the Activity.Value.Authentication for + Invoke + + activity with Name of 'adaptiveCard/action'. +fullName: AdaptiveCardAuthentication +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: connectionName + uid: botbuilder-core.AdaptiveCardAuthentication.connectionName + package: botbuilder-core + summary: The connection name. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TokenExchangeInvokeRequest.connectionName](xref:botbuilder-core.TokenExchangeInvokeRequest.connectionName) + - name: id + uid: botbuilder-core.AdaptiveCardAuthentication.id + package: botbuilder-core + summary: The id from the OAuthCard. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TokenExchangeInvokeRequest.id](xref:botbuilder-core.TokenExchangeInvokeRequest.id) + - name: token + uid: botbuilder-core.AdaptiveCardAuthentication.token + package: botbuilder-core + summary: The user token that can be exchanged. + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TokenExchangeInvokeRequest.token](xref:botbuilder-core.TokenExchangeInvokeRequest.token) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeAction.yml new file mode 100644 index 00000000..5a03a6e3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeAction.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: AdaptiveCardInvokeAction +uid: botbuilder-core.AdaptiveCardInvokeAction +package: botbuilder-core +summary: |- + Defines the structure that arrives in the Activity.Value.Action for Invoke + activity with Name of 'adaptiveCard/action'. +fullName: AdaptiveCardInvokeAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder-core.AdaptiveCardInvokeAction.data + package: botbuilder-core + summary: The Data of this adaptive card action invoke. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: Record' + return: + description: '' + type: Record<string, unknown> + - name: id + uid: botbuilder-core.AdaptiveCardInvokeAction.id + package: botbuilder-core + summary: The id of this Adaptive Card Invoke Action. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.AdaptiveCardInvokeAction.type + package: botbuilder-core + summary: The Type of this Adaptive Card Invoke Action. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: verb + uid: botbuilder-core.AdaptiveCardInvokeAction.verb + package: botbuilder-core + summary: The Verb of this adaptive card action invoke. + fullName: verb + remarks: '' + isDeprecated: false + syntax: + content: 'verb: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeResponse.yml new file mode 100644 index 00000000..6ed4141b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeResponse.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: AdaptiveCardInvokeResponse +uid: botbuilder-core.AdaptiveCardInvokeResponse +package: botbuilder-core +summary: >- + Defines the structure that is returned as the result of an Invoke activity + with + + Name of 'adaptiveCard/action'. +fullName: AdaptiveCardInvokeResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: statusCode + uid: botbuilder-core.AdaptiveCardInvokeResponse.statusCode + package: botbuilder-core + summary: The Card Action response status code. + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: number' + return: + description: '' + type: number + - name: type + uid: botbuilder-core.AdaptiveCardInvokeResponse.type + package: botbuilder-core + summary: The type of this response. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.AdaptiveCardInvokeResponse.value + package: botbuilder-core + summary: The json response object. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: Record' + return: + description: '' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeValue.yml new file mode 100644 index 00000000..4e8d40d4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AdaptiveCardInvokeValue.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: AdaptiveCardInvokeValue +uid: botbuilder-core.AdaptiveCardInvokeValue +package: botbuilder-core +summary: >- + Defines the structure that arrives in the Activity.Value for Invoke activity + with + + Name of 'adaptiveCard/action'. +fullName: AdaptiveCardInvokeValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder-core.AdaptiveCardInvokeValue.action + package: botbuilder-core + summary: >- + The + [AdaptiveCardInvokeAction](xref:botframework-schema.AdaptiveCardInvokeAction) + of + + this adaptive card invoke action value. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: AdaptiveCardInvokeAction' + return: + description: '' + type: + - name: authentication + uid: botbuilder-core.AdaptiveCardInvokeValue.authentication + package: botbuilder-core + summary: >- + The + [AdaptiveCardAuthentication](xref:botframework-schema.AdaptiveCardAuthentication) + + for this adaptive card invoke action value. + fullName: authentication + remarks: '' + isDeprecated: false + syntax: + content: 'authentication: AdaptiveCardAuthentication' + return: + description: '' + type: + - name: state + uid: botbuilder-core.AdaptiveCardInvokeValue.state + package: botbuilder-core + summary: The 'state' or magic code for an OAuth flow. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AnimationCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AnimationCard.yml new file mode 100644 index 00000000..419271d3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AnimationCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: AnimationCard +uid: botbuilder-core.AnimationCard +package: botbuilder-core +summary: 'An animation card (Ex: gif or short video clip)' +fullName: AnimationCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder-core.AnimationCard.aspect + package: botbuilder-core + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder-core.AnimationCard.autoloop + package: botbuilder-core + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder-core.AnimationCard.autostart + package: botbuilder-core + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder-core.AnimationCard.buttons + package: botbuilder-core + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder-core.AnimationCard.duration + package: botbuilder-core + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder-core.AnimationCard.image + package: botbuilder-core + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder-core.AnimationCard.media + package: botbuilder-core + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder-core.AnimationCard.shareable + package: botbuilder-core + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder-core.AnimationCard.subtitle + package: botbuilder-core + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.AnimationCard.text + package: botbuilder-core + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.AnimationCard.title + package: botbuilder-core + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.AnimationCard.value + package: botbuilder-core + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AppBasedLinkQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AppBasedLinkQuery.yml new file mode 100644 index 00000000..f5c4783d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AppBasedLinkQuery.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AppBasedLinkQuery +uid: botbuilder-core.AppBasedLinkQuery +package: botbuilder-core +summary: '' +fullName: AppBasedLinkQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: state + uid: botbuilder-core.AppBasedLinkQuery.state + package: botbuilder-core + summary: State is the magic code for OAuth Flow + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string + - name: url + uid: botbuilder-core.AppBasedLinkQuery.url + package: botbuilder-core + summary: Url queried by user + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ApplicationIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ApplicationIdentityType.yml new file mode 100644 index 00000000..9b0e7be6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ApplicationIdentityType.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: ApplicationIdentityType +uid: botbuilder-core.ApplicationIdentityType +package: botbuilder-core +summary: >- + Defines values for ApplicationIdentityType. + + Possible values include: 'aadApplication', 'bot', 'tenantBot', + 'office365Connector', 'webhook' +fullName: ApplicationIdentityType +remarks: '' +isDeprecated: false +syntax: | + type ApplicationIdentityType = + | "aadApplication" + | "bot" + | "tenantBot" + | "office365Connector" + | "webhook" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Attachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Attachment.yml new file mode 100644 index 00000000..06984524 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Attachment.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: Attachment +uid: botbuilder-core.Attachment +package: botbuilder-core +summary: An attachment within an activity +fullName: Attachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder-core.Attachment.content + package: botbuilder-core + summary: Embedded content + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: any' + return: + description: '' + type: any + - name: contentType + uid: botbuilder-core.Attachment.contentType + package: botbuilder-core + summary: mimetype/Contenttype for the file + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: string' + return: + description: '' + type: string + - name: contentUrl + uid: botbuilder-core.Attachment.contentUrl + package: botbuilder-core + summary: Content Url + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.Attachment.name + package: botbuilder-core + summary: (OPTIONAL) The name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: thumbnailUrl + uid: botbuilder-core.Attachment.thumbnailUrl + package: botbuilder-core + summary: (OPTIONAL) Thumbnail associated with attachment + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentData.yml new file mode 100644 index 00000000..ebd13221 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentData.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: AttachmentData +uid: botbuilder-core.AttachmentData +package: botbuilder-core +summary: Attachment data +fullName: AttachmentData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.AttachmentData.name + package: botbuilder-core + summary: Name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: originalBase64 + uid: botbuilder-core.AttachmentData.originalBase64 + package: botbuilder-core + summary: Attachment content + fullName: originalBase64 + remarks: '' + isDeprecated: false + syntax: + content: 'originalBase64: Uint8Array' + return: + description: '' + type: Uint8Array + - name: thumbnailBase64 + uid: botbuilder-core.AttachmentData.thumbnailBase64 + package: botbuilder-core + summary: Attachment thumbnail + fullName: thumbnailBase64 + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailBase64: Uint8Array' + return: + description: '' + type: Uint8Array + - name: type + uid: botbuilder-core.AttachmentData.type + package: botbuilder-core + summary: Content-Type of the attachment + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentInfo.yml new file mode 100644 index 00000000..f17a9efa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: AttachmentInfo +uid: botbuilder-core.AttachmentInfo +package: botbuilder-core +summary: Metadata for an attachment +fullName: AttachmentInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.AttachmentInfo.name + package: botbuilder-core + summary: Name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.AttachmentInfo.type + package: botbuilder-core + summary: ContentType of the attachment + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: views + uid: botbuilder-core.AttachmentInfo.views + package: botbuilder-core + summary: attachment views + fullName: views + remarks: '' + isDeprecated: false + syntax: + content: 'views: AttachmentView[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayout.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayout.yml new file mode 100644 index 00000000..9f7a16b1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayout.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: AttachmentLayout +uid: botbuilder-core.AttachmentLayout +package: botbuilder-core +summary: |- + Defines values for AttachmentLayout. + Possible values include: 'list', 'grid' +fullName: AttachmentLayout +remarks: '' +isDeprecated: false +syntax: | + type AttachmentLayout = "list" | "grid" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayoutTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayoutTypes.yml new file mode 100644 index 00000000..63df4afd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentLayoutTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: AttachmentLayoutTypes +uid: botbuilder-core.AttachmentLayoutTypes +package: botbuilder-core +summary: |- + Defines values for AttachmentLayoutTypes. + Possible values include: 'list', 'carousel' +fullName: AttachmentLayoutTypes +remarks: '' +isDeprecated: false +fields: + - name: Carousel + uid: botbuilder-core.AttachmentLayoutTypes.Carousel + package: botbuilder-core + summary: '' + - name: List + uid: botbuilder-core.AttachmentLayoutTypes.List + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentView.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentView.yml new file mode 100644 index 00000000..a9cd2e28 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AttachmentView.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AttachmentView +uid: botbuilder-core.AttachmentView +package: botbuilder-core +summary: Attachment View name and size +fullName: AttachmentView +remarks: '' +isDeprecated: false +type: interface +properties: + - name: size + uid: botbuilder-core.AttachmentView.size + package: botbuilder-core + summary: Size of the attachment + fullName: size + remarks: '' + isDeprecated: false + syntax: + content: 'size: number' + return: + description: '' + type: number + - name: viewId + uid: botbuilder-core.AttachmentView.viewId + package: botbuilder-core + summary: Id of the attachment + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AudioCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AudioCard.yml new file mode 100644 index 00000000..cac45de9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AudioCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: AudioCard +uid: botbuilder-core.AudioCard +package: botbuilder-core +summary: Audio card +fullName: AudioCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder-core.AudioCard.aspect + package: botbuilder-core + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder-core.AudioCard.autoloop + package: botbuilder-core + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder-core.AudioCard.autostart + package: botbuilder-core + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder-core.AudioCard.buttons + package: botbuilder-core + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder-core.AudioCard.duration + package: botbuilder-core + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder-core.AudioCard.image + package: botbuilder-core + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder-core.AudioCard.media + package: botbuilder-core + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder-core.AudioCard.shareable + package: botbuilder-core + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder-core.AudioCard.subtitle + package: botbuilder-core + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.AudioCard.text + package: botbuilder-core + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.AudioCard.title + package: botbuilder-core + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.AudioCard.value + package: botbuilder-core + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AutoSaveStateMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AutoSaveStateMiddleware.yml index bfdb0c47..d150327c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AutoSaveStateMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/AutoSaveStateMiddleware.yml @@ -53,23 +53,21 @@ remarks: >- }); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'AutoSaveStateMiddleware(BotState[])' + - name: AutoSaveStateMiddleware(BotState[]) uid: botbuilder-core.AutoSaveStateMiddleware.constructor package: botbuilder-core summary: Creates a new AutoSaveStateMiddleware instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AutoSaveStateMiddleware(botStates: BotState[])' parameters: - id: botStates - type: '[]' - description: > + type: [] + description: >- One or more BotState plugins to automatically save at the end of the turn. properties: @@ -79,7 +77,6 @@ properties: summary: Set of `BotState` plugins being automatically saved. fullName: botStateSet remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botStateSet: BotStateSet' @@ -87,30 +84,28 @@ properties: description: '' type: methods: - - name: 'add(BotState[])' + - name: add(BotState[]) uid: botbuilder-core.AutoSaveStateMiddleware.add package: botbuilder-core summary: Adds additional `BotState` plugins to be saved. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function add(botStates: BotState[]): this' + content: 'function add(botStates: BotState[]): AutoSaveStateMiddleware' parameters: - id: botStates - type: '[]' + type: [] description: One or more BotState plugins to add. return: description: The updated BotStateSet object. - type: this - - name: 'onTurn(TurnContext, () => Promise)' + type: + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.AutoSaveStateMiddleware.onTurn package: botbuilder-core summary: >- Called by the adapter (for example, a `BotFrameworkAdapter`) at runtime in order to process an inbound [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -122,8 +117,7 @@ methods: description: The context object for this turn. - id: next type: () => Promise<void> - description: | - The next delegate function. + description: '{function} The next delegate function.' return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardComponent.yml new file mode 100644 index 00000000..9e38a282 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardComponent.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: BaseCardComponent +uid: botbuilder-core.BaseCardComponent +package: botbuilder-core +summary: Base Adaptive Card Extension card view component. +fullName: BaseCardComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder-core.BaseCardComponent.componentName + package: botbuilder-core + summary: |- + Unique component name. + For example, "textInput" + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: CardComponentName' + return: + description: '' + type: + - name: id + uid: botbuilder-core.BaseCardComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardViewParameters.yml new file mode 100644 index 00000000..6044faf0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseCardViewParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: BaseCardViewParameters +uid: botbuilder-core.BaseCardViewParameters +package: botbuilder-core +summary: Base parameters for the card view. +fullName: BaseCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardBar + uid: botbuilder-core.BaseCardViewParameters.cardBar + package: botbuilder-core + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseHandleActionResponse.yml new file mode 100644 index 00000000..f77fd0ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BaseHandleActionResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: BaseHandleActionResponse +uid: botbuilder-core.BaseHandleActionResponse +package: botbuilder-core +summary: The base handle action response. +fullName: BaseHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder-core.BaseHandleActionResponse.renderArguments + package: botbuilder-core + summary: The render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments?: CardViewResponse | QuickViewResponse' + return: + description: '' + type: >- + | + - name: responseType + uid: botbuilder-core.BaseHandleActionResponse.responseType + package: botbuilder-core + summary: The type of the view in the handle action response. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: ViewResponseType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BasicCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BasicCard.yml new file mode 100644 index 00000000..ce9b296d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BasicCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: BasicCard +uid: botbuilder-core.BasicCard +package: botbuilder-core +summary: A basic card +fullName: BasicCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder-core.BasicCard.buttons + package: botbuilder-core + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder-core.BasicCard.images + package: botbuilder-core + summary: Array of images for the card + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images: CardImage[]' + return: + description: '' + type: [] + - name: subtitle + uid: botbuilder-core.BasicCard.subtitle + package: botbuilder-core + summary: Subtitle of the card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder-core.BasicCard.tap + package: botbuilder-core + summary: This action will be activated when user taps on the card itself + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder-core.BasicCard.text + package: botbuilder-core + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.BasicCard.title + package: botbuilder-core + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntriesResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntriesResponse.yml new file mode 100644 index 00000000..e3a57ea6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntriesResponse.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BatchFailedEntriesResponse +uid: botbuilder-core.BatchFailedEntriesResponse +package: botbuilder-core +summary: '' +fullName: BatchFailedEntriesResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder-core.BatchFailedEntriesResponse.continuationToken + package: botbuilder-core + summary: The continuation token for paginated results. + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: failedEntryResponses + uid: botbuilder-core.BatchFailedEntriesResponse.failedEntryResponses + package: botbuilder-core + summary: The list of failed entries result of a batch operation. + fullName: failedEntryResponses + remarks: '' + isDeprecated: false + syntax: + content: 'failedEntryResponses: BatchFailedEntry[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntry.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntry.yml new file mode 100644 index 00000000..7c95c623 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchFailedEntry.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BatchFailedEntry +uid: botbuilder-core.BatchFailedEntry +package: botbuilder-core +summary: '' +fullName: BatchFailedEntry +remarks: '' +isDeprecated: false +type: interface +properties: + - name: error + uid: botbuilder-core.BatchFailedEntry.error + package: botbuilder-core + summary: The error of the failed entry. + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.BatchFailedEntry.id + package: botbuilder-core + summary: The id of the failed entry. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationRequest.yml new file mode 100644 index 00000000..c1c47b7b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationRequest.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: BatchOperationRequest +uid: botbuilder-core.BatchOperationRequest +package: botbuilder-core +summary: '' +fullName: BatchOperationRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: botbuilder-core.BatchOperationRequest.activity + package: botbuilder-core + summary: The activity of the request. + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity: Activity' + return: + description: '' + type: + - name: members + uid: botbuilder-core.BatchOperationRequest.members + package: botbuilder-core + summary: The list of members. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members?: TeamsMember[]' + return: + description: '' + type: [] + - name: teamId + uid: botbuilder-core.BatchOperationRequest.teamId + package: botbuilder-core + summary: The id of the team. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string' + return: + description: '' + type: string + - name: tenantId + uid: botbuilder-core.BatchOperationRequest.tenantId + package: botbuilder-core + summary: The id of the Teams tenant. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationResponse.yml new file mode 100644 index 00000000..816c88c9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: BatchOperationResponse +uid: botbuilder-core.BatchOperationResponse +package: botbuilder-core +summary: '' +fullName: BatchOperationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: operationId + uid: botbuilder-core.BatchOperationResponse.operationId + package: botbuilder-core + summary: The id of the operation executed. + fullName: operationId + remarks: '' + isDeprecated: false + syntax: + content: 'operationId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationStateResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationStateResponse.yml new file mode 100644 index 00000000..646b6193 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BatchOperationStateResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: BatchOperationStateResponse +uid: botbuilder-core.BatchOperationStateResponse +package: botbuilder-core +summary: '' +fullName: BatchOperationStateResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: retryAfter + uid: botbuilder-core.BatchOperationStateResponse.retryAfter + package: botbuilder-core + summary: The datetime value to retry the operation. + fullName: retryAfter + remarks: '' + isDeprecated: false + syntax: + content: 'retryAfter?: Date' + return: + description: '' + type: Date + - name: state + uid: botbuilder-core.BatchOperationStateResponse.state + package: botbuilder-core + summary: The state of the operation. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string + - name: statusMap + uid: botbuilder-core.BatchOperationStateResponse.statusMap + package: botbuilder-core + summary: The status map for processed operations. + fullName: statusMap + remarks: '' + isDeprecated: false + syntax: + content: 'statusMap: Record' + return: + description: '' + type: Record<number, number> + - name: totalEntriesCount + uid: botbuilder-core.BatchOperationStateResponse.totalEntriesCount + package: botbuilder-core + summary: The number of entries. + fullName: totalEntriesCount + remarks: '' + isDeprecated: false + syntax: + content: 'totalEntriesCount: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotAdapter.yml index 01e26ccd..510c6c9c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotAdapter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotAdapter.yml @@ -40,7 +40,6 @@ remarks: >- work](https://docs.microsoft.com/azure/bot-service/bot-builder-basics) and [Middleware](https://docs.microsoft.com/azure/bot-service/bot-builder-concept-middleware). -isPreview: false isDeprecated: false type: class properties: @@ -50,7 +49,6 @@ properties: summary: '' fullName: BotIdentityKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'BotIdentityKey: symbol' @@ -63,7 +61,6 @@ properties: summary: '' fullName: ConnectorClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorClientKey: symbol' @@ -76,7 +73,6 @@ properties: summary: '' fullName: OAuthScopeKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'OAuthScopeKey: symbol' @@ -89,23 +85,8 @@ properties: summary: >- Gets or sets an error handler that can catch exceptions in the middleware or application. - - Sets an error handler that can catch exceptions in the middleware or - application. fullName: onTurnError - remarks: >- - The error handler is called with these parameters: - - - | Name | Type | Description | - - | :--- | :--- | :--- | - - | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The - context object for the turn. | - - | `error` | `Error` | The Node.js error thrown. | - isPreview: false + remarks: '' isDeprecated: false syntax: content: '(context: TurnContext, error: Error) => Promise onTurnError' @@ -130,7 +111,6 @@ methods: For example, a bot can use this method to send notifications or coupons to a user. - isPreview: false isDeprecated: false syntax: content: >- @@ -138,12 +118,11 @@ methods: logic: (revocableContext: TurnContext) => Promise): Promise parameters: - id: reference - type: Partial<ConversationReference> + type: Partial<> description: A reference to the conversation to continue. - id: logic type: '(revocableContext: TurnContext) => Promise<void>' - description: | - The asynchronous method to call after the adapter middleware runs. + description: The asynchronous method to call after the adapter middleware runs. return: description: '' type: Promise<void> @@ -156,7 +135,6 @@ methods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -170,7 +148,7 @@ methods: A [ClaimsIdentity](xref:botframework-connector) for the conversation. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -190,7 +168,6 @@ methods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -204,7 +181,7 @@ methods: A [ClaimsIdentity](xref:botframework-connector) for the conversation. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -227,7 +204,6 @@ methods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,7 +218,7 @@ methods: tenant the Adapters (Console,Test, etc) but is critical to the BotFrameworkAdapter which is multi-tenant aware. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -277,7 +253,6 @@ methods: activity's converstion will contain the ID of the new conversation. - isPreview: false isDeprecated: false syntax: content: >- @@ -301,7 +276,7 @@ methods: The audience for the connector. - id: _conversationParameters - type: ConversationParameters + type: description: The conversation information to use to create the conversation - id: _logic type: '(context: TurnContext) => Promise<void>' @@ -309,12 +284,13 @@ methods: return: description: A promise that represents the asynchronous operation type: Promise<void> - - name: 'deleteActivity(TurnContext, Partial)' + - name: deleteActivity(TurnContext, Partial) uid: botbuilder-core.BotAdapter.deleteActivity package: botbuilder-core - summary: > + summary: >- Asynchronously deletes an existing activity. + This interface supports the framework and is not intended to be called directly for your code. @@ -326,7 +302,6 @@ methods: remarks: >- Not all channels support this operation. For channels that don't, this call may throw an exception. - isPreview: false isDeprecated: false syntax: content: >- @@ -337,18 +312,18 @@ methods: type: description: The context object for the turn. - id: reference - type: Partial<ConversationReference> - description: | - Conversation reference information for the activity to delete. + type: Partial<> + description: Conversation reference information for the activity to delete. return: description: '' type: Promise<void> - - name: 'sendActivities(TurnContext, Partial[])' + - name: sendActivities(TurnContext, Partial[]) uid: botbuilder-core.BotAdapter.sendActivities package: botbuilder-core - summary: > + summary: >- Asynchronously sends a set of outgoing activities to a channel server. + This method supports the framework and is not intended to be called directly for your code. @@ -365,7 +340,6 @@ methods: activities this will contain the ID of the delivered message. - isPreview: false isDeprecated: false syntax: content: >- @@ -376,18 +350,18 @@ methods: type: description: The context object for the turn. - id: activities - type: 'Partial<Activity>[]' - description: | - The activities to send. + type: Partial<>[] + description: The activities to send. return: - description: 'An array of [ResourceResponse](xref:botbuilder-core.Storage)' - type: 'Promise<ResourceResponse[]>' - - name: 'updateActivity(TurnContext, Partial)' + description: An array of [ResourceResponse](xref:botbuilder-core.Os) + type: Promise<[]> + - name: updateActivity(TurnContext, Partial) uid: botbuilder-core.BotAdapter.updateActivity package: botbuilder-core - summary: > + summary: >- Asynchronously replaces a previous activity with an updated version. + This interface supports the framework and is not intended to be called directly for your code. @@ -399,26 +373,22 @@ methods: remarks: >- Not all channels support this operation. For channels that don't, this call may throw an exception. - isPreview: false isDeprecated: false syntax: content: >- function updateActivity(context: TurnContext, activity: - Partial): Promise + Partial): Promise parameters: - id: context type: description: The context object for the turn. - id: activity - type: Partial<Activity> - description: | - The updated version of the activity to replace. + type: Partial<> + description: The updated version of the activity to replace. return: description: '' - type: Promise<ResourceResponse | void> - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) + type: Promise<void | > + - name: use((MiddlewareHandler | Middleware)[]) uid: botbuilder-core.BotAdapter.use package: botbuilder-core summary: Adds middleware to the adapter's pipeline. @@ -427,18 +397,17 @@ methods: Each turn, the adapter calls its middleware in the order in which you added it. - isPreview: false isDeprecated: false syntax: content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this + function use(middlewares: (MiddlewareHandler | Middleware)[]): + BotAdapter parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | [] + ( | )[] description: The middleware or middleware handlers to add. return: description: The updated adapter object. - type: this + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotComponent.yml index f99f2a03..fe141469 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotComponent.yml @@ -2,10 +2,11 @@ name: BotComponent uid: botbuilder-core.BotComponent package: botbuilder-core -summary: > +summary: >- Definition of a BotComponent that allows registration of services, custom actions, memory scopes and adapters. + To make your components available to the system you derive from BotComponent and register services to add functionality. @@ -16,7 +17,6 @@ summary: > components are registered in the configuration. fullName: BotComponent remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -26,20 +26,20 @@ properties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<, ZodTypeDef>' + type: >- + ZodType<, ZodTypeDef, + > methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: botbuilder-core.BotComponent.configureServices package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuth.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuth.yml new file mode 100644 index 00000000..49f64ea9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuth.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BotConfigAuth +uid: botbuilder-core.BotConfigAuth +package: botbuilder-core +summary: '' +fullName: BotConfigAuth +remarks: '' +isDeprecated: false +type: interface +properties: + - name: suggestedActions + uid: botbuilder-core.BotConfigAuth.suggestedActions + package: botbuilder-core + summary: SuggestedActions for the Bot Config Auth + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: type + uid: botbuilder-core.BotConfigAuth.type + package: botbuilder-core + summary: Type of the Bot Config Auth + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "auth"' + return: + description: '' + type: '"auth"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuthType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuthType.yml new file mode 100644 index 00000000..63f24bb1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotConfigAuthType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotConfigAuthType +uid: botbuilder-core.BotConfigAuthType +package: botbuilder-core +summary: |- + Defines possible values for BotConfigAuth type. + Possible values include: "auth" +fullName: BotConfigAuthType +remarks: '' +isDeprecated: false +syntax: | + type BotConfigAuthType = "auth" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkClient.yml new file mode 100644 index 00000000..7cb65270 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkClient.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: BotFrameworkClient +uid: botbuilder-core.BotFrameworkClient +package: botbuilder-core +summary: '' +fullName: BotFrameworkClient +remarks: '' +isDeprecated: false +type: interface +properties: + - name: postActivity + uid: botbuilder-core.BotFrameworkClient.postActivity + package: botbuilder-core + summary: Forwards an activity to a another bot. + fullName: postActivity + remarks: '' + isDeprecated: false + syntax: + content: >- + postActivity: (fromBotId: string, toBotId: string, toUrl: string, + serviceUrl: string, conversationId: string, activity: Activity) => + Promise> + return: + description: '' + type: >- + (fromBotId: string, toBotId: string, toUrl: string, serviceUrl: + string, conversationId: string, activity: Activity) => + Promise<InvokeResponse<T>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkSkill.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkSkill.yml index e33030e5..062f103c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkSkill.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotFrameworkSkill.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Registration for a BotFrameworkHttpProtocol based Skill endpoint. fullName: BotFrameworkSkill remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: AppId of the skill. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -28,7 +26,6 @@ properties: summary: Id of the skill. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -41,7 +38,6 @@ properties: summary: Endpoint for the skill fullName: skillEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillEndpoint: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotHandler.yml index 316527a6..ccf389b1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotHandler.yml @@ -35,7 +35,6 @@ remarks: >- A bot activity handler can return a value, to support _invoke_ activities. -isPreview: false isDeprecated: false syntax: | type BotHandler = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewActionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewActionType.yml new file mode 100644 index 00000000..287bed6f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewActionType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotMessagePreviewActionType +uid: botbuilder-core.BotMessagePreviewActionType +package: botbuilder-core +summary: |- + Defines values for BotMessagePreviewActionType. + Possible values include: 'edit', 'send' +fullName: BotMessagePreviewActionType +remarks: '' +isDeprecated: false +syntax: | + type BotMessagePreviewActionType = "edit" | "send" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewType.yml new file mode 100644 index 00000000..65f98b45 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotMessagePreviewType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotMessagePreviewType +uid: botbuilder-core.BotMessagePreviewType +package: botbuilder-core +summary: |- + Defines values for BotMessagePreviewType. + Possible values include: 'message', 'continue' +fullName: BotMessagePreviewType +remarks: '' +isDeprecated: false +syntax: | + type BotMessagePreviewType = "message" | "continue" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotPageViewTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotPageViewTelemetryClient.yml index cd526ec0..25c4e137 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotPageViewTelemetryClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotPageViewTelemetryClient.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: BotPageViewTelemetryClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackPageView(telemetry: TelemetryPageView): any' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotState.yml index 4ec9c8f6..29e6bd3d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotState.yml @@ -20,16 +20,14 @@ remarks: >- lifetime of the turn and will only be written to storage if it has been modified. -isPreview: false isDeprecated: false type: class constructors: - - name: 'BotState(Storage, StorageKeyFactory)' + - name: BotState(Storage, StorageKeyFactory) uid: botbuilder-core.BotState.constructor package: botbuilder-core summary: Creates a new BotState instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BotState(storage: Storage, storageKey: StorageKeyFactory)' @@ -39,7 +37,7 @@ constructors: description: Storage provider to persist the state object to. - id: storageKey type: - description: > + description: >- Function called anytime the storage key for a given turn needs to be calculated. methods: @@ -61,7 +59,6 @@ methods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function clear(context: TurnContext): Promise' @@ -81,7 +78,6 @@ methods: states storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createProperty(name: string): StatePropertyAccessor' @@ -108,7 +104,6 @@ methods: await botState.delete(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' @@ -133,18 +128,17 @@ methods: const state = botState.get(context); ``` - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): any | undefined' + content: 'function get(context: TurnContext): any' parameters: - id: context type: description: Context for current turn of conversation with the user. return: description: A cached state object or undefined if not cached. - type: any | undefined - - name: 'load(TurnContext, boolean)' + type: any + - name: load(TurnContext, boolean) uid: botbuilder-core.BotState.load package: botbuilder-core summary: Reads in and caches the backing state object for a turn. @@ -164,7 +158,6 @@ methods: const state = await botState.load(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function load(context: TurnContext, force?: boolean): Promise' @@ -180,7 +173,7 @@ methods: return: description: The cached state. type: Promise<any> - - name: 'saveChanges(TurnContext, boolean)' + - name: saveChanges(TurnContext, boolean) uid: botbuilder-core.BotState.saveChanges package: botbuilder-core summary: Saves the cached state object if it's been changed. @@ -199,7 +192,6 @@ methods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStatePropertyAccessor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStatePropertyAccessor.yml index ddefe4d1..7e6aac35 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStatePropertyAccessor.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStatePropertyAccessor.yml @@ -16,16 +16,14 @@ remarks: >- const dialogs = new DialogSet(dialogStateProperty); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'BotStatePropertyAccessor(BotState, string)' + - name: BotStatePropertyAccessor(BotState, string) uid: botbuilder-core.BotStatePropertyAccessor.constructor package: botbuilder-core summary: Creates a new BotStatePropertyAccessor instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BotStatePropertyAccessor(state: BotState, name: string)' @@ -35,8 +33,7 @@ constructors: description: Parent BotState instance. - id: name type: string - description: | - Unique name of the property for the parent BotState. + description: Unique name of the property for the parent BotState. properties: - name: name uid: botbuilder-core.BotStatePropertyAccessor.name @@ -44,7 +41,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -57,15 +53,15 @@ methods: package: botbuilder-core summary: Deletes the persisted property from its backing storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' parameters: - id: context type: - description: | - (xref:botbuilder-core.TurnContext) object for this turn. + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. return: description: '' type: Promise<void> @@ -74,23 +70,23 @@ methods: package: botbuilder-core summary: Reads a persisted property from its backing storage object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): Promise' + content: 'function get(context: TurnContext): Promise' parameters: - id: context type: - description: '(xref:botbuilder-core.TurnContext) object for this turn.' + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. return: description: A JSON representation of the cached state. - type: Promise<T | undefined> - - name: 'get(TurnContext, T)' + type: Promise<undefined | T> + - name: get(TurnContext, T) uid: botbuilder-core.BotStatePropertyAccessor.get_1 package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(context: TurnContext, defaultValue: T): Promise' @@ -104,23 +100,23 @@ methods: return: description: '' type: Promise<T> - - name: 'set(TurnContext, T)' + - name: set(TurnContext, T) uid: botbuilder-core.BotStatePropertyAccessor.set package: botbuilder-core summary: Assigns a new value to the properties backing storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function set(context: TurnContext, value: T): Promise' parameters: - id: context type: - description: '(xref:botbuilder-core.TurnContext) object for this turn.' + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. - id: value type: T - description: | - Value to set on the property. + description: Value to set on the property. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStateSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStateSet.yml index 6c11e37b..14b5346c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStateSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotStateSet.yml @@ -9,24 +9,21 @@ summary: >- See `AutoSaveStateMiddleware` for an implementation of this class. fullName: BotStateSet remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BotStateSet(BotState[])' + - name: BotStateSet(BotState[]) uid: botbuilder-core.BotStateSet.constructor package: botbuilder-core summary: Creates a new BotStateSet instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BotStateSet(botStates: BotState[])' parameters: - id: botStates - type: '[]' - description: | - One or more BotState plugins to register. + type: [] + description: One or more BotState plugins to register. properties: - name: botStates uid: botbuilder-core.BotStateSet.botStates @@ -34,31 +31,29 @@ properties: summary: Array of the sets `BotState` plugins. fullName: botStates remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botStates: BotState[]' return: description: '' - type: '[]' + type: [] methods: - - name: 'add(BotState[])' + - name: add(BotState[]) uid: botbuilder-core.BotStateSet.add package: botbuilder-core summary: Registers one or more `BotState` plugins with the set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function add(botStates: BotState[]): this' + content: 'function add(botStates: BotState[]): BotStateSet' parameters: - id: botStates - type: '[]' + type: [] description: One or more BotState plugins to register. return: description: The updated BotStateSet. - type: this - - name: 'loadAll(TurnContext, boolean)' + type: + - name: loadAll(TurnContext, boolean) uid: botbuilder-core.BotStateSet.loadAll package: botbuilder-core summary: Calls `BotState.load()` on all of the BotState plugins in the set. @@ -68,7 +63,6 @@ methods: ```JavaScript await stateSet.readAll(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function loadAll(context: TurnContext, force?: boolean): Promise' @@ -78,13 +72,13 @@ methods: description: Context for current turn of conversation with the user. - id: force type: boolean - description: > + description: >- (Optional) If `true` the cache will be bypassed and the state will always be read in directly from storage. Defaults to `false`. return: description: '' type: Promise<void> - - name: 'saveAllChanges(TurnContext, boolean)' + - name: saveAllChanges(TurnContext, boolean) uid: botbuilder-core.BotStateSet.saveAllChanges package: botbuilder-core summary: Calls `BotState.saveChanges()` on all of the BotState plugins in the set. @@ -94,7 +88,6 @@ methods: ```JavaScript await stateSet.saveAllChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -106,7 +99,7 @@ methods: description: Context for current turn of conversation with the user. - id: force type: boolean - description: > + description: >- (Optional) if `true` the state will always be written out regardless of its change state. Defaults to `false`. return: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotTelemetryClient.yml index b3c9b4bc..ced99fa8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotTelemetryClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BotTelemetryClient.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: BotTelemetryClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function flush(): any' @@ -26,7 +24,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackDependency(telemetry: TelemetryDependency): any' @@ -42,7 +39,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackEvent(telemetry: TelemetryEvent): any' @@ -58,7 +54,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackException(telemetry: TelemetryException): any' @@ -74,7 +69,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackTrace(telemetry: TelemetryTrace): any' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserLocalStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserLocalStorage.yml index 50a08bec..01121c0c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserLocalStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserLocalStorage.yml @@ -19,7 +19,6 @@ remarks: >- const userState = new UserState(new BrowserLocalStorage()); ``` -isPreview: false isDeprecated: false type: class constructors: @@ -30,23 +29,21 @@ constructors: Creates a new [BrowserLocalStorage](xref:botbuilder-core.BrowserLocalStorage) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: new BrowserLocalStorage() inheritedMethods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-core.BrowserLocalStorage.delete package: botbuilder-core summary: Deletes storage items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: >- Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to delete. @@ -56,18 +53,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [MemoryStorage.delete](xref:botbuilder-core.MemoryStorage.delete) - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-core.BrowserLocalStorage.read package: botbuilder-core summary: Reads storage items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: >- Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to read. @@ -82,7 +78,6 @@ inheritedMethods: package: botbuilder-core summary: Writes storage items to storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserSessionStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserSessionStorage.yml index c563385d..750814b7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserSessionStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/BrowserSessionStorage.yml @@ -25,7 +25,6 @@ remarks: >- const conversationState = new ConversationState(new BrowserSessionStorage()); ``` -isPreview: false isDeprecated: false type: class constructors: @@ -37,23 +36,21 @@ constructors: [BrowserSessionStorage](xref:botbuilder-core.BrowserSessionStorage) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: new BrowserSessionStorage() inheritedMethods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-core.BrowserSessionStorage.delete package: botbuilder-core summary: Deletes storage items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: >- Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to delete. @@ -63,18 +60,17 @@ inheritedMethods: inheritanceDescription: >- Inherited From [MemoryStorage.delete](xref:botbuilder-core.MemoryStorage.delete) - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-core.BrowserSessionStorage.read package: botbuilder-core summary: Reads storage items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: >- Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to read. @@ -89,7 +85,6 @@ inheritedMethods: package: botbuilder-core summary: Writes storage items to storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CacheInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CacheInfo.yml new file mode 100644 index 00000000..d4c6fcf5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CacheInfo.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: CacheInfo +uid: botbuilder-core.CacheInfo +package: botbuilder-core +summary: '' +fullName: CacheInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheDuration + uid: botbuilder-core.CacheInfo.cacheDuration + package: botbuilder-core + summary: The time in seconds for which the cached object should remain in the cache + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: number' + return: + description: '' + type: number + - name: cacheType + uid: botbuilder-core.CacheInfo.cacheType + package: botbuilder-core + summary: The type of cache for this object. + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CachedBotState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CachedBotState.yml index afd62cb7..d852ddd8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CachedBotState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CachedBotState.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: State information cached off the context object by a `BotState` instance. fullName: CachedBotState remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: detection. fullName: hash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hash: string' @@ -30,10 +28,9 @@ properties: summary: Dictionary of state values. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'state: [key: string]: any' + content: 'state: {[id: string]: any}' return: description: '' - type: '[key: string]\: any' + type: '{[id: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CallerIdConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CallerIdConstants.yml new file mode 100644 index 00000000..6485562e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CallerIdConstants.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: CallerIdConstants +uid: botbuilder-core.CallerIdConstants +package: botbuilder-core +summary: Constants used to populate the Activity.callerId property. +fullName: CallerIdConstants +remarks: '' +isDeprecated: false +type: class +properties: + - name: BotToBotPrefix + uid: botbuilder-core.CallerIdConstants.BotToBotPrefix + package: botbuilder-core + summary: The caller ID prefix when a bot initiates a request to another bot. + fullName: BotToBotPrefix + remarks: >- + This prefix will be followed by the Azure Active Directory App ID of the + bot that initiated the call. + isDeprecated: false + syntax: + content: 'static BotToBotPrefix: string' + return: + description: '' + type: string + - name: PublicAzureChannel + uid: botbuilder-core.CallerIdConstants.PublicAzureChannel + package: botbuilder-core + summary: The caller ID for any Bot Framework channel. + fullName: PublicAzureChannel + remarks: '' + isDeprecated: false + syntax: + content: 'static PublicAzureChannel: string' + return: + description: '' + type: string + - name: USGovChannel + uid: botbuilder-core.CallerIdConstants.USGovChannel + package: botbuilder-core + summary: The caller ID for any Bot Framework US Government cloud channel. + fullName: USGovChannel + remarks: '' + isDeprecated: false + syntax: + content: 'static USGovChannel: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardAction.yml new file mode 100644 index 00000000..34870fc9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardAction.yml @@ -0,0 +1,115 @@ +### YamlMime:TSType +name: CardAction +uid: botbuilder-core.CardAction +package: botbuilder-core +summary: A clickable action +fullName: CardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botbuilder-core.CardAction.channelData + package: botbuilder-core + summary: Channel-specific data associated with this action + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + - name: displayText + uid: botbuilder-core.CardAction.displayText + package: botbuilder-core + summary: (Optional) text to display in the chat feed if the button is clicked + fullName: displayText + remarks: '' + isDeprecated: false + syntax: + content: 'displayText?: string' + return: + description: '' + type: string + - name: image + uid: botbuilder-core.CardAction.image + package: botbuilder-core + summary: Image URL which will appear on the button, next to text label + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: string' + return: + description: '' + type: string + - name: imageAltText + uid: botbuilder-core.CardAction.imageAltText + package: botbuilder-core + summary: Alternate image text to be used in place of the `image` field + fullName: imageAltText + remarks: '' + isDeprecated: false + syntax: + content: 'imageAltText?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.CardAction.text + package: botbuilder-core + summary: Text for this action + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.CardAction.title + package: botbuilder-core + summary: Text description which appears on the button + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.CardAction.type + package: botbuilder-core + summary: >- + The type of action implemented by this button. Possible values include: + 'openUrl', 'imBack', + + 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', + 'signin', 'call', + + messageBack', 'openApp' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.CardAction.value + package: botbuilder-core + summary: >- + Supplementary parameter for action. Content of this property depends on + the ActionType + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardBarComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardBarComponent.yml new file mode 100644 index 00000000..e1989d8e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardBarComponent.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: CardBarComponent +uid: botbuilder-core.CardBarComponent +package: botbuilder-core +summary: Adaptive Card Extension Card view title area (card bar) component +fullName: CardBarComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder-core.CardBarComponent.componentName + package: botbuilder-core + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "cardBar"' + return: + description: '' + type: '"cardBar"' + - name: icon + uid: botbuilder-core.CardBarComponent.icon + package: botbuilder-core + summary: The icon to display. + fullName: icon + remarks: '' + isDeprecated: false + syntax: + content: 'icon?: CardImage' + return: + description: '' + type: CardImage + - name: title + uid: botbuilder-core.CardBarComponent.title + package: botbuilder-core + summary: The title to display. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.CardBarComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder-core.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonBase.yml new file mode 100644 index 00000000..991ec57d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonBase.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: CardButtonBase +uid: botbuilder-core.CardButtonBase +package: botbuilder-core +summary: >- + Base properties for the buttons used in different Adaptive Card Extension card + view components, such as Text Input, Search Box and Card Button. +fullName: CardButtonBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder-core.CardButtonBase.action + package: botbuilder-core + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + - name: id + uid: botbuilder-core.CardButtonBase.id + package: botbuilder-core + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonComponent.yml new file mode 100644 index 00000000..61c2e2c3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardButtonComponent.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: CardButtonComponent +uid: botbuilder-core.CardButtonComponent +package: botbuilder-core +summary: Adaptive Card Extension Card button component. +fullName: CardButtonComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder-core.CardButtonComponent.componentName + package: botbuilder-core + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "cardButton"' + return: + description: '' + type: '"cardButton"' + - name: style + uid: botbuilder-core.CardButtonComponent.style + package: botbuilder-core + summary: Controls the style of the button. + fullName: style + remarks: '' + isDeprecated: false + syntax: + content: 'style?: "default" | "positive"' + return: + description: '' + type: '"default" | "positive"' + - name: title + uid: botbuilder-core.CardButtonComponent.title + package: botbuilder-core + summary: Text displayed on the button. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botbuilder-core.CardButtonComponent.action + package: botbuilder-core + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder-core.CardButtonBase.action) + - name: id + uid: botbuilder-core.CardButtonComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder-core.CardButtonBase.id) +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardComponentName.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardComponentName.yml new file mode 100644 index 00000000..91063a3c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardComponentName.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: CardComponentName +uid: botbuilder-core.CardComponentName +package: botbuilder-core +summary: Names of the components allowed in a card view. +fullName: CardComponentName +remarks: '' +isDeprecated: false +syntax: | + type CardComponentName = + | "text" + | "cardButton" + | "cardBar" + | "textInput" + | "searchBox" + | "searchFooter" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardFactory.yml index 128846eb..7116291b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardFactory.yml @@ -36,7 +36,6 @@ remarks: >- await context.sendActivity(message); ``` -isPreview: false isDeprecated: false type: class properties: @@ -46,7 +45,6 @@ properties: summary: Lists the content type schema for each card style. fullName: contentTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static contentTypes: any' @@ -54,27 +52,26 @@ properties: description: '' type: any methods: - - name: 'actions(string | CardAction[] | undefined)' + - name: actions(undefined | (string | CardAction)[]) uid: botbuilder-core.CardFactory.actions package: botbuilder-core summary: Returns a properly formatted array of actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function actions(actions: string | CardAction[] | undefined): + static function actions(actions: undefined | (string | CardAction)[]): CardAction[] parameters: - id: actions - type: 'string | CardAction[] | undefined' + type: undefined | (string | )[] description: >- The array of action to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. return: description: A properly formatted array of actions. - type: 'CardAction[]' + type: [] - name: adaptiveCard(any) uid: botbuilder-core.CardFactory.adaptiveCard package: botbuilder-core @@ -125,7 +122,6 @@ methods: }); ``` - isPreview: false isDeprecated: false syntax: content: 'static function adaptiveCard(card: any): Attachment' @@ -134,75 +130,74 @@ methods: type: any description: A description of the Adaptive Card to return. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - animationCard(string, string | MediaUrl[], string | CardAction[], + animationCard(string, (string | MediaUrl)[], (string | CardAction)[], Partial) uid: botbuilder-core.CardFactory.animationCard package: botbuilder-core summary: Returns an attachment for an animation card. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function animationCard(title: string, media: string | MediaUrl[], - buttons?: string | CardAction[], other?: Partial): - Attachment + static function animationCard(title: string, media: (string | + MediaUrl)[], buttons?: (string | CardAction)[], other?: + Partial): Attachment parameters: - id: title type: string description: The card title. - id: media - type: 'string | MediaUrl[]' + type: (string | )[] description: The media URLs for the card. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<AnimationCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - audioCard(string, string | MediaUrl[], string | CardAction[], + audioCard(string, (string | MediaUrl)[], (string | CardAction)[], Partial) uid: botbuilder-core.CardFactory.audioCard package: botbuilder-core summary: Returns an attachment for an audio card. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function audioCard(title: string, media: string | MediaUrl[], - buttons?: string | CardAction[], other?: Partial): Attachment + static function audioCard(title: string, media: (string | MediaUrl)[], + buttons?: (string | CardAction)[], other?: Partial): + Attachment parameters: - id: title type: string description: The card title. - id: media - type: 'string | MediaUrl[]' + type: (string | )[] description: The media URL for the card. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<AudioCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - heroCard(string, string | CardImage[], string | CardAction[], + heroCard(string, (string | CardImage)[], (string | CardAction)[], Partial) uid: botbuilder-core.CardFactory.heroCard package: botbuilder-core @@ -219,36 +214,36 @@ methods: ['buy'] ); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function heroCard(title: string, images?: string | CardImage[], - buttons?: string | CardAction[], other?: Partial): Attachment + static function heroCard(title: string, images?: (string | CardImage)[], + buttons?: (string | CardAction)[], other?: Partial): + Attachment parameters: - id: title type: string description: The card title. - id: images - type: 'string | CardImage[]' + type: (string | )[] description: >- Optional. The array of images to include on the card. Each element can be a [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<HeroCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - heroCard(string, string, string | CardImage[], string | CardAction[], + heroCard(string, string, (string | CardImage)[], (string | CardAction)[], Partial) uid: botbuilder-core.CardFactory.heroCard_1 package: botbuilder-core @@ -264,12 +259,11 @@ methods: ['buy'] ); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function heroCard(title: string, text: string, images?: string | - CardImage[], buttons?: string | CardAction[], other?: + static function heroCard(title: string, text: string, images?: (string | + CardImage)[], buttons?: (string | CardAction)[], other?: Partial): Attachment parameters: - id: title @@ -279,61 +273,59 @@ methods: type: string description: The card text. - id: images - type: 'string | CardImage[]' + type: (string | )[] description: >- Optional. The array of images to include on the card. Each element can be a [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<HeroCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment - - name: 'images(string | CardImage[] | undefined)' + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: images(undefined | (string | CardImage)[]) uid: botbuilder-core.CardFactory.images package: botbuilder-core summary: Returns a properly formatted array of card images. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function images(images: string | CardImage[] | undefined): + static function images(images: undefined | (string | CardImage)[]): CardImage[] parameters: - id: images - type: 'string | CardImage[] | undefined' + type: undefined | (string | )[] description: |- The array of images to include on the card. Each element can be a [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. return: description: A properly formatted array of card images. - type: 'CardImage[]' - - name: 'media(string | MediaUrl[] | undefined)' + type: [] + - name: media(undefined | (string | MediaUrl)[]) uid: botbuilder-core.CardFactory.media package: botbuilder-core summary: Returns a properly formatted array of media URL objects. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function media(links: string | MediaUrl[] | undefined): + static function media(links: undefined | (string | MediaUrl)[]): MediaUrl[] parameters: - id: links - type: 'string | MediaUrl[] | undefined' + type: undefined | (string | )[] description: The media URLs. Each `string` is converted to a media URL object. return: description: A properly formatted array of media URL objects. - type: 'MediaUrl[]' + type: [] - name: o365ConnectorCard(O365ConnectorCard) uid: botbuilder-core.CardFactory.o365ConnectorCard package: botbuilder-core @@ -355,29 +347,29 @@ methods: ] }); ``` - isPreview: false isDeprecated: false syntax: content: 'static function o365ConnectorCard(card: O365ConnectorCard): Attachment' parameters: - id: card - type: O365ConnectorCard + type: description: a description of the Office 365 connector card to return. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment - - name: 'oauthCard(string, string, string, string, TokenExchangeResource)' + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + oauthCard(string, string, string, string, TokenExchangeResource, + TokenPostResource) uid: botbuilder-core.CardFactory.oauthCard package: botbuilder-core summary: Returns an attachment for an OAuth card. remarks: OAuth cards support the Bot Framework's single sign on (SSO) service. - isPreview: false isDeprecated: false syntax: content: >- static function oauthCard(connectionName: string, title: string, text?: - string, link?: string, tokenExchangeResource?: TokenExchangeResource): - Attachment + string, link?: string, tokenExchangeResource?: TokenExchangeResource, + tokenPostResource?: TokenPostResource): Attachment parameters: - id: connectionName type: string @@ -392,35 +384,36 @@ methods: type: string description: Optional. The sign-in link to use. - id: tokenExchangeResource - type: TokenExchangeResource + type: description: optional. The resource to try to perform token exchange with. + - id: tokenPostResource + type: + description: optional. The resource for directly post a token to token service. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: receiptCard(ReceiptCard) uid: botbuilder-core.CardFactory.receiptCard package: botbuilder-core summary: Returns an attachment for a receipt card. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function receiptCard(card: ReceiptCard): Attachment' parameters: - id: card - type: ReceiptCard + type: description: A description of the receipt card to return. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment - - name: 'signinCard(string, string, string)' + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: signinCard(string, string, string) uid: botbuilder-core.CardFactory.signinCard package: botbuilder-core summary: Returns an attachment for a sign-in card. remarks: >- For channels that don't natively support sign-in cards, an alternative message is rendered. - isPreview: false isDeprecated: false syntax: content: >- @@ -437,10 +430,10 @@ methods: type: string description: Optional. Additional text to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - thumbnailCard(string, string | CardImage[], string | CardAction[], + thumbnailCard(string, (string | CardImage)[], (string | CardAction)[], Partial) uid: botbuilder-core.CardFactory.thumbnailCard package: botbuilder-core @@ -454,38 +447,37 @@ methods: Channels typically render the card's text to one side of the image, with any buttons displayed below the card. - isPreview: false isDeprecated: false syntax: content: >- - static function thumbnailCard(title: string, images?: string | - CardImage[], buttons?: string | CardAction[], other?: + static function thumbnailCard(title: string, images?: (string | + CardImage)[], buttons?: (string | CardAction)[], other?: Partial): Attachment parameters: - id: title type: string description: The card title. - id: images - type: 'string | CardImage[]' + type: (string | )[] description: >- Optional. The array of images to include on the card. Each element can be a [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<ThumbnailCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - thumbnailCard(string, string, string | CardImage[], string | CardAction[], - Partial) + thumbnailCard(string, string, (string | CardImage)[], (string | + CardAction)[], Partial) uid: botbuilder-core.CardFactory.thumbnailCard_1 package: botbuilder-core summary: Returns an attachment for a thumbnail card. @@ -498,12 +490,11 @@ methods: Channels typically render the card's text to one side of the image, with any buttons displayed below the card. - isPreview: false isDeprecated: false syntax: content: >- static function thumbnailCard(title: string, text: string, images?: - string | CardImage[], buttons?: string | CardAction[], other?: + (string | CardImage)[], buttons?: (string | CardAction)[], other?: Partial): Attachment parameters: - id: title @@ -513,52 +504,52 @@ methods: type: string description: The card text. - id: images - type: 'string | CardImage[]' + type: (string | )[] description: >- Optional. The array of images to include on the card. Each element can be a [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<ThumbnailCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: - name: >- - videoCard(string, string | MediaUrl[], string | CardAction[], + videoCard(string, (string | MediaUrl)[], (string | CardAction)[], Partial) uid: botbuilder-core.CardFactory.videoCard package: botbuilder-core summary: Returns an attachment for a video card. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function videoCard(title: string, media: string | MediaUrl[], - buttons?: string | CardAction[], other?: Partial): Attachment + static function videoCard(title: string, media: (string | MediaUrl)[], + buttons?: (string | CardAction)[], other?: Partial): + Attachment parameters: - id: title type: string description: The card title. - id: media - type: 'string | MediaUrl[]' + type: (string | )[] description: The media URLs for the card. - id: buttons - type: 'string | CardAction[]' + type: (string | )[] description: >- Optional. The array of buttons to include on the card. Each `string` in the array is converted to an `imBack` button with a title and value set to the value of the string. - id: other - type: Partial<VideoCard> + type: Partial<> description: Optional. Any additional properties to include on the card. return: - description: 'An [Attachment](xref:botframework-schema.Attachment).' - type: Attachment + description: An [Attachment](xref:botframework-schema.Attachment). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardImage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardImage.yml new file mode 100644 index 00000000..9d399e6c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardImage.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: CardImage +uid: botbuilder-core.CardImage +package: botbuilder-core +summary: An image on a card +fullName: CardImage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alt + uid: botbuilder-core.CardImage.alt + package: botbuilder-core + summary: Image description intended for screen readers + fullName: alt + remarks: '' + isDeprecated: false + syntax: + content: 'alt?: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder-core.CardImage.tap + package: botbuilder-core + summary: Action assigned to specific Attachment + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap?: CardAction' + return: + description: '' + type: + - name: url + uid: botbuilder-core.CardImage.url + package: botbuilder-core + summary: URL thumbnail image for major content property + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchBoxComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchBoxComponent.yml new file mode 100644 index 00000000..7ef084a1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchBoxComponent.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: CardSearchBoxComponent +uid: botbuilder-core.CardSearchBoxComponent +package: botbuilder-core +summary: >- + Adaptive Card Extension Search box component. Represents a search box rendered + in the card view. +fullName: CardSearchBoxComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: button + uid: botbuilder-core.CardSearchBoxComponent.button + package: botbuilder-core + summary: Button displayed on the search box. + fullName: button + remarks: '' + isDeprecated: false + syntax: + content: 'button: ICardSearchBoxButton' + return: + description: '' + type: + - name: componentName + uid: botbuilder-core.CardSearchBoxComponent.componentName + package: botbuilder-core + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "searchBox"' + return: + description: '' + type: '"searchBox"' + - name: defaultValue + uid: botbuilder-core.CardSearchBoxComponent.defaultValue + package: botbuilder-core + summary: Default value to display. + fullName: defaultValue + remarks: '' + isDeprecated: false + syntax: + content: 'defaultValue?: string' + return: + description: '' + type: string + - name: placeholder + uid: botbuilder-core.CardSearchBoxComponent.placeholder + package: botbuilder-core + summary: Placeholder text to display. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.CardSearchBoxComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder-core.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchFooterComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchFooterComponent.yml new file mode 100644 index 00000000..2ea67b1e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardSearchFooterComponent.yml @@ -0,0 +1,105 @@ +### YamlMime:TSType +name: CardSearchFooterComponent +uid: botbuilder-core.CardSearchFooterComponent +package: botbuilder-core +summary: >- + Adaptive Card Extension Search footer component. Represents a container with + an image (in the shape of a circle) and text. +fullName: CardSearchFooterComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder-core.CardSearchFooterComponent.componentName + package: botbuilder-core + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "searchFooter"' + return: + description: '' + type: '"searchFooter"' + - name: imageInitials + uid: botbuilder-core.CardSearchFooterComponent.imageInitials + package: botbuilder-core + summary: The initials to display in the image area when there is no image. + fullName: imageInitials + remarks: '' + isDeprecated: false + syntax: + content: 'imageInitials?: string' + return: + description: '' + type: string + - name: imageUrl + uid: botbuilder-core.CardSearchFooterComponent.imageUrl + package: botbuilder-core + summary: >- + Url to the image to use, should be a square aspect ratio and big enough to + fit in the image area. + fullName: imageUrl + remarks: '' + isDeprecated: false + syntax: + content: 'imageUrl?: string' + return: + description: '' + type: string + - name: onSelection + uid: botbuilder-core.CardSearchFooterComponent.onSelection + package: botbuilder-core + summary: Action to invoke when the footer is selected. + fullName: onSelection + remarks: '' + isDeprecated: false + syntax: + content: 'onSelection?: CardAction' + return: + description: '' + type: CardAction + - name: text + uid: botbuilder-core.CardSearchFooterComponent.text + package: botbuilder-core + summary: >- + Primary text to display. For example, name of the person for people + search. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.CardSearchFooterComponent.title + package: botbuilder-core + summary: Title text to display. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.CardSearchFooterComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder-core.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextComponent.yml new file mode 100644 index 00000000..6ef55254 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextComponent.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: CardTextComponent +uid: botbuilder-core.CardTextComponent +package: botbuilder-core +summary: >- + Adaptive Card Extension Text component. Represents a text block rendered in + the card view. +fullName: CardTextComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder-core.CardTextComponent.componentName + package: botbuilder-core + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "text"' + return: + description: '' + type: '"text"' + - name: text + uid: botbuilder-core.CardTextComponent.text + package: botbuilder-core + summary: Text to display. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.CardTextComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder-core.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextInputComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextInputComponent.yml new file mode 100644 index 00000000..623838bc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardTextInputComponent.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: CardTextInputComponent +uid: botbuilder-core.CardTextInputComponent +package: botbuilder-core +summary: Adaptive Card Extension Text input component. +fullName: CardTextInputComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.CardTextInputComponent.ariaLabel + package: botbuilder-core + summary: Aria label for the text field. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: button + uid: botbuilder-core.CardTextInputComponent.button + package: botbuilder-core + summary: Optional button to display. + fullName: button + remarks: '' + isDeprecated: false + syntax: + content: 'button?: ICardTextInputIconButton | ICardTextInputTitleButton' + return: + description: '' + type: >- + | + - name: componentName + uid: botbuilder-core.CardTextInputComponent.componentName + package: botbuilder-core + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "textInput"' + return: + description: '' + type: '"textInput"' + - name: defaultValue + uid: botbuilder-core.CardTextInputComponent.defaultValue + package: botbuilder-core + summary: Default value to display. + fullName: defaultValue + remarks: '' + isDeprecated: false + syntax: + content: 'defaultValue?: string' + return: + description: '' + type: string + - name: iconAfter + uid: botbuilder-core.CardTextInputComponent.iconAfter + package: botbuilder-core + summary: >- + Properties for an optional icon, displayed in the right end of the text + input. + fullName: iconAfter + remarks: '' + isDeprecated: false + syntax: + content: 'iconAfter?: CardImage' + return: + description: '' + type: CardImage + - name: iconBefore + uid: botbuilder-core.CardTextInputComponent.iconBefore + package: botbuilder-core + summary: >- + Properties for an optional icon, displayed in the left end of the text + input. + fullName: iconBefore + remarks: '' + isDeprecated: false + syntax: + content: 'iconBefore?: CardImage' + return: + description: '' + type: CardImage + - name: placeholder + uid: botbuilder-core.CardTextInputComponent.placeholder + package: botbuilder-core + summary: Placeholder text to display. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.CardTextInputComponent.id + package: botbuilder-core + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder-core.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewActionsFooterParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewActionsFooterParameters.yml new file mode 100644 index 00000000..1dde666b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewActionsFooterParameters.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: CardViewActionsFooterParameters +uid: botbuilder-core.CardViewActionsFooterParameters +package: botbuilder-core +summary: The actions-only footer parameters for the card view. +fullName: CardViewActionsFooterParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewActionsFooterParameters = + | [CardButtonComponent] + | [CardButtonComponent, CardButtonComponent] + | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewFooterParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewFooterParameters.yml new file mode 100644 index 00000000..938b2912 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewFooterParameters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: CardViewFooterParameters +uid: botbuilder-core.CardViewFooterParameters +package: botbuilder-core +summary: >- + The footer parameters for the card view. Can contain either 0 to 2 buttons or + a single text input. +fullName: CardViewFooterParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewFooterParameters = + | CardViewActionsFooterParameters + | [CardTextInputComponent] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewHandleActionResponse.yml new file mode 100644 index 00000000..2f82a55a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: CardViewHandleActionResponse +uid: botbuilder-core.CardViewHandleActionResponse +package: botbuilder-core +summary: The handle action response for card view. +fullName: CardViewHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder-core.CardViewHandleActionResponse.renderArguments + package: botbuilder-core + summary: Card view render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments: CardViewResponse' + return: + description: '' + type: + - name: responseType + uid: botbuilder-core.CardViewHandleActionResponse.responseType + package: botbuilder-core + summary: Card view. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "Card"' + return: + description: '' + type: '"Card"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewParameters.yml new file mode 100644 index 00000000..9385f758 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewParameters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: CardViewParameters +uid: botbuilder-core.CardViewParameters +package: botbuilder-core +summary: Card View Parameters. +fullName: CardViewParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewParameters = + | TextCardViewParameters + | TextInputCardViewParameters + | SearchCardViewParameters + | SignInCardViewParameters diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewResponse.yml new file mode 100644 index 00000000..f289042a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CardViewResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: CardViewResponse +uid: botbuilder-core.CardViewResponse +package: botbuilder-core +summary: SharePoint ACE Card view response payload. +fullName: CardViewResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aceData + uid: botbuilder-core.CardViewResponse.aceData + package: botbuilder-core + summary: The ACE data. + fullName: aceData + remarks: '' + isDeprecated: false + syntax: + content: 'aceData: AceData' + return: + description: '' + type: + - name: cardViewParameters + uid: botbuilder-core.CardViewResponse.cardViewParameters + package: botbuilder-core + summary: The card view parameters. + fullName: cardViewParameters + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewParameters: CardViewParameters' + return: + description: '' + type: + - name: onCardSelection + uid: botbuilder-core.CardViewResponse.onCardSelection + package: botbuilder-core + summary: The on card selection action. + fullName: onCardSelection + remarks: '' + isDeprecated: false + syntax: + content: 'onCardSelection?: OnCardSelectionAction' + return: + description: '' + type: + - name: viewId + uid: botbuilder-core.CardViewResponse.viewId + package: botbuilder-core + summary: The view id. + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelAccount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelAccount.yml new file mode 100644 index 00000000..cfa58c32 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelAccount.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: ChannelAccount +uid: botbuilder-core.ChannelAccount +package: botbuilder-core +summary: Channel account information needed to route a message +fullName: ChannelAccount +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadObjectId + uid: botbuilder-core.ChannelAccount.aadObjectId + package: botbuilder-core + summary: This account's object ID within Azure Active Directory (AAD) + fullName: aadObjectId + remarks: '' + isDeprecated: false + syntax: + content: 'aadObjectId?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.ChannelAccount.id + package: botbuilder-core + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.ChannelAccount.name + package: botbuilder-core + summary: Display friendly name + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder-core.ChannelAccount.properties + package: botbuilder-core + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + - name: role + uid: botbuilder-core.ChannelAccount.role + package: botbuilder-core + summary: >- + Role of the entity behind the account (Example: User, Bot, etc.). Possible + values include: + + 'user', 'bot', 'skill' + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelInfo.yml new file mode 100644 index 00000000..0b2cce8a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ChannelInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ChannelInfo +uid: botbuilder-core.ChannelInfo +package: botbuilder-core +summary: '' +fullName: ChannelInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.ChannelInfo.id + package: botbuilder-core + summary: Unique identifier representing a channel + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.ChannelInfo.name + package: botbuilder-core + summary: Name of the channel + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.ChannelInfo.type + package: botbuilder-core + summary: The type of the channel. Valid values are standard, shared and private. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Channels.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Channels.yml new file mode 100644 index 00000000..1692f811 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Channels.yml @@ -0,0 +1,106 @@ +### YamlMime:TSEnum +name: Channels +uid: botbuilder-core.Channels +package: botbuilder-core +summary: >- + Defines values for ChannelIds for Channels. + + Possible values include: 'alexa', 'console', 'cortana', 'directline', + 'directlinespeech', 'email', + + 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', + 'outlook', 'skype', 'skypeforbusiness', + + 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' +fullName: Channels +remarks: '' +isDeprecated: false +fields: + - name: Alexa + uid: botbuilder-core.Channels.Alexa + package: botbuilder-core + summary: '' + - name: Console + uid: botbuilder-core.Channels.Console + package: botbuilder-core + summary: '' + - name: Directline + uid: botbuilder-core.Channels.Directline + package: botbuilder-core + summary: '' + - name: DirectlineSpeech + uid: botbuilder-core.Channels.DirectlineSpeech + package: botbuilder-core + summary: '' + - name: Email + uid: botbuilder-core.Channels.Email + package: botbuilder-core + summary: '' + - name: Emulator + uid: botbuilder-core.Channels.Emulator + package: botbuilder-core + summary: '' + - name: Facebook + uid: botbuilder-core.Channels.Facebook + package: botbuilder-core + summary: '' + - name: Groupme + uid: botbuilder-core.Channels.Groupme + package: botbuilder-core + summary: '' + - name: Kik + uid: botbuilder-core.Channels.Kik + package: botbuilder-core + summary: '' + - name: Line + uid: botbuilder-core.Channels.Line + package: botbuilder-core + summary: '' + - name: Msteams + uid: botbuilder-core.Channels.Msteams + package: botbuilder-core + summary: '' + - name: Omni + uid: botbuilder-core.Channels.Omni + package: botbuilder-core + summary: '' + - name: Outlook + uid: botbuilder-core.Channels.Outlook + package: botbuilder-core + summary: '' + - name: Skype + uid: botbuilder-core.Channels.Skype + package: botbuilder-core + summary: '' + - name: Skypeforbusiness + uid: botbuilder-core.Channels.Skypeforbusiness + package: botbuilder-core + summary: '' + - name: Slack + uid: botbuilder-core.Channels.Slack + package: botbuilder-core + summary: '' + - name: Sms + uid: botbuilder-core.Channels.Sms + package: botbuilder-core + summary: '' + - name: Telegram + uid: botbuilder-core.Channels.Telegram + package: botbuilder-core + summary: '' + - name: Telephony + uid: botbuilder-core.Channels.Telephony + package: botbuilder-core + summary: '' + - name: Test + uid: botbuilder-core.Channels.Test + package: botbuilder-core + summary: '' + - name: Twilio + uid: botbuilder-core.Channels.Twilio + package: botbuilder-core + summary: '' + - name: Webchat + uid: botbuilder-core.Channels.Webchat + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CloudAdapterBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CloudAdapterBase.yml index d6296513..8432e07c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CloudAdapterBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CloudAdapterBase.yml @@ -7,7 +7,6 @@ summary: >- different cloud environments both public and private. fullName: CloudAdapterBase remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: Create a new [CloudAdapterBase](xref:botbuilder.CloudAdapterBase) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,7 +25,7 @@ constructors: parameters: - id: botFrameworkAuthentication type: BotFrameworkAuthentication - description: > + description: >- A [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) used for validating and creating tokens. @@ -38,7 +36,6 @@ properties: summary: '' fullName: ConnectorFactoryKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorFactoryKey: symbol' @@ -51,23 +48,8 @@ properties: summary: >- Gets or sets an error handler that can catch exceptions in the middleware or application. - - Sets an error handler that can catch exceptions in the middleware or - application. fullName: onTurnError - remarks: >- - The error handler is called with these parameters: - - - | Name | Type | Description | - - | :--- | :--- | :--- | - - | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The - context object for the turn. | - - | `error` | `Error` | The Node.js error thrown. | - isPreview: false + remarks: '' isDeprecated: false syntax: content: '(context: TurnContext, error: Error) => Promise onTurnError' @@ -80,7 +62,6 @@ properties: summary: '' fullName: UserTokenClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'UserTokenClientKey: symbol' @@ -94,7 +75,6 @@ inheritedProperties: summary: '' fullName: BotIdentityKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'BotIdentityKey: symbol' @@ -110,7 +90,6 @@ inheritedProperties: summary: '' fullName: ConnectorClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorClientKey: symbol' @@ -126,7 +105,6 @@ inheritedProperties: summary: '' fullName: OAuthScopeKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'OAuthScopeKey: symbol' @@ -137,9 +115,7 @@ inheritedProperties: Inherited From [BotAdapter.OAuthScopeKey](xref:botbuilder-core.BotAdapter.OAuthScopeKey) inheritedMethods: - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) + - name: use((MiddlewareHandler | Middleware)[]) uid: botbuilder-core.CloudAdapterBase.use package: botbuilder-core summary: Adds middleware to the adapter's pipeline. @@ -148,21 +124,20 @@ inheritedMethods: Each turn, the adapter calls its middleware in the order in which you added it. - isPreview: false isDeprecated: false syntax: content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this + function use(middlewares: (MiddlewareHandler | Middleware)[]): + CloudAdapterBase parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | [] + ( | )[] description: The middleware or middleware handlers to add. return: description: The updated adapter object. - type: this + type: inheritanceDescription: >- Inherited From [BotAdapter.use](xref:botbuilder-core.BotAdapter.use) @@ -172,11 +147,19 @@ methods: TurnContext) => Promise) uid: botbuilder-core.CloudAdapterBase.continueConversation package: botbuilder-core - summary: '' - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '' + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: >- + This is often referred to as a _proactive notification_, the bot can + proactively + + send a message to a conversation or user without waiting for an incoming + message. + + For example, a bot can use this method to send notifications or coupons to + a user. + isDeprecated: false syntax: content: >- function continueConversation(_reference: @@ -184,43 +167,11 @@ methods: Promise): Promise parameters: - id: _reference - type: Partial<ConversationReference> - description: '' + type: Partial<> + description: A reference to the conversation to continue. - id: _logic type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - - name: >- - continueConversationAsync(string | ClaimsIdentity, - Partial, (context: TurnContext) => Promise | - string, (context: TurnContext) => Promise) - uid: botbuilder-core.CloudAdapterBase.continueConversationAsync - package: botbuilder-core - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function continueConversationAsync(botAppIdOrClaimsIdentity: string | - ClaimsIdentity, reference: Partial, - logicOrAudience: (context: TurnContext) => Promise | string, - maybeLogic?: (context: TurnContext) => Promise): Promise - parameters: - - id: botAppIdOrClaimsIdentity - type: string | ClaimsIdentity - description: '' - - id: reference - type: Partial<ConversationReference> - description: '' - - id: logicOrAudience - type: '(context: TurnContext) => Promise<void> | string' - description: '' - - id: maybeLogic - type: '(context: TurnContext) => Promise<void>' - description: '' + description: The asynchronous method to call after the adapter middleware runs. return: description: '' type: Promise<void> @@ -229,9 +180,25 @@ methods: ConversationParameters, (context: TurnContext) => Promise) uid: botbuilder-core.CloudAdapterBase.createConversationAsync package: botbuilder-core - summary: '' - remarks: '' - isPreview: false + summary: Creates a conversation on the specified channel. + remarks: >- + To start a conversation, your bot must know its account information and + the user's account information on that + + channel. Most _channels only support initiating a direct message + (non-group) conversation. + + + The adapter attempts to create a new conversation on the channel, and then + sends a `conversationUpdate` activity + + through its middleware pipeline to the logic method. + + + If the conversation is established with the specified users, the ID of the + activity's converstion will contain + + the ID of the new conversation. isDeprecated: false syntax: content: >- @@ -242,31 +209,45 @@ methods: parameters: - id: botAppId type: string - description: '' + description: The application ID of the bot. - id: channelId type: string - description: '' + description: The ID for the channel. - id: serviceUrl type: string - description: '' + description: The ID for the channel. - id: audience type: string - description: '' + description: |- + The audience for the connector. + - id: conversationParameters - type: ConversationParameters - description: '' + type: + description: The conversation information to use to create the conversation - id: logic type: '(context: TurnContext) => Promise<void>' - description: '' + description: The method to call for the resulting bot turn. return: - description: '' + description: A promise that represents the asynchronous operation type: Promise<void> - - name: 'deleteActivity(TurnContext, Partial)' + - name: deleteActivity(TurnContext, Partial) uid: botbuilder-core.CloudAdapterBase.deleteActivity package: botbuilder-core - summary: '' - remarks: '' - isPreview: false + summary: >- + Asynchronously deletes an existing activity. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + to delete + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. isDeprecated: false syntax: content: >- @@ -275,19 +256,36 @@ methods: parameters: - id: context type: - description: '' + description: The context object for the turn. - id: reference - type: Partial<ConversationReference> - description: '' + type: Partial<> + description: Conversation reference information for the activity to delete. return: description: '' type: Promise<void> - - name: 'sendActivities(TurnContext, Partial[])' + - name: sendActivities(TurnContext, Partial[]) uid: botbuilder-core.CloudAdapterBase.sendActivities package: botbuilder-core - summary: '' - remarks: '' - isPreview: false + summary: >- + Asynchronously sends a set of outgoing activities to a channel server. + + + This method supports the framework and is not intended to be called + directly for your code. + + Use the turn context's + [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or + + [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) method + from your bot code. + remarks: >- + The activities will be sent one after another in the order in which + they're received. A + + response object will be returned for each sent activity. For `message` + activities this will + + contain the ID of the delivered message. isDeprecated: false syntax: content: >- @@ -296,32 +294,44 @@ methods: parameters: - id: context type: - description: '' + description: The context object for the turn. - id: activities - type: 'Partial<Activity>[]' - description: '' + type: Partial<>[] + description: The activities to send. return: - description: '' - type: 'Promise<ResourceResponse[]>' - - name: 'updateActivity(TurnContext, Partial)' + description: An array of [ResourceResponse](xref:botbuilder-core.Os) + type: Promise<[]> + - name: updateActivity(TurnContext, Partial) uid: botbuilder-core.CloudAdapterBase.updateActivity package: botbuilder-core - summary: '' - remarks: '' - isPreview: false + summary: >- + Asynchronously replaces a previous activity with an updated version. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + to update + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. isDeprecated: false syntax: content: >- function updateActivity(context: TurnContext, activity: - Partial): Promise + Partial): Promise parameters: - id: context type: - description: '' + description: The context object for the turn. - id: activity - type: Partial<Activity> - description: '' + type: Partial<> + description: The updated version of the activity to replace. return: description: '' - type: Promise<ResourceResponse | void> + type: Promise<void | > extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandContext.yml new file mode 100644 index 00000000..3a9b50bc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandContext.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: CommandContext +uid: botbuilder-core.CommandContext +package: botbuilder-core +summary: |- + Defines values for CommandContext. + Possible values include: 'message', 'compose', 'commandbox' +fullName: CommandContext +remarks: '' +isDeprecated: false +syntax: | + type CommandContext = "message" | "compose" | "commandbox" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandResultValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandResultValue.yml new file mode 100644 index 00000000..2530a6a8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandResultValue.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: CommandResultValue +uid: botbuilder-core.CommandResultValue +package: botbuilder-core +summary: >- + The value field of a ICommandResultActivity contains metadata related to a + command result. + + An optional extensible data payload may be included if defined by the command + activity name. + + The presence of an error field indicates that the original command failed to + complete. +fullName: CommandResultValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: commandId + uid: botbuilder-core.CommandResultValue.commandId + package: botbuilder-core + summary: ID of the command. + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId: string' + return: + description: '' + type: string + - name: data + uid: botbuilder-core.CommandResultValue.data + package: botbuilder-core + summary: >- + The data field containing optional parameters specific to this command + activity, + + as defined by the name. The value of the data field is a complex type. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: T' + return: + description: '' + type: T + - name: error + uid: botbuilder-core.CommandResultValue.error + package: botbuilder-core + summary: The optional error, if the command result indicates a failure. + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error?: Error' + return: + description: '' + type: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandValue.yml new file mode 100644 index 00000000..82bef88d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CommandValue.yml @@ -0,0 +1,42 @@ +### YamlMime:TSType +name: CommandValue +uid: botbuilder-core.CommandValue +package: botbuilder-core +summary: >- + The value field of a ICommandActivity contains metadata related to a command. + + An optional extensible data payload may be included if defined by the command + activity name. +fullName: CommandValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: commandId + uid: botbuilder-core.CommandValue.commandId + package: botbuilder-core + summary: ID of the command. + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId: string' + return: + description: '' + type: string + - name: data + uid: botbuilder-core.CommandValue.data + package: botbuilder-core + summary: >- + The data field containing optional parameters specific to this command + activity, + + as defined by the name. The value of the data field is a complex type. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: T' + return: + description: '' + type: T diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ComponentRegistration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ComponentRegistration.yml index df80da3d..9a979bb5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ComponentRegistration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ComponentRegistration.yml @@ -7,7 +7,6 @@ summary: >- components. fullName: ComponentRegistration remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,25 +16,22 @@ properties: summary: Gets list of all ComponentRegistration objects registered. fullName: components remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static ComponentRegistration[] components' + content: static ComponentRegistration[] components return: description: A list of ComponentRegistration objects. - type: '[]' + type: [] methods: - name: add(ComponentRegistration) uid: botbuilder-core.ComponentRegistration.add package: botbuilder-core - summary: 'Add a component, only one instance per type is allowed for components.' + summary: Add a component, only one instance per type is allowed for components. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function add(componentRegistration: ComponentRegistration)' parameters: - id: componentRegistration type: - description: | - The component to be registered. + description: The component to be registered. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponse.yml new file mode 100644 index 00000000..4eb0c0b3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: ConfigResponse +uid: botbuilder-core.ConfigResponse +package: botbuilder-core +summary: '' +fullName: ConfigResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder-core.ConfigResponse.cacheInfo + package: botbuilder-core + summary: >- + The data of the ConfigResponse cache, including cache type and cache + duration. + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: config + uid: botbuilder-core.ConfigResponse.config + package: botbuilder-core + summary: The ConfigResponse config of BotConfigAuth or TaskModuleResponse + fullName: config + remarks: '' + isDeprecated: false + syntax: + content: 'config: ConfigResponseConfig' + return: + description: '' + type: + - name: responseType + uid: botbuilder-core.ConfigResponse.responseType + package: botbuilder-core + summary: The type of response 'config'. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "config"' + return: + description: '' + type: '"config"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponseConfig.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponseConfig.yml new file mode 100644 index 00000000..f446daca --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigResponseConfig.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ConfigResponseConfig +uid: botbuilder-core.ConfigResponseConfig +package: botbuilder-core +summary: '' +fullName: ConfigResponseConfig +remarks: '' +isDeprecated: false +syntax: | + type ConfigResponseConfig = BotConfigAuth | TaskModuleResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthentication.yml index da8086c8..89a7a4e0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthentication.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthentication.yml @@ -10,12 +10,18 @@ summary: >- instance. fullName: ConfigurationBotFrameworkAuthentication remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- - ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, + ConfigurationBotFrameworkAuthentication({ BotOpenIdMetadata?: string, + CallerId?: string, CertificatePrivateKey?: string, CertificateThumbprint?: + string, ChannelService?: string, MicrosoftAppId?: string, + MicrosoftAppTenantId?: string, OAuthApiEndpoint?: string, OAuthUrl?: + string, ToBotFromChannelOpenIdMetadataUrl?: string, + ToBotFromChannelTokenIssuer?: string, ToBotFromEmulatorOpenIdMetadataUrl?: + string, ToChannelFromBotLoginUrl?: string, ToChannelFromBotOAuthScope?: + string, ValidateAuthority?: string | boolean }, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise, ConnectorClientOptions) @@ -26,22 +32,34 @@ constructors: [ConfigurationBotFrameworkAuthentication](xref:botbuilder-core.ConfigurationBotFrameworkAuthentication) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: - ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: - ServiceClientCredentialsFactory, authConfiguration?: - AuthenticationConfiguration, botFrameworkClientFetch?: (input: - RequestInfo, init?: RequestInit) => Promise, - connectorClientOptions?: ConnectorClientOptions) + new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: { + BotOpenIdMetadata?: string, CallerId?: string, CertificatePrivateKey?: + string, CertificateThumbprint?: string, ChannelService?: string, + MicrosoftAppId?: string, MicrosoftAppTenantId?: string, + OAuthApiEndpoint?: string, OAuthUrl?: string, + ToBotFromChannelOpenIdMetadataUrl?: string, + ToBotFromChannelTokenIssuer?: string, + ToBotFromEmulatorOpenIdMetadataUrl?: string, ToChannelFromBotLoginUrl?: + string, ToChannelFromBotOAuthScope?: string, ValidateAuthority?: string + | boolean }, credentialsFactory?: ServiceClientCredentialsFactory, + authConfiguration?: AuthenticationConfiguration, + botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => + Promise, connectorClientOptions?: ConnectorClientOptions) parameters: - id: botFrameworkAuthConfig type: >- - + { BotOpenIdMetadata?: string, CallerId?: string, + CertificatePrivateKey?: string, CertificateThumbprint?: string, + ChannelService?: string, MicrosoftAppId?: string, + MicrosoftAppTenantId?: string, OAuthApiEndpoint?: string, OAuthUrl?: + string, ToBotFromChannelOpenIdMetadataUrl?: string, + ToBotFromChannelTokenIssuer?: string, + ToBotFromEmulatorOpenIdMetadataUrl?: string, + ToChannelFromBotLoginUrl?: string, ToChannelFromBotOAuthScope?: + string, ValidateAuthority?: string | boolean } description: >- A [ConfigurationBotFrameworkAuthenticationOptions](xref:botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions) @@ -67,7 +85,7 @@ constructors: [BotFrameworkClient](xref:botframework-connector.BotFrameworkClient). - id: connectorClientOptions type: ConnectorClientOptions - description: > + description: >- A [ConnectorClientOptions](xref:botframework-connector.ConnectorClientOptions) object. @@ -78,7 +96,6 @@ inheritedMethods: package: botbuilder-core summary: Gets the originating audience from Bot OAuth scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getOriginatingAudience(): string' @@ -93,7 +110,6 @@ methods: package: botbuilder-core summary: Authenticate Bot Framework Protocol requests to Skills. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -104,15 +120,14 @@ methods: type: string description: The http auth header received in the skill request. return: - description: 'A [ClaimsIdentity](xref:botframework-connector.ClaimsIdentity).' + description: A [ClaimsIdentity](xref:botframework-connector.ClaimsIdentity). type: Promise<ClaimsIdentity> - - name: 'authenticateRequest(Activity, string)' + - name: authenticateRequest(Activity, string) uid: >- botbuilder-core.ConfigurationBotFrameworkAuthentication.authenticateRequest package: botbuilder-core summary: Validate Bot Framework Protocol requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -120,7 +135,7 @@ methods: Promise parameters: - id: activity - type: Activity + type: description: The inbound Activity. - id: authHeader type: string @@ -130,13 +145,12 @@ methods: An [AuthenticateRequestResult](xref:botframework-connector.AuthenticateRequestResult). type: Promise<AuthenticateRequestResult> - - name: 'authenticateStreamingRequest(string, string)' + - name: authenticateStreamingRequest(string, string) uid: >- botbuilder-core.ConfigurationBotFrameworkAuthentication.authenticateStreamingRequest package: botbuilder-core summary: Validate Bot Framework Protocol requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -160,7 +174,6 @@ methods: package: botbuilder-core summary: Creates a BotFrameworkClient for calling Skills. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createBotFrameworkClient(): BotFrameworkClient' @@ -168,7 +181,7 @@ methods: description: >- A [BotFrameworkClient](xref:botframework-connector.BotFrameworkClient). - type: BotFrameworkClient + type: - name: createConnectorFactory(ClaimsIdentity) uid: >- botbuilder-core.ConfigurationBotFrameworkAuthentication.createConnectorFactory @@ -177,7 +190,6 @@ methods: Creates a ConnectorFactory that can be used to create ConnectorClients that can use credentials from this particular Cloud Environment. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -188,7 +200,7 @@ methods: type: ClaimsIdentity description: The inbound Activity's ClaimsIdentity. return: - description: 'A [ConnectorFactory](xref:botframework-connector.ConnectorFactory).' + description: A [ConnectorFactory](xref:botframework-connector.ConnectorFactory). type: ConnectorFactory - name: createUserTokenClient(ClaimsIdentity) uid: >- @@ -196,7 +208,6 @@ methods: package: botbuilder-core summary: Creates the appropriate UserTokenClient instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -207,6 +218,6 @@ methods: type: ClaimsIdentity description: The inbound Activity's ClaimsIdentity. return: - description: 'An [UserTokenClient](xref:botframework-connector.UserTokenClient).' + description: An [UserTokenClient](xref:botframework-connector.UserTokenClient). type: Promise<UserTokenClient> extends: BotFrameworkAuthentication diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthenticationOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthenticationOptions.yml index 475adf6c..ae54f7a7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthenticationOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationBotFrameworkAuthenticationOptions.yml @@ -8,7 +8,8 @@ summary: >- instance. fullName: ConfigurationBotFrameworkAuthenticationOptions remarks: '' -isPreview: false isDeprecated: false syntax: | - type ConfigurationBotFrameworkAuthenticationOptions = z.infer + type ConfigurationBotFrameworkAuthenticationOptions = z.infer< + typeof TypedOptions + > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactory.yml index f19778d9..874c4053 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactory.yml @@ -10,12 +10,14 @@ summary: >- instance to build ServiceClientCredentials with an AppId and App Password. fullName: ConfigurationServiceClientCredentialFactory remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- - ConfigurationServiceClientCredentialFactory(ConfigurationServiceClientCredentialFactoryOptions) + ConfigurationServiceClientCredentialFactory({ CertificatePrivateKey?: + string, CertificateThumbprint?: string, MicrosoftAppId?: string, + MicrosoftAppPassword?: string, MicrosoftAppTenantId?: string, + MicrosoftAppType?: string }) uid: botbuilder-core.ConfigurationServiceClientCredentialFactory.constructor package: botbuilder-core summary: >- @@ -23,19 +25,20 @@ constructors: [ConfigurationServiceClientCredentialFactory](xref:botbuilder-core.ConfigurationServiceClientCredentialFactory) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ConfigurationServiceClientCredentialFactory(factoryOptions?: - ConfigurationServiceClientCredentialFactoryOptions) + new ConfigurationServiceClientCredentialFactory(factoryOptions?: { + CertificatePrivateKey?: string, CertificateThumbprint?: string, + MicrosoftAppId?: string, MicrosoftAppPassword?: string, + MicrosoftAppTenantId?: string, MicrosoftAppType?: string }) parameters: - id: factoryOptions type: >- - - description: > + { CertificatePrivateKey?: string, CertificateThumbprint?: string, + MicrosoftAppId?: string, MicrosoftAppPassword?: string, + MicrosoftAppTenantId?: string, MicrosoftAppType?: string } + description: >- A [ConfigurationServiceClientCredentialFactoryOptions](xref:botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions) object. @@ -46,13 +49,12 @@ inheritedProperties: summary: The app ID for this credential. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'appId: string | null' + content: 'appId: null | string' return: description: '' - type: string | null + type: null | string inheritanceDescription: Inherited From PasswordServiceClientCredentialFactory.appId - name: password uid: botbuilder-core.ConfigurationServiceClientCredentialFactory.password @@ -60,13 +62,12 @@ inheritedProperties: summary: The app password for this credential. fullName: password remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'password: string | null' + content: 'password: null | string' return: description: '' - type: string | null + type: null | string inheritanceDescription: Inherited From PasswordServiceClientCredentialFactory.password - name: tenantId uid: botbuilder-core.ConfigurationServiceClientCredentialFactory.tenantId @@ -74,22 +75,20 @@ inheritedProperties: summary: The tenant ID of the Azure AD tenant where the bot is created. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'tenantId: string | null' + content: 'tenantId: null | string' return: description: '' - type: string | null + type: null | string inheritanceDescription: Inherited From PasswordServiceClientCredentialFactory.tenantId methods: - - name: 'createCredentials(string, string, string, boolean)' + - name: createCredentials(string, string, string, boolean) uid: >- botbuilder-core.ConfigurationServiceClientCredentialFactory.createCredentials package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -111,14 +110,15 @@ methods: description: '' return: description: '' - type: Promise<ServiceClientCredentials> + type: >- + Promise<> - name: isAuthenticationDisabled() uid: >- botbuilder-core.ConfigurationServiceClientCredentialFactory.isAuthenticationDisabled package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAuthenticationDisabled(): Promise' @@ -130,7 +130,6 @@ methods: package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidAppId(microsoftAppId: string): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactoryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactoryOptions.yml index d81c5002..11d38590 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactoryOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfigurationServiceClientCredentialFactoryOptions.yml @@ -8,7 +8,8 @@ summary: >- instance. fullName: ConfigurationServiceClientCredentialFactoryOptions remarks: '' -isPreview: false isDeprecated: false syntax: | - type ConfigurationServiceClientCredentialFactoryOptions = z.infer + type ConfigurationServiceClientCredentialFactoryOptions = z.infer< + typeof TypedConfig + > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfirmationDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfirmationDialog.yml new file mode 100644 index 00000000..ddd2ffa3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConfirmationDialog.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: ConfirmationDialog +uid: botbuilder-core.ConfirmationDialog +package: botbuilder-core +summary: >- + SharePoint Confirmation Dialog option that is passed through `Submit` Action + is executed. +fullName: ConfirmationDialog +remarks: '' +isDeprecated: false +type: interface +properties: + - name: message + uid: botbuilder-core.ConfirmationDialog.message + package: botbuilder-core + summary: Dialog message. + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.ConfirmationDialog.title + package: botbuilder-core + summary: Dialog title. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConsoleTranscriptLogger.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConsoleTranscriptLogger.yml index 315d9e8c..62c316e9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConsoleTranscriptLogger.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConsoleTranscriptLogger.yml @@ -2,10 +2,9 @@ name: ConsoleTranscriptLogger uid: botbuilder-core.ConsoleTranscriptLogger package: botbuilder-core -summary: 'ConsoleTranscriptLogger , writes activities to Console output.' +summary: ConsoleTranscriptLogger , writes activities to Console output. fullName: ConsoleTranscriptLogger remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,15 +13,13 @@ methods: package: botbuilder-core summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logActivity(activity: Activity): void | Promise' parameters: - id: activity - type: Activity - description: | - Activity being logged. + type: + description: Activity being logged. return: description: '' type: void | Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContactRelationUpdateActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContactRelationUpdateActionTypes.yml new file mode 100644 index 00000000..3d6c183a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContactRelationUpdateActionTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: ContactRelationUpdateActionTypes +uid: botbuilder-core.ContactRelationUpdateActionTypes +package: botbuilder-core +summary: |- + Defines values for ContactRelationUpdateActionTypes. + Possible values include: 'add', 'remove' +fullName: ContactRelationUpdateActionTypes +remarks: '' +isDeprecated: false +fields: + - name: Add + uid: botbuilder-core.ContactRelationUpdateActionTypes.Add + package: botbuilder-core + summary: '' + - name: Remove + uid: botbuilder-core.ContactRelationUpdateActionTypes.Remove + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContentType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContentType.yml new file mode 100644 index 00000000..5a1fd11d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ContentType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ContentType +uid: botbuilder-core.ContentType +package: botbuilder-core +summary: |- + Defines values for ContentType. + Possible values include: 'html', 'text' +fullName: ContentType +remarks: '' +isDeprecated: false +syntax: | + type ContentType = "html" | "text" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationAccount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationAccount.yml new file mode 100644 index 00000000..7113568c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationAccount.yml @@ -0,0 +1,116 @@ +### YamlMime:TSType +name: ConversationAccount +uid: botbuilder-core.ConversationAccount +package: botbuilder-core +summary: Channel account information for a conversation +fullName: ConversationAccount +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadObjectId + uid: botbuilder-core.ConversationAccount.aadObjectId + package: botbuilder-core + summary: This account's object ID within Azure Active Directory (AAD) + fullName: aadObjectId + remarks: '' + isDeprecated: false + syntax: + content: 'aadObjectId?: string' + return: + description: '' + type: string + - name: conversationType + uid: botbuilder-core.ConversationAccount.conversationType + package: botbuilder-core + summary: >- + Indicates the type of the conversation in channels that distinguish + between conversation types + fullName: conversationType + remarks: '' + isDeprecated: false + syntax: + content: 'conversationType: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.ConversationAccount.id + package: botbuilder-core + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: isGroup + uid: botbuilder-core.ConversationAccount.isGroup + package: botbuilder-core + summary: >- + Indicates whether the conversation contains more than two participants at + the time the + + activity was generated + fullName: isGroup + remarks: '' + isDeprecated: false + syntax: + content: 'isGroup: boolean' + return: + description: '' + type: boolean + - name: name + uid: botbuilder-core.ConversationAccount.name + package: botbuilder-core + summary: Display friendly name + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder-core.ConversationAccount.properties + package: botbuilder-core + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + - name: role + uid: botbuilder-core.ConversationAccount.role + package: botbuilder-core + summary: >- + Role of the entity behind the account (Example: User, Bot, etc.). Possible + values include: + + 'user', 'bot' + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: RoleTypes' + return: + description: '' + type: + - name: tenantId + uid: botbuilder-core.ConversationAccount.tenantId + package: botbuilder-core + summary: This conversation's tenant ID + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationIdentityType.yml new file mode 100644 index 00000000..8991c197 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationIdentityType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ConversationIdentityType +uid: botbuilder-core.ConversationIdentityType +package: botbuilder-core +summary: |- + Defines values for ConversationIdentityType. + Possible values include: 'team', 'channel' +fullName: ConversationIdentityType +remarks: '' +isDeprecated: false +syntax: | + type ConversationIdentityType = "team" | "channel" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationList.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationList.yml new file mode 100644 index 00000000..a12ca06f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationList.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ConversationList +uid: botbuilder-core.ConversationList +package: botbuilder-core +summary: '' +fullName: ConversationList +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversations + uid: botbuilder-core.ConversationList.conversations + package: botbuilder-core + summary: '' + fullName: conversations + remarks: '' + isDeprecated: false + syntax: + content: 'conversations?: ChannelInfo[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationMembers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationMembers.yml new file mode 100644 index 00000000..7efa03b2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationMembers.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ConversationMembers +uid: botbuilder-core.ConversationMembers +package: botbuilder-core +summary: Conversation and its members +fullName: ConversationMembers +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.ConversationMembers.id + package: botbuilder-core + summary: Conversation ID + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: members + uid: botbuilder-core.ConversationMembers.members + package: botbuilder-core + summary: List of members in this conversation + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: ChannelAccount[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationParameters.yml new file mode 100644 index 00000000..5f77dd99 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationParameters.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: ConversationParameters +uid: botbuilder-core.ConversationParameters +package: botbuilder-core +summary: Parameters for creating a new conversation +fullName: ConversationParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: botbuilder-core.ConversationParameters.activity + package: botbuilder-core + summary: >- + (Optional) When creating a new conversation, use this activity as the + initial message to the + + conversation + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity: Activity' + return: + description: '' + type: + - name: bot + uid: botbuilder-core.ConversationParameters.bot + package: botbuilder-core + summary: The bot address for this conversation + fullName: bot + remarks: '' + isDeprecated: false + syntax: + content: 'bot: ChannelAccount' + return: + description: '' + type: + - name: channelData + uid: botbuilder-core.ConversationParameters.channelData + package: botbuilder-core + summary: Channel specific payload for creating the conversation + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData: any' + return: + description: '' + type: any + - name: isGroup + uid: botbuilder-core.ConversationParameters.isGroup + package: botbuilder-core + summary: IsGroup + fullName: isGroup + remarks: '' + isDeprecated: false + syntax: + content: 'isGroup: boolean' + return: + description: '' + type: boolean + - name: members + uid: botbuilder-core.ConversationParameters.members + package: botbuilder-core + summary: Members to add to the conversation + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members?: ChannelAccount[]' + return: + description: '' + type: [] + - name: tenantId + uid: botbuilder-core.ConversationParameters.tenantId + package: botbuilder-core + summary: (Optional) The tenant ID in which the conversation should be created + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string + - name: topicName + uid: botbuilder-core.ConversationParameters.topicName + package: botbuilder-core + summary: (Optional) Topic of the conversation (if supported by the channel) + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationReference.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationReference.yml new file mode 100644 index 00000000..52d86f19 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationReference.yml @@ -0,0 +1,101 @@ +### YamlMime:TSType +name: ConversationReference +uid: botbuilder-core.ConversationReference +package: botbuilder-core +summary: An object relating to a particular point in a conversation +fullName: ConversationReference +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityId + uid: botbuilder-core.ConversationReference.activityId + package: botbuilder-core + summary: (Optional) ID of the activity to refer to + fullName: activityId + remarks: '' + isDeprecated: false + syntax: + content: 'activityId?: string' + return: + description: '' + type: string + - name: bot + uid: botbuilder-core.ConversationReference.bot + package: botbuilder-core + summary: Bot participating in this conversation + fullName: bot + remarks: '' + isDeprecated: false + syntax: + content: 'bot: ChannelAccount' + return: + description: '' + type: + - name: channelId + uid: botbuilder-core.ConversationReference.channelId + package: botbuilder-core + summary: Channel ID + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: conversation + uid: botbuilder-core.ConversationReference.conversation + package: botbuilder-core + summary: Conversation reference + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: locale + uid: botbuilder-core.ConversationReference.locale + package: botbuilder-core + summary: |- + A locale name for the contents of the text field. + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated with a language and an ISO 3166 two-letter + subculture code associated with a country or region. + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: serviceUrl + uid: botbuilder-core.ConversationReference.serviceUrl + package: botbuilder-core + summary: >- + Service endpoint where operations concerning the referenced conversation + may be performed + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + - name: user + uid: botbuilder-core.ConversationReference.user + package: botbuilder-core + summary: (Optional) User participating in this conversation + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: ChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationResourceResponse.yml new file mode 100644 index 00000000..7ac21f3e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationResourceResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: ConversationResourceResponse +uid: botbuilder-core.ConversationResourceResponse +package: botbuilder-core +summary: A response containing a resource +fullName: ConversationResourceResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityId + uid: botbuilder-core.ConversationResourceResponse.activityId + package: botbuilder-core + summary: ID of the Activity (if sent) + fullName: activityId + remarks: '' + isDeprecated: false + syntax: + content: 'activityId: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.ConversationResourceResponse.id + package: botbuilder-core + summary: Id of the resource + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: serviceUrl + uid: botbuilder-core.ConversationResourceResponse.serviceUrl + package: botbuilder-core + summary: >- + Service endpoint where operations concerning the conversation may be + performed + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationState.yml index ae4daad1..37aca08f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationState.yml @@ -22,16 +22,14 @@ remarks: >- const conversationState = new ConversationState(new MemoryStorage()); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'ConversationState(Storage, string)' + - name: ConversationState(Storage, string) uid: botbuilder-core.ConversationState.constructor package: botbuilder-core summary: Creates a new ConversationState instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ConversationState(storage: Storage, namespace?: string)' @@ -41,7 +39,7 @@ constructors: description: Storage provider to persist conversation state to. - id: namespace type: string - description: > + description: >- (Optional) namespace to append to storage keys. Defaults to an empty string. inheritedMethods: @@ -63,7 +61,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function clear(context: TurnContext): Promise' @@ -86,7 +83,6 @@ inheritedMethods: states storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createProperty(name: string): StatePropertyAccessor' @@ -116,7 +112,6 @@ inheritedMethods: await botState.delete(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' @@ -144,19 +139,18 @@ inheritedMethods: const state = botState.get(context); ``` - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): any | undefined' + content: 'function get(context: TurnContext): any' parameters: - id: context type: description: Context for current turn of conversation with the user. return: description: A cached state object or undefined if not cached. - type: any | undefined - inheritanceDescription: 'Inherited From [BotState.get](xref:botbuilder-core.BotState.get)' - - name: 'load(TurnContext, boolean)' + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder-core.BotState.get) + - name: load(TurnContext, boolean) uid: botbuilder-core.ConversationState.load package: botbuilder-core summary: Reads in and caches the backing state object for a turn. @@ -176,7 +170,6 @@ inheritedMethods: const state = await botState.load(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function load(context: TurnContext, force?: boolean): Promise' @@ -192,8 +185,8 @@ inheritedMethods: return: description: The cached state. type: Promise<any> - inheritanceDescription: 'Inherited From [BotState.load](xref:botbuilder-core.BotState.load)' - - name: 'saveChanges(TurnContext, boolean)' + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder-core.BotState.load) + - name: saveChanges(TurnContext, boolean) uid: botbuilder-core.ConversationState.saveChanges package: botbuilder-core summary: Saves the cached state object if it's been changed. @@ -212,7 +205,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -239,15 +231,14 @@ methods: package: botbuilder-core summary: Returns the storage key for the current conversation state. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getStorageKey(context: TurnContext): string | undefined' + content: 'function getStorageKey(context: TurnContext): undefined | string' parameters: - id: context type: description: Context for current turn of conversation with the user. return: description: The storage key for the current conversation state. - type: string | undefined + type: undefined | string extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationsResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationsResult.yml new file mode 100644 index 00000000..1e9a5c3c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ConversationsResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ConversationsResult +uid: botbuilder-core.ConversationsResult +package: botbuilder-core +summary: Conversations result +fullName: ConversationsResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder-core.ConversationsResult.continuationToken + package: botbuilder-core + summary: Paging token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: conversations + uid: botbuilder-core.ConversationsResult.conversations + package: botbuilder-core + summary: List of conversations + fullName: conversations + remarks: '' + isDeprecated: false + syntax: + content: 'conversations: ConversationMembers[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreAppCredentials.yml index 3a345bb3..9ca6a7c5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreAppCredentials.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreAppCredentials.yml @@ -7,7 +7,6 @@ fullName: CoreAppCredentials remarks: >- Runtime-agnostic interface representing "ServiceClientCredentials" from @azure/ms-rest-js -isPreview: false isDeprecated: false type: interface methods: @@ -16,7 +15,6 @@ methods: package: botbuilder-core summary: Signs a request with the Authentication header. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -24,8 +22,8 @@ methods: Promise parameters: - id: webResource - type: + type: CoreWebResource description: The CoreWebResource/request to be signed. return: description: The signed request object; - type: Promise<> + type: Promise<CoreWebResource> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreWebResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreWebResource.yml deleted file mode 100644 index 4bea7c1a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/CoreWebResource.yml +++ /dev/null @@ -1,63 +0,0 @@ -### YamlMime:TSType -name: CoreWebResource -uid: botbuilder-core.CoreWebResource -package: botbuilder-core -summary: Internal interface representing the "WebResource" from @azure/ms-rest-js -fullName: CoreWebResource -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: body - uid: botbuilder-core.CoreWebResource.body - package: botbuilder-core - summary: '' - fullName: body - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'body?: any' - return: - description: '' - type: any - - name: headers - uid: botbuilder-core.CoreWebResource.headers - package: botbuilder-core - summary: '' - fullName: headers - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'headers?: any' - return: - description: '' - type: any - - name: method - uid: botbuilder-core.CoreWebResource.method - package: botbuilder-core - summary: '' - fullName: method - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'method?: any' - return: - description: '' - type: any - - name: url - uid: botbuilder-core.CoreWebResource.url - package: botbuilder-core - summary: '' - fullName: url - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'url?: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeleteActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeleteActivityHandler.yml index 81a8ce7a..db838563 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeleteActivityHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeleteActivityHandler.yml @@ -50,7 +50,6 @@ remarks: >- - [TurnContext.onDeleteActivity](xref:botbuilder-core.TurnContext.onDeleteActivity) -isPreview: false isDeprecated: false syntax: | type DeleteActivityHandler = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeliveryModes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeliveryModes.yml new file mode 100644 index 00000000..7fa440e8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DeliveryModes.yml @@ -0,0 +1,29 @@ +### YamlMime:TSEnum +name: DeliveryModes +uid: botbuilder-core.DeliveryModes +package: botbuilder-core +summary: >- + Defines values for DeliveryModes. + + Possible values include: 'normal', 'notification', 'expectReplies', + 'ephemeral' +fullName: DeliveryModes +remarks: '' +isDeprecated: false +fields: + - name: Ephemeral + uid: botbuilder-core.DeliveryModes.Ephemeral + package: botbuilder-core + summary: '' + - name: ExpectReplies + uid: botbuilder-core.DeliveryModes.ExpectReplies + package: botbuilder-core + summary: '' + - name: Normal + uid: botbuilder-core.DeliveryModes.Normal + package: botbuilder-core + summary: '' + - name: Notification + uid: botbuilder-core.DeliveryModes.Notification + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DropDownOptionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DropDownOptionType.yml new file mode 100644 index 00000000..ae24a2fc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/DropDownOptionType.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: DropDownOptionType +uid: botbuilder-core.DropDownOptionType +package: botbuilder-core +summary: SharePoint property pane drop down option type. +fullName: DropDownOptionType +remarks: '' +isDeprecated: false +fields: + - name: Normal + uid: botbuilder-core.DropDownOptionType.Normal + package: botbuilder-core + summary: Render a normal option. + numericValue: 0 + - name: Divider + uid: botbuilder-core.DropDownOptionType.Divider + package: botbuilder-core + summary: Render a divider. + numericValue: 1 + - name: Header + uid: botbuilder-core.DropDownOptionType.Header + package: botbuilder-core + summary: Render a header. + numericValue: 2 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/EndOfConversationCodes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/EndOfConversationCodes.yml new file mode 100644 index 00000000..dfa9f4e2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/EndOfConversationCodes.yml @@ -0,0 +1,39 @@ +### YamlMime:TSEnum +name: EndOfConversationCodes +uid: botbuilder-core.EndOfConversationCodes +package: botbuilder-core +summary: >- + Defines values for EndOfConversationCodes. + + Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', + 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' +fullName: EndOfConversationCodes +remarks: '' +isDeprecated: false +fields: + - name: BotIssuedInvalidMessage + uid: botbuilder-core.EndOfConversationCodes.BotIssuedInvalidMessage + package: botbuilder-core + summary: '' + - name: BotTimedOut + uid: botbuilder-core.EndOfConversationCodes.BotTimedOut + package: botbuilder-core + summary: '' + - name: ChannelFailed + uid: botbuilder-core.EndOfConversationCodes.ChannelFailed + package: botbuilder-core + summary: '' + - name: CompletedSuccessfully + uid: botbuilder-core.EndOfConversationCodes.CompletedSuccessfully + package: botbuilder-core + summary: '' + - name: Unknown + uid: botbuilder-core.EndOfConversationCodes.Unknown + package: botbuilder-core + summary: '' + - name: UserCancelled + uid: botbuilder-core.EndOfConversationCodes.UserCancelled + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Entity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Entity.yml new file mode 100644 index 00000000..b69cf1b1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Entity.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: Entity +uid: botbuilder-core.Entity +package: botbuilder-core +summary: Metadata object pertaining to an activity +fullName: Entity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder-core.Entity.type + package: botbuilder-core + summary: Type of this entity (RFC 3987 IRI) + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorModel.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorModel.yml new file mode 100644 index 00000000..c4f0e33e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorModel.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ErrorModel +uid: botbuilder-core.ErrorModel +package: botbuilder-core +summary: Object representing error information +fullName: ErrorModel +remarks: '' +isDeprecated: false +type: interface +properties: + - name: code + uid: botbuilder-core.ErrorModel.code + package: botbuilder-core + summary: Error code + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code: string' + return: + description: '' + type: string + - name: innerHttpError + uid: botbuilder-core.ErrorModel.innerHttpError + package: botbuilder-core + summary: Error from inner http call + fullName: innerHttpError + remarks: '' + isDeprecated: false + syntax: + content: 'innerHttpError: InnerHttpError' + return: + description: '' + type: + - name: message + uid: botbuilder-core.ErrorModel.message + package: botbuilder-core + summary: Error message + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorResponse.yml new file mode 100644 index 00000000..e2b9b9ed --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ErrorResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ErrorResponse +uid: botbuilder-core.ErrorResponse +package: botbuilder-core +summary: An HTTP API response +fullName: ErrorResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: error + uid: botbuilder-core.ErrorResponse.error + package: botbuilder-core + summary: Error message + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: ErrorModel' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardAction.yml new file mode 100644 index 00000000..bd978352 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ExecuteCardAction +uid: botbuilder-core.ExecuteCardAction +package: botbuilder-core +summary: SharePoint `Action.Execute` event. +fullName: ExecuteCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder-core.ExecuteCardAction.parameters + package: botbuilder-core + summary: Parameters passed to the Execute event handler + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: ExecuteCardParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.ExecuteCardAction.type + package: botbuilder-core + summary: Indicates this is an Execute button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "Execute"' + return: + description: '' + type: '"Execute"' + - name: verb + uid: botbuilder-core.ExecuteCardAction.verb + package: botbuilder-core + summary: Verb associated with this action + fullName: verb + remarks: '' + isDeprecated: false + syntax: + content: 'verb?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardParameters.yml new file mode 100644 index 00000000..6a7b1d77 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExecuteCardParameters.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: ExecuteCardParameters +uid: botbuilder-core.ExecuteCardParameters +package: botbuilder-core +summary: Parameters for SharePoint Action.Execute card action. +fullName: ExecuteCardParameters +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExpectedReplies.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExpectedReplies.yml new file mode 100644 index 00000000..de87384d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExpectedReplies.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ExpectedReplies +uid: botbuilder-core.ExpectedReplies +package: botbuilder-core +summary: Expected Replies in response to DeliveryModes.ExpectReplies +fullName: ExpectedReplies +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activities + uid: botbuilder-core.ExpectedReplies.activities + package: botbuilder-core + summary: A collection of Activities that conforms to the ExpectedReplies schema. + fullName: activities + remarks: '' + isDeprecated: false + syntax: + content: 'activities: Activity[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExtendedUserTokenProvider.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExtendedUserTokenProvider.yml index 83e0942d..4454fbfe 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExtendedUserTokenProvider.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExtendedUserTokenProvider.yml @@ -7,19 +7,17 @@ summary: >- BotAdapters fullName: ExtendedUserTokenProvider remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Use `UserTokenClient` instead. type: interface inheritedMethods: - - name: 'getTokenStatus(TurnContext, string, string, any)' + - name: getTokenStatus(TurnContext, string, string, any) uid: botbuilder-core.ExtendedUserTokenProvider.getTokenStatus package: botbuilder-core summary: >- Retrieves the token status for each configured connection for the given user, using the bot's AppCredentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -39,21 +37,19 @@ inheritedMethods: token status for all configured connections. - id: oAuthAppCredentials type: any - description: | - The app credentials for OAuth. + description: The app credentials for OAuth. return: description: '' - type: 'Promise<any[]>' + type: Promise<any[]> inheritanceDescription: >- Inherited From [IUserTokenProvider.getTokenStatus](xref:botbuilder-core.IUserTokenProvider.getTokenStatus) methods: - - name: 'exchangeToken(TurnContext, string, string, TokenExchangeRequest)' + - name: exchangeToken(TurnContext, string, string, TokenExchangeRequest) uid: botbuilder-core.ExtendedUserTokenProvider.exchangeToken package: botbuilder-core summary: Performs a token exchange operation such as for single sign-on. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,13 +67,13 @@ methods: type: string description: The user id that will be associated with the token. - id: tokenExchangeRequest - type: TokenExchangeRequest - description: > + type: + description: >- The exchange request details, either a token to exchange or a uri to exchange. return: description: '' - type: Promise<TokenResponse> + type: Promise<> - name: >- exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials) @@ -85,7 +81,6 @@ methods: package: botbuilder-core summary: Performs a token exchange operation such as for single sign-on. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -103,8 +98,8 @@ methods: type: string description: The user id that will be associated with the token. - id: tokenExchangeRequest - type: TokenExchangeRequest - description: > + type: + description: >- The exchange request details, either a token to exchange or a uri to exchange. - id: appCredentials @@ -112,19 +107,18 @@ methods: description: '' return: description: '' - type: Promise<TokenResponse> - - name: 'getAadTokens(TurnContext, string, string[], CoreAppCredentials)' + type: Promise<> + - name: getAadTokens(TurnContext, string, string[], CoreAppCredentials) uid: botbuilder-core.ExtendedUserTokenProvider.getAadTokens package: botbuilder-core summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): - Promise<[key: string]: TokenResponse> + Promise<{[propertyName: string]: TokenResponse}> parameters: - id: context type: @@ -133,22 +127,23 @@ methods: type: string description: Name of the auth connection to use. - id: resourceUrls - type: 'string[]' + type: string[] description: '' - id: appCredentials type: description: '' return: description: '' - type: 'Promise<[key: string]: TokenResponse>' - - name: 'getSignInLink(TurnContext, string, CoreAppCredentials)' + type: >- + Promise<{[propertyName: string]: }> + - name: getSignInLink(TurnContext, string, CoreAppCredentials) uid: botbuilder-core.ExtendedUserTokenProvider.getSignInLink package: botbuilder-core summary: >- Gets a signin link from the token server that can be sent as part of a SigninCard. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +162,13 @@ methods: return: description: '' type: Promise<string> - - name: 'getSignInResource(TurnContext, string)' + - name: getSignInResource(TurnContext, string) uid: botbuilder-core.ExtendedUserTokenProvider.getSignInResource package: botbuilder-core summary: >- Get the raw signin resource to be sent to the user for signin for a connection name. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -186,19 +180,17 @@ methods: description: Context for the current turn of conversation with the user. - id: connectionName type: string - description: | - Name of the auth connection to use. + description: Name of the auth connection to use. return: description: '' - type: Promise<SignInUrlResponse> - - name: 'getSignInResource(TurnContext, string, string, string)' + type: Promise<> + - name: getSignInResource(TurnContext, string, string, string) uid: botbuilder-core.ExtendedUserTokenProvider.getSignInResource_1 package: botbuilder-core summary: >- Get the raw signin resource to be sent to the user for signin for a connection name. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -216,19 +208,17 @@ methods: description: The user id that will be associated with the token. - id: finalRedirect type: string - description: | - The final URL that the OAuth flow will redirect to. + description: The final URL that the OAuth flow will redirect to. return: description: '' - type: Promise<SignInUrlResponse> - - name: 'getSignInResource(TurnContext, string, string, string, CoreAppCredentials)' + type: Promise<> + - name: getSignInResource(TurnContext, string, string, string, CoreAppCredentials) uid: botbuilder-core.ExtendedUserTokenProvider.getSignInResource_2 package: botbuilder-core summary: >- Get the raw signin resource to be sent to the user for signin for a connection name. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -247,20 +237,18 @@ methods: description: The user id that will be associated with the token. - id: finalRedirect type: string - description: | - The final URL that the OAuth flow will redirect to. + description: The final URL that the OAuth flow will redirect to. - id: appCredentials type: description: '' return: description: '' - type: Promise<SignInUrlResponse> - - name: 'getUserToken(TurnContext, string, string, CoreAppCredentials)' + type: Promise<> + - name: getUserToken(TurnContext, string, string, CoreAppCredentials) uid: botbuilder-core.ExtendedUserTokenProvider.getUserToken package: botbuilder-core summary: Retrieves the OAuth token for a user that is in a sign-in flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -276,20 +264,18 @@ methods: description: Name of the auth connection to use. - id: magicCode type: string - description: | - (Optional) Optional user entered code to validate. + description: (Optional) Optional user entered code to validate. - id: appCredentials type: description: '' return: description: '' - type: Promise<TokenResponse> - - name: 'signOutUser(TurnContext, string, string, CoreAppCredentials)' + type: Promise<> + - name: signOutUser(TurnContext, string, string, CoreAppCredentials) uid: botbuilder-core.ExtendedUserTokenProvider.signOutUser package: botbuilder-core summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkActionParameters.yml new file mode 100644 index 00000000..ab748904 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkActionParameters.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ExternalLinkActionParameters +uid: botbuilder-core.ExternalLinkActionParameters +package: botbuilder-core +summary: Parameters for opening an external link. +fullName: ExternalLinkActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isTeamsDeepLink + uid: botbuilder-core.ExternalLinkActionParameters.isTeamsDeepLink + package: botbuilder-core + summary: Indicates whether this is a Teams Deep Link. + fullName: isTeamsDeepLink + remarks: '' + isDeprecated: false + syntax: + content: 'isTeamsDeepLink?: boolean' + return: + description: '' + type: boolean + - name: target + uid: botbuilder-core.ExternalLinkActionParameters.target + package: botbuilder-core + summary: The URL of the link. + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkCardAction.yml new file mode 100644 index 00000000..a4bd4021 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ExternalLinkCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ExternalLinkCardAction +uid: botbuilder-core.ExternalLinkCardAction +package: botbuilder-core +summary: SharePoint ExternalLink action. +fullName: ExternalLinkCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder-core.ExternalLinkCardAction.parameters + package: botbuilder-core + summary: Parameters for the external link. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: ExternalLinkActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.ExternalLinkCardAction.type + package: botbuilder-core + summary: Indicates this is an external link button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "ExternalLink"' + return: + description: '' + type: '"ExternalLink"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Fact.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Fact.yml new file mode 100644 index 00000000..616ed8b2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Fact.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: Fact +uid: botbuilder-core.Fact +package: botbuilder-core +summary: >- + Set of key-value pairs. Advantage of this section is that key and value + properties will be + + rendered with default style information with some delimiter between them. So + there is no need + + for developer to specify style information. +fullName: Fact +remarks: '' +isDeprecated: false +type: interface +properties: + - name: key + uid: botbuilder-core.Fact.key + package: botbuilder-core + summary: The key for this Fact + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.Fact.value + package: botbuilder-core + summary: The value for this Fact + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FieldType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FieldType.yml new file mode 100644 index 00000000..e55a0c1b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FieldType.yml @@ -0,0 +1,54 @@ +### YamlMime:TSEnum +name: FieldType +uid: botbuilder-core.FieldType +package: botbuilder-core +summary: SharePoint property pane group field type. +fullName: FieldType +remarks: '' +isDeprecated: false +fields: + - name: CheckBox + uid: botbuilder-core.FieldType.CheckBox + package: botbuilder-core + summary: Checkbox field. + numericValue: 2 + - name: TextField + uid: botbuilder-core.FieldType.TextField + package: botbuilder-core + summary: Text field. + numericValue: 3 + - name: Toggle + uid: botbuilder-core.FieldType.Toggle + package: botbuilder-core + summary: Toggle field. + numericValue: 5 + - name: Dropdown + uid: botbuilder-core.FieldType.Dropdown + package: botbuilder-core + summary: Dropdown field. + numericValue: 6 + - name: Label + uid: botbuilder-core.FieldType.Label + package: botbuilder-core + summary: Label field. + numericValue: 7 + - name: Slider + uid: botbuilder-core.FieldType.Slider + package: botbuilder-core + summary: Slider field. + numericValue: 8 + - name: ChoiceGroup + uid: botbuilder-core.FieldType.ChoiceGroup + package: botbuilder-core + summary: Choice Group field. + numericValue: 10 + - name: HorizontalRule + uid: botbuilder-core.FieldType.HorizontalRule + package: botbuilder-core + summary: Horizontal Rule field. + numericValue: 12 + - name: Link + uid: botbuilder-core.FieldType.Link + package: botbuilder-core + summary: Link field. + numericValue: 13 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCard.yml new file mode 100644 index 00000000..ffcef7d4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCard.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: FileConsentCard +uid: botbuilder-core.FileConsentCard +package: botbuilder-core +summary: '' +fullName: FileConsentCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: acceptContext + uid: botbuilder-core.FileConsentCard.acceptContext + package: botbuilder-core + summary: Context sent back to the Bot if user + fullName: acceptContext + remarks: '' + isDeprecated: false + syntax: + content: 'acceptContext?: any' + return: + description: '' + type: any + - name: declineContext + uid: botbuilder-core.FileConsentCard.declineContext + package: botbuilder-core + summary: Context sent back to the Bot if user + fullName: declineContext + remarks: '' + isDeprecated: false + syntax: + content: 'declineContext?: any' + return: + description: '' + type: any + - name: description + uid: botbuilder-core.FileConsentCard.description + package: botbuilder-core + summary: File description. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description?: string' + return: + description: '' + type: string + - name: sizeInBytes + uid: botbuilder-core.FileConsentCard.sizeInBytes + package: botbuilder-core + summary: Size of the file to be uploaded in Bytes. + fullName: sizeInBytes + remarks: '' + isDeprecated: false + syntax: + content: 'sizeInBytes?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCardResponse.yml new file mode 100644 index 00000000..b699eb65 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileConsentCardResponse.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: FileConsentCardResponse +uid: botbuilder-core.FileConsentCardResponse +package: botbuilder-core +summary: '' +fullName: FileConsentCardResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder-core.FileConsentCardResponse.action + package: botbuilder-core + summary: The action the user took. Possible values + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: Action' + return: + description: '' + type: + - name: context + uid: botbuilder-core.FileConsentCardResponse.context + package: botbuilder-core + summary: The context associated with the action. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: any' + return: + description: '' + type: any + - name: uploadInfo + uid: botbuilder-core.FileConsentCardResponse.uploadInfo + package: botbuilder-core + summary: If the user accepted the file, + fullName: uploadInfo + remarks: '' + isDeprecated: false + syntax: + content: 'uploadInfo?: FileUploadInfo' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfo.yml new file mode 100644 index 00000000..951ccf16 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfo.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: FileDownloadInfo +uid: botbuilder-core.FileDownloadInfo +package: botbuilder-core +summary: '' +fullName: FileDownloadInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: downloadUrl + uid: botbuilder-core.FileDownloadInfo.downloadUrl + package: botbuilder-core + summary: File download url. + fullName: downloadUrl + remarks: '' + isDeprecated: false + syntax: + content: 'downloadUrl?: string' + return: + description: '' + type: string + - name: etag + uid: botbuilder-core.FileDownloadInfo.etag + package: botbuilder-core + summary: ETag for the file. + fullName: etag + remarks: '' + isDeprecated: false + syntax: + content: 'etag?: any' + return: + description: '' + type: any + - name: fileType + uid: botbuilder-core.FileDownloadInfo.fileType + package: botbuilder-core + summary: Type of file. + fullName: fileType + remarks: '' + isDeprecated: false + syntax: + content: 'fileType?: string' + return: + description: '' + type: string + - name: uniqueId + uid: botbuilder-core.FileDownloadInfo.uniqueId + package: botbuilder-core + summary: Unique Id for the file. + fullName: uniqueId + remarks: '' + isDeprecated: false + syntax: + content: 'uniqueId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfoAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfoAttachment.yml new file mode 100644 index 00000000..0252adf9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileDownloadInfoAttachment.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: FileDownloadInfoAttachment +uid: botbuilder-core.FileDownloadInfoAttachment +package: botbuilder-core +summary: '' +fullName: FileDownloadInfoAttachment +remarks: '' +isDeprecated: false +syntax: | + type FileDownloadInfoAttachment = TeamsAttachment diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileInfoCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileInfoCard.yml new file mode 100644 index 00000000..184298f2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileInfoCard.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: FileInfoCard +uid: botbuilder-core.FileInfoCard +package: botbuilder-core +summary: '' +fullName: FileInfoCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: etag + uid: botbuilder-core.FileInfoCard.etag + package: botbuilder-core + summary: ETag for the file. + fullName: etag + remarks: '' + isDeprecated: false + syntax: + content: 'etag?: any' + return: + description: '' + type: any + - name: fileType + uid: botbuilder-core.FileInfoCard.fileType + package: botbuilder-core + summary: Type of file. + fullName: fileType + remarks: '' + isDeprecated: false + syntax: + content: 'fileType?: string' + return: + description: '' + type: string + - name: uniqueId + uid: botbuilder-core.FileInfoCard.uniqueId + package: botbuilder-core + summary: Unique Id for the file. + fullName: uniqueId + remarks: '' + isDeprecated: false + syntax: + content: 'uniqueId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileUploadInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileUploadInfo.yml new file mode 100644 index 00000000..0fcd9afa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FileUploadInfo.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: FileUploadInfo +uid: botbuilder-core.FileUploadInfo +package: botbuilder-core +summary: '' +fullName: FileUploadInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: contentUrl + uid: botbuilder-core.FileUploadInfo.contentUrl + package: botbuilder-core + summary: URL to file. + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + - name: fileType + uid: botbuilder-core.FileUploadInfo.fileType + package: botbuilder-core + summary: Type of the file. + fullName: fileType + remarks: '' + isDeprecated: false + syntax: + content: 'fileType?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.FileUploadInfo.name + package: botbuilder-core + summary: Name of the file. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: uniqueId + uid: botbuilder-core.FileUploadInfo.uniqueId + package: botbuilder-core + summary: ID that uniquely identifies the file. + fullName: uniqueId + remarks: '' + isDeprecated: false + syntax: + content: 'uniqueId?: string' + return: + description: '' + type: string + - name: uploadUrl + uid: botbuilder-core.FileUploadInfo.uploadUrl + package: botbuilder-core + summary: URL to an upload session that the bot can use + fullName: uploadUrl + remarks: '' + isDeprecated: false + syntax: + content: 'uploadUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FocusParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FocusParameters.yml new file mode 100644 index 00000000..4c28fe68 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/FocusParameters.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: FocusParameters +uid: botbuilder-core.FocusParameters +package: botbuilder-core +summary: >- + Interface to give third party developers the capability to determine which + element should recieve focus, when, and how often content should be read. +fullName: FocusParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLive + uid: botbuilder-core.FocusParameters.ariaLive + package: botbuilder-core + summary: >- + Sets the accessibility reading of the contents within the focus target. + + Polite - Content in the target's subtree is read when the user is idle. + + Assertive - Disrupts any announcement in favor of the changed contents + within the target's subtree. + + Off - The screen reader will not read contents within the target's + subtree. + fullName: ariaLive + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLive?: "polite" | "assertive" | "off"' + return: + description: '' + type: '"polite" | "assertive" | "off"' + - name: focusTarget + uid: botbuilder-core.FocusParameters.focusTarget + package: botbuilder-core + summary: >- + Sets the default focus on the DOM. Developers pass in the id of a unique + element that is to attain focus within a quick view. + + If the `focusTarget` is not defined then the root element is selected. + fullName: focusTarget + remarks: '' + isDeprecated: false + syntax: + content: 'focusTarget?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GeoCoordinates.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GeoCoordinates.yml new file mode 100644 index 00000000..657cd6bb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GeoCoordinates.yml @@ -0,0 +1,76 @@ +### YamlMime:TSType +name: GeoCoordinates +uid: botbuilder-core.GeoCoordinates +package: botbuilder-core +summary: 'GeoCoordinates (entity type: "https://schema.org/GeoCoordinates")' +fullName: GeoCoordinates +remarks: '' +isDeprecated: false +type: interface +properties: + - name: elevation + uid: botbuilder-core.GeoCoordinates.elevation + package: botbuilder-core + summary: >- + Elevation of the location [WGS + 84](https://en.wikipedia.org/wiki/World_Geodetic_System) + fullName: elevation + remarks: '' + isDeprecated: false + syntax: + content: 'elevation: number' + return: + description: '' + type: number + - name: latitude + uid: botbuilder-core.GeoCoordinates.latitude + package: botbuilder-core + summary: >- + Latitude of the location [WGS + 84](https://en.wikipedia.org/wiki/World_Geodetic_System) + fullName: latitude + remarks: '' + isDeprecated: false + syntax: + content: 'latitude: number' + return: + description: '' + type: number + - name: longitude + uid: botbuilder-core.GeoCoordinates.longitude + package: botbuilder-core + summary: >- + Longitude of the location [WGS + 84](https://en.wikipedia.org/wiki/World_Geodetic_System) + fullName: longitude + remarks: '' + isDeprecated: false + syntax: + content: 'longitude: number' + return: + description: '' + type: number + - name: name + uid: botbuilder-core.GeoCoordinates.name + package: botbuilder-core + summary: The name of the thing + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.GeoCoordinates.type + package: botbuilder-core + summary: The type of the thing + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationActionParameters.yml new file mode 100644 index 00000000..e87b89c6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationActionParameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: GetLocationActionParameters +uid: botbuilder-core.GetLocationActionParameters +package: botbuilder-core +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.GetLocation + action. +fullName: GetLocationActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: chooseLocationOnMap + uid: botbuilder-core.GetLocationActionParameters.chooseLocationOnMap + package: botbuilder-core + summary: |- + If true, allow the user to choose a location by opening a map. + Otherwise, get the current location. + fullName: chooseLocationOnMap + remarks: '' + isDeprecated: false + syntax: + content: 'chooseLocationOnMap?: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationCardAction.yml new file mode 100644 index 00000000..da732a5f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetLocationCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: GetLocationCardAction +uid: botbuilder-core.GetLocationCardAction +package: botbuilder-core +summary: SharePoint `VivaAction.GetLocation` event. +fullName: GetLocationCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder-core.GetLocationCardAction.parameters + package: botbuilder-core + summary: Parameters that can be supplied with the Viva Get Location Action. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: GetLocationActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.GetLocationCardAction.type + package: botbuilder-core + summary: Indicates this is a Viva Select Location button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.GetLocation"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetPropertyPaneConfigurationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetPropertyPaneConfigurationResponse.yml new file mode 100644 index 00000000..2de12817 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/GetPropertyPaneConfigurationResponse.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: GetPropertyPaneConfigurationResponse +uid: botbuilder-core.GetPropertyPaneConfigurationResponse +package: botbuilder-core +summary: SharePoint ACE get property pane configuration response. +fullName: GetPropertyPaneConfigurationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: currentPage + uid: botbuilder-core.GetPropertyPaneConfigurationResponse.currentPage + package: botbuilder-core + summary: Current page number. + fullName: currentPage + remarks: '' + isDeprecated: false + syntax: + content: 'currentPage: number' + return: + description: '' + type: number + - name: loadingIndicatorDelayTime + uid: >- + botbuilder-core.GetPropertyPaneConfigurationResponse.loadingIndicatorDelayTime + package: botbuilder-core + summary: Loading indicator delay time. + fullName: loadingIndicatorDelayTime + remarks: '' + isDeprecated: false + syntax: + content: 'loadingIndicatorDelayTime: number' + return: + description: '' + type: number + - name: pages + uid: botbuilder-core.GetPropertyPaneConfigurationResponse.pages + package: botbuilder-core + summary: Property pane pages. + fullName: pages + remarks: '' + isDeprecated: false + syntax: + content: 'pages: PropertyPanePage[]' + return: + description: '' + type: [] + - name: showLoadingIndicator + uid: botbuilder-core.GetPropertyPaneConfigurationResponse.showLoadingIndicator + package: botbuilder-core + summary: >- + Value indicating whether to show loading indicator on top of the property + pane. + fullName: showLoadingIndicator + remarks: '' + isDeprecated: false + syntax: + content: 'showLoadingIndicator: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/HandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/HandleActionResponse.yml new file mode 100644 index 00000000..98456c89 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/HandleActionResponse.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: HandleActionResponse +uid: botbuilder-core.HandleActionResponse +package: botbuilder-core +summary: The handle action response. +fullName: HandleActionResponse +remarks: '' +isDeprecated: false +syntax: | + type HandleActionResponse = + | CardViewHandleActionResponse + | QuickViewHandleActionResponse + | NoOpHandleActionResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/HeroCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/HeroCard.yml new file mode 100644 index 00000000..25486746 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/HeroCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: HeroCard +uid: botbuilder-core.HeroCard +package: botbuilder-core +summary: A Hero card (card with a single, large image) +fullName: HeroCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder-core.HeroCard.buttons + package: botbuilder-core + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder-core.HeroCard.images + package: botbuilder-core + summary: Array of images for the card + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images: CardImage[]' + return: + description: '' + type: [] + - name: subtitle + uid: botbuilder-core.HeroCard.subtitle + package: botbuilder-core + summary: Subtitle of the card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder-core.HeroCard.tap + package: botbuilder-core + summary: This action will be activated when user taps on the card itself + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder-core.HeroCard.text + package: botbuilder-core + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.HeroCard.title + package: botbuilder-core + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IActivity.yml new file mode 100644 index 00000000..52480261 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IActivity.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: IActivity +uid: botbuilder-core.IActivity +package: botbuilder-core +summary: '' +fullName: IActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botbuilder-core.IActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + - name: channelId + uid: botbuilder-core.IActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: conversation + uid: botbuilder-core.IActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: entities + uid: botbuilder-core.IActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + - name: from + uid: botbuilder-core.IActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + - name: id + uid: botbuilder-core.IActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: localTimestamp + uid: botbuilder-core.IActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + - name: recipient + uid: botbuilder-core.IActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + - name: replyToId + uid: botbuilder-core.IActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + - name: serviceUrl + uid: botbuilder-core.IActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + - name: timestamp + uid: botbuilder-core.IActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + - name: type + uid: botbuilder-core.IActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardSearchBoxButton.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardSearchBoxButton.yml new file mode 100644 index 00000000..4d6d9f9a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardSearchBoxButton.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: ICardSearchBoxButton +uid: botbuilder-core.ICardSearchBoxButton +package: botbuilder-core +summary: Search box button properties. +fullName: ICardSearchBoxButton +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: action + uid: botbuilder-core.ICardSearchBoxButton.action + package: botbuilder-core + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder-core.CardButtonBase.action) + - name: id + uid: botbuilder-core.ICardSearchBoxButton.id + package: botbuilder-core + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder-core.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputIconButton.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputIconButton.yml new file mode 100644 index 00000000..fda0508d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputIconButton.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: ICardTextInputIconButton +uid: botbuilder-core.ICardTextInputIconButton +package: botbuilder-core +summary: Text input icon button. +fullName: ICardTextInputIconButton +remarks: '' +isDeprecated: false +type: interface +properties: + - name: icon + uid: botbuilder-core.ICardTextInputIconButton.icon + package: botbuilder-core + summary: Properties for the icon displayed on the button. + fullName: icon + remarks: '' + isDeprecated: false + syntax: + content: 'icon: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: action + uid: botbuilder-core.ICardTextInputIconButton.action + package: botbuilder-core + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder-core.CardButtonBase.action) + - name: id + uid: botbuilder-core.ICardTextInputIconButton.id + package: botbuilder-core + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder-core.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputTitleButton.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputTitleButton.yml new file mode 100644 index 00000000..b8c7612d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICardTextInputTitleButton.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: ICardTextInputTitleButton +uid: botbuilder-core.ICardTextInputTitleButton +package: botbuilder-core +summary: Text input title button. +fullName: ICardTextInputTitleButton +remarks: '' +isDeprecated: false +type: interface +properties: + - name: title + uid: botbuilder-core.ICardTextInputTitleButton.title + package: botbuilder-core + summary: Text displayed on the button. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botbuilder-core.ICardTextInputTitleButton.action + package: botbuilder-core + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder-core.CardButtonBase.action) + - name: id + uid: botbuilder-core.ICardTextInputTitleButton.id + package: botbuilder-core + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder-core.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandActivity.yml new file mode 100644 index 00000000..a46465e8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandActivity.yml @@ -0,0 +1,223 @@ +### YamlMime:TSType +name: ICommandActivity +uid: botbuilder-core.ICommandActivity +package: botbuilder-core +summary: Asynchronous external command. +fullName: ICommandActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.ICommandActivity.name + package: botbuilder-core + summary: The name of the event. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.ICommandActivity.value + package: botbuilder-core + summary: The value for this command. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: CommandValue' + return: + description: '' + type: <T> +inheritedProperties: + - name: channelData + uid: botbuilder-core.ICommandActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.ICommandActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.ICommandActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.ICommandActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.ICommandActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.ICommandActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.ICommandActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.ICommandActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.ICommandActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.ICommandActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.ICommandActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.ICommandActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandResultActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandResultActivity.yml new file mode 100644 index 00000000..444dde6d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ICommandResultActivity.yml @@ -0,0 +1,223 @@ +### YamlMime:TSType +name: ICommandResultActivity +uid: botbuilder-core.ICommandResultActivity +package: botbuilder-core +summary: Asynchronous external command result. +fullName: ICommandResultActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.ICommandResultActivity.name + package: botbuilder-core + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.ICommandResultActivity.value + package: botbuilder-core + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: CommandResultValue' + return: + description: '' + type: <T> +inheritedProperties: + - name: channelData + uid: botbuilder-core.ICommandResultActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.ICommandResultActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.ICommandResultActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.ICommandResultActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.ICommandResultActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.ICommandResultActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.ICommandResultActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.ICommandResultActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.ICommandResultActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.ICommandResultActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.ICommandResultActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.ICommandResultActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IContactRelationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IContactRelationUpdateActivity.yml new file mode 100644 index 00000000..74c45110 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IContactRelationUpdateActivity.yml @@ -0,0 +1,215 @@ +### YamlMime:TSType +name: IContactRelationUpdateActivity +uid: botbuilder-core.IContactRelationUpdateActivity +package: botbuilder-core +summary: '' +fullName: IContactRelationUpdateActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder-core.IContactRelationUpdateActivity.action + package: botbuilder-core + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder-core.IContactRelationUpdateActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IContactRelationUpdateActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IContactRelationUpdateActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IContactRelationUpdateActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IContactRelationUpdateActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IContactRelationUpdateActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IContactRelationUpdateActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IContactRelationUpdateActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IContactRelationUpdateActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IContactRelationUpdateActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IContactRelationUpdateActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IContactRelationUpdateActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IConversationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IConversationUpdateActivity.yml new file mode 100644 index 00000000..4bca9079 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IConversationUpdateActivity.yml @@ -0,0 +1,247 @@ +### YamlMime:TSType +name: IConversationUpdateActivity +uid: botbuilder-core.IConversationUpdateActivity +package: botbuilder-core +summary: '' +fullName: IConversationUpdateActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: historyDisclosed + uid: botbuilder-core.IConversationUpdateActivity.historyDisclosed + package: botbuilder-core + summary: Indicates whether the prior history of the channel is disclosed. + fullName: historyDisclosed + remarks: '' + isDeprecated: false + syntax: + content: 'historyDisclosed?: boolean' + return: + description: '' + type: boolean + - name: membersAdded + uid: botbuilder-core.IConversationUpdateActivity.membersAdded + package: botbuilder-core + summary: The collection of members added to the conversation. + fullName: membersAdded + remarks: '' + isDeprecated: false + syntax: + content: 'membersAdded?: ChannelAccount[]' + return: + description: '' + type: [] + - name: membersRemoved + uid: botbuilder-core.IConversationUpdateActivity.membersRemoved + package: botbuilder-core + summary: The collection of members removed from the conversation. + fullName: membersRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'membersRemoved?: ChannelAccount[]' + return: + description: '' + type: [] + - name: topicName + uid: botbuilder-core.IConversationUpdateActivity.topicName + package: botbuilder-core + summary: The updated topic name of the conversation. + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder-core.IConversationUpdateActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IConversationUpdateActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IConversationUpdateActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IConversationUpdateActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IConversationUpdateActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IConversationUpdateActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IConversationUpdateActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IConversationUpdateActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IConversationUpdateActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IConversationUpdateActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IConversationUpdateActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IConversationUpdateActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEndOfConversationActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEndOfConversationActivity.yml new file mode 100644 index 00000000..6fd45223 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEndOfConversationActivity.yml @@ -0,0 +1,230 @@ +### YamlMime:TSType +name: IEndOfConversationActivity +uid: botbuilder-core.IEndOfConversationActivity +package: botbuilder-core +summary: '' +fullName: IEndOfConversationActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: code + uid: botbuilder-core.IEndOfConversationActivity.code + package: botbuilder-core + summary: >- + The a code for endOfConversation activities that indicates why the + conversation ended. + + Possible values include: 'unknown', 'completedSuccessfully', + 'userCancelled', 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.IEndOfConversationActivity.text + package: botbuilder-core + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder-core.IEndOfConversationActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IEndOfConversationActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IEndOfConversationActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IEndOfConversationActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IEndOfConversationActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IEndOfConversationActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IEndOfConversationActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IEndOfConversationActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IEndOfConversationActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IEndOfConversationActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IEndOfConversationActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IEndOfConversationActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEventActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEventActivity.yml new file mode 100644 index 00000000..8d7a6e52 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IEventActivity.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: IEventActivity +uid: botbuilder-core.IEventActivity +package: botbuilder-core +summary: '' +fullName: IEventActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.IEventActivity.name + package: botbuilder-core + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: relatesTo + uid: botbuilder-core.IEventActivity.relatesTo + package: botbuilder-core + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: value + uid: botbuilder-core.IEventActivity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any +inheritedProperties: + - name: channelData + uid: botbuilder-core.IEventActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IEventActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IEventActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IEventActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IEventActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IEventActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IEventActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IEventActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IEventActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IEventActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IEventActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IEventActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IHandoffActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IHandoffActivity.yml new file mode 100644 index 00000000..678264d5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IHandoffActivity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: IHandoffActivity +uid: botbuilder-core.IHandoffActivity +package: botbuilder-core +summary: '' +fullName: IHandoffActivity +remarks: '' +isDeprecated: false +syntax: | + type IHandoffActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInstallationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInstallationUpdateActivity.yml new file mode 100644 index 00000000..879d0e90 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInstallationUpdateActivity.yml @@ -0,0 +1,215 @@ +### YamlMime:TSType +name: IInstallationUpdateActivity +uid: botbuilder-core.IInstallationUpdateActivity +package: botbuilder-core +summary: '' +fullName: IInstallationUpdateActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder-core.IInstallationUpdateActivity.action + package: botbuilder-core + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder-core.IInstallationUpdateActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IInstallationUpdateActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IInstallationUpdateActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IInstallationUpdateActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IInstallationUpdateActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IInstallationUpdateActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IInstallationUpdateActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IInstallationUpdateActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IInstallationUpdateActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IInstallationUpdateActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IInstallationUpdateActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IInstallationUpdateActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInvokeActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInvokeActivity.yml new file mode 100644 index 00000000..5786c182 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IInvokeActivity.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: IInvokeActivity +uid: botbuilder-core.IInvokeActivity +package: botbuilder-core +summary: '' +fullName: IInvokeActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.IInvokeActivity.name + package: botbuilder-core + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: relatesTo + uid: botbuilder-core.IInvokeActivity.relatesTo + package: botbuilder-core + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: value + uid: botbuilder-core.IInvokeActivity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any +inheritedProperties: + - name: channelData + uid: botbuilder-core.IInvokeActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IInvokeActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IInvokeActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IInvokeActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IInvokeActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IInvokeActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IInvokeActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IInvokeActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IInvokeActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IInvokeActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IInvokeActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IInvokeActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageActivity.yml new file mode 100644 index 00000000..b40bcb0d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageActivity.yml @@ -0,0 +1,389 @@ +### YamlMime:TSType +name: IMessageActivity +uid: botbuilder-core.IMessageActivity +package: botbuilder-core +summary: '' +fullName: IMessageActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: attachmentLayout + uid: botbuilder-core.IMessageActivity.attachmentLayout + package: botbuilder-core + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + - name: attachments + uid: botbuilder-core.IMessageActivity.attachments + package: botbuilder-core + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + - name: deliveryMode + uid: botbuilder-core.IMessageActivity.deliveryMode + package: botbuilder-core + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + - name: expiration + uid: botbuilder-core.IMessageActivity.expiration + package: botbuilder-core + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + - name: importance + uid: botbuilder-core.IMessageActivity.importance + package: botbuilder-core + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + - name: inputHint + uid: botbuilder-core.IMessageActivity.inputHint + package: botbuilder-core + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + - name: locale + uid: botbuilder-core.IMessageActivity.locale + package: botbuilder-core + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: speak + uid: botbuilder-core.IMessageActivity.speak + package: botbuilder-core + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + - name: suggestedActions + uid: botbuilder-core.IMessageActivity.suggestedActions + package: botbuilder-core + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: summary + uid: botbuilder-core.IMessageActivity.summary + package: botbuilder-core + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.IMessageActivity.text + package: botbuilder-core + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: textFormat + uid: botbuilder-core.IMessageActivity.textFormat + package: botbuilder-core + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.IMessageActivity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any +inheritedProperties: + - name: channelData + uid: botbuilder-core.IMessageActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IMessageActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IMessageActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IMessageActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IMessageActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IMessageActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IMessageActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IMessageActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IMessageActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IMessageActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IMessageActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IMessageActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageDeleteActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageDeleteActivity.yml new file mode 100644 index 00000000..cd058efe --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageDeleteActivity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: IMessageDeleteActivity +uid: botbuilder-core.IMessageDeleteActivity +package: botbuilder-core +summary: '' +fullName: IMessageDeleteActivity +remarks: '' +isDeprecated: false +syntax: | + type IMessageDeleteActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageReactionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageReactionActivity.yml new file mode 100644 index 00000000..ad30501a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageReactionActivity.yml @@ -0,0 +1,223 @@ +### YamlMime:TSType +name: IMessageReactionActivity +uid: botbuilder-core.IMessageReactionActivity +package: botbuilder-core +summary: '' +fullName: IMessageReactionActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: reactionsAdded + uid: botbuilder-core.IMessageReactionActivity.reactionsAdded + package: botbuilder-core + summary: The collection of reactions added to the conversation. + fullName: reactionsAdded + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsAdded?: MessageReaction[]' + return: + description: '' + type: [] + - name: reactionsRemoved + uid: botbuilder-core.IMessageReactionActivity.reactionsRemoved + package: botbuilder-core + summary: The collection of reactions removed from the conversation. + fullName: reactionsRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsRemoved?: MessageReaction[]' + return: + description: '' + type: [] +inheritedProperties: + - name: channelData + uid: botbuilder-core.IMessageReactionActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IMessageReactionActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IMessageReactionActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.IMessageReactionActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.IMessageReactionActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IMessageReactionActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.IMessageReactionActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IMessageReactionActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IMessageReactionActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IMessageReactionActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.IMessageReactionActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IMessageReactionActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageUpdateActivity.yml new file mode 100644 index 00000000..a877019e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IMessageUpdateActivity.yml @@ -0,0 +1,429 @@ +### YamlMime:TSType +name: IMessageUpdateActivity +uid: botbuilder-core.IMessageUpdateActivity +package: botbuilder-core +summary: '' +fullName: IMessageUpdateActivity +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: attachmentLayout + uid: botbuilder-core.IMessageUpdateActivity.attachmentLayout + package: botbuilder-core + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachmentLayout](xref:botbuilder-core.IMessageActivity.attachmentLayout) + - name: attachments + uid: botbuilder-core.IMessageUpdateActivity.attachments + package: botbuilder-core + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachments](xref:botbuilder-core.IMessageActivity.attachments) + - name: channelData + uid: botbuilder-core.IMessageUpdateActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.IMessageUpdateActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.IMessageUpdateActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: deliveryMode + uid: botbuilder-core.IMessageUpdateActivity.deliveryMode + package: botbuilder-core + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.deliveryMode](xref:botbuilder-core.IMessageActivity.deliveryMode) + - name: entities + uid: botbuilder-core.IMessageUpdateActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: expiration + uid: botbuilder-core.IMessageUpdateActivity.expiration + package: botbuilder-core + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IMessageActivity.expiration](xref:botbuilder-core.IMessageActivity.expiration) + - name: from + uid: botbuilder-core.IMessageUpdateActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.IMessageUpdateActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: importance + uid: botbuilder-core.IMessageUpdateActivity.importance + package: botbuilder-core + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.importance](xref:botbuilder-core.IMessageActivity.importance) + - name: inputHint + uid: botbuilder-core.IMessageUpdateActivity.inputHint + package: botbuilder-core + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.inputHint](xref:botbuilder-core.IMessageActivity.inputHint) + - name: locale + uid: botbuilder-core.IMessageUpdateActivity.locale + package: botbuilder-core + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.locale](xref:botbuilder-core.IMessageActivity.locale) + - name: localTimestamp + uid: botbuilder-core.IMessageUpdateActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.IMessageUpdateActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.IMessageUpdateActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.IMessageUpdateActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: speak + uid: botbuilder-core.IMessageUpdateActivity.speak + package: botbuilder-core + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.speak](xref:botbuilder-core.IMessageActivity.speak) + - name: suggestedActions + uid: botbuilder-core.IMessageUpdateActivity.suggestedActions + package: botbuilder-core + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IMessageActivity.suggestedActions](xref:botbuilder-core.IMessageActivity.suggestedActions) + - name: summary + uid: botbuilder-core.IMessageUpdateActivity.summary + package: botbuilder-core + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.summary](xref:botbuilder-core.IMessageActivity.summary) + - name: text + uid: botbuilder-core.IMessageUpdateActivity.text + package: botbuilder-core + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.text](xref:botbuilder-core.IMessageActivity.text) + - name: textFormat + uid: botbuilder-core.IMessageUpdateActivity.textFormat + package: botbuilder-core + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.textFormat](xref:botbuilder-core.IMessageActivity.textFormat) + - name: timestamp + uid: botbuilder-core.IMessageUpdateActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.IMessageUpdateActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) + - name: value + uid: botbuilder-core.IMessageUpdateActivity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IMessageActivity.value](xref:botbuilder-core.IMessageActivity.value) +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IStatusCodeError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IStatusCodeError.yml new file mode 100644 index 00000000..30d7b6a4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IStatusCodeError.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: IStatusCodeError +uid: botbuilder-core.IStatusCodeError +package: botbuilder-core +summary: '' +fullName: IStatusCodeError +remarks: '' +isDeprecated: false +type: interface +properties: + - name: message + uid: botbuilder-core.IStatusCodeError.message + package: botbuilder-core + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: string' + return: + description: '' + type: string + - name: statusCode + uid: botbuilder-core.IStatusCodeError.statusCode + package: botbuilder-core + summary: '' + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: StatusCodes' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ISuggestionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ISuggestionActivity.yml new file mode 100644 index 00000000..160d3e8a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ISuggestionActivity.yml @@ -0,0 +1,444 @@ +### YamlMime:TSType +name: ISuggestionActivity +uid: botbuilder-core.ISuggestionActivity +package: botbuilder-core +summary: '' +fullName: ISuggestionActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: textHighlights + uid: botbuilder-core.ISuggestionActivity.textHighlights + package: botbuilder-core + summary: >- + The collection of text fragments to highlight when the activity contains a + ReplyToId value. + fullName: textHighlights + remarks: '' + isDeprecated: false + syntax: + content: 'textHighlights?: TextHighlight[]' + return: + description: '' + type: [] +inheritedProperties: + - name: attachmentLayout + uid: botbuilder-core.ISuggestionActivity.attachmentLayout + package: botbuilder-core + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachmentLayout](xref:botbuilder-core.IMessageActivity.attachmentLayout) + - name: attachments + uid: botbuilder-core.ISuggestionActivity.attachments + package: botbuilder-core + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachments](xref:botbuilder-core.IMessageActivity.attachments) + - name: channelData + uid: botbuilder-core.ISuggestionActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.ISuggestionActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.ISuggestionActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: deliveryMode + uid: botbuilder-core.ISuggestionActivity.deliveryMode + package: botbuilder-core + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.deliveryMode](xref:botbuilder-core.IMessageActivity.deliveryMode) + - name: entities + uid: botbuilder-core.ISuggestionActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: expiration + uid: botbuilder-core.ISuggestionActivity.expiration + package: botbuilder-core + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IMessageActivity.expiration](xref:botbuilder-core.IMessageActivity.expiration) + - name: from + uid: botbuilder-core.ISuggestionActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.ISuggestionActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: importance + uid: botbuilder-core.ISuggestionActivity.importance + package: botbuilder-core + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.importance](xref:botbuilder-core.IMessageActivity.importance) + - name: inputHint + uid: botbuilder-core.ISuggestionActivity.inputHint + package: botbuilder-core + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.inputHint](xref:botbuilder-core.IMessageActivity.inputHint) + - name: locale + uid: botbuilder-core.ISuggestionActivity.locale + package: botbuilder-core + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.locale](xref:botbuilder-core.IMessageActivity.locale) + - name: localTimestamp + uid: botbuilder-core.ISuggestionActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.ISuggestionActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.ISuggestionActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.ISuggestionActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: speak + uid: botbuilder-core.ISuggestionActivity.speak + package: botbuilder-core + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.speak](xref:botbuilder-core.IMessageActivity.speak) + - name: suggestedActions + uid: botbuilder-core.ISuggestionActivity.suggestedActions + package: botbuilder-core + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IMessageActivity.suggestedActions](xref:botbuilder-core.IMessageActivity.suggestedActions) + - name: summary + uid: botbuilder-core.ISuggestionActivity.summary + package: botbuilder-core + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.summary](xref:botbuilder-core.IMessageActivity.summary) + - name: text + uid: botbuilder-core.ISuggestionActivity.text + package: botbuilder-core + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.text](xref:botbuilder-core.IMessageActivity.text) + - name: textFormat + uid: botbuilder-core.ISuggestionActivity.textFormat + package: botbuilder-core + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.textFormat](xref:botbuilder-core.IMessageActivity.textFormat) + - name: timestamp + uid: botbuilder-core.ISuggestionActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.ISuggestionActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) + - name: value + uid: botbuilder-core.ISuggestionActivity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IMessageActivity.value](xref:botbuilder-core.IMessageActivity.value) +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITraceActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITraceActivity.yml new file mode 100644 index 00000000..5cb3e0c9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITraceActivity.yml @@ -0,0 +1,259 @@ +### YamlMime:TSType +name: ITraceActivity +uid: botbuilder-core.ITraceActivity +package: botbuilder-core +summary: '' +fullName: ITraceActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: label + uid: botbuilder-core.ITraceActivity.label + package: botbuilder-core + summary: A descriptive label for the activity. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.ITraceActivity.name + package: botbuilder-core + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: relatesTo + uid: botbuilder-core.ITraceActivity.relatesTo + package: botbuilder-core + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: value + uid: botbuilder-core.ITraceActivity.value + package: botbuilder-core + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + - name: valueType + uid: botbuilder-core.ITraceActivity.valueType + package: botbuilder-core + summary: The type of the activity's value object. + fullName: valueType + remarks: '' + isDeprecated: false + syntax: + content: 'valueType: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder-core.ITraceActivity.channelData + package: botbuilder-core + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder-core.IActivity.channelData) + - name: channelId + uid: botbuilder-core.ITraceActivity.channelId + package: botbuilder-core + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder-core.IActivity.channelId) + - name: conversation + uid: botbuilder-core.ITraceActivity.conversation + package: botbuilder-core + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder-core.IActivity.conversation) + - name: entities + uid: botbuilder-core.ITraceActivity.entities + package: botbuilder-core + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder-core.IActivity.entities) + - name: from + uid: botbuilder-core.ITraceActivity.from + package: botbuilder-core + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.from](xref:botbuilder-core.IActivity.from) + - name: id + uid: botbuilder-core.ITraceActivity.id + package: botbuilder-core + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder-core.IActivity.id) + - name: localTimestamp + uid: botbuilder-core.ITraceActivity.localTimestamp + package: botbuilder-core + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder-core.IActivity.localTimestamp) + - name: recipient + uid: botbuilder-core.ITraceActivity.recipient + package: botbuilder-core + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder-core.IActivity.recipient) + - name: replyToId + uid: botbuilder-core.ITraceActivity.replyToId + package: botbuilder-core + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder-core.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder-core.ITraceActivity.serviceUrl + package: botbuilder-core + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder-core.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder-core.ITraceActivity.timestamp + package: botbuilder-core + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder-core.IActivity.timestamp) + - name: type + uid: botbuilder-core.ITraceActivity.type + package: botbuilder-core + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.type](xref:botbuilder-core.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITypingActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITypingActivity.yml new file mode 100644 index 00000000..abe7efcd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ITypingActivity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ITypingActivity +uid: botbuilder-core.ITypingActivity +package: botbuilder-core +summary: '' +fullName: ITypingActivity +remarks: '' +isDeprecated: false +syntax: | + type ITypingActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IUserTokenProvider.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IUserTokenProvider.yml index 324e2665..30faa205 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IUserTokenProvider.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IUserTokenProvider.yml @@ -5,44 +5,43 @@ package: botbuilder-core summary: Interface for User Token OAuth APIs for BotAdapters fullName: IUserTokenProvider remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Use `UserTokenClient` instead. type: interface methods: - - name: 'getAadTokens(TurnContext, string, string[])' + - name: getAadTokens(TurnContext, string, string[]) uid: botbuilder-core.IUserTokenProvider.getAadTokens package: botbuilder-core summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAadTokens(context: TurnContext, connectionName: string, - resourceUrls: string[]): Promise<[key: string]: TokenResponse> + resourceUrls: string[]): Promise<{[propertyName: string]: + TokenResponse}> parameters: - id: context type: description: Context for the current turn of conversation with the user. - id: connectionName type: string - description: | - Name of the auth connection to use. + description: Name of the auth connection to use. - id: resourceUrls - type: 'string[]' + type: string[] description: '' return: description: '' - type: 'Promise<[key: string]: TokenResponse>' - - name: 'getSignInLink(TurnContext, string)' + type: >- + Promise<{[propertyName: string]: }> + - name: getSignInLink(TurnContext, string) uid: botbuilder-core.IUserTokenProvider.getSignInLink package: botbuilder-core summary: >- Gets a signin link from the token server that can be sent as part of a SigninCard. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -54,19 +53,17 @@ methods: description: Context for the current turn of conversation with the user. - id: connectionName type: string - description: | - Name of the auth connection to use. + description: Name of the auth connection to use. return: description: '' type: Promise<string> - - name: 'getTokenStatus(TurnContext, string, string, any)' + - name: getTokenStatus(TurnContext, string, string, any) uid: botbuilder-core.IUserTokenProvider.getTokenStatus package: botbuilder-core summary: >- Retrieves the token status for each configured connection for the given user, using the bot's AppCredentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -86,17 +83,15 @@ methods: token status for all configured connections. - id: oAuthAppCredentials type: any - description: | - The app credentials for OAuth. + description: The app credentials for OAuth. return: description: '' - type: 'Promise<any[]>' - - name: 'getUserToken(TurnContext, string, string)' + type: Promise<any[]> + - name: getUserToken(TurnContext, string, string) uid: botbuilder-core.IUserTokenProvider.getUserToken package: botbuilder-core summary: Retrieves the OAuth token for a user that is in a sign-in flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -111,17 +106,15 @@ methods: description: Name of the auth connection to use. - id: magicCode type: string - description: | - (Optional) Optional user entered code to validate. + description: (Optional) Optional user entered code to validate. return: description: '' - type: Promise<TokenResponse> - - name: 'signOutUser(TurnContext, string, string)' + type: Promise<> + - name: signOutUser(TurnContext, string, string) uid: botbuilder-core.IUserTokenProvider.signOutUser package: botbuilder-core summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -136,8 +129,7 @@ methods: description: Name of the auth connection to use. - id: userId type: string - description: | - User id of user to sign out. + description: User id of user to sign out. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Importance.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Importance.yml new file mode 100644 index 00000000..a9a25829 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Importance.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Importance +uid: botbuilder-core.Importance +package: botbuilder-core +summary: |- + Defines values for Importance. + Possible values include: 'normal', 'high', 'urgent' +fullName: Importance +remarks: '' +isDeprecated: false +syntax: | + type Importance = "normal" | "high" | "urgent" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InnerHttpError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InnerHttpError.yml new file mode 100644 index 00000000..f29ee65d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InnerHttpError.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: InnerHttpError +uid: botbuilder-core.InnerHttpError +package: botbuilder-core +summary: Object representing inner http error +fullName: InnerHttpError +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.InnerHttpError.body + package: botbuilder-core + summary: Body from failed request + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: any' + return: + description: '' + type: any + - name: statusCode + uid: botbuilder-core.InnerHttpError.statusCode + package: botbuilder-core + summary: HttpStatusCode from failed request + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InputHints.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InputHints.yml new file mode 100644 index 00000000..12e2112e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InputHints.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: InputHints +uid: botbuilder-core.InputHints +package: botbuilder-core +summary: |- + Defines values for InputHints. + Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput' +fullName: InputHints +remarks: '' +isDeprecated: false +fields: + - name: AcceptingInput + uid: botbuilder-core.InputHints.AcceptingInput + package: botbuilder-core + summary: '' + - name: ExpectingInput + uid: botbuilder-core.InputHints.ExpectingInput + package: botbuilder-core + summary: '' + - name: IgnoringInput + uid: botbuilder-core.InputHints.IgnoringInput + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InstallationUpdateActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InstallationUpdateActionTypes.yml new file mode 100644 index 00000000..60cb41c6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InstallationUpdateActionTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: InstallationUpdateActionTypes +uid: botbuilder-core.InstallationUpdateActionTypes +package: botbuilder-core +summary: |- + Defines values for InstallationUpdateActionTypes. + Possible values include: 'add', 'remove' +fullName: InstallationUpdateActionTypes +remarks: '' +isDeprecated: false +fields: + - name: Add + uid: botbuilder-core.InstallationUpdateActionTypes.Add + package: botbuilder-core + summary: '' + - name: Remove + uid: botbuilder-core.InstallationUpdateActionTypes.Remove + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IntentScore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IntentScore.yml index 8519813d..047ca875 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IntentScore.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/IntentScore.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Score plus any extra information about an intent. fullName: IntentScore remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Gets or sets confidence in an intent. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeException.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeException.yml index b44a3d4b..d44213b6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeException.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeException.yml @@ -5,41 +5,24 @@ package: botbuilder-core summary: A custom exception for invoke response errors. fullName: InvokeException remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'InvokeException(StatusCodes, T)' + - name: InvokeException(StatusCodes, T) uid: botbuilder-core.InvokeException.constructor package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new InvokeException(status: StatusCodes, response?: T)' parameters: - id: status - type: StatusCodes + type: description: The Http status code of the error. - id: response type: T - description: | - optional. The body of the exception. Default is null. -properties: - - name: Error - uid: botbuilder-core.InvokeException.Error - package: botbuilder-core - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor + description: optional. The body of the exception. Default is null. inheritedProperties: - name: message uid: botbuilder-core.InvokeException.message @@ -47,7 +30,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -61,7 +43,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -69,13 +50,28 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: botbuilder-core.InvokeException.prepareStackTrace + package: botbuilder-core + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: botbuilder-core.InvokeException.stack package: botbuilder-core summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -83,6 +79,38 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: botbuilder-core.InvokeException.stackTraceLimit + package: botbuilder-core + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: botbuilder-core.InvokeException.captureStackTrace + package: botbuilder-core + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace methods: - name: createInvokeResponse() uid: botbuilder-core.InvokeException.createInvokeResponse @@ -92,11 +120,10 @@ methods: [InvokeResponse](xref:botbuilder-core.InvokeResponse) object with the status code and body of the current object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function createInvokeResponse(): InvokeResponse' + content: 'function createInvokeResponse(): InvokeResponse' return: - description: 'A new [InvokeResponse](xref:botbuilder-core.InvokeResponse) object.' - type: InvokeResponse + description: A new [InvokeResponse](xref:botbuilder-core.InvokeResponse) object. + type: <any> extends: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeResponse.yml new file mode 100644 index 00000000..a8920fbc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/InvokeResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: InvokeResponse +uid: botbuilder-core.InvokeResponse +package: botbuilder-core +summary: >- + Represents a response returned by a bot when it receives an `invoke` activity. + + + This interface supports the framework and is not intended to be called + directly for your code. +fullName: InvokeResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.InvokeResponse.body + package: botbuilder-core + summary: Optional. The body of the response. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: T' + return: + description: '' + type: T + - name: status + uid: botbuilder-core.InvokeResponse.status + package: botbuilder-core + summary: The HTTP status code of the response. + fullName: status + remarks: '' + isDeprecated: false + syntax: + content: 'status: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Location.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Location.yml new file mode 100644 index 00000000..280e09ac --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Location.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: Location +uid: botbuilder-core.Location +package: botbuilder-core +summary: Interface for location coordinates +fullName: Location +remarks: '' +isDeprecated: false +type: interface +properties: + - name: accuracy + uid: botbuilder-core.Location.accuracy + package: botbuilder-core + summary: Accuracy of the location. + fullName: accuracy + remarks: '' + isDeprecated: false + syntax: + content: 'accuracy?: number' + return: + description: '' + type: number + - name: latitude + uid: botbuilder-core.Location.latitude + package: botbuilder-core + summary: Latitude of the location. + fullName: latitude + remarks: '' + isDeprecated: false + syntax: + content: 'latitude: number' + return: + description: '' + type: number + - name: longitude + uid: botbuilder-core.Location.longitude + package: botbuilder-core + summary: Longitude of the location. + fullName: longitude + remarks: '' + isDeprecated: false + syntax: + content: 'longitude: number' + return: + description: '' + type: number + - name: timestamp + uid: botbuilder-core.Location.timestamp + package: botbuilder-core + summary: Timestamp in ISO milliseconds since epoch. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaCard.yml new file mode 100644 index 00000000..ae5cac39 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: MediaCard +uid: botbuilder-core.MediaCard +package: botbuilder-core +summary: Media card +fullName: MediaCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder-core.MediaCard.aspect + package: botbuilder-core + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder-core.MediaCard.autoloop + package: botbuilder-core + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder-core.MediaCard.autostart + package: botbuilder-core + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder-core.MediaCard.buttons + package: botbuilder-core + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder-core.MediaCard.duration + package: botbuilder-core + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder-core.MediaCard.image + package: botbuilder-core + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder-core.MediaCard.media + package: botbuilder-core + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder-core.MediaCard.shareable + package: botbuilder-core + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder-core.MediaCard.subtitle + package: botbuilder-core + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.MediaCard.text + package: botbuilder-core + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.MediaCard.title + package: botbuilder-core + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.MediaCard.value + package: botbuilder-core + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaEventValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaEventValue.yml new file mode 100644 index 00000000..fa53dd08 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaEventValue.yml @@ -0,0 +1,24 @@ +### YamlMime:TSType +name: MediaEventValue +uid: botbuilder-core.MediaEventValue +package: botbuilder-core +summary: Supplementary parameter for media events +fullName: MediaEventValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardValue + uid: botbuilder-core.MediaEventValue.cardValue + package: botbuilder-core + summary: >- + Callback parameter specified in the Value field of the MediaCard that + originated this event + fullName: cardValue + remarks: '' + isDeprecated: false + syntax: + content: 'cardValue: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaType.yml new file mode 100644 index 00000000..59dae1e3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaType.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: MediaType +uid: botbuilder-core.MediaType +package: botbuilder-core +summary: Enum value to specify the type of media for VivaAction.SelectMedia action. +fullName: MediaType +remarks: '' +isDeprecated: false +fields: + - name: Image + uid: botbuilder-core.MediaType.Image + package: botbuilder-core + summary: '' + numericValue: 1 + - name: Audio + uid: botbuilder-core.MediaType.Audio + package: botbuilder-core + summary: '' + numericValue: 4 + - name: Document + uid: botbuilder-core.MediaType.Document + package: botbuilder-core + summary: '' + numericValue: 8 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaUrl.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaUrl.yml new file mode 100644 index 00000000..cf333e11 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MediaUrl.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: MediaUrl +uid: botbuilder-core.MediaUrl +package: botbuilder-core +summary: Media URL +fullName: MediaUrl +remarks: '' +isDeprecated: false +type: interface +properties: + - name: profile + uid: botbuilder-core.MediaUrl.profile + package: botbuilder-core + summary: >- + Optional profile hint to the client to differentiate multiple MediaUrl + objects from each other + fullName: profile + remarks: '' + isDeprecated: false + syntax: + content: 'profile?: string' + return: + description: '' + type: string + - name: url + uid: botbuilder-core.MediaUrl.url + package: botbuilder-core + summary: Url for the media + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Meeting.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Meeting.yml new file mode 100644 index 00000000..5bf2854a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Meeting.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: Meeting +uid: botbuilder-core.Meeting +package: botbuilder-core +summary: '' +fullName: Meeting +remarks: '' +isDeprecated: false +type: interface +properties: + - name: inMeeting + uid: botbuilder-core.Meeting.inMeeting + package: botbuilder-core + summary: Indicates if the participant is in the meeting. + fullName: inMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'inMeeting?: boolean' + return: + description: '' + type: boolean + - name: role + uid: botbuilder-core.Meeting.role + package: botbuilder-core + summary: Meeting role of the user. + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingDetails.yml new file mode 100644 index 00000000..99e18d0a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingDetails.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: MeetingDetails +uid: botbuilder-core.MeetingDetails +package: botbuilder-core +summary: '' +fullName: MeetingDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: msGraphResourceId + uid: botbuilder-core.MeetingDetails.msGraphResourceId + package: botbuilder-core + summary: The MsGraphResourceId, used specifically for MS Graph API calls. + fullName: msGraphResourceId + remarks: '' + isDeprecated: false + syntax: + content: 'msGraphResourceId: string' + return: + description: '' + type: string + - name: scheduledEndTime + uid: botbuilder-core.MeetingDetails.scheduledEndTime + package: botbuilder-core + summary: The meeting's scheduled end time, in UTC. + fullName: scheduledEndTime + remarks: '' + isDeprecated: false + syntax: + content: 'scheduledEndTime?: Date' + return: + description: '' + type: Date + - name: scheduledStartTime + uid: botbuilder-core.MeetingDetails.scheduledStartTime + package: botbuilder-core + summary: The meeting's scheduled start time, in UTC. + fullName: scheduledStartTime + remarks: '' + isDeprecated: false + syntax: + content: 'scheduledStartTime?: Date' + return: + description: '' + type: Date + - name: type + uid: botbuilder-core.MeetingDetails.type + package: botbuilder-core + summary: The meeting's type. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.MeetingDetails.id + package: botbuilder-core + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.id + - name: joinUrl + uid: botbuilder-core.MeetingDetails.joinUrl + package: botbuilder-core + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.joinUrl + - name: title + uid: botbuilder-core.MeetingDetails.title + package: botbuilder-core + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.title +extends: MeetingDetailsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEndEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEndEventDetails.yml new file mode 100644 index 00000000..93dc3286 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEndEventDetails.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: MeetingEndEventDetails +uid: botbuilder-core.MeetingEndEventDetails +package: botbuilder-core +summary: '' +fullName: MeetingEndEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: endTime + uid: botbuilder-core.MeetingEndEventDetails.endTime + package: botbuilder-core + summary: Timestamp for meeting end, in UTC. + fullName: endTime + remarks: '' + isDeprecated: false + syntax: + content: 'endTime: Date' + return: + description: '' + type: Date +inheritedProperties: + - name: id + uid: botbuilder-core.MeetingEndEventDetails.id + package: botbuilder-core + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.id](xref:botbuilder-core.MeetingEventDetails.id) + - name: joinUrl + uid: botbuilder-core.MeetingEndEventDetails.joinUrl + package: botbuilder-core + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.joinUrl](xref:botbuilder-core.MeetingEventDetails.joinUrl) + - name: meetingType + uid: botbuilder-core.MeetingEndEventDetails.meetingType + package: botbuilder-core + summary: The meeting's type. + fullName: meetingType + remarks: '' + isDeprecated: false + syntax: + content: 'meetingType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.meetingType](xref:botbuilder-core.MeetingEventDetails.meetingType) + - name: title + uid: botbuilder-core.MeetingEndEventDetails.title + package: botbuilder-core + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.title](xref:botbuilder-core.MeetingEventDetails.title) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEventDetails.yml new file mode 100644 index 00000000..096b940a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingEventDetails.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: MeetingEventDetails +uid: botbuilder-core.MeetingEventDetails +package: botbuilder-core +summary: '' +fullName: MeetingEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: meetingType + uid: botbuilder-core.MeetingEventDetails.meetingType + package: botbuilder-core + summary: The meeting's type. + fullName: meetingType + remarks: '' + isDeprecated: false + syntax: + content: 'meetingType: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder-core.MeetingEventDetails.id + package: botbuilder-core + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.id + - name: joinUrl + uid: botbuilder-core.MeetingEventDetails.joinUrl + package: botbuilder-core + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.joinUrl + - name: title + uid: botbuilder-core.MeetingEventDetails.title + package: botbuilder-core + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.title +extends: MeetingDetailsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingInfo.yml new file mode 100644 index 00000000..4dfc0e0a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MeetingInfo +uid: botbuilder-core.MeetingInfo +package: botbuilder-core +summary: '' +fullName: MeetingInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversation + uid: botbuilder-core.MeetingInfo.conversation + package: botbuilder-core + summary: The Conversation Account for the meeting. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: details + uid: botbuilder-core.MeetingInfo.details + package: botbuilder-core + summary: The specific details of a Teams meeting. + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: MeetingDetails' + return: + description: '' + type: + - name: organizer + uid: botbuilder-core.MeetingInfo.organizer + package: botbuilder-core + summary: The organizer's user information. + fullName: organizer + remarks: '' + isDeprecated: false + syntax: + content: 'organizer: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotification.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotification.yml new file mode 100644 index 00000000..908adde3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotification.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MeetingNotification +uid: botbuilder-core.MeetingNotification +package: botbuilder-core +summary: '' +fullName: MeetingNotification +remarks: '' +isDeprecated: false +syntax: | + type MeetingNotification = TargetedMeetingNotification diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationBase.yml new file mode 100644 index 00000000..9a808425 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationBase.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MeetingNotificationBase +uid: botbuilder-core.MeetingNotificationBase +package: botbuilder-core +summary: '' +fullName: MeetingNotificationBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder-core.MeetingNotificationBase.type + package: botbuilder-core + summary: The type of meeting notification. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.MeetingNotificationBase.value + package: botbuilder-core + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T' + return: + description: '' + type: T diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationChannelData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationChannelData.yml new file mode 100644 index 00000000..ba321d9f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationChannelData.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MeetingNotificationChannelData +uid: botbuilder-core.MeetingNotificationChannelData +package: botbuilder-core +summary: '' +fullName: MeetingNotificationChannelData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: onBehalfOf + uid: botbuilder-core.MeetingNotificationChannelData.onBehalfOf + package: botbuilder-core + summary: The user that the bot is sending the notification on behalfOf, if any. + fullName: onBehalfOf + remarks: '' + isDeprecated: false + syntax: + content: 'onBehalfOf?: OnBehalfOf[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationRecipientFailureInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationRecipientFailureInfo.yml new file mode 100644 index 00000000..a2521696 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationRecipientFailureInfo.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: MeetingNotificationRecipientFailureInfo +uid: botbuilder-core.MeetingNotificationRecipientFailureInfo +package: botbuilder-core +summary: '' +fullName: MeetingNotificationRecipientFailureInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: errorCode + uid: botbuilder-core.MeetingNotificationRecipientFailureInfo.errorCode + package: botbuilder-core + summary: The error code. + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: failureReason + uid: botbuilder-core.MeetingNotificationRecipientFailureInfo.failureReason + package: botbuilder-core + summary: >- + The reason for which the meetings notification could not be sent to the + recipient. + fullName: failureReason + remarks: '' + isDeprecated: false + syntax: + content: 'failureReason: string' + return: + description: '' + type: string + - name: recipientMri + uid: botbuilder-core.MeetingNotificationRecipientFailureInfo.recipientMri + package: botbuilder-core + summary: The targeted recipient's MRI. + fullName: recipientMri + remarks: '' + isDeprecated: false + syntax: + content: 'recipientMri: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationResponse.yml new file mode 100644 index 00000000..c844b0fe --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingNotificationResponse.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: MeetingNotificationResponse +uid: botbuilder-core.MeetingNotificationResponse +package: botbuilder-core +summary: '' +fullName: MeetingNotificationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: recipientsFailureInfo + uid: botbuilder-core.MeetingNotificationResponse.recipientsFailureInfo + package: botbuilder-core + summary: >- + The list of recipients that failed to recieve the sent meetings + notification. + fullName: recipientsFailureInfo + remarks: '' + isDeprecated: false + syntax: + content: 'recipientsFailureInfo?: MeetingNotificationRecipientFailureInfo[]' + return: + description: '' + type: >- + [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingParticipantsEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingParticipantsEventDetails.yml new file mode 100644 index 00000000..28615d46 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingParticipantsEventDetails.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MeetingParticipantsEventDetails +uid: botbuilder-core.MeetingParticipantsEventDetails +package: botbuilder-core +summary: '' +fullName: MeetingParticipantsEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: members + uid: botbuilder-core.MeetingParticipantsEventDetails.members + package: botbuilder-core + summary: The participants info. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: TeamsMeetingMember[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStageSurface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStageSurface.yml new file mode 100644 index 00000000..8cbf92e7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStageSurface.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MeetingStageSurface +uid: botbuilder-core.MeetingStageSurface +package: botbuilder-core +summary: '' +fullName: MeetingStageSurface +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder-core.MeetingStageSurface.content + package: botbuilder-core + summary: The content to display in the meeting notification. + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content: T' + return: + description: '' + type: T + - name: contentType + uid: botbuilder-core.MeetingStageSurface.contentType + package: botbuilder-core + summary: The content type. + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: "task"' + return: + description: '' + type: '"task"' + - name: surface + uid: botbuilder-core.MeetingStageSurface.surface + package: botbuilder-core + summary: The surface type. + fullName: surface + remarks: '' + isDeprecated: false + syntax: + content: 'surface: "meetingStage"' + return: + description: '' + type: '"meetingStage"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStartEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStartEventDetails.yml new file mode 100644 index 00000000..412390d9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingStartEventDetails.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: MeetingStartEventDetails +uid: botbuilder-core.MeetingStartEventDetails +package: botbuilder-core +summary: '' +fullName: MeetingStartEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: startTime + uid: botbuilder-core.MeetingStartEventDetails.startTime + package: botbuilder-core + summary: Timestamp for meeting start, in UTC. + fullName: startTime + remarks: '' + isDeprecated: false + syntax: + content: 'startTime: Date' + return: + description: '' + type: Date +inheritedProperties: + - name: id + uid: botbuilder-core.MeetingStartEventDetails.id + package: botbuilder-core + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.id](xref:botbuilder-core.MeetingEventDetails.id) + - name: joinUrl + uid: botbuilder-core.MeetingStartEventDetails.joinUrl + package: botbuilder-core + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.joinUrl](xref:botbuilder-core.MeetingEventDetails.joinUrl) + - name: meetingType + uid: botbuilder-core.MeetingStartEventDetails.meetingType + package: botbuilder-core + summary: The meeting's type. + fullName: meetingType + remarks: '' + isDeprecated: false + syntax: + content: 'meetingType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.meetingType](xref:botbuilder-core.MeetingEventDetails.meetingType) + - name: title + uid: botbuilder-core.MeetingStartEventDetails.title + package: botbuilder-core + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.title](xref:botbuilder-core.MeetingEventDetails.title) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingSurface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingSurface.yml new file mode 100644 index 00000000..26cb6fe8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingSurface.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MeetingSurface +uid: botbuilder-core.MeetingSurface +package: botbuilder-core +summary: '' +fullName: MeetingSurface +remarks: '' +isDeprecated: false +syntax: | + type MeetingSurface = MeetingStageSurface | MeetingTabIconSurface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingTabIconSurface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingTabIconSurface.yml new file mode 100644 index 00000000..59a26ac4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MeetingTabIconSurface.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MeetingTabIconSurface +uid: botbuilder-core.MeetingTabIconSurface +package: botbuilder-core +summary: '' +fullName: MeetingTabIconSurface +remarks: '' +isDeprecated: false +type: interface +properties: + - name: surface + uid: botbuilder-core.MeetingTabIconSurface.surface + package: botbuilder-core + summary: The surface type. + fullName: surface + remarks: '' + isDeprecated: false + syntax: + content: 'surface: "meetingTabIcon"' + return: + description: '' + type: '"meetingTabIcon"' + - name: tabEntityId + uid: botbuilder-core.MeetingTabIconSurface.tabEntityId + package: botbuilder-core + summary: The tab entity ID. + fullName: tabEntityId + remarks: '' + isDeprecated: false + syntax: + content: 'tabEntityId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryStorage.yml index f700eb06..780df023 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryStorage.yml @@ -30,56 +30,52 @@ remarks: >- const storage = new MemoryStorage(); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'MemoryStorage([key: string]: string)' + - name: 'MemoryStorage({[k: string]: string})' uid: botbuilder-core.MemoryStorage.constructor package: botbuilder-core summary: Creates a new MemoryStorage instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new MemoryStorage(memory?: [key: string]: string)' + content: 'new MemoryStorage(memory?: {[k: string]: string})' parameters: - id: memory - type: '[key: string]\: string' - description: > + type: '{[k: string]: string}' + description: >- (Optional) memory to use for storing items. By default it will create an empty JSON object `{}`. methods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-core.MemoryStorage.delete package: botbuilder-core summary: Deletes storage items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: >- Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to delete. return: description: A promise representing the async operation. type: Promise<void> - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-core.MemoryStorage.read package: botbuilder-core summary: Reads storage items from storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' + type: string[] description: >- Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to read. @@ -91,7 +87,6 @@ methods: package: botbuilder-core summary: Writes storage items to storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryTranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryTranscriptStore.yml index 94fed918..31c5f5d4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryTranscriptStore.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MemoryTranscriptStore.yml @@ -9,16 +9,14 @@ remarks: >- for unit tests or non-production environments. -isPreview: false isDeprecated: false type: class methods: - - name: 'deleteTranscript(string, string)' + - name: deleteTranscript(string, string) uid: botbuilder-core.MemoryTranscriptStore.deleteTranscript package: botbuilder-core summary: Delete a specific conversation and all of it's activities. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,12 +32,11 @@ methods: return: description: A promise representing the async operation. type: Promise<void> - - name: 'getTranscriptActivities(string, string, string, Date)' + - name: getTranscriptActivities(string, string, string, Date) uid: botbuilder-core.MemoryTranscriptStore.getTranscriptActivities package: botbuilder-core summary: Get activities from the memory transcript store. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -62,14 +59,13 @@ methods: return: description: A page of matching activities. type: >- - Promise<<Activity>> - - name: 'listTranscripts(string, string)' + Promise<<>> + - name: listTranscripts(string, string) uid: botbuilder-core.MemoryTranscriptStore.listTranscripts package: botbuilder-core summary: List conversations in the channelId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -92,13 +88,12 @@ methods: package: botbuilder-core summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logActivity(activity: Activity): void | Promise' parameters: - id: activity - type: Activity + type: description: Activity to log. return: description: A promise representing the async operation. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Mention.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Mention.yml new file mode 100644 index 00000000..eec1ff90 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Mention.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Mention +uid: botbuilder-core.Mention +package: botbuilder-core +summary: 'Mention information (entity type: "mention")' +fullName: Mention +remarks: '' +isDeprecated: false +type: interface +properties: + - name: mentioned + uid: botbuilder-core.Mention.mentioned + package: botbuilder-core + summary: The mentioned user + fullName: mentioned + remarks: '' + isDeprecated: false + syntax: + content: 'mentioned: ChannelAccount' + return: + description: '' + type: + - name: text + uid: botbuilder-core.Mention.text + package: botbuilder-core + summary: Sub Text which represents the mention (can be null or empty) + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.Mention.type + package: botbuilder-core + summary: Type of this entity (RFC 3987 IRI) + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayload.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayload.yml new file mode 100644 index 00000000..a6baa898 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayload.yml @@ -0,0 +1,214 @@ +### YamlMime:TSType +name: MessageActionsPayload +uid: botbuilder-core.MessageActionsPayload +package: botbuilder-core +summary: '' +fullName: MessageActionsPayload +remarks: '' +isDeprecated: false +type: interface +properties: + - name: attachmentLayout + uid: botbuilder-core.MessageActionsPayload.attachmentLayout + package: botbuilder-core + summary: How the attachment(s) are displayed in + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + - name: attachments + uid: botbuilder-core.MessageActionsPayload.attachments + package: botbuilder-core + summary: Attachments in + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: MessageActionsPayloadAttachment[]' + return: + description: '' + type: [] + - name: body + uid: botbuilder-core.MessageActionsPayload.body + package: botbuilder-core + summary: Plaintext/HTML representation + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: MessageActionsPayloadBody' + return: + description: '' + type: + - name: createdDateTime + uid: botbuilder-core.MessageActionsPayload.createdDateTime + package: botbuilder-core + summary: Timestamp of when the message was + fullName: createdDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'createdDateTime?: string' + return: + description: '' + type: string + - name: deleted + uid: botbuilder-core.MessageActionsPayload.deleted + package: botbuilder-core + summary: Indicates whether a message has been soft + fullName: deleted + remarks: '' + isDeprecated: false + syntax: + content: 'deleted?: boolean' + return: + description: '' + type: boolean + - name: from + uid: botbuilder-core.MessageActionsPayload.from + package: botbuilder-core + summary: Sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from?: MessageActionsPayloadFrom' + return: + description: '' + type: + - name: id + uid: botbuilder-core.MessageActionsPayload.id + package: botbuilder-core + summary: Unique id of the message. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: importance + uid: botbuilder-core.MessageActionsPayload.importance + package: botbuilder-core + summary: The importance of the message. Possible + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: Importance' + return: + description: '' + type: + - name: lastModifiedDateTime + uid: botbuilder-core.MessageActionsPayload.lastModifiedDateTime + package: botbuilder-core + summary: Timestamp of when the message was + fullName: lastModifiedDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'lastModifiedDateTime?: string' + return: + description: '' + type: string + - name: linkToMessage + uid: botbuilder-core.MessageActionsPayload.linkToMessage + package: botbuilder-core + summary: Link back to the message. + fullName: linkToMessage + remarks: '' + isDeprecated: false + syntax: + content: 'linkToMessage?: string' + return: + description: '' + type: string + - name: locale + uid: botbuilder-core.MessageActionsPayload.locale + package: botbuilder-core + summary: Locale of the message set by the client. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: mentions + uid: botbuilder-core.MessageActionsPayload.mentions + package: botbuilder-core + summary: List of entities + fullName: mentions + remarks: '' + isDeprecated: false + syntax: + content: 'mentions?: MessageActionsPayloadMention[]' + return: + description: '' + type: [] + - name: messageType + uid: botbuilder-core.MessageActionsPayload.messageType + package: botbuilder-core + summary: Type of message - automatically set to + fullName: messageType + remarks: '' + isDeprecated: false + syntax: + content: 'messageType?: "message"' + return: + description: '' + type: '"message"' + - name: reactions + uid: botbuilder-core.MessageActionsPayload.reactions + package: botbuilder-core + summary: Reactions for the + fullName: reactions + remarks: '' + isDeprecated: false + syntax: + content: 'reactions?: MessageActionsPayloadReaction[]' + return: + description: '' + type: [] + - name: replyToId + uid: botbuilder-core.MessageActionsPayload.replyToId + package: botbuilder-core + summary: Id of the parent/root message of the thread. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + - name: subject + uid: botbuilder-core.MessageActionsPayload.subject + package: botbuilder-core + summary: Subject line of the message. + fullName: subject + remarks: '' + isDeprecated: false + syntax: + content: 'subject?: string' + return: + description: '' + type: string + - name: summary + uid: botbuilder-core.MessageActionsPayload.summary + package: botbuilder-core + summary: Summary text of the message that could be used + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadApp.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadApp.yml new file mode 100644 index 00000000..1e5c0287 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadApp.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadApp +uid: botbuilder-core.MessageActionsPayloadApp +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadApp +remarks: '' +isDeprecated: false +type: interface +properties: + - name: applicationIdentityType + uid: botbuilder-core.MessageActionsPayloadApp.applicationIdentityType + package: botbuilder-core + summary: The type of + fullName: applicationIdentityType + remarks: '' + isDeprecated: false + syntax: + content: 'applicationIdentityType?: ApplicationIdentityType' + return: + description: '' + type: + - name: displayName + uid: botbuilder-core.MessageActionsPayloadApp.displayName + package: botbuilder-core + summary: The plaintext display name of the + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.MessageActionsPayloadApp.id + package: botbuilder-core + summary: The id of the application. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadAttachment.yml new file mode 100644 index 00000000..7e2c3585 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadAttachment.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: MessageActionsPayloadAttachment +uid: botbuilder-core.MessageActionsPayloadAttachment +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadAttachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder-core.MessageActionsPayloadAttachment.content + package: botbuilder-core + summary: The content of the attachment, in case of a code + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: any' + return: + description: '' + type: any + - name: contentType + uid: botbuilder-core.MessageActionsPayloadAttachment.contentType + package: botbuilder-core + summary: The type of the attachment. + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType?: string' + return: + description: '' + type: string + - name: contentUrl + uid: botbuilder-core.MessageActionsPayloadAttachment.contentUrl + package: botbuilder-core + summary: The url of the attachment, in case of a + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.MessageActionsPayloadAttachment.id + package: botbuilder-core + summary: The id of the attachment. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.MessageActionsPayloadAttachment.name + package: botbuilder-core + summary: The plaintext display name of the attachment. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: thumbnailUrl + uid: botbuilder-core.MessageActionsPayloadAttachment.thumbnailUrl + package: botbuilder-core + summary: The url of a thumbnail image that might be + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadBody.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadBody.yml new file mode 100644 index 00000000..5ae9b2c8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadBody.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadBody +uid: botbuilder-core.MessageActionsPayloadBody +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadBody +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder-core.MessageActionsPayloadBody.content + package: botbuilder-core + summary: The content of the body. + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: string' + return: + description: '' + type: string + - name: contentType + uid: botbuilder-core.MessageActionsPayloadBody.contentType + package: botbuilder-core + summary: Type of the content. Possible values + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType?: ContentType' + return: + description: '' + type: + - name: textContent + uid: botbuilder-core.MessageActionsPayloadBody.textContent + package: botbuilder-core + summary: The text content of the body after + fullName: textContent + remarks: '' + isDeprecated: false + syntax: + content: 'textContent?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadConversation.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadConversation.yml new file mode 100644 index 00000000..7bfce93a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadConversation.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadConversation +uid: botbuilder-core.MessageActionsPayloadConversation +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadConversation +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversationIdentityType + uid: botbuilder-core.MessageActionsPayloadConversation.conversationIdentityType + package: botbuilder-core + summary: The type of + fullName: conversationIdentityType + remarks: '' + isDeprecated: false + syntax: + content: 'conversationIdentityType?: ConversationIdentityType' + return: + description: '' + type: + - name: displayName + uid: botbuilder-core.MessageActionsPayloadConversation.displayName + package: botbuilder-core + summary: The plaintext display name of the team or + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.MessageActionsPayloadConversation.id + package: botbuilder-core + summary: The id of the team or channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadFrom.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadFrom.yml new file mode 100644 index 00000000..cf488ee8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadFrom.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadFrom +uid: botbuilder-core.MessageActionsPayloadFrom +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadFrom +remarks: '' +isDeprecated: false +type: interface +properties: + - name: application + uid: botbuilder-core.MessageActionsPayloadFrom.application + package: botbuilder-core + summary: Represents details of the + fullName: application + remarks: '' + isDeprecated: false + syntax: + content: 'application?: MessageActionsPayloadApp' + return: + description: '' + type: + - name: conversation + uid: botbuilder-core.MessageActionsPayloadFrom.conversation + package: botbuilder-core + summary: Represents + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation?: MessageActionsPayloadConversation' + return: + description: '' + type: + - name: user + uid: botbuilder-core.MessageActionsPayloadFrom.user + package: botbuilder-core + summary: Represents details of the user. + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: MessageActionsPayloadUser' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadMention.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadMention.yml new file mode 100644 index 00000000..2768924e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadMention.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadMention +uid: botbuilder-core.MessageActionsPayloadMention +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadMention +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.MessageActionsPayloadMention.id + package: botbuilder-core + summary: The id of the mentioned entity. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: number' + return: + description: '' + type: number + - name: mentioned + uid: botbuilder-core.MessageActionsPayloadMention.mentioned + package: botbuilder-core + summary: Provides more details on + fullName: mentioned + remarks: '' + isDeprecated: false + syntax: + content: 'mentioned?: MessageActionsPayloadFrom' + return: + description: '' + type: + - name: mentionText + uid: botbuilder-core.MessageActionsPayloadMention.mentionText + package: botbuilder-core + summary: The plaintext display name of the mentioned + fullName: mentionText + remarks: '' + isDeprecated: false + syntax: + content: 'mentionText?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadReaction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadReaction.yml new file mode 100644 index 00000000..15c4b45f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadReaction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadReaction +uid: botbuilder-core.MessageActionsPayloadReaction +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadReaction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: createdDateTime + uid: botbuilder-core.MessageActionsPayloadReaction.createdDateTime + package: botbuilder-core + summary: Timestamp of when the user reacted to + fullName: createdDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'createdDateTime?: string' + return: + description: '' + type: string + - name: reactionType + uid: botbuilder-core.MessageActionsPayloadReaction.reactionType + package: botbuilder-core + summary: The type of reaction given to the + fullName: reactionType + remarks: '' + isDeprecated: false + syntax: + content: 'reactionType?: ReactionType' + return: + description: '' + type: + - name: user + uid: botbuilder-core.MessageActionsPayloadReaction.user + package: botbuilder-core + summary: The user with which the + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: MessageActionsPayloadFrom' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadUser.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadUser.yml new file mode 100644 index 00000000..4cebdc61 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageActionsPayloadUser.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadUser +uid: botbuilder-core.MessageActionsPayloadUser +package: botbuilder-core +summary: '' +fullName: MessageActionsPayloadUser +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayName + uid: botbuilder-core.MessageActionsPayloadUser.displayName + package: botbuilder-core + summary: The plaintext display name of the user. + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.MessageActionsPayloadUser.id + package: botbuilder-core + summary: The id of the user. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: userIdentityType + uid: botbuilder-core.MessageActionsPayloadUser.userIdentityType + package: botbuilder-core + summary: The identity type of the + fullName: userIdentityType + remarks: '' + isDeprecated: false + syntax: + content: 'userIdentityType?: UserIdentityType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageFactory.yml index b6d477bd..313522c3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageFactory.yml @@ -22,11 +22,10 @@ remarks: |- const message = MessageFactory.attachment(card); await context.sendActivity(message); ``` -isPreview: false isDeprecated: false type: class methods: - - name: 'attachment(Attachment, string, string, InputHints | string)' + - name: attachment(Attachment, string, string, string) uid: botbuilder-core.MessageFactory.attachment package: botbuilder-core summary: Returns a single message activity containing an attachment. @@ -42,15 +41,14 @@ methods: ) ); ``` - isPreview: false isDeprecated: false syntax: content: >- static function attachment(attachment: Attachment, text?: string, - speak?: string, inputHint?: InputHints | string): Partial + speak?: string, inputHint?: string): Partial parameters: - id: attachment - type: Attachment + type: description: Adaptive card to include in the message. - id: text type: string @@ -59,12 +57,12 @@ methods: type: string description: (Optional) SSML to include with the message. - id: inputHint - type: InputHints | string + type: string description: (Optional) input hint for the message. Defaults to `acceptingInput`. return: description: A message activity containing the attachment. - type: Partial<Activity> - - name: 'carousel(Attachment[], string, string, InputHints | string)' + type: Partial<> + - name: carousel(Attachment[], string, string, string) uid: botbuilder-core.MessageFactory.carousel package: botbuilder-core summary: >- @@ -80,15 +78,14 @@ methods: CardFactory.heroCard('title3', ['imageUrl3'], ['button3']) ]); ``` - isPreview: false isDeprecated: false syntax: content: >- static function carousel(attachments: Attachment[], text?: string, - speak?: string, inputHint?: InputHints | string): Partial + speak?: string, inputHint?: string): Partial parameters: - id: attachments - type: 'Attachment[]' + type: [] description: Array of attachments to include in the message. - id: text type: string @@ -97,14 +94,14 @@ methods: type: string description: (Optional) SSML to include with the message. - id: inputHint - type: InputHints | string + type: string description: (Optional) input hint for the message. return: description: >- A message activity that will display a set of attachments using a carousel layout. - type: Partial<Activity> - - name: 'contentUrl(string, string, string, string, string, InputHints | string)' + type: Partial<> + - name: contentUrl(string, string, string, string, string, string) uid: botbuilder-core.MessageFactory.contentUrl package: botbuilder-core summary: Returns a message that will display a single image or video to a user. @@ -119,12 +116,11 @@ methods: 'Hawaii Trip', 'A photo from our family vacation.'); ``` - isPreview: false isDeprecated: false syntax: content: >- static function contentUrl(url: string, contentType: string, name?: - string, text?: string, speak?: string, inputHint?: InputHints | string): + string, text?: string, speak?: string, inputHint?: string): Partial parameters: - id: url @@ -143,14 +139,14 @@ methods: type: string description: (Optional) SSML to include with the message. - id: inputHint - type: InputHints | string + type: string description: (Optional) input hint for the message. return: description: >- A message activity that will display a single image or video to a user. - type: Partial<Activity> - - name: 'list(Attachment[], string, string, InputHints | string)' + type: Partial<> + - name: list(Attachment[], string, string, string) uid: botbuilder-core.MessageFactory.list package: botbuilder-core summary: Returns a message that will display a set of attachments in list form. @@ -164,15 +160,14 @@ methods: CardFactory.heroCard('title3', ['imageUrl3'], ['button3']) ]); ``` - isPreview: false isDeprecated: false syntax: content: >- static function list(attachments: Attachment[], text?: string, speak?: - string, inputHint?: InputHints | string): Partial + string, inputHint?: string): Partial parameters: - id: attachments - type: 'Attachment[]' + type: [] description: Array of attachments to include in the message. - id: text type: string @@ -181,16 +176,14 @@ methods: type: string description: (Optional) SSML to include with the message. - id: inputHint - type: InputHints | string + type: string description: (Optional) input hint for the message. return: description: >- A message activity that will display a set of attachments in list form. - type: Partial<Activity> - - name: >- - suggestedActions(string | CardAction[], string, string, InputHints | - string) + type: Partial<> + - name: suggestedActions((string | CardAction)[], string, string, string) uid: botbuilder-core.MessageFactory.suggestedActions package: botbuilder-core summary: >- @@ -206,16 +199,14 @@ methods: `Choose a color`); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function suggestedActions(actions: string | CardAction[], text?: - string, speak?: string, inputHint?: InputHints | string): - Partial + static function suggestedActions(actions: (string | CardAction)[], + text?: string, speak?: string, inputHint?: string): Partial parameters: - id: actions - type: 'string | CardAction[]' + type: (string | )[] description: >- Array of card actions or strings to include. Strings will be converted to `messageBack` actions. @@ -226,12 +217,12 @@ methods: type: string description: (Optional) SSML to include with the message. - id: inputHint - type: InputHints | string + type: string description: (Optional) input hint for the message. Defaults to `acceptingInput`. return: description: A message activity that contains the suggested actions. - type: Partial<Activity> - - name: 'text(string, string, InputHints | string)' + type: Partial<> + - name: text(string, string, string) uid: botbuilder-core.MessageFactory.text package: botbuilder-core summary: Returns a simple text message. @@ -241,12 +232,11 @@ methods: ```JavaScript const message = MessageFactory.text('Greetings from example message'); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function text(text: string, speak?: string, inputHint?: - InputHints | string): Partial + static function text(text: string, speak?: string, inputHint?: string): + Partial parameters: - id: text type: string @@ -255,8 +245,8 @@ methods: type: string description: (Optional) SSML to include in the message. - id: inputHint - type: InputHints | string + type: string description: (Optional) input hint for the message. Defaults to `acceptingInput`. return: description: A message activity containing the text. - type: Partial<Activity> + type: Partial<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReaction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReaction.yml new file mode 100644 index 00000000..7503d046 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReaction.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MessageReaction +uid: botbuilder-core.MessageReaction +package: botbuilder-core +summary: Message reaction object +fullName: MessageReaction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder-core.MessageReaction.type + package: botbuilder-core + summary: 'Message reaction type. Possible values include: ''like'', ''plusOne''' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReactionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReactionTypes.yml new file mode 100644 index 00000000..341d6916 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageReactionTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: MessageReactionTypes +uid: botbuilder-core.MessageReactionTypes +package: botbuilder-core +summary: |- + Defines values for MessageReactionTypes. + Possible values include: 'like', 'plusOne' +fullName: MessageReactionTypes +remarks: '' +isDeprecated: false +fields: + - name: Like + uid: botbuilder-core.MessageReactionTypes.Like + package: botbuilder-core + summary: '' + - name: PlusOne + uid: botbuilder-core.MessageReactionTypes.PlusOne + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageType.yml new file mode 100644 index 00000000..72850100 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessageType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: MessageType +uid: botbuilder-core.MessageType +package: botbuilder-core +summary: |- + Defines values for MessageType. + Possible values include: 'message' +fullName: MessageType +remarks: '' +isDeprecated: false +syntax: | + type MessageType = "message" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAction.yml new file mode 100644 index 00000000..888d414e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAction.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: MessagingExtensionAction +uid: botbuilder-core.MessagingExtensionAction +package: botbuilder-core +summary: '' +fullName: MessagingExtensionAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: botActivityPreview + uid: botbuilder-core.MessagingExtensionAction.botActivityPreview + package: botbuilder-core + summary: '' + fullName: botActivityPreview + remarks: '' + isDeprecated: false + syntax: + content: 'botActivityPreview?: Activity[]' + return: + description: '' + type: [] + - name: botMessagePreviewAction + uid: botbuilder-core.MessagingExtensionAction.botMessagePreviewAction + package: botbuilder-core + summary: Bot message + fullName: botMessagePreviewAction + remarks: '' + isDeprecated: false + syntax: + content: 'botMessagePreviewAction?: BotMessagePreviewActionType' + return: + description: '' + type: + - name: commandContext + uid: botbuilder-core.MessagingExtensionAction.commandContext + package: botbuilder-core + summary: The context from which the + fullName: commandContext + remarks: '' + isDeprecated: false + syntax: + content: 'commandContext?: CommandContext' + return: + description: '' + type: + - name: commandId + uid: botbuilder-core.MessagingExtensionAction.commandId + package: botbuilder-core + summary: Id of the command assigned by Bot + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId?: string' + return: + description: '' + type: string + - name: messagePayload + uid: botbuilder-core.MessagingExtensionAction.messagePayload + package: botbuilder-core + summary: Message content sent as + fullName: messagePayload + remarks: '' + isDeprecated: false + syntax: + content: 'messagePayload?: MessageActionsPayload' + return: + description: '' + type: +inheritedProperties: + - name: context + uid: botbuilder-core.MessagingExtensionAction.context + package: botbuilder-core + summary: Current user context, i.e., + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TaskModuleRequestContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleRequest.context](xref:botbuilder-core.TaskModuleRequest.context) + - name: data + uid: botbuilder-core.MessagingExtensionAction.data + package: botbuilder-core + summary: User input data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [TaskModuleRequest.data](xref:botbuilder-core.TaskModuleRequest.data) + - name: tabContext + uid: botbuilder-core.MessagingExtensionAction.tabContext + package: botbuilder-core + summary: Tab request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleRequest.tabContext](xref:botbuilder-core.TaskModuleRequest.tabContext) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionActionResponse.yml new file mode 100644 index 00000000..03082a6b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionActionResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: MessagingExtensionActionResponse +uid: botbuilder-core.MessagingExtensionActionResponse +package: botbuilder-core +summary: '' +fullName: MessagingExtensionActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder-core.MessagingExtensionActionResponse.cacheInfo + package: botbuilder-core + summary: The cache info for this response + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: composeExtension + uid: botbuilder-core.MessagingExtensionActionResponse.composeExtension + package: botbuilder-core + summary: '' + fullName: composeExtension + remarks: '' + isDeprecated: false + syntax: + content: 'composeExtension?: MessagingExtensionResult' + return: + description: '' + type: + - name: task + uid: botbuilder-core.MessagingExtensionActionResponse.task + package: botbuilder-core + summary: The JSON for the response to + fullName: task + remarks: '' + isDeprecated: false + syntax: + content: 'task?: TaskModuleContinueResponse | TaskModuleMessageResponse' + return: + description: '' + type: >- + | diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAttachment.yml new file mode 100644 index 00000000..712760ed --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionAttachment.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: MessagingExtensionAttachment +uid: botbuilder-core.MessagingExtensionAttachment +package: botbuilder-core +summary: '' +fullName: MessagingExtensionAttachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: preview + uid: botbuilder-core.MessagingExtensionAttachment.preview + package: botbuilder-core + summary: '' + fullName: preview + remarks: '' + isDeprecated: false + syntax: + content: 'preview?: Attachment' + return: + description: '' + type: +inheritedProperties: + - name: content + uid: botbuilder-core.MessagingExtensionAttachment.content + package: botbuilder-core + summary: Embedded content + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [Attachment.content](xref:botbuilder-core.Attachment.content) + - name: contentType + uid: botbuilder-core.MessagingExtensionAttachment.contentType + package: botbuilder-core + summary: mimetype/Contenttype for the file + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentType](xref:botbuilder-core.Attachment.contentType) + - name: contentUrl + uid: botbuilder-core.MessagingExtensionAttachment.contentUrl + package: botbuilder-core + summary: Content Url + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentUrl](xref:botbuilder-core.Attachment.contentUrl) + - name: name + uid: botbuilder-core.MessagingExtensionAttachment.name + package: botbuilder-core + summary: (OPTIONAL) The name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.name](xref:botbuilder-core.Attachment.name) + - name: thumbnailUrl + uid: botbuilder-core.MessagingExtensionAttachment.thumbnailUrl + package: botbuilder-core + summary: (OPTIONAL) Thumbnail associated with attachment + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.thumbnailUrl](xref:botbuilder-core.Attachment.thumbnailUrl) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionParameter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionParameter.yml new file mode 100644 index 00000000..f779c03b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionParameter.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MessagingExtensionParameter +uid: botbuilder-core.MessagingExtensionParameter +package: botbuilder-core +summary: '' +fullName: MessagingExtensionParameter +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.MessagingExtensionParameter.name + package: botbuilder-core + summary: Name of the parameter + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.MessagingExtensionParameter.value + package: botbuilder-core + summary: Value of the parameter + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQuery.yml new file mode 100644 index 00000000..206ce51e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQuery.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: MessagingExtensionQuery +uid: botbuilder-core.MessagingExtensionQuery +package: botbuilder-core +summary: '' +fullName: MessagingExtensionQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: commandId + uid: botbuilder-core.MessagingExtensionQuery.commandId + package: botbuilder-core + summary: Id of the command assigned by Bot + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId?: string' + return: + description: '' + type: string + - name: parameters + uid: botbuilder-core.MessagingExtensionQuery.parameters + package: botbuilder-core + summary: Parameters for the + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: MessagingExtensionParameter[]' + return: + description: '' + type: [] + - name: queryOptions + uid: botbuilder-core.MessagingExtensionQuery.queryOptions + package: botbuilder-core + summary: '' + fullName: queryOptions + remarks: '' + isDeprecated: false + syntax: + content: 'queryOptions?: MessagingExtensionQueryOptions' + return: + description: '' + type: + - name: state + uid: botbuilder-core.MessagingExtensionQuery.state + package: botbuilder-core + summary: State parameter passed back to the bot after + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQueryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQueryOptions.yml new file mode 100644 index 00000000..0d2d8372 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionQueryOptions.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MessagingExtensionQueryOptions +uid: botbuilder-core.MessagingExtensionQueryOptions +package: botbuilder-core +summary: '' +fullName: MessagingExtensionQueryOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: count + uid: botbuilder-core.MessagingExtensionQueryOptions.count + package: botbuilder-core + summary: Number of entities to fetch + fullName: count + remarks: '' + isDeprecated: false + syntax: + content: 'count?: number' + return: + description: '' + type: number + - name: skip + uid: botbuilder-core.MessagingExtensionQueryOptions.skip + package: botbuilder-core + summary: Number of entities to skip + fullName: skip + remarks: '' + isDeprecated: false + syntax: + content: 'skip?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResponse.yml new file mode 100644 index 00000000..6c1590d3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResponse.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MessagingExtensionResponse +uid: botbuilder-core.MessagingExtensionResponse +package: botbuilder-core +summary: '' +fullName: MessagingExtensionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder-core.MessagingExtensionResponse.cacheInfo + package: botbuilder-core + summary: The cache info for this response + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: composeExtension + uid: botbuilder-core.MessagingExtensionResponse.composeExtension + package: botbuilder-core + summary: '' + fullName: composeExtension + remarks: '' + isDeprecated: false + syntax: + content: 'composeExtension?: MessagingExtensionResult' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResult.yml new file mode 100644 index 00000000..cc318714 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResult.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: MessagingExtensionResult +uid: botbuilder-core.MessagingExtensionResult +package: botbuilder-core +summary: '' +fullName: MessagingExtensionResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityPreview + uid: botbuilder-core.MessagingExtensionResult.activityPreview + package: botbuilder-core + summary: (Only when type is botMessagePreview) + fullName: activityPreview + remarks: '' + isDeprecated: false + syntax: + content: 'activityPreview?: Activity' + return: + description: '' + type: + - name: attachmentLayout + uid: botbuilder-core.MessagingExtensionResult.attachmentLayout + package: botbuilder-core + summary: Hint for how to deal with + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: AttachmentLayout' + return: + description: '' + type: + - name: attachments + uid: botbuilder-core.MessagingExtensionResult.attachments + package: botbuilder-core + summary: (Only when type is + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: MessagingExtensionAttachment[]' + return: + description: '' + type: [] + - name: suggestedActions + uid: botbuilder-core.MessagingExtensionResult.suggestedActions + package: botbuilder-core + summary: '' + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: MessagingExtensionSuggestedAction' + return: + description: '' + type: + - name: text + uid: botbuilder-core.MessagingExtensionResult.text + package: botbuilder-core + summary: (Only when type is message) Text + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.MessagingExtensionResult.type + package: botbuilder-core + summary: 'The type of the result. Possible values include:' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: MessagingExtensionResultType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResultType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResultType.yml new file mode 100644 index 00000000..5f29d111 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionResultType.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: MessagingExtensionResultType +uid: botbuilder-core.MessagingExtensionResultType +package: botbuilder-core +summary: >- + Defines values for MessagingExtensionResultType. + + Possible values include: 'result', 'auth', 'config', 'message', + 'botMessagePreview', 'silentAuth'. +fullName: MessagingExtensionResultType +remarks: '' +isDeprecated: false +syntax: | + type MessagingExtensionResultType = + | "result" + | "auth" + | "config" + | "message" + | "botMessagePreview" + | "silentAuth" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionSuggestedAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionSuggestedAction.yml new file mode 100644 index 00000000..86f8155e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MessagingExtensionSuggestedAction.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MessagingExtensionSuggestedAction +uid: botbuilder-core.MessagingExtensionSuggestedAction +package: botbuilder-core +summary: '' +fullName: MessagingExtensionSuggestedAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder-core.MessagingExtensionSuggestedAction.actions + package: botbuilder-core + summary: Actions + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions?: CardAction[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MicrosoftPayMethodData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MicrosoftPayMethodData.yml new file mode 100644 index 00000000..d026d7a4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MicrosoftPayMethodData.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: MicrosoftPayMethodData +uid: botbuilder-core.MicrosoftPayMethodData +package: botbuilder-core +summary: W3C Payment Method Data for Microsoft Pay +fullName: MicrosoftPayMethodData +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: merchantId + uid: botbuilder-core.MicrosoftPayMethodData.merchantId + package: botbuilder-core + summary: Microsoft Pay Merchant ID + fullName: merchantId + remarks: '' + isDeprecated: false + syntax: + content: 'merchantId: string' + return: + description: '' + type: string + - name: supportedNetworks + uid: botbuilder-core.MicrosoftPayMethodData.supportedNetworks + package: botbuilder-core + summary: Supported payment networks (e.g., "visa" and "mastercard") + fullName: supportedNetworks + remarks: '' + isDeprecated: false + syntax: + content: 'supportedNetworks: string[]' + return: + description: '' + type: string[] + - name: supportedTypes + uid: botbuilder-core.MicrosoftPayMethodData.supportedTypes + package: botbuilder-core + summary: Supported payment types (e.g., "credit") + fullName: supportedTypes + remarks: '' + isDeprecated: false + syntax: + content: 'supportedTypes: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Middleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Middleware.yml index 13d3e4bd..63bafd91 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Middleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Middleware.yml @@ -5,11 +5,10 @@ package: botbuilder-core summary: Interface implemented by object based middleware. fullName: Middleware remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.Middleware.onTurn package: botbuilder-core summary: Called each time the bot receives a new request. @@ -42,7 +41,6 @@ methods: } ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -54,7 +52,7 @@ methods: description: Context for current turn of conversation with the user. - id: next type: () => Promise<void> - description: > + description: >- Function to call to continue execution to the next step in the middleware chain. return: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareHandler.yml index 52c303f6..389dae83 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareHandler.yml @@ -2,9 +2,10 @@ name: MiddlewareHandler uid: botbuilder-core.MiddlewareHandler package: botbuilder-core -summary: > +summary: >- Signature implemented by function based middleware. + ```TypeScript type MiddlewareHandler = (context: TurnContext, next: () => Promise) => @@ -13,7 +14,6 @@ summary: > ``` fullName: MiddlewareHandler remarks: '' -isPreview: false isDeprecated: false syntax: | type MiddlewareHandler = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareSet.yml index f3551266..9380ea5b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/MiddlewareSet.yml @@ -28,37 +28,29 @@ remarks: >- }); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: >- - MiddlewareSet((context: TurnContext, next: () => Promise) => - Promise | Middleware[]) + - name: MiddlewareSet((MiddlewareHandler | Middleware)[]) uid: botbuilder-core.MiddlewareSet.constructor package: botbuilder-core summary: Creates a new MiddlewareSet instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - new MiddlewareSet(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]) + content: 'new MiddlewareSet(middlewares: (MiddlewareHandler | Middleware)[])' parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | [] - description: | - One or more middleware handlers(s) to register. + ( | )[] + description: One or more middleware handlers(s) to register. methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.MiddlewareSet.onTurn package: botbuilder-core summary: Processes an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -67,19 +59,20 @@ methods: parameters: - id: context type: - description: '(xref:botbuilder-core.TurnContext) object for this turn.' + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. - id: next type: () => Promise<void> description: Delegate to call to continue the bot middleware pipeline. return: description: A Promise representing the async operation. type: Promise<void> - - name: 'run(TurnContext, () => Promise)' + - name: run(TurnContext, () => Promise) uid: botbuilder-core.MiddlewareSet.run package: botbuilder-core summary: Executes a set of middleware in series. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -95,9 +88,7 @@ methods: return: description: A promise that resolves after the handler chain is complete. type: Promise<void> - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) + - name: use((MiddlewareHandler | Middleware)[]) uid: botbuilder-core.MiddlewareSet.use package: botbuilder-core summary: Registers middleware handlers(s) with the set. @@ -110,18 +101,17 @@ methods: console.log(`Trailing Edge`); }); ``` - isPreview: false isDeprecated: false syntax: content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this + function use(middlewares: (MiddlewareHandler | Middleware)[]): + MiddlewareSet parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | [] + ( | )[] description: One or more middleware handlers(s) to register. return: description: The updated middleware set. - type: this + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NoOpHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NoOpHandleActionResponse.yml new file mode 100644 index 00000000..d374ed80 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NoOpHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: NoOpHandleActionResponse +uid: botbuilder-core.NoOpHandleActionResponse +package: botbuilder-core +summary: The handle action response for no op. +fullName: NoOpHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder-core.NoOpHandleActionResponse.renderArguments + package: botbuilder-core + summary: No op doesn't have render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments?: undefined' + return: + description: '' + type: undefined + - name: responseType + uid: botbuilder-core.NoOpHandleActionResponse.responseType + package: botbuilder-core + summary: No op. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "NoOp"' + return: + description: '' + type: '"NoOp"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NotificationInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NotificationInfo.yml new file mode 100644 index 00000000..d426a59a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NotificationInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: NotificationInfo +uid: botbuilder-core.NotificationInfo +package: botbuilder-core +summary: '' +fullName: NotificationInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alert + uid: botbuilder-core.NotificationInfo.alert + package: botbuilder-core + summary: true if notification is to be sent to the user, + fullName: alert + remarks: '' + isDeprecated: false + syntax: + content: 'alert?: boolean' + return: + description: '' + type: boolean + - name: alertInMeeting + uid: botbuilder-core.NotificationInfo.alertInMeeting + package: botbuilder-core + summary: true if a notification is to be shown to the user while in a meeting, + fullName: alertInMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'alertInMeeting?: boolean' + return: + description: '' + type: boolean + - name: externalResourceUrl + uid: botbuilder-core.NotificationInfo.externalResourceUrl + package: botbuilder-core + summary: the value of the notification's external resource url + fullName: externalResourceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'externalResourceUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NullTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NullTelemetryClient.yml index b5d45aca..7dcea266 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NullTelemetryClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/NullTelemetryClient.yml @@ -7,7 +7,6 @@ summary: >- [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient). fullName: NullTelemetryClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,22 +17,19 @@ constructors: Creates a new instance of the [NullTelemetryClient](xref:botbuilder-core.NullTelemetryClient) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new NullTelemetryClient(_settings?: any)' parameters: - id: _settings type: any - description: | - Optional. Settings for the telemetry client. + description: Optional. Settings for the telemetry client. methods: - name: flush() uid: botbuilder-core.NullTelemetryClient.flush package: botbuilder-core summary: Flushes the in-memory buffer and any metrics being pre-aggregated. remarks: '' - isPreview: false isDeprecated: false syntax: content: function flush() @@ -44,14 +40,13 @@ methods: Sends information about an external dependency (outgoing call) in the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackDependency(_telemetry: TelemetryDependency)' parameters: - id: _telemetry type: - description: > + description: >- An object implementing [TelemetryDependency](xref:botbuilder-core.TelemetryDependency). - name: trackEvent(TelemetryEvent) @@ -59,14 +54,13 @@ methods: package: botbuilder-core summary: Logs custom events with extensible named fields. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackEvent(_telemetry: TelemetryEvent)' parameters: - id: _telemetry type: - description: > + description: >- An object implementing [TelemetryEvent](xref:botbuilder-core.TelemetryEvent). - name: trackException(TelemetryException) @@ -74,14 +68,13 @@ methods: package: botbuilder-core summary: Logs a system exception. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackException(_telemetry: TelemetryException)' parameters: - id: _telemetry type: - description: > + description: >- An object implementing [TelemetryException](xref:botbuilder-core.TelemetryException). - name: trackPageView(TelemetryPageView) @@ -89,14 +82,13 @@ methods: package: botbuilder-core summary: Logs an Application Insights page view. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackPageView(_telemetry: TelemetryPageView)' parameters: - id: _telemetry type: - description: > + description: >- An object implementing [TelemetryPageView](xref:botbuilder-core.TelemetryPageView). - name: trackTrace(TelemetryTrace) @@ -104,13 +96,12 @@ methods: package: botbuilder-core summary: Sends a trace message. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackTrace(_telemetry: TelemetryTrace)' parameters: - id: _telemetry type: - description: > + description: >- An object implementing [TelemetryTrace](xref:botbuilder-core.TelemetryTrace). diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCard.yml new file mode 100644 index 00000000..1dc12cc4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: O365ConnectorCard +uid: botbuilder-core.O365ConnectorCard +package: botbuilder-core +summary: '' +fullName: O365ConnectorCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: potentialAction + uid: botbuilder-core.O365ConnectorCard.potentialAction + package: botbuilder-core + summary: Set of actions + fullName: potentialAction + remarks: '' + isDeprecated: false + syntax: + content: 'potentialAction?: O365ConnectorCardActionBase[]' + return: + description: '' + type: [] + - name: sections + uid: botbuilder-core.O365ConnectorCard.sections + package: botbuilder-core + summary: Set of sections for the + fullName: sections + remarks: '' + isDeprecated: false + syntax: + content: 'sections?: O365ConnectorCardSection[]' + return: + description: '' + type: [] + - name: summary + uid: botbuilder-core.O365ConnectorCard.summary + package: botbuilder-core + summary: Summary for the card + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.O365ConnectorCard.text + package: botbuilder-core + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: themeColor + uid: botbuilder-core.O365ConnectorCard.themeColor + package: botbuilder-core + summary: Theme color for the card + fullName: themeColor + remarks: '' + isDeprecated: false + syntax: + content: 'themeColor?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.O365ConnectorCard.title + package: botbuilder-core + summary: Title of the item + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionBase.yml new file mode 100644 index 00000000..f6eb4562 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionBase.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: O365ConnectorCardActionBase +uid: botbuilder-core.O365ConnectorCardActionBase +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardActionBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: '@id' + uid: botbuilder-core.O365ConnectorCardActionBase.@id + package: botbuilder-core + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + - name: '@type' + uid: botbuilder-core.O365ConnectorCardActionBase.@type + package: botbuilder-core + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + - name: name + uid: botbuilder-core.O365ConnectorCardActionBase.name + package: botbuilder-core + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionCard.yml new file mode 100644 index 00000000..ee8fe65b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionCard.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: O365ConnectorCardActionCard +uid: botbuilder-core.O365ConnectorCardActionCard +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardActionCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder-core.O365ConnectorCardActionCard.actions + package: botbuilder-core + summary: Set of actions contained + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions?: O365ConnectorCardActionBase[]' + return: + description: '' + type: [] + - name: inputs + uid: botbuilder-core.O365ConnectorCardActionCard.inputs + package: botbuilder-core + summary: Set of inputs contained in + fullName: inputs + remarks: '' + isDeprecated: false + syntax: + content: 'inputs?: O365ConnectorCardInputBase[]' + return: + description: '' + type: [] +inheritedProperties: + - name: '@id' + uid: botbuilder-core.O365ConnectorCardActionCard.@id + package: botbuilder-core + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder-core.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder-core.O365ConnectorCardActionCard.@type + package: botbuilder-core + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder-core.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder-core.O365ConnectorCardActionCard.name + package: botbuilder-core + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder-core.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionQuery.yml new file mode 100644 index 00000000..5a89040e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionQuery.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardActionQuery +uid: botbuilder-core.O365ConnectorCardActionQuery +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardActionQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actionId + uid: botbuilder-core.O365ConnectorCardActionQuery.actionId + package: botbuilder-core + summary: Action Id associated with the HttpPOST action + fullName: actionId + remarks: '' + isDeprecated: false + syntax: + content: 'actionId?: string' + return: + description: '' + type: string + - name: body + uid: botbuilder-core.O365ConnectorCardActionQuery.body + package: botbuilder-core + summary: The results of body string defined in + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionType.yml new file mode 100644 index 00000000..86e44790 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardActionType.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: O365ConnectorCardActionType +uid: botbuilder-core.O365ConnectorCardActionType +package: botbuilder-core +summary: |- + Defines values for Type. + Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' +fullName: O365ConnectorCardActionType +remarks: '' +isDeprecated: false +syntax: | + type O365ConnectorCardActionType = + | "ViewAction" + | "OpenUri" + | "HttpPOST" + | "ActionCard" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardDateInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardDateInput.yml new file mode 100644 index 00000000..ad951308 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardDateInput.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: O365ConnectorCardDateInput +uid: botbuilder-core.O365ConnectorCardDateInput +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardDateInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: includeTime + uid: botbuilder-core.O365ConnectorCardDateInput.includeTime + package: botbuilder-core + summary: Include time input field. Default value + fullName: includeTime + remarks: '' + isDeprecated: false + syntax: + content: 'includeTime?: boolean' + return: + description: '' + type: boolean +inheritedProperties: + - name: '@type' + uid: botbuilder-core.O365ConnectorCardDateInput.@type + package: botbuilder-core + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.@type](xref:botbuilder-core.O365ConnectorCardInputBase.@type) + - name: id + uid: botbuilder-core.O365ConnectorCardDateInput.id + package: botbuilder-core + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.id](xref:botbuilder-core.O365ConnectorCardInputBase.id) + - name: isRequired + uid: botbuilder-core.O365ConnectorCardDateInput.isRequired + package: botbuilder-core + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.isRequired](xref:botbuilder-core.O365ConnectorCardInputBase.isRequired) + - name: title + uid: botbuilder-core.O365ConnectorCardDateInput.title + package: botbuilder-core + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.title](xref:botbuilder-core.O365ConnectorCardInputBase.title) + - name: value + uid: botbuilder-core.O365ConnectorCardDateInput.value + package: botbuilder-core + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.value](xref:botbuilder-core.O365ConnectorCardInputBase.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardFact.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardFact.yml new file mode 100644 index 00000000..a5043ce8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardFact.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardFact +uid: botbuilder-core.O365ConnectorCardFact +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardFact +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.O365ConnectorCardFact.name + package: botbuilder-core + summary: Display name of the fact + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.O365ConnectorCardFact.value + package: botbuilder-core + summary: Display value for the fact + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardHttpPOST.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardHttpPOST.yml new file mode 100644 index 00000000..53354266 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardHttpPOST.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: O365ConnectorCardHttpPOST +uid: botbuilder-core.O365ConnectorCardHttpPOST +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardHttpPOST +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.O365ConnectorCardHttpPOST.body + package: botbuilder-core + summary: Content to be posted back to bots via invoke + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: string' + return: + description: '' + type: string +inheritedProperties: + - name: '@id' + uid: botbuilder-core.O365ConnectorCardHttpPOST.@id + package: botbuilder-core + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder-core.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder-core.O365ConnectorCardHttpPOST.@type + package: botbuilder-core + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder-core.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder-core.O365ConnectorCardHttpPOST.name + package: botbuilder-core + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder-core.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardImage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardImage.yml new file mode 100644 index 00000000..803219fc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardImage.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardImage +uid: botbuilder-core.O365ConnectorCardImage +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardImage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: image + uid: botbuilder-core.O365ConnectorCardImage.image + package: botbuilder-core + summary: URL for the image + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.O365ConnectorCardImage.title + package: botbuilder-core + summary: Alternative text for the image + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBase.yml new file mode 100644 index 00000000..4b118724 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBase.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: O365ConnectorCardInputBase +uid: botbuilder-core.O365ConnectorCardInputBase +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardInputBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: '@type' + uid: botbuilder-core.O365ConnectorCardInputBase.@type + package: botbuilder-core + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + - name: id + uid: botbuilder-core.O365ConnectorCardInputBase.id + package: botbuilder-core + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: isRequired + uid: botbuilder-core.O365ConnectorCardInputBase.isRequired + package: botbuilder-core + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + - name: title + uid: botbuilder-core.O365ConnectorCardInputBase.title + package: botbuilder-core + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.O365ConnectorCardInputBase.value + package: botbuilder-core + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBaseType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBaseType.yml new file mode 100644 index 00000000..e66a728f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputBaseType.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: O365ConnectorCardInputBaseType +uid: botbuilder-core.O365ConnectorCardInputBaseType +package: botbuilder-core +summary: |- + Defines values for O365ConnectorCardInputBaseType. + Possible values include: 'textInput', 'dateInput', 'multichoiceInput' +fullName: O365ConnectorCardInputBaseType +remarks: '' +isDeprecated: false +syntax: | + type O365ConnectorCardInputBaseType = + | "textInput" + | "dateInput" + | "multichoiceInput" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputType.yml new file mode 100644 index 00000000..08442a00 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardInputType.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: O365ConnectorCardInputType +uid: botbuilder-core.O365ConnectorCardInputType +package: botbuilder-core +summary: |- + Defines values for O365ConnectorCardInputType. + Possible values include: 'textInput', 'dateInput', 'multichoiceInput' +fullName: O365ConnectorCardInputType +remarks: '' +isDeprecated: false +syntax: > + type O365ConnectorCardInputType = "textInput" | "dateInput" | + "multichoiceInput" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInput.yml new file mode 100644 index 00000000..acd3f79d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInput.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: O365ConnectorCardMultichoiceInput +uid: botbuilder-core.O365ConnectorCardMultichoiceInput +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardMultichoiceInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: choices + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.choices + package: botbuilder-core + summary: Set of + fullName: choices + remarks: '' + isDeprecated: false + syntax: + content: 'choices?: O365ConnectorCardMultichoiceInputChoice[]' + return: + description: '' + type: >- + [] + - name: isMultiSelect + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.isMultiSelect + package: botbuilder-core + summary: Define if this input field allows + fullName: isMultiSelect + remarks: '' + isDeprecated: false + syntax: + content: 'isMultiSelect?: boolean' + return: + description: '' + type: boolean + - name: style + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.style + package: botbuilder-core + summary: Choice item rendering style. Default valud is + fullName: style + remarks: '' + isDeprecated: false + syntax: + content: 'style?: Style' + return: + description: '' + type: +inheritedProperties: + - name: '@type' + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.@type + package: botbuilder-core + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.@type](xref:botbuilder-core.O365ConnectorCardInputBase.@type) + - name: id + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.id + package: botbuilder-core + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.id](xref:botbuilder-core.O365ConnectorCardInputBase.id) + - name: isRequired + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.isRequired + package: botbuilder-core + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.isRequired](xref:botbuilder-core.O365ConnectorCardInputBase.isRequired) + - name: title + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.title + package: botbuilder-core + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.title](xref:botbuilder-core.O365ConnectorCardInputBase.title) + - name: value + uid: botbuilder-core.O365ConnectorCardMultichoiceInput.value + package: botbuilder-core + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.value](xref:botbuilder-core.O365ConnectorCardInputBase.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInputChoice.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInputChoice.yml new file mode 100644 index 00000000..cf098d2f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardMultichoiceInputChoice.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardMultichoiceInputChoice +uid: botbuilder-core.O365ConnectorCardMultichoiceInputChoice +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardMultichoiceInputChoice +remarks: '' +isDeprecated: false +type: interface +properties: + - name: display + uid: botbuilder-core.O365ConnectorCardMultichoiceInputChoice.display + package: botbuilder-core + summary: The text rednered on ActionCard. + fullName: display + remarks: '' + isDeprecated: false + syntax: + content: 'display?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.O365ConnectorCardMultichoiceInputChoice.value + package: botbuilder-core + summary: The value received as results. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUri.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUri.yml new file mode 100644 index 00000000..d4d12d78 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUri.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: O365ConnectorCardOpenUri +uid: botbuilder-core.O365ConnectorCardOpenUri +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardOpenUri +remarks: '' +isDeprecated: false +type: interface +properties: + - name: targets + uid: botbuilder-core.O365ConnectorCardOpenUri.targets + package: botbuilder-core + summary: Target os / urls + fullName: targets + remarks: '' + isDeprecated: false + syntax: + content: 'targets?: O365ConnectorCardOpenUriTarget[]' + return: + description: '' + type: [] +inheritedProperties: + - name: '@id' + uid: botbuilder-core.O365ConnectorCardOpenUri.@id + package: botbuilder-core + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder-core.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder-core.O365ConnectorCardOpenUri.@type + package: botbuilder-core + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder-core.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder-core.O365ConnectorCardOpenUri.name + package: botbuilder-core + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder-core.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUriTarget.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUriTarget.yml new file mode 100644 index 00000000..020afdad --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardOpenUriTarget.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardOpenUriTarget +uid: botbuilder-core.O365ConnectorCardOpenUriTarget +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardOpenUriTarget +remarks: '' +isDeprecated: false +type: interface +properties: + - name: os + uid: botbuilder-core.O365ConnectorCardOpenUriTarget.os + package: botbuilder-core + summary: 'Target operating system. Possible values include:' + fullName: os + remarks: '' + isDeprecated: false + syntax: + content: 'os?: Os' + return: + description: '' + type: + - name: uri + uid: botbuilder-core.O365ConnectorCardOpenUriTarget.uri + package: botbuilder-core + summary: Target url + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardSection.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardSection.yml new file mode 100644 index 00000000..59211e50 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardSection.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: O365ConnectorCardSection +uid: botbuilder-core.O365ConnectorCardSection +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardSection +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityImage + uid: botbuilder-core.O365ConnectorCardSection.activityImage + package: botbuilder-core + summary: Activity image + fullName: activityImage + remarks: '' + isDeprecated: false + syntax: + content: 'activityImage?: string' + return: + description: '' + type: string + - name: activityImageType + uid: botbuilder-core.O365ConnectorCardSection.activityImageType + package: botbuilder-core + summary: Describes how Activity + fullName: activityImageType + remarks: '' + isDeprecated: false + syntax: + content: 'activityImageType?: ActivityImageType' + return: + description: '' + type: + - name: activitySubtitle + uid: botbuilder-core.O365ConnectorCardSection.activitySubtitle + package: botbuilder-core + summary: Activity subtitle + fullName: activitySubtitle + remarks: '' + isDeprecated: false + syntax: + content: 'activitySubtitle?: string' + return: + description: '' + type: string + - name: activityText + uid: botbuilder-core.O365ConnectorCardSection.activityText + package: botbuilder-core + summary: Activity text + fullName: activityText + remarks: '' + isDeprecated: false + syntax: + content: 'activityText?: string' + return: + description: '' + type: string + - name: activityTitle + uid: botbuilder-core.O365ConnectorCardSection.activityTitle + package: botbuilder-core + summary: Activity title + fullName: activityTitle + remarks: '' + isDeprecated: false + syntax: + content: 'activityTitle?: string' + return: + description: '' + type: string + - name: facts + uid: botbuilder-core.O365ConnectorCardSection.facts + package: botbuilder-core + summary: Set of facts for the current + fullName: facts + remarks: '' + isDeprecated: false + syntax: + content: 'facts?: O365ConnectorCardFact[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder-core.O365ConnectorCardSection.images + package: botbuilder-core + summary: Set of images for the current + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images?: O365ConnectorCardImage[]' + return: + description: '' + type: [] + - name: markdown + uid: botbuilder-core.O365ConnectorCardSection.markdown + package: botbuilder-core + summary: Use markdown for all text contents. Default + fullName: markdown + remarks: '' + isDeprecated: false + syntax: + content: 'markdown?: boolean' + return: + description: '' + type: boolean + - name: potentialAction + uid: botbuilder-core.O365ConnectorCardSection.potentialAction + package: botbuilder-core + summary: Set of actions + fullName: potentialAction + remarks: '' + isDeprecated: false + syntax: + content: 'potentialAction?: O365ConnectorCardActionBase[]' + return: + description: '' + type: [] + - name: text + uid: botbuilder-core.O365ConnectorCardSection.text + package: botbuilder-core + summary: Text for the section + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.O365ConnectorCardSection.title + package: botbuilder-core + summary: Title of the section + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardTextInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardTextInput.yml new file mode 100644 index 00000000..4fdcc8b5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardTextInput.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: O365ConnectorCardTextInput +uid: botbuilder-core.O365ConnectorCardTextInput +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardTextInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isMultiline + uid: botbuilder-core.O365ConnectorCardTextInput.isMultiline + package: botbuilder-core + summary: Define if text input is allowed for + fullName: isMultiline + remarks: '' + isDeprecated: false + syntax: + content: 'isMultiline?: boolean' + return: + description: '' + type: boolean + - name: maxLength + uid: botbuilder-core.O365ConnectorCardTextInput.maxLength + package: botbuilder-core + summary: Maximum length of text input. Default value + fullName: maxLength + remarks: '' + isDeprecated: false + syntax: + content: 'maxLength?: number' + return: + description: '' + type: number +inheritedProperties: + - name: '@type' + uid: botbuilder-core.O365ConnectorCardTextInput.@type + package: botbuilder-core + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.@type](xref:botbuilder-core.O365ConnectorCardInputBase.@type) + - name: id + uid: botbuilder-core.O365ConnectorCardTextInput.id + package: botbuilder-core + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.id](xref:botbuilder-core.O365ConnectorCardInputBase.id) + - name: isRequired + uid: botbuilder-core.O365ConnectorCardTextInput.isRequired + package: botbuilder-core + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.isRequired](xref:botbuilder-core.O365ConnectorCardInputBase.isRequired) + - name: title + uid: botbuilder-core.O365ConnectorCardTextInput.title + package: botbuilder-core + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.title](xref:botbuilder-core.O365ConnectorCardInputBase.title) + - name: value + uid: botbuilder-core.O365ConnectorCardTextInput.value + package: botbuilder-core + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.value](xref:botbuilder-core.O365ConnectorCardInputBase.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardViewAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardViewAction.yml new file mode 100644 index 00000000..dcb484d3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/O365ConnectorCardViewAction.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: O365ConnectorCardViewAction +uid: botbuilder-core.O365ConnectorCardViewAction +package: botbuilder-core +summary: '' +fullName: O365ConnectorCardViewAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: target + uid: botbuilder-core.O365ConnectorCardViewAction.target + package: botbuilder-core + summary: Target urls, only the first url effective for + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target?: string[]' + return: + description: '' + type: string[] +inheritedProperties: + - name: '@id' + uid: botbuilder-core.O365ConnectorCardViewAction.@id + package: botbuilder-core + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder-core.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder-core.O365ConnectorCardViewAction.@type + package: botbuilder-core + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder-core.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder-core.O365ConnectorCardViewAction.name + package: botbuilder-core + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder-core.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OAuthCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OAuthCard.yml new file mode 100644 index 00000000..1e83b771 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OAuthCard.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: OAuthCard +uid: botbuilder-core.OAuthCard +package: botbuilder-core +summary: A card representing a request to perform a sign in via OAuth +fullName: OAuthCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder-core.OAuthCard.buttons + package: botbuilder-core + summary: Action to use to perform signin + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: connectionName + uid: botbuilder-core.OAuthCard.connectionName + package: botbuilder-core + summary: The name of the registered connection + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.OAuthCard.text + package: botbuilder-core + summary: Text for signin request + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: tokenExchangeResource + uid: botbuilder-core.OAuthCard.tokenExchangeResource + package: botbuilder-core + summary: The token exchange resource for single sign on + fullName: tokenExchangeResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenExchangeResource: TokenExchangeResource' + return: + description: '' + type: + - name: tokenPostResource + uid: botbuilder-core.OAuthCard.tokenPostResource + package: botbuilder-core + summary: The token for directly post a token to token service + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource: TokenPostResource' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnBehalfOf.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnBehalfOf.yml new file mode 100644 index 00000000..135e3bf4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnBehalfOf.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: OnBehalfOf +uid: botbuilder-core.OnBehalfOf +package: botbuilder-core +summary: '' +fullName: OnBehalfOf +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayName + uid: botbuilder-core.OnBehalfOf.displayName + package: botbuilder-core + summary: The of the person. + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: itemid + uid: botbuilder-core.OnBehalfOf.itemid + package: botbuilder-core + summary: The id of the item. + fullName: itemid + remarks: '' + isDeprecated: false + syntax: + content: 'itemid: number' + return: + description: '' + type: number + - name: mentionType + uid: botbuilder-core.OnBehalfOf.mentionType + package: botbuilder-core + summary: The mention type of a "person". + fullName: mentionType + remarks: '' + isDeprecated: false + syntax: + content: 'mentionType: string' + return: + description: '' + type: string + - name: mri + uid: botbuilder-core.OnBehalfOf.mri + package: botbuilder-core + summary: Ther user MRI of the sender. + fullName: mri + remarks: '' + isDeprecated: false + syntax: + content: 'mri: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnCardSelectionAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnCardSelectionAction.yml new file mode 100644 index 00000000..75a9b3db --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/OnCardSelectionAction.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: OnCardSelectionAction +uid: botbuilder-core.OnCardSelectionAction +package: botbuilder-core +summary: Type of handler for when a card is selected. +fullName: OnCardSelectionAction +remarks: '' +isDeprecated: false +syntax: | + type OnCardSelectionAction = + | QuickViewCardAction + | ExternalLinkCardAction + | SelectMediaCardAction + | GetLocationCardAction + | ShowLocationCardAction + | ExecuteCardAction + | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Os.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Os.yml new file mode 100644 index 00000000..6e7b4caa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Os.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Os +uid: botbuilder-core.Os +package: botbuilder-core +summary: |- + Defines values for Os. + Possible values include: 'default', 'iOS', 'android', 'windows' +fullName: Os +remarks: '' +isDeprecated: false +syntax: | + type Os = "default" | "iOS" | "android" | "windows" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedMembersResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedMembersResult.yml new file mode 100644 index 00000000..f3dbeea3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedMembersResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PagedMembersResult +uid: botbuilder-core.PagedMembersResult +package: botbuilder-core +summary: Page of members. +fullName: PagedMembersResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder-core.PagedMembersResult.continuationToken + package: botbuilder-core + summary: Paging token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: members + uid: botbuilder-core.PagedMembersResult.members + package: botbuilder-core + summary: The Channel Accounts. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: ChannelAccount[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedResult.yml index 44d0e285..b00777bd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PagedResult.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Page of results. fullName: PagedResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Token used to page through multiple pages. fullName: continuationToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'continuationToken: string' @@ -28,10 +26,9 @@ properties: summary: Page of items. fullName: items remarks: '' - isPreview: false isDeprecated: false syntax: content: 'items: T[]' return: description: '' - type: 'T[]' + type: T[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentAddress.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentAddress.yml new file mode 100644 index 00000000..2720892f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentAddress.yml @@ -0,0 +1,164 @@ +### YamlMime:TSType +name: PaymentAddress +uid: botbuilder-core.PaymentAddress +package: botbuilder-core +summary: Address within a Payment Request +fullName: PaymentAddress +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: addressLine + uid: botbuilder-core.PaymentAddress.addressLine + package: botbuilder-core + summary: >- + This is the most specific part of the address. It can include, for + example, a street name, a + + house number, apartment number, a rural delivery route, descriptive + instructions, or a post + + office box number. + fullName: addressLine + remarks: '' + isDeprecated: false + syntax: + content: 'addressLine: string[]' + return: + description: '' + type: string[] + - name: city + uid: botbuilder-core.PaymentAddress.city + package: botbuilder-core + summary: This is the city/town portion of the address. + fullName: city + remarks: '' + isDeprecated: false + syntax: + content: 'city: string' + return: + description: '' + type: string + - name: country + uid: botbuilder-core.PaymentAddress.country + package: botbuilder-core + summary: >- + This is the CLDR (Common Locale Data Repository) region code. For example, + US, GB, CN, or JP + fullName: country + remarks: '' + isDeprecated: false + syntax: + content: 'country: string' + return: + description: '' + type: string + - name: dependentLocality + uid: botbuilder-core.PaymentAddress.dependentLocality + package: botbuilder-core + summary: >- + This is the dependent locality or sublocality within a city. For example, + used for + + neighborhoods, boroughs, districts, or UK dependent localities. + fullName: dependentLocality + remarks: '' + isDeprecated: false + syntax: + content: 'dependentLocality: string' + return: + description: '' + type: string + - name: languageCode + uid: botbuilder-core.PaymentAddress.languageCode + package: botbuilder-core + summary: >- + This is the BCP-47 language code for the address. It's used to determine + the field separators + + and the order of fields when formatting the address for display. + fullName: languageCode + remarks: '' + isDeprecated: false + syntax: + content: 'languageCode: string' + return: + description: '' + type: string + - name: organization + uid: botbuilder-core.PaymentAddress.organization + package: botbuilder-core + summary: This is the organization, firm, company, or institution at this address. + fullName: organization + remarks: '' + isDeprecated: false + syntax: + content: 'organization: string' + return: + description: '' + type: string + - name: phone + uid: botbuilder-core.PaymentAddress.phone + package: botbuilder-core + summary: This is the phone number of the recipient or contact person. + fullName: phone + remarks: '' + isDeprecated: false + syntax: + content: 'phone: string' + return: + description: '' + type: string + - name: postalCode + uid: botbuilder-core.PaymentAddress.postalCode + package: botbuilder-core + summary: This is the postal code or ZIP code, also known as PIN code in India. + fullName: postalCode + remarks: '' + isDeprecated: false + syntax: + content: 'postalCode: string' + return: + description: '' + type: string + - name: recipient + uid: botbuilder-core.PaymentAddress.recipient + package: botbuilder-core + summary: This is the name of the recipient or contact person. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: string' + return: + description: '' + type: string + - name: region + uid: botbuilder-core.PaymentAddress.region + package: botbuilder-core + summary: >- + This is the top level administrative subdivision of the country. For + example, this can be a + + state, a province, an oblast, or a prefecture. + fullName: region + remarks: '' + isDeprecated: false + syntax: + content: 'region: string' + return: + description: '' + type: string + - name: sortingCode + uid: botbuilder-core.PaymentAddress.sortingCode + package: botbuilder-core + summary: This is the sorting code as used in, for example, France. + fullName: sortingCode + remarks: '' + isDeprecated: false + syntax: + content: 'sortingCode: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentCurrencyAmount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentCurrencyAmount.yml new file mode 100644 index 00000000..efa3effe --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentCurrencyAmount.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentCurrencyAmount +uid: botbuilder-core.PaymentCurrencyAmount +package: botbuilder-core +summary: Supplies monetary amounts +fullName: PaymentCurrencyAmount +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: currency + uid: botbuilder-core.PaymentCurrencyAmount.currency + package: botbuilder-core + summary: A currency identifier + fullName: currency + remarks: '' + isDeprecated: false + syntax: + content: 'currency: string' + return: + description: '' + type: string + - name: currencySystem + uid: botbuilder-core.PaymentCurrencyAmount.currencySystem + package: botbuilder-core + summary: Currency system + fullName: currencySystem + remarks: '' + isDeprecated: false + syntax: + content: 'currencySystem: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.PaymentCurrencyAmount.value + package: botbuilder-core + summary: Decimal monetary value + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetails.yml new file mode 100644 index 00000000..cf2d9034 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetails.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: PaymentDetails +uid: botbuilder-core.PaymentDetails +package: botbuilder-core +summary: Provides information about the requested transaction +fullName: PaymentDetails +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: displayItems + uid: botbuilder-core.PaymentDetails.displayItems + package: botbuilder-core + summary: >- + Contains line items for the payment request that the user agent may + display + fullName: displayItems + remarks: '' + isDeprecated: false + syntax: + content: 'displayItems: PaymentItem[]' + return: + description: '' + type: [] + - name: error + uid: botbuilder-core.PaymentDetails.error + package: botbuilder-core + summary: Error description + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: string' + return: + description: '' + type: string + - name: modifiers + uid: botbuilder-core.PaymentDetails.modifiers + package: botbuilder-core + summary: Contains modifiers for particular payment method identifiers + fullName: modifiers + remarks: '' + isDeprecated: false + syntax: + content: 'modifiers: PaymentDetailsModifier[]' + return: + description: '' + type: [] + - name: shippingOptions + uid: botbuilder-core.PaymentDetails.shippingOptions + package: botbuilder-core + summary: >- + A sequence containing the different shipping options for the user to + choose from + fullName: shippingOptions + remarks: '' + isDeprecated: false + syntax: + content: 'shippingOptions: PaymentShippingOption[]' + return: + description: '' + type: [] + - name: total + uid: botbuilder-core.PaymentDetails.total + package: botbuilder-core + summary: Contains the total amount of the payment request + fullName: total + remarks: '' + isDeprecated: false + syntax: + content: 'total: PaymentItem' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetailsModifier.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetailsModifier.yml new file mode 100644 index 00000000..74a3f575 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentDetailsModifier.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: PaymentDetailsModifier +uid: botbuilder-core.PaymentDetailsModifier +package: botbuilder-core +summary: >- + Provides details that modify the PaymentDetails based on payment method + identifier +fullName: PaymentDetailsModifier +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: additionalDisplayItems + uid: botbuilder-core.PaymentDetailsModifier.additionalDisplayItems + package: botbuilder-core + summary: >- + Provides additional display items that are appended to the displayItems + field in the + + PaymentDetails dictionary for the payment method identifiers in the + supportedMethods field + fullName: additionalDisplayItems + remarks: '' + isDeprecated: false + syntax: + content: 'additionalDisplayItems: PaymentItem[]' + return: + description: '' + type: [] + - name: data + uid: botbuilder-core.PaymentDetailsModifier.data + package: botbuilder-core + summary: >- + A JSON-serializable object that provides optional information that might + be needed by the + + supported payment methods + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: any' + return: + description: '' + type: any + - name: supportedMethods + uid: botbuilder-core.PaymentDetailsModifier.supportedMethods + package: botbuilder-core + summary: Contains a sequence of payment method identifiers + fullName: supportedMethods + remarks: '' + isDeprecated: false + syntax: + content: 'supportedMethods: string[]' + return: + description: '' + type: string[] + - name: total + uid: botbuilder-core.PaymentDetailsModifier.total + package: botbuilder-core + summary: >- + This value overrides the total field in the PaymentDetails dictionary for + the payment method + + identifiers in the supportedMethods field + fullName: total + remarks: '' + isDeprecated: false + syntax: + content: 'total: PaymentItem' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentItem.yml new file mode 100644 index 00000000..899574cb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentItem.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentItem +uid: botbuilder-core.PaymentItem +package: botbuilder-core +summary: Indicates what the payment request is for and the value asked for +fullName: PaymentItem +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: amount + uid: botbuilder-core.PaymentItem.amount + package: botbuilder-core + summary: Monetary amount for the item + fullName: amount + remarks: '' + isDeprecated: false + syntax: + content: 'amount: PaymentCurrencyAmount' + return: + description: '' + type: + - name: label + uid: botbuilder-core.PaymentItem.label + package: botbuilder-core + summary: Human-readable description of the item + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: pending + uid: botbuilder-core.PaymentItem.pending + package: botbuilder-core + summary: When set to true this flag means that the amount field is not final. + fullName: pending + remarks: '' + isDeprecated: false + syntax: + content: 'pending: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentMethodData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentMethodData.yml new file mode 100644 index 00000000..10d0fe84 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentMethodData.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentMethodData +uid: botbuilder-core.PaymentMethodData +package: botbuilder-core +summary: >- + Indicates a set of supported payment methods and any associated payment method + specific data for + + those methods +fullName: PaymentMethodData +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: data + uid: botbuilder-core.PaymentMethodData.data + package: botbuilder-core + summary: >- + A JSON-serializable object that provides optional information that might + be needed by the + + supported payment methods + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: any' + return: + description: '' + type: any + - name: supportedMethods + uid: botbuilder-core.PaymentMethodData.supportedMethods + package: botbuilder-core + summary: >- + Required sequence of strings containing payment method identifiers for + payment methods that + + the merchant web site accepts + fullName: supportedMethods + remarks: '' + isDeprecated: false + syntax: + content: 'supportedMethods: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentOptions.yml new file mode 100644 index 00000000..b9d844c0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentOptions.yml @@ -0,0 +1,92 @@ +### YamlMime:TSType +name: PaymentOptions +uid: botbuilder-core.PaymentOptions +package: botbuilder-core +summary: Provides information about the options desired for the payment request +fullName: PaymentOptions +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: requestPayerEmail + uid: botbuilder-core.PaymentOptions.requestPayerEmail + package: botbuilder-core + summary: >- + Indicates whether the user agent should collect and return the payer's + email address as part + + of the payment request + fullName: requestPayerEmail + remarks: '' + isDeprecated: false + syntax: + content: 'requestPayerEmail: boolean' + return: + description: '' + type: boolean + - name: requestPayerName + uid: botbuilder-core.PaymentOptions.requestPayerName + package: botbuilder-core + summary: >- + Indicates whether the user agent should collect and return the payer's + name as part of the + + payment request + fullName: requestPayerName + remarks: '' + isDeprecated: false + syntax: + content: 'requestPayerName: boolean' + return: + description: '' + type: boolean + - name: requestPayerPhone + uid: botbuilder-core.PaymentOptions.requestPayerPhone + package: botbuilder-core + summary: >- + Indicates whether the user agent should collect and return the payer's + phone number as part of + + the payment request + fullName: requestPayerPhone + remarks: '' + isDeprecated: false + syntax: + content: 'requestPayerPhone: boolean' + return: + description: '' + type: boolean + - name: requestShipping + uid: botbuilder-core.PaymentOptions.requestShipping + package: botbuilder-core + summary: >- + Indicates whether the user agent should collect and return a shipping + address as part of the + + payment request + fullName: requestShipping + remarks: '' + isDeprecated: false + syntax: + content: 'requestShipping: boolean' + return: + description: '' + type: boolean + - name: shippingType + uid: botbuilder-core.PaymentOptions.shippingType + package: botbuilder-core + summary: >- + If requestShipping is set to true, then the shippingType field may be used + to influence the + + way the user agent presents the user interface for gathering the shipping + address + fullName: shippingType + remarks: '' + isDeprecated: false + syntax: + content: 'shippingType: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequest.yml new file mode 100644 index 00000000..4efaf7a3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequest.yml @@ -0,0 +1,71 @@ +### YamlMime:TSType +name: PaymentRequest +uid: botbuilder-core.PaymentRequest +package: botbuilder-core +summary: A request to make a payment +fullName: PaymentRequest +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder-core.PaymentRequest.details + package: botbuilder-core + summary: Details for this request + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: PaymentDetails' + return: + description: '' + type: + - name: expires + uid: botbuilder-core.PaymentRequest.expires + package: botbuilder-core + summary: Expiration for this request, in ISO 8601 duration format (e.g., 'P1D') + fullName: expires + remarks: '' + isDeprecated: false + syntax: + content: 'expires: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.PaymentRequest.id + package: botbuilder-core + summary: ID of this payment request + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: methodData + uid: botbuilder-core.PaymentRequest.methodData + package: botbuilder-core + summary: Allowed payment methods for this request + fullName: methodData + remarks: '' + isDeprecated: false + syntax: + content: 'methodData: PaymentMethodData[]' + return: + description: '' + type: [] + - name: options + uid: botbuilder-core.PaymentRequest.options + package: botbuilder-core + summary: Provides information about the options desired for the payment request + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options: PaymentOptions' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestComplete.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestComplete.yml new file mode 100644 index 00000000..1806ce68 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestComplete.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentRequestComplete +uid: botbuilder-core.PaymentRequestComplete +package: botbuilder-core +summary: Payload delivered when completing a payment request +fullName: PaymentRequestComplete +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: id + uid: botbuilder-core.PaymentRequestComplete.id + package: botbuilder-core + summary: Payment request ID + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: paymentRequest + uid: botbuilder-core.PaymentRequestComplete.paymentRequest + package: botbuilder-core + summary: Initial payment request + fullName: paymentRequest + remarks: '' + isDeprecated: false + syntax: + content: 'paymentRequest: PaymentRequest' + return: + description: '' + type: + - name: paymentResponse + uid: botbuilder-core.PaymentRequestComplete.paymentResponse + package: botbuilder-core + summary: Corresponding payment response + fullName: paymentResponse + remarks: '' + isDeprecated: false + syntax: + content: 'paymentResponse: PaymentResponse' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestCompleteResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestCompleteResult.yml new file mode 100644 index 00000000..c22ecc0b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestCompleteResult.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: PaymentRequestCompleteResult +uid: botbuilder-core.PaymentRequestCompleteResult +package: botbuilder-core +summary: Result from a completed payment request +fullName: PaymentRequestCompleteResult +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: result + uid: botbuilder-core.PaymentRequestCompleteResult.result + package: botbuilder-core + summary: Result of the payment request completion + fullName: result + remarks: '' + isDeprecated: false + syntax: + content: 'result: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdate.yml new file mode 100644 index 00000000..25438d01 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdate.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PaymentRequestUpdate +uid: botbuilder-core.PaymentRequestUpdate +package: botbuilder-core +summary: An update to a payment request +fullName: PaymentRequestUpdate +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder-core.PaymentRequestUpdate.details + package: botbuilder-core + summary: Update payment details + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: PaymentDetails' + return: + description: '' + type: + - name: id + uid: botbuilder-core.PaymentRequestUpdate.id + package: botbuilder-core + summary: ID for the payment request to update + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: shippingAddress + uid: botbuilder-core.PaymentRequestUpdate.shippingAddress + package: botbuilder-core + summary: Updated shipping address + fullName: shippingAddress + remarks: '' + isDeprecated: false + syntax: + content: 'shippingAddress: PaymentAddress' + return: + description: '' + type: + - name: shippingOption + uid: botbuilder-core.PaymentRequestUpdate.shippingOption + package: botbuilder-core + summary: Updated shipping options + fullName: shippingOption + remarks: '' + isDeprecated: false + syntax: + content: 'shippingOption: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdateResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdateResult.yml new file mode 100644 index 00000000..92157dd6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentRequestUpdateResult.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: PaymentRequestUpdateResult +uid: botbuilder-core.PaymentRequestUpdateResult +package: botbuilder-core +summary: A result object from a Payment Request Update invoke operation +fullName: PaymentRequestUpdateResult +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder-core.PaymentRequestUpdateResult.details + package: botbuilder-core + summary: Update payment details + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: PaymentDetails' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentResponse.yml new file mode 100644 index 00000000..2368f3e1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentResponse.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: PaymentResponse +uid: botbuilder-core.PaymentResponse +package: botbuilder-core +summary: >- + A PaymentResponse is returned when a user has selected a payment method and + approved a payment + + request +fullName: PaymentResponse +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder-core.PaymentResponse.details + package: botbuilder-core + summary: >- + A JSON-serializable object that provides a payment method specific message + used by the + + merchant to process the transaction and determine successful fund transfer + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: any' + return: + description: '' + type: any + - name: methodName + uid: botbuilder-core.PaymentResponse.methodName + package: botbuilder-core + summary: >- + The payment method identifier for the payment method that the user + selected to fulfil the + + transaction + fullName: methodName + remarks: '' + isDeprecated: false + syntax: + content: 'methodName: string' + return: + description: '' + type: string + - name: payerEmail + uid: botbuilder-core.PaymentResponse.payerEmail + package: botbuilder-core + summary: >- + If the requestPayerEmail flag was set to true in the PaymentOptions passed + to the + + PaymentRequest constructor, then payerEmail will be the email address + chosen by the user + fullName: payerEmail + remarks: '' + isDeprecated: false + syntax: + content: 'payerEmail: string' + return: + description: '' + type: string + - name: payerPhone + uid: botbuilder-core.PaymentResponse.payerPhone + package: botbuilder-core + summary: >- + If the requestPayerPhone flag was set to true in the PaymentOptions passed + to the + + PaymentRequest constructor, then payerPhone will be the phone number + chosen by the user + fullName: payerPhone + remarks: '' + isDeprecated: false + syntax: + content: 'payerPhone: string' + return: + description: '' + type: string + - name: shippingAddress + uid: botbuilder-core.PaymentResponse.shippingAddress + package: botbuilder-core + summary: >- + If the requestShipping flag was set to true in the PaymentOptions passed + to the PaymentRequest + + constructor, then shippingAddress will be the full and final shipping + address chosen by the + + user + fullName: shippingAddress + remarks: '' + isDeprecated: false + syntax: + content: 'shippingAddress: PaymentAddress' + return: + description: '' + type: + - name: shippingOption + uid: botbuilder-core.PaymentResponse.shippingOption + package: botbuilder-core + summary: >- + If the requestShipping flag was set to true in the PaymentOptions passed + to the PaymentRequest + + constructor, then shippingOption will be the id attribute of the selected + shipping option + fullName: shippingOption + remarks: '' + isDeprecated: false + syntax: + content: 'shippingOption: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentShippingOption.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentShippingOption.yml new file mode 100644 index 00000000..5807102d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PaymentShippingOption.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PaymentShippingOption +uid: botbuilder-core.PaymentShippingOption +package: botbuilder-core +summary: Describes a shipping option +fullName: PaymentShippingOption +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: amount + uid: botbuilder-core.PaymentShippingOption.amount + package: botbuilder-core + summary: Contains the monetary amount for the item + fullName: amount + remarks: '' + isDeprecated: false + syntax: + content: 'amount: PaymentCurrencyAmount' + return: + description: '' + type: + - name: id + uid: botbuilder-core.PaymentShippingOption.id + package: botbuilder-core + summary: String identifier used to reference this PaymentShippingOption + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: label + uid: botbuilder-core.PaymentShippingOption.label + package: botbuilder-core + summary: Human-readable description of the item + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: selected + uid: botbuilder-core.PaymentShippingOption.selected + package: botbuilder-core + summary: Indicates whether this is the default selected PaymentShippingOption + fullName: selected + remarks: '' + isDeprecated: false + syntax: + content: 'selected: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Place.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Place.yml new file mode 100644 index 00000000..bd9445e0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Place.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Place +uid: botbuilder-core.Place +package: botbuilder-core +summary: 'Place (entity type: "https://schema.org/Place")' +fullName: Place +remarks: '' +isDeprecated: false +type: interface +properties: + - name: address + uid: botbuilder-core.Place.address + package: botbuilder-core + summary: >- + Address of the place (may be `string` or complex object of type + `PostalAddress`) + fullName: address + remarks: '' + isDeprecated: false + syntax: + content: 'address: any' + return: + description: '' + type: any + - name: geo + uid: botbuilder-core.Place.geo + package: botbuilder-core + summary: >- + Geo coordinates of the place (may be complex object of type + `GeoCoordinates` or `GeoShape`) + fullName: geo + remarks: '' + isDeprecated: false + syntax: + content: 'geo: any' + return: + description: '' + type: any + - name: hasMap + uid: botbuilder-core.Place.hasMap + package: botbuilder-core + summary: Map to the place (may be `string` (URL) or complex object of type `Map`) + fullName: hasMap + remarks: '' + isDeprecated: false + syntax: + content: 'hasMap: any' + return: + description: '' + type: any + - name: name + uid: botbuilder-core.Place.name + package: botbuilder-core + summary: The name of the thing + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.Place.type + package: botbuilder-core + summary: The type of the thing + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PopupWindowPosition.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PopupWindowPosition.yml new file mode 100644 index 00000000..e50446e1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PopupWindowPosition.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: PopupWindowPosition +uid: botbuilder-core.PopupWindowPosition +package: botbuilder-core +summary: SharePoint property pane link popup window position. +fullName: PopupWindowPosition +remarks: '' +isDeprecated: false +fields: + - name: Center + uid: botbuilder-core.PopupWindowPosition.Center + package: botbuilder-core + summary: Center. + numericValue: 0 + - name: RightTop + uid: botbuilder-core.PopupWindowPosition.RightTop + package: botbuilder-core + summary: Right top. + numericValue: 1 + - name: LeftTop + uid: botbuilder-core.PopupWindowPosition.LeftTop + package: botbuilder-core + summary: Left top. + numericValue: 2 + - name: RightBottom + uid: botbuilder-core.PopupWindowPosition.RightBottom + package: botbuilder-core + summary: Right bottom. + numericValue: 3 + - name: LeftBottom + uid: botbuilder-core.PopupWindowPosition.LeftBottom + package: botbuilder-core + summary: Left bottom. + numericValue: 4 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PrivateConversationState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PrivateConversationState.yml index cdf9ade0..4a8f1cba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PrivateConversationState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PrivateConversationState.yml @@ -23,16 +23,14 @@ remarks: >- MemoryStorage()); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'PrivateConversationState(Storage, string)' + - name: PrivateConversationState(Storage, string) uid: botbuilder-core.PrivateConversationState.constructor package: botbuilder-core summary: Creates a new PrivateConversationState instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new PrivateConversationState(storage: Storage, namespace?: string)' @@ -42,7 +40,7 @@ constructors: description: Storage provider to persist PrivateConversation state to. - id: namespace type: string - description: > + description: >- (Optional) namespace to append to storage keys. Defaults to an empty string. inheritedMethods: @@ -64,7 +62,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function clear(context: TurnContext): Promise' @@ -87,7 +84,6 @@ inheritedMethods: states storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createProperty(name: string): StatePropertyAccessor' @@ -117,7 +113,6 @@ inheritedMethods: await botState.delete(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' @@ -145,19 +140,18 @@ inheritedMethods: const state = botState.get(context); ``` - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): any | undefined' + content: 'function get(context: TurnContext): any' parameters: - id: context type: description: Context for current turn of conversation with the user. return: description: A cached state object or undefined if not cached. - type: any | undefined - inheritanceDescription: 'Inherited From [BotState.get](xref:botbuilder-core.BotState.get)' - - name: 'load(TurnContext, boolean)' + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder-core.BotState.get) + - name: load(TurnContext, boolean) uid: botbuilder-core.PrivateConversationState.load package: botbuilder-core summary: Reads in and caches the backing state object for a turn. @@ -177,7 +171,6 @@ inheritedMethods: const state = await botState.load(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function load(context: TurnContext, force?: boolean): Promise' @@ -193,8 +186,8 @@ inheritedMethods: return: description: The cached state. type: Promise<any> - inheritanceDescription: 'Inherited From [BotState.load](xref:botbuilder-core.BotState.load)' - - name: 'saveChanges(TurnContext, boolean)' + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder-core.BotState.load) + - name: saveChanges(TurnContext, boolean) uid: botbuilder-core.PrivateConversationState.saveChanges package: botbuilder-core summary: Saves the cached state object if it's been changed. @@ -213,7 +206,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -240,15 +232,14 @@ methods: package: botbuilder-core summary: Returns the storage key for the current PrivateConversation state. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getStorageKey(context: TurnContext): string | undefined' + content: 'function getStorageKey(context: TurnContext): undefined | string' parameters: - id: context type: description: Context for current turn of PrivateConversation with the user. return: description: The storage key for the current PrivateConversation state. - type: string | undefined + type: undefined | string extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyManager.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyManager.yml index bdbe063f..ee643ea4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyManager.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyManager.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Interface implemented by classes capable of factoring property accessors. fullName: PropertyManager remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -18,15 +17,13 @@ methods: state management system. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createProperty(name: string): StatePropertyAccessor' parameters: - id: name type: string - description: | - Name of the property being created. + description: Name of the property being created. return: description: '' type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneCheckboxProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneCheckboxProperties.yml new file mode 100644 index 00000000..e6201418 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneCheckboxProperties.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PropertyPaneCheckboxProperties +uid: botbuilder-core.PropertyPaneCheckboxProperties +package: botbuilder-core +summary: SharePoint property pane checkbox field properties. +fullName: PropertyPaneCheckboxProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: checked + uid: botbuilder-core.PropertyPaneCheckboxProperties.checked + package: botbuilder-core + summary: Indicates whether the checkbox is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botbuilder-core.PropertyPaneCheckboxProperties.disabled + package: botbuilder-core + summary: Indicates whether the checkbox is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: text + uid: botbuilder-core.PropertyPaneCheckboxProperties.text + package: botbuilder-core + summary: The label text to display next to the checkbox. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupIconProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupIconProperties.yml new file mode 100644 index 00000000..6c497f9a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupIconProperties.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupIconProperties +uid: botbuilder-core.PropertyPaneChoiceGroupIconProperties +package: botbuilder-core +summary: SharePoint property pane choice group icon properties. +fullName: PropertyPaneChoiceGroupIconProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: officeFabricIconFontName + uid: >- + botbuilder-core.PropertyPaneChoiceGroupIconProperties.officeFabricIconFontName + package: botbuilder-core + summary: The name of the icon to use from Office Fabric icon set. + fullName: officeFabricIconFontName + remarks: '' + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupImageSize.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupImageSize.yml new file mode 100644 index 00000000..17eb5a43 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupImageSize.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupImageSize +uid: botbuilder-core.PropertyPaneChoiceGroupImageSize +package: botbuilder-core +summary: SharePoint property pane choice group image size. +fullName: PropertyPaneChoiceGroupImageSize +remarks: '' +isDeprecated: false +type: interface +properties: + - name: height + uid: botbuilder-core.PropertyPaneChoiceGroupImageSize.height + package: botbuilder-core + summary: The height of the image. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height: number' + return: + description: '' + type: number + - name: width + uid: botbuilder-core.PropertyPaneChoiceGroupImageSize.width + package: botbuilder-core + summary: The width of the image. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupOption.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupOption.yml new file mode 100644 index 00000000..37d3f3e8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupOption.yml @@ -0,0 +1,108 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupOption +uid: botbuilder-core.PropertyPaneChoiceGroupOption +package: botbuilder-core +summary: SharePoint property pane choice group option. +fullName: PropertyPaneChoiceGroupOption +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.PropertyPaneChoiceGroupOption.ariaLabel + package: botbuilder-core + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: checked + uid: botbuilder-core.PropertyPaneChoiceGroupOption.checked + package: botbuilder-core + summary: Indicates whether the choice group option is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botbuilder-core.PropertyPaneChoiceGroupOption.disabled + package: botbuilder-core + summary: Indicates whether the choice group option is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: iconProps + uid: botbuilder-core.PropertyPaneChoiceGroupOption.iconProps + package: botbuilder-core + summary: The icon properties to use for the choice group option. + fullName: iconProps + remarks: '' + isDeprecated: false + syntax: + content: 'iconProps?: PropertyPaneChoiceGroupIconProperties' + return: + description: '' + type: + - name: imageSize + uid: botbuilder-core.PropertyPaneChoiceGroupOption.imageSize + package: botbuilder-core + summary: The image size to use for the choice group option. + fullName: imageSize + remarks: '' + isDeprecated: false + syntax: + content: 'imageSize?: PropertyPaneChoiceGroupImageSize' + return: + description: '' + type: + - name: imageSrc + uid: botbuilder-core.PropertyPaneChoiceGroupOption.imageSrc + package: botbuilder-core + summary: The image source to use for the choice group option. + fullName: imageSrc + remarks: '' + isDeprecated: false + syntax: + content: 'imageSrc?: string' + return: + description: '' + type: string + - name: key + uid: botbuilder-core.PropertyPaneChoiceGroupOption.key + package: botbuilder-core + summary: The key to uniquely identify the choice group option. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.PropertyPaneChoiceGroupOption.text + package: botbuilder-core + summary: The text to display next for this choice group option. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupProperties.yml new file mode 100644 index 00000000..f7647ec6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneChoiceGroupProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupProperties +uid: botbuilder-core.PropertyPaneChoiceGroupProperties +package: botbuilder-core +summary: SharePoint property pane choice group field properties. +fullName: PropertyPaneChoiceGroupProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: label + uid: botbuilder-core.PropertyPaneChoiceGroupProperties.label + package: botbuilder-core + summary: The label text to display next to the choice group. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: options + uid: botbuilder-core.PropertyPaneChoiceGroupProperties.options + package: botbuilder-core + summary: The options for the choice group. + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options: PropertyPaneChoiceGroupOption[]' + return: + description: '' + type: [] +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownOption.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownOption.yml new file mode 100644 index 00000000..aabf58f5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownOption.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneDropDownOption +uid: botbuilder-core.PropertyPaneDropDownOption +package: botbuilder-core +summary: SharePoint property pane drop down option. +fullName: PropertyPaneDropDownOption +remarks: '' +isDeprecated: false +type: interface +properties: + - name: index + uid: botbuilder-core.PropertyPaneDropDownOption.index + package: botbuilder-core + summary: The index of the option. + fullName: index + remarks: '' + isDeprecated: false + syntax: + content: 'index?: number' + return: + description: '' + type: number + - name: key + uid: botbuilder-core.PropertyPaneDropDownOption.key + package: botbuilder-core + summary: The key to uniquely identify the option. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.PropertyPaneDropDownOption.text + package: botbuilder-core + summary: The text to render for this option. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.PropertyPaneDropDownOption.type + package: botbuilder-core + summary: The type of option to render. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: DropDownOptionType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownProperties.yml new file mode 100644 index 00000000..cf133767 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneDropDownProperties.yml @@ -0,0 +1,113 @@ +### YamlMime:TSType +name: PropertyPaneDropDownProperties +uid: botbuilder-core.PropertyPaneDropDownProperties +package: botbuilder-core +summary: SharePoint property pane dropdown field properties. +fullName: PropertyPaneDropDownProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.PropertyPaneDropDownProperties.ariaLabel + package: botbuilder-core + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: ariaPositionInSet + uid: botbuilder-core.PropertyPaneDropDownProperties.ariaPositionInSet + package: botbuilder-core + summary: >- + The elemement's number or position in the current set of controls. Maps to + native aria-positionset attribute. It starts from 1. + fullName: ariaPositionInSet + remarks: '' + isDeprecated: false + syntax: + content: 'ariaPositionInSet?: number' + return: + description: '' + type: number + - name: ariaSetSize + uid: botbuilder-core.PropertyPaneDropDownProperties.ariaSetSize + package: botbuilder-core + summary: >- + The total number of elements in the current set of controls. Maps to + native aria-setsize attribute. + fullName: ariaSetSize + remarks: '' + isDeprecated: false + syntax: + content: 'ariaSetSize?: number' + return: + description: '' + type: number + - name: disabled + uid: botbuilder-core.PropertyPaneDropDownProperties.disabled + package: botbuilder-core + summary: Indicates whether the dropdown is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: errorMessage + uid: botbuilder-core.PropertyPaneDropDownProperties.errorMessage + package: botbuilder-core + summary: The error message to display when the dropdown value is invalid. + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder-core.PropertyPaneDropDownProperties.label + package: botbuilder-core + summary: The label text to display next to the dropdown. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: options + uid: botbuilder-core.PropertyPaneDropDownProperties.options + package: botbuilder-core + summary: The options for the dropdown. + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options?: PropertyPaneDropDownOption[]' + return: + description: '' + type: [] + - name: selectedKey + uid: botbuilder-core.PropertyPaneDropDownProperties.selectedKey + package: botbuilder-core + summary: The key of the selected dropdown option. + fullName: selectedKey + remarks: '' + isDeprecated: false + syntax: + content: 'selectedKey?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneFieldProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneFieldProperties.yml new file mode 100644 index 00000000..072dcf05 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneFieldProperties.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: PropertyPaneFieldProperties +uid: botbuilder-core.PropertyPaneFieldProperties +package: botbuilder-core +summary: SharePoint base property pane field properties +fullName: PropertyPaneFieldProperties +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroup.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroup.yml new file mode 100644 index 00000000..7543e99a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroup.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PropertyPaneGroup +uid: botbuilder-core.PropertyPaneGroup +package: botbuilder-core +summary: SharePoint property pane group. +fullName: PropertyPaneGroup +remarks: '' +isDeprecated: false +type: interface +properties: + - name: groupFields + uid: botbuilder-core.PropertyPaneGroup.groupFields + package: botbuilder-core + summary: The fields to be rendered inside this group. + fullName: groupFields + remarks: '' + isDeprecated: false + syntax: + content: 'groupFields: PropertyPaneGroupField[]' + return: + description: '' + type: [] + - name: groupName + uid: botbuilder-core.PropertyPaneGroup.groupName + package: botbuilder-core + summary: The name of the group. + fullName: groupName + remarks: '' + isDeprecated: false + syntax: + content: 'groupName?: string' + return: + description: '' + type: string + - name: isCollapsed + uid: botbuilder-core.PropertyPaneGroup.isCollapsed + package: botbuilder-core + summary: Whether the group is collapsed or not. + fullName: isCollapsed + remarks: '' + isDeprecated: false + syntax: + content: 'isCollapsed?: boolean' + return: + description: '' + type: boolean + - name: isGroupNameHidden + uid: botbuilder-core.PropertyPaneGroup.isGroupNameHidden + package: botbuilder-core + summary: Whether the group name is hidden or not. + fullName: isGroupNameHidden + remarks: '' + isDeprecated: false + syntax: + content: 'isGroupNameHidden?: boolean' + return: + description: '' + type: boolean +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupField.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupField.yml new file mode 100644 index 00000000..b08d0f5a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupField.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneGroupField +uid: botbuilder-core.PropertyPaneGroupField +package: botbuilder-core +summary: SharePoint property pane group field. +fullName: PropertyPaneGroupField +remarks: '' +isDeprecated: false +type: interface +properties: + - name: properties + uid: botbuilder-core.PropertyPaneGroupField.properties + package: botbuilder-core + summary: The properties for the field. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties: PropertyPaneFieldProperties' + return: + description: '' + type: + - name: shouldFocus + uid: botbuilder-core.PropertyPaneGroupField.shouldFocus + package: botbuilder-core + summary: Indicates whether the field should be focused or not. + fullName: shouldFocus + remarks: '' + isDeprecated: false + syntax: + content: 'shouldFocus?: boolean' + return: + description: '' + type: boolean + - name: targetProperty + uid: botbuilder-core.PropertyPaneGroupField.targetProperty + package: botbuilder-core + summary: The target property for the field. + fullName: targetProperty + remarks: '' + isDeprecated: false + syntax: + content: 'targetProperty: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.PropertyPaneGroupField.type + package: botbuilder-core + summary: The type of the field. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: FieldType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupOrConditionalGroup.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupOrConditionalGroup.yml new file mode 100644 index 00000000..1070f366 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneGroupOrConditionalGroup.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: PropertyPaneGroupOrConditionalGroup +uid: botbuilder-core.PropertyPaneGroupOrConditionalGroup +package: botbuilder-core +summary: SharePoint property pane group or conditional group +fullName: PropertyPaneGroupOrConditionalGroup +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLabelProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLabelProperties.yml new file mode 100644 index 00000000..3e2ca2d7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLabelProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: PropertyPaneLabelProperties +uid: botbuilder-core.PropertyPaneLabelProperties +package: botbuilder-core +summary: SharePoint property pane label properties. +fullName: PropertyPaneLabelProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: required + uid: botbuilder-core.PropertyPaneLabelProperties.required + package: botbuilder-core + summary: Whether the label is required or not. + fullName: required + remarks: '' + isDeprecated: false + syntax: + content: 'required?: boolean' + return: + description: '' + type: boolean + - name: text + uid: botbuilder-core.PropertyPaneLabelProperties.text + package: botbuilder-core + summary: The text to display in the label. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkPopupWindowProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkPopupWindowProperties.yml new file mode 100644 index 00000000..30824c1b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkPopupWindowProperties.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PropertyPaneLinkPopupWindowProperties +uid: botbuilder-core.PropertyPaneLinkPopupWindowProperties +package: botbuilder-core +summary: SharePoint property pane link popup window properties. +fullName: PropertyPaneLinkPopupWindowProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: height + uid: botbuilder-core.PropertyPaneLinkPopupWindowProperties.height + package: botbuilder-core + summary: The height of the popup window. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height: number' + return: + description: '' + type: number + - name: positionWindowPosition + uid: >- + botbuilder-core.PropertyPaneLinkPopupWindowProperties.positionWindowPosition + package: botbuilder-core + summary: The position of the popup window. + fullName: positionWindowPosition + remarks: '' + isDeprecated: false + syntax: + content: 'positionWindowPosition: PopupWindowPosition' + return: + description: '' + type: + - name: title + uid: botbuilder-core.PropertyPaneLinkPopupWindowProperties.title + package: botbuilder-core + summary: The title of the popup window. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: width + uid: botbuilder-core.PropertyPaneLinkPopupWindowProperties.width + package: botbuilder-core + summary: The width of the popup window. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkProperties.yml new file mode 100644 index 00000000..88edc0a2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneLinkProperties.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: PropertyPaneLinkProperties +uid: botbuilder-core.PropertyPaneLinkProperties +package: botbuilder-core +summary: SharePoint property pane link field properties. +fullName: PropertyPaneLinkProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.PropertyPaneLinkProperties.ariaLabel + package: botbuilder-core + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: disabled + uid: botbuilder-core.PropertyPaneLinkProperties.disabled + package: botbuilder-core + summary: Whether the link is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: href + uid: botbuilder-core.PropertyPaneLinkProperties.href + package: botbuilder-core + summary: The URL of the link. + fullName: href + remarks: '' + isDeprecated: false + syntax: + content: 'href: string' + return: + description: '' + type: string + - name: popupWindowProps + uid: botbuilder-core.PropertyPaneLinkProperties.popupWindowProps + package: botbuilder-core + summary: The properties of the popup window. + fullName: popupWindowProps + remarks: '' + isDeprecated: false + syntax: + content: 'popupWindowProps?: PropertyPaneLinkPopupWindowProperties' + return: + description: '' + type: + - name: target + uid: botbuilder-core.PropertyPaneLinkProperties.target + package: botbuilder-core + summary: The target of the link. + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.PropertyPaneLinkProperties.text + package: botbuilder-core + summary: The text to display in the link. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePage.yml new file mode 100644 index 00000000..e697e2f0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePage.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: PropertyPanePage +uid: botbuilder-core.PropertyPanePage +package: botbuilder-core +summary: SharePoint property pane page. +fullName: PropertyPanePage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayGroupsAsAccordion + uid: botbuilder-core.PropertyPanePage.displayGroupsAsAccordion + package: botbuilder-core + summary: Whether the groups should be displayed as an accordion or not. + fullName: displayGroupsAsAccordion + remarks: '' + isDeprecated: false + syntax: + content: 'displayGroupsAsAccordion?: boolean' + return: + description: '' + type: boolean + - name: groups + uid: botbuilder-core.PropertyPanePage.groups + package: botbuilder-core + summary: The groups to be rendered inside this page. + fullName: groups + remarks: '' + isDeprecated: false + syntax: + content: 'groups: PropertyPaneGroupOrConditionalGroup[]' + return: + description: '' + type: [] + - name: header + uid: botbuilder-core.PropertyPanePage.header + package: botbuilder-core + summary: The header to be rendered inside this page. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header?: PropertyPanePageHeader' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePageHeader.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePageHeader.yml new file mode 100644 index 00000000..092628ff --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPanePageHeader.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: PropertyPanePageHeader +uid: botbuilder-core.PropertyPanePageHeader +package: botbuilder-core +summary: SharePoint property pane page header. +fullName: PropertyPanePageHeader +remarks: '' +isDeprecated: false +type: interface +properties: + - name: description + uid: botbuilder-core.PropertyPanePageHeader.description + package: botbuilder-core + summary: The description of the page. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneSliderProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneSliderProperties.yml new file mode 100644 index 00000000..096ee076 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneSliderProperties.yml @@ -0,0 +1,109 @@ +### YamlMime:TSType +name: PropertyPaneSliderProperties +uid: botbuilder-core.PropertyPaneSliderProperties +package: botbuilder-core +summary: SharePoint property pane slider field properties. +fullName: PropertyPaneSliderProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.PropertyPaneSliderProperties.ariaLabel + package: botbuilder-core + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: disabled + uid: botbuilder-core.PropertyPaneSliderProperties.disabled + package: botbuilder-core + summary: Whether the slider is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: label + uid: botbuilder-core.PropertyPaneSliderProperties.label + package: botbuilder-core + summary: The label of the slider. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: max + uid: botbuilder-core.PropertyPaneSliderProperties.max + package: botbuilder-core + summary: The maximum value of the slider. + fullName: max + remarks: '' + isDeprecated: false + syntax: + content: 'max: number' + return: + description: '' + type: number + - name: min + uid: botbuilder-core.PropertyPaneSliderProperties.min + package: botbuilder-core + summary: The minimum value of the slider. + fullName: min + remarks: '' + isDeprecated: false + syntax: + content: 'min: number' + return: + description: '' + type: number + - name: showValue + uid: botbuilder-core.PropertyPaneSliderProperties.showValue + package: botbuilder-core + summary: Whether to show the value on the right of the slider or no. + fullName: showValue + remarks: '' + isDeprecated: false + syntax: + content: 'showValue?: boolean' + return: + description: '' + type: boolean + - name: step + uid: botbuilder-core.PropertyPaneSliderProperties.step + package: botbuilder-core + summary: The step value of the slider. + fullName: step + remarks: '' + isDeprecated: false + syntax: + content: 'step?: number' + return: + description: '' + type: number + - name: value + uid: botbuilder-core.PropertyPaneSliderProperties.value + package: botbuilder-core + summary: The value of the slider. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneTextFieldProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneTextFieldProperties.yml new file mode 100644 index 00000000..da69f7fc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneTextFieldProperties.yml @@ -0,0 +1,175 @@ +### YamlMime:TSType +name: PropertyPaneTextFieldProperties +uid: botbuilder-core.PropertyPaneTextFieldProperties +package: botbuilder-core +summary: SharePoint property pane text field properties. +fullName: PropertyPaneTextFieldProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.PropertyPaneTextFieldProperties.ariaLabel + package: botbuilder-core + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: description + uid: botbuilder-core.PropertyPaneTextFieldProperties.description + package: botbuilder-core + summary: The description to display under the text field. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description?: string' + return: + description: '' + type: string + - name: disabled + uid: botbuilder-core.PropertyPaneTextFieldProperties.disabled + package: botbuilder-core + summary: Whether the text field is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: errorMessage + uid: botbuilder-core.PropertyPaneTextFieldProperties.errorMessage + package: botbuilder-core + summary: >- + If set, this will be displayed as an error message underneath the text + field.. + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder-core.PropertyPaneTextFieldProperties.label + package: botbuilder-core + summary: The label of the text field. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: logName + uid: botbuilder-core.PropertyPaneTextFieldProperties.logName + package: botbuilder-core + summary: >- + Name used to log PropertyPaneTextField value changes for engagement + tracking. + fullName: logName + remarks: '' + isDeprecated: false + syntax: + content: 'logName?: string' + return: + description: '' + type: string + - name: maxLength + uid: botbuilder-core.PropertyPaneTextFieldProperties.maxLength + package: botbuilder-core + summary: The maximum length of the text field. + fullName: maxLength + remarks: '' + isDeprecated: false + syntax: + content: 'maxLength?: number' + return: + description: '' + type: number + - name: multiline + uid: botbuilder-core.PropertyPaneTextFieldProperties.multiline + package: botbuilder-core + summary: Whether or not the text field is multiline. + fullName: multiline + remarks: '' + isDeprecated: false + syntax: + content: 'multiline?: boolean' + return: + description: '' + type: boolean + - name: placeholder + uid: botbuilder-core.PropertyPaneTextFieldProperties.placeholder + package: botbuilder-core + summary: The placeholder text to display in the text field. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string + - name: resizable + uid: botbuilder-core.PropertyPaneTextFieldProperties.resizable + package: botbuilder-core + summary: Whether or not the multiline text field is resizable. + fullName: resizable + remarks: '' + isDeprecated: false + syntax: + content: 'resizable?: boolean' + return: + description: '' + type: boolean + - name: rows + uid: botbuilder-core.PropertyPaneTextFieldProperties.rows + package: botbuilder-core + summary: >- + Specifies the visible height of a text area(multiline text TextField), in + lines. + fullName: rows + remarks: '' + isDeprecated: false + syntax: + content: 'rows?: number' + return: + description: '' + type: number + - name: underlined + uid: botbuilder-core.PropertyPaneTextFieldProperties.underlined + package: botbuilder-core + summary: Whether or not the text field is underlined. + fullName: underlined + remarks: '' + isDeprecated: false + syntax: + content: 'underlined?: boolean' + return: + description: '' + type: boolean + - name: value + uid: botbuilder-core.PropertyPaneTextFieldProperties.value + package: botbuilder-core + summary: The value of the text field. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneToggleProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneToggleProperties.yml new file mode 100644 index 00000000..44d6a7ea --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/PropertyPaneToggleProperties.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: PropertyPaneToggleProperties +uid: botbuilder-core.PropertyPaneToggleProperties +package: botbuilder-core +summary: SharePoint property pane toggle field properties. +fullName: PropertyPaneToggleProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder-core.PropertyPaneToggleProperties.ariaLabel + package: botbuilder-core + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: checked + uid: botbuilder-core.PropertyPaneToggleProperties.checked + package: botbuilder-core + summary: Indicates whether the toggle is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botbuilder-core.PropertyPaneToggleProperties.disabled + package: botbuilder-core + summary: Indicates whether the toggle is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: key + uid: botbuilder-core.PropertyPaneToggleProperties.key + package: botbuilder-core + summary: A key to uniquely identify the toggle. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder-core.PropertyPaneToggleProperties.label + package: botbuilder-core + summary: A label for the toggle. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: offAriaLabel + uid: botbuilder-core.PropertyPaneToggleProperties.offAriaLabel + package: botbuilder-core + summary: >- + Optional offAriaLabel flag. Text for screen-reader to announce when toggle + is OFF. + fullName: offAriaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'offAriaLabel?: string' + return: + description: '' + type: string + - name: offText + uid: botbuilder-core.PropertyPaneToggleProperties.offText + package: botbuilder-core + summary: Text to display when toggle is OFF. + fullName: offText + remarks: '' + isDeprecated: false + syntax: + content: 'offText?: string' + return: + description: '' + type: string + - name: onAriaLabel + uid: botbuilder-core.PropertyPaneToggleProperties.onAriaLabel + package: botbuilder-core + summary: >- + Optional onAriaLabel flag. Text for screen-reader to announce when toggle + is ON. + fullName: onAriaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'onAriaLabel?: string' + return: + description: '' + type: string + - name: onText + uid: botbuilder-core.PropertyPaneToggleProperties.onText + package: botbuilder-core + summary: Text to display when toggle is ON. + fullName: onText + remarks: '' + isDeprecated: false + syntax: + content: 'onText?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QueueStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QueueStorage.yml index e0e7f166..714b4475 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QueueStorage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QueueStorage.yml @@ -5,11 +5,10 @@ package: botbuilder-core summary: A base class for enqueueing an Activity for later processing. fullName: QueueStorage remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'queueActivity(Partial, number, number)' + - name: queueActivity(Partial, number, number) uid: botbuilder-core.QueueStorage.queueActivity package: botbuilder-core summary: >- @@ -18,7 +17,6 @@ methods: to Dequeue and Peek operations. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -26,7 +24,7 @@ methods: number, timeToLive?: number): Promise parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: >- The [Activity](xref:botframework-schema.Activity) to be queued for later processing. @@ -37,8 +35,7 @@ methods: Cannot be larger than 7 days. - id: timeToLive type: number - description: | - Specifies the time-to-live interval for the message in seconds. + description: Specifies the time-to-live interval for the message in seconds. return: description: '' type: Promise<string> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewCardAction.yml new file mode 100644 index 00000000..62df6f18 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: QuickViewCardAction +uid: botbuilder-core.QuickViewCardAction +package: botbuilder-core +summary: SharePoint QuickView action. +fullName: QuickViewCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder-core.QuickViewCardAction.parameters + package: botbuilder-core + summary: Parameters for the quick view opened by this action + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: QuickViewParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.QuickViewCardAction.type + package: botbuilder-core + summary: Indicates this action opens the quick view. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "QuickView"' + return: + description: '' + type: '"QuickView"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewData.yml new file mode 100644 index 00000000..dc986ea2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewData.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: QuickViewData +uid: botbuilder-core.QuickViewData +package: botbuilder-core +summary: '' +fullName: QuickViewData +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewHandleActionResponse.yml new file mode 100644 index 00000000..25670884 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: QuickViewHandleActionResponse +uid: botbuilder-core.QuickViewHandleActionResponse +package: botbuilder-core +summary: The handle action response for quick view. +fullName: QuickViewHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder-core.QuickViewHandleActionResponse.renderArguments + package: botbuilder-core + summary: Quick view render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments: QuickViewResponse' + return: + description: '' + type: + - name: responseType + uid: botbuilder-core.QuickViewHandleActionResponse.responseType + package: botbuilder-core + summary: Quick view. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "QuickView"' + return: + description: '' + type: '"QuickView"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewParameters.yml new file mode 100644 index 00000000..b93b8ba4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: QuickViewParameters +uid: botbuilder-core.QuickViewParameters +package: botbuilder-core +summary: Parameters for opening a Quick view. +fullName: QuickViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: view + uid: botbuilder-core.QuickViewParameters.view + package: botbuilder-core + summary: The view of the Quick view to open. + fullName: view + remarks: '' + isDeprecated: false + syntax: + content: 'view: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewResponse.yml new file mode 100644 index 00000000..6c1d9cdb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/QuickViewResponse.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: QuickViewResponse +uid: botbuilder-core.QuickViewResponse +package: botbuilder-core +summary: SharePoint ACE Quick view response payload. +fullName: QuickViewResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder-core.QuickViewResponse.data + package: botbuilder-core + summary: The quick view data. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: QuickViewData' + return: + description: '' + type: + - name: externalLink + uid: botbuilder-core.QuickViewResponse.externalLink + package: botbuilder-core + summary: >- + An optional external link to be displayed in the navigation bar above the + Adaptive Card. + fullName: externalLink + remarks: '' + isDeprecated: false + syntax: + content: 'externalLink: ExternalLinkActionParameters' + return: + description: '' + type: + - name: focusParameters + uid: botbuilder-core.QuickViewResponse.focusParameters + package: botbuilder-core + summary: >- + An optional focus element to set focus when the view is rendered for + accessibility purposes. + fullName: focusParameters + remarks: '' + isDeprecated: false + syntax: + content: 'focusParameters: FocusParameters' + return: + description: '' + type: + - name: template + uid: botbuilder-core.QuickViewResponse.template + package: botbuilder-core + summary: The adaptive card template for the quick view. + fullName: template + remarks: '' + isDeprecated: false + syntax: + content: 'template: AdaptiveCard' + return: + description: '' + type: AdaptiveCard + - name: title + uid: botbuilder-core.QuickViewResponse.title + package: botbuilder-core + summary: The title of the quick view. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: viewId + uid: botbuilder-core.QuickViewResponse.viewId + package: botbuilder-core + summary: The view id. + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReactionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReactionType.yml new file mode 100644 index 00000000..9c6d39ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReactionType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ReactionType +uid: botbuilder-core.ReactionType +package: botbuilder-core +summary: |- + Defines values for ReactionType. + Possible values include: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' +fullName: ReactionType +remarks: '' +isDeprecated: false +syntax: | + type ReactionType = "like" | "heart" | "laugh" | "surprised" | "sad" | "angry" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptCard.yml new file mode 100644 index 00000000..3e08a1be --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptCard.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: ReceiptCard +uid: botbuilder-core.ReceiptCard +package: botbuilder-core +summary: A receipt card +fullName: ReceiptCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder-core.ReceiptCard.buttons + package: botbuilder-core + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: facts + uid: botbuilder-core.ReceiptCard.facts + package: botbuilder-core + summary: Array of Fact objects + fullName: facts + remarks: '' + isDeprecated: false + syntax: + content: 'facts: Fact[]' + return: + description: '' + type: [] + - name: items + uid: botbuilder-core.ReceiptCard.items + package: botbuilder-core + summary: Array of Receipt Items + fullName: items + remarks: '' + isDeprecated: false + syntax: + content: 'items: ReceiptItem[]' + return: + description: '' + type: [] + - name: tap + uid: botbuilder-core.ReceiptCard.tap + package: botbuilder-core + summary: This action will be activated when user taps on the card + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: tax + uid: botbuilder-core.ReceiptCard.tax + package: botbuilder-core + summary: Total amount of tax paid (or to be paid) + fullName: tax + remarks: '' + isDeprecated: false + syntax: + content: 'tax: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.ReceiptCard.title + package: botbuilder-core + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: total + uid: botbuilder-core.ReceiptCard.total + package: botbuilder-core + summary: Total amount of money paid (or to be paid) + fullName: total + remarks: '' + isDeprecated: false + syntax: + content: 'total: string' + return: + description: '' + type: string + - name: vat + uid: botbuilder-core.ReceiptCard.vat + package: botbuilder-core + summary: Total amount of VAT paid (or to be paid) + fullName: vat + remarks: '' + isDeprecated: false + syntax: + content: 'vat: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptItem.yml new file mode 100644 index 00000000..6fc15999 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ReceiptItem.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: ReceiptItem +uid: botbuilder-core.ReceiptItem +package: botbuilder-core +summary: An item on a receipt card +fullName: ReceiptItem +remarks: '' +isDeprecated: false +type: interface +properties: + - name: image + uid: botbuilder-core.ReceiptItem.image + package: botbuilder-core + summary: Image + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: CardImage' + return: + description: '' + type: + - name: price + uid: botbuilder-core.ReceiptItem.price + package: botbuilder-core + summary: Amount with currency + fullName: price + remarks: '' + isDeprecated: false + syntax: + content: 'price: string' + return: + description: '' + type: string + - name: quantity + uid: botbuilder-core.ReceiptItem.quantity + package: botbuilder-core + summary: Number of items of given kind + fullName: quantity + remarks: '' + isDeprecated: false + syntax: + content: 'quantity: string' + return: + description: '' + type: string + - name: subtitle + uid: botbuilder-core.ReceiptItem.subtitle + package: botbuilder-core + summary: >- + Subtitle appears just below Title field, differs from Title in font + styling only + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder-core.ReceiptItem.tap + package: botbuilder-core + summary: This action will be activated when user taps on the Item bubble. + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder-core.ReceiptItem.text + package: botbuilder-core + summary: >- + Text field appears just below subtitle, differs from Subtitle in font + styling only + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.ReceiptItem.title + package: botbuilder-core + summary: Title of the Card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RecognizerResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RecognizerResult.yml index 7b14d548..1f496d51 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RecognizerResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RecognizerResult.yml @@ -5,17 +5,15 @@ package: botbuilder-core summary: Value returned from a recognizer. fullName: RecognizerResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: alteredText uid: botbuilder-core.RecognizerResult.alteredText package: botbuilder-core - summary: 'If original text is changed by things like spelling, the altered version.' + summary: If original text is changed by things like spelling, the altered version. fullName: alteredText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alteredText?: string' @@ -28,7 +26,6 @@ properties: summary: (Optional) entities recognized. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: any' @@ -41,20 +38,18 @@ properties: summary: Intents recognized for the utterance. fullName: intents remarks: A map of intent names to an object with score is returned. - isPreview: false isDeprecated: false syntax: content: 'intents: Record' return: description: '' - type: 'Record<string, >' + type: Record<string, > - name: text uid: botbuilder-core.RecognizerResult.text package: botbuilder-core summary: Utterance sent to recognizer fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RegisterClassMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RegisterClassMiddleware.yml index 18ee6b62..e11e6a4d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RegisterClassMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RegisterClassMiddleware.yml @@ -7,16 +7,14 @@ summary: >- turn context. fullName: RegisterClassMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'RegisterClassMiddleware(T, string | symbol)' + - name: RegisterClassMiddleware(T, string | symbol) uid: botbuilder-core.RegisterClassMiddleware.constructor package: botbuilder-core summary: Initialize a new instance of the RegisterClassMiddleware class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new RegisterClassMiddleware(service: T, key: string | symbol)' @@ -26,8 +24,7 @@ constructors: description: The object or service to add. - id: key type: string | symbol - description: | - The key for service object in turn state. + description: The key for service object in turn state. properties: - name: service uid: botbuilder-core.RegisterClassMiddleware.service @@ -35,7 +32,6 @@ properties: summary: The object or service to add to the turn context. fullName: service remarks: '' - isPreview: false isDeprecated: false syntax: content: 'service: T' @@ -43,12 +39,11 @@ properties: description: '' type: T methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.RegisterClassMiddleware.onTurn package: botbuilder-core summary: Adds the associated object or service to the current turn context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,8 +55,7 @@ methods: description: The context object for this turn. - id: next type: () => Promise<void> - description: | - The delegate to call to continue the bot middleware pipeline. + description: The delegate to call to continue the bot middleware pipeline. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ResourceResponse.yml new file mode 100644 index 00000000..63af3ca9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ResourceResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ResourceResponse +uid: botbuilder-core.ResourceResponse +package: botbuilder-core +summary: A response containing a resource ID +fullName: ResourceResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.ResourceResponse.id + package: botbuilder-core + summary: Id of the resource + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RoleTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RoleTypes.yml new file mode 100644 index 00000000..efc3f30f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/RoleTypes.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: RoleTypes +uid: botbuilder-core.RoleTypes +package: botbuilder-core +summary: |- + Defines values for RoleTypes. + Possible values include: 'user', 'bot', 'skill' +fullName: RoleTypes +remarks: '' +isDeprecated: false +fields: + - name: Bot + uid: botbuilder-core.RoleTypes.Bot + package: botbuilder-core + summary: '' + - name: Skill + uid: botbuilder-core.RoleTypes.Skill + package: botbuilder-core + summary: '' + - name: User + uid: botbuilder-core.RoleTypes.User + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchCardViewParameters.yml new file mode 100644 index 00000000..1638f9d9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchCardViewParameters.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: SearchCardViewParameters +uid: botbuilder-core.SearchCardViewParameters +package: botbuilder-core +summary: The parameters for the search card view. +fullName: SearchCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.SearchCardViewParameters.body + package: botbuilder-core + summary: Body area components. Contains a single search box. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: [CardSearchBoxComponent]' + return: + description: '' + type: '[CardSearchBoxComponent]' + - name: cardViewType + uid: botbuilder-core.SearchCardViewParameters.cardViewType + package: botbuilder-core + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "search"' + return: + description: '' + type: '"search"' + - name: footer + uid: botbuilder-core.SearchCardViewParameters.footer + package: botbuilder-core + summary: Footer area components. Contains a single search footer. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: [CardSearchFooterComponent]' + return: + description: '' + type: '[CardSearchFooterComponent]' + - name: header + uid: botbuilder-core.SearchCardViewParameters.header + package: botbuilder-core + summary: Header area components. Contains a single text field. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' +inheritedProperties: + - name: cardBar + uid: botbuilder-core.SearchCardViewParameters.cardBar + package: botbuilder-core + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder-core.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeOptions.yml new file mode 100644 index 00000000..e468ab91 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeOptions.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: SearchInvokeOptions +uid: botbuilder-core.SearchInvokeOptions +package: botbuilder-core +summary: >- + Provides information about the options desired for a + [SearchInvokeValue](xref:botframework-schema.SearchInvokeValue) +fullName: SearchInvokeOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: skip + uid: botbuilder-core.SearchInvokeOptions.skip + package: botbuilder-core + summary: >- + Indicates starting reference number from which ordered search results + should be returned. + fullName: skip + remarks: '' + isDeprecated: false + syntax: + content: 'skip: number' + return: + description: '' + type: number + - name: top + uid: botbuilder-core.SearchInvokeOptions.top + package: botbuilder-core + summary: Indicates the number of search results that should be returned. + fullName: top + remarks: '' + isDeprecated: false + syntax: + content: 'top: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeResponse.yml new file mode 100644 index 00000000..65970801 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeResponse.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: SearchInvokeResponse +uid: botbuilder-core.SearchInvokeResponse +package: botbuilder-core +summary: >- + Defines the structure that is returned as the result of an Invoke activity + with + + Name of 'application/search'. +fullName: SearchInvokeResponse +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: statusCode + uid: botbuilder-core.SearchInvokeResponse.statusCode + package: botbuilder-core + summary: The Card Action response status code. + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AdaptiveCardInvokeResponse.statusCode](xref:botbuilder-core.AdaptiveCardInvokeResponse.statusCode) + - name: type + uid: botbuilder-core.SearchInvokeResponse.type + package: botbuilder-core + summary: The type of this response. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AdaptiveCardInvokeResponse.type](xref:botbuilder-core.AdaptiveCardInvokeResponse.type) + - name: value + uid: botbuilder-core.SearchInvokeResponse.value + package: botbuilder-core + summary: The json response object. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: Record' + return: + description: '' + type: Record<string, unknown> + inheritanceDescription: >- + Inherited From + [AdaptiveCardInvokeResponse.value](xref:botbuilder-core.AdaptiveCardInvokeResponse.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeValue.yml new file mode 100644 index 00000000..3117856a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SearchInvokeValue.yml @@ -0,0 +1,73 @@ +### YamlMime:TSType +name: SearchInvokeValue +uid: botbuilder-core.SearchInvokeValue +package: botbuilder-core +summary: >- + Defines the structure that arrives in the Activity.Value for Invoke activity + with + + Name of 'application/search'. +fullName: SearchInvokeValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder-core.SearchInvokeValue.context + package: botbuilder-core + summary: >- + The the context information about the query. Such as the UI control that + issued the query. + + The type of the context field is object and is dependent on the kind + field. + + For search and searchAnswers, there is no defined context value. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context: any' + return: + description: '' + type: any + - name: kind + uid: botbuilder-core.SearchInvokeValue.kind + package: botbuilder-core + summary: |- + The kind of the search invoke value. + Must be either search, searchAnswer or typeAhead. + fullName: kind + remarks: '' + isDeprecated: false + syntax: + content: 'kind: string' + return: + description: '' + type: string + - name: queryOptions + uid: botbuilder-core.SearchInvokeValue.queryOptions + package: botbuilder-core + summary: |- + The [SearchInvokeOptions](xref:botframework-schema.SearchInvokeOptions) + for this search invoke value. + fullName: queryOptions + remarks: '' + isDeprecated: false + syntax: + content: 'queryOptions: SearchInvokeOptions' + return: + description: '' + type: + - name: queryText + uid: botbuilder-core.SearchInvokeValue.queryText + package: botbuilder-core + summary: The query text for the search invoke value. + fullName: queryText + remarks: '' + isDeprecated: false + syntax: + content: 'queryText: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaActionParameters.yml new file mode 100644 index 00000000..ddd12985 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaActionParameters.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: SelectMediaActionParameters +uid: botbuilder-core.SelectMediaActionParameters +package: botbuilder-core +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.SelectMendia + action. +fullName: SelectMediaActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: allowMultipleCapture + uid: botbuilder-core.SelectMediaActionParameters.allowMultipleCapture + package: botbuilder-core + summary: Allow multiple images to be selected. + fullName: allowMultipleCapture + remarks: '' + isDeprecated: false + syntax: + content: 'allowMultipleCapture?: boolean' + return: + description: '' + type: boolean + - name: maxSizePerFile + uid: botbuilder-core.SelectMediaActionParameters.maxSizePerFile + package: botbuilder-core + summary: Max file size that can be uploaded. + fullName: maxSizePerFile + remarks: '' + isDeprecated: false + syntax: + content: 'maxSizePerFile?: number' + return: + description: '' + type: number + - name: mediaType + uid: botbuilder-core.SelectMediaActionParameters.mediaType + package: botbuilder-core + summary: Specifies the specific media type that should be selected + fullName: mediaType + remarks: '' + isDeprecated: false + syntax: + content: 'mediaType: MediaType' + return: + description: '' + type: + - name: supportedFileFormats + uid: botbuilder-core.SelectMediaActionParameters.supportedFileFormats + package: botbuilder-core + summary: File formats supported for upload. + fullName: supportedFileFormats + remarks: '' + isDeprecated: false + syntax: + content: 'supportedFileFormats?: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaCardAction.yml new file mode 100644 index 00000000..dc40a56c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SelectMediaCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: SelectMediaCardAction +uid: botbuilder-core.SelectMediaCardAction +package: botbuilder-core +summary: SharePoint `VivaAction.SelectMedia` event. +fullName: SelectMediaCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder-core.SelectMediaCardAction.parameters + package: botbuilder-core + summary: Parameters for the Select Media Action + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: SelectMediaActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.SelectMediaCardAction.type + package: botbuilder-core + summary: Indicates this is a Viva Select Media button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.SelectMedia"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticAction.yml new file mode 100644 index 00000000..4cfe5348 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SemanticAction +uid: botbuilder-core.SemanticAction +package: botbuilder-core +summary: Represents a reference to a programmatic action +fullName: SemanticAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: entities + uid: botbuilder-core.SemanticAction.entities + package: botbuilder-core + summary: Entities associated with this action + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities: {[propertyName: string]: Entity}' + return: + description: '' + type: '{[propertyName: string]: }' + - name: id + uid: botbuilder-core.SemanticAction.id + package: botbuilder-core + summary: ID of this action + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: state + uid: botbuilder-core.SemanticAction.state + package: botbuilder-core + summary: 'State of this action. Allowed values: ''start'', ''continue'', ''done''' + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticActionStateTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticActionStateTypes.yml new file mode 100644 index 00000000..0086258e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SemanticActionStateTypes.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: SemanticActionStateTypes +uid: botbuilder-core.SemanticActionStateTypes +package: botbuilder-core +summary: |- + Defines values for SemanticActionStateTypes. + Possible values include: 'start', 'continue', 'done' +fullName: SemanticActionStateTypes +remarks: '' +isDeprecated: false +fields: + - name: Continue + uid: botbuilder-core.SemanticActionStateTypes.Continue + package: botbuilder-core + summary: '' + - name: Done + uid: botbuilder-core.SemanticActionStateTypes.Done + package: botbuilder-core + summary: '' + - name: Start + uid: botbuilder-core.SemanticActionStateTypes.Start + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SendActivitiesHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SendActivitiesHandler.yml index 2cc9e658..c900877c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SendActivitiesHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SendActivitiesHandler.yml @@ -59,7 +59,6 @@ remarks: >- - [TurnContext.onSendActivities](xref:botbuilder-core.TurnContext.onSendActivities) -isPreview: false isDeprecated: false syntax: | type SendActivitiesHandler = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SetPropertyPaneConfigurationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SetPropertyPaneConfigurationResponse.yml new file mode 100644 index 00000000..29a843f1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SetPropertyPaneConfigurationResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: SetPropertyPaneConfigurationResponse +uid: botbuilder-core.SetPropertyPaneConfigurationResponse +package: botbuilder-core +summary: '' +fullName: SetPropertyPaneConfigurationResponse +remarks: '' +isDeprecated: false +syntax: | + type SetPropertyPaneConfigurationResponse = + | CardViewHandleActionResponse + | NoOpHandleActionResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Severity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Severity.yml index 9ea1c1ff..3cf807ab 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Severity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Severity.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Defines the level of severity for the event. fullName: Severity remarks: '' -isPreview: false isDeprecated: false fields: - name: Verbose diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationActionParameters.yml new file mode 100644 index 00000000..05441116 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationActionParameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: ShowLocationActionParameters +uid: botbuilder-core.ShowLocationActionParameters +package: botbuilder-core +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.ShowLocation + action. +fullName: ShowLocationActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: locationCoordinates + uid: botbuilder-core.ShowLocationActionParameters.locationCoordinates + package: botbuilder-core + summary: |- + If set, show the coordinates that were passed. + Otherwise, show the current location. + fullName: locationCoordinates + remarks: '' + isDeprecated: false + syntax: + content: 'locationCoordinates?: Location' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationCardAction.yml new file mode 100644 index 00000000..5bd11179 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowLocationCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ShowLocationCardAction +uid: botbuilder-core.ShowLocationCardAction +package: botbuilder-core +summary: SharePoint `VivaAction.ShowLocation` event. +fullName: ShowLocationCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder-core.ShowLocationCardAction.parameters + package: botbuilder-core + summary: Parameters that can be supplied with the Viva Show Location action. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: ShowLocationActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.ShowLocationCardAction.type + package: botbuilder-core + summary: Indicates this is a Viva show Location button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.ShowLocation"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowTypingMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowTypingMiddleware.yml index b637d0de..beb33d51 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowTypingMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ShowTypingMiddleware.yml @@ -18,16 +18,14 @@ remarks: >- sent. Typing activities will continue to be sent until your bot sends another message back to the user -isPreview: false isDeprecated: false type: class constructors: - - name: 'ShowTypingMiddleware(number, number)' + - name: ShowTypingMiddleware(number, number) uid: botbuilder-core.ShowTypingMiddleware.constructor package: botbuilder-core summary: Create the SendTypingIndicator middleware remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ShowTypingMiddleware(delay?: number, period?: number)' @@ -35,20 +33,19 @@ constructors: - id: delay type: number description: >- - Number of milliseconds to wait before sending the first typing - indicator. + {number} Number of milliseconds to wait before sending the first + typing indicator. - id: period type: number - description: > - Number of milliseconds to wait before sending each following - indicator. + description: >- + {number} Number of milliseconds to wait before sending each + following indicator. methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.ShowTypingMiddleware.onTurn package: botbuilder-core summary: Processes an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -57,11 +54,10 @@ methods: parameters: - id: context type: - description: An incoming TurnContext object. + description: '{TurnContext} An incoming TurnContext object.' - id: next type: () => Promise<void> - description: | - The next delegate function. + description: '{function} The next delegate function.' return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInCardViewParameters.yml new file mode 100644 index 00000000..1756e5ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInCardViewParameters.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: SignInCardViewParameters +uid: botbuilder-core.SignInCardViewParameters +package: botbuilder-core +summary: The parameters for the sign in card view. +fullName: SignInCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.SignInCardViewParameters.body + package: botbuilder-core + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: undefined | [CardTextComponent]' + return: + description: '' + type: undefined | [CardTextComponent] + - name: cardViewType + uid: botbuilder-core.SignInCardViewParameters.cardViewType + package: botbuilder-core + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "signIn"' + return: + description: '' + type: '"signIn"' + - name: footer + uid: botbuilder-core.SignInCardViewParameters.footer + package: botbuilder-core + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: [CardButtonComponent]' + return: + description: '' + type: '[CardButtonComponent]' + - name: header + uid: botbuilder-core.SignInCardViewParameters.header + package: botbuilder-core + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' +inheritedProperties: + - name: cardBar + uid: botbuilder-core.SignInCardViewParameters.cardBar + package: botbuilder-core + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder-core.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInUrlResponse.yml new file mode 100644 index 00000000..07e0ccb1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SignInUrlResponse.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SignInUrlResponse +uid: botbuilder-core.SignInUrlResponse +package: botbuilder-core +summary: '' +fullName: SignInUrlResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: signInLink + uid: botbuilder-core.SignInUrlResponse.signInLink + package: botbuilder-core + summary: '' + fullName: signInLink + remarks: '' + isDeprecated: false + syntax: + content: 'signInLink?: string' + return: + description: '' + type: string + - name: tokenExchangeResource + uid: botbuilder-core.SignInUrlResponse.tokenExchangeResource + package: botbuilder-core + summary: '' + fullName: tokenExchangeResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenExchangeResource?: TokenExchangeResource' + return: + description: '' + type: + - name: tokenPostResource + uid: botbuilder-core.SignInUrlResponse.tokenPostResource + package: botbuilder-core + summary: '' + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource?: TokenPostResource' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninCard.yml new file mode 100644 index 00000000..94c9b6de --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninCard.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: SigninCard +uid: botbuilder-core.SigninCard +package: botbuilder-core +summary: A card representing a request to sign in +fullName: SigninCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder-core.SigninCard.buttons + package: botbuilder-core + summary: Action to use to perform signin + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: text + uid: botbuilder-core.SigninCard.text + package: botbuilder-core + summary: Text for signin request + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninStateVerificationQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninStateVerificationQuery.yml new file mode 100644 index 00000000..c6293d62 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SigninStateVerificationQuery.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: SigninStateVerificationQuery +uid: botbuilder-core.SigninStateVerificationQuery +package: botbuilder-core +summary: '' +fullName: SigninStateVerificationQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: state + uid: botbuilder-core.SigninStateVerificationQuery.state + package: botbuilder-core + summary: The state string originally received when the + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactory.yml index 54a29c18..6e5d4dab 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactory.yml @@ -8,7 +8,6 @@ summary: >- instances. fullName: SkillConversationIdFactory remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,14 +16,13 @@ constructors: package: botbuilder-core summary: Creates a new instance of the SkillConversationIdFactory class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SkillConversationIdFactory(storage: Storage)' parameters: - id: storage type: - description: > + description: >- The storage for the [ConversationReference](xref:botframework-schema:ConversationReference) instances. @@ -40,7 +38,6 @@ inheritedMethods: should not contain special characters. Returns A unique conversation ID used to communicate with the skill. - isPreview: false isDeprecated: true customDeprecatedMessage: >- Method is deprecated, please use createSkillConversationIdWithOptions() @@ -51,7 +48,7 @@ inheritedMethods: ConversationReference): Promise parameters: - id: _conversationReference - type: ConversationReference + type: description: The skill's caller ConversationReference. return: description: '' @@ -68,9 +65,8 @@ inheritedMethods: remarks: >- Returns The caller's ConversationReference for a skillConversationId. null if not found. - isPreview: false isDeprecated: true - customDeprecatedMessage: 'Method is deprecated, please use getSkillConversationReference() instead.' + customDeprecatedMessage: Method is deprecated, please use getSkillConversationReference() instead. syntax: content: >- function getConversationReference(_skillConversationId: string): @@ -81,7 +77,7 @@ inheritedMethods: description: A skill conversationId created using createSkillConversationId(). return: description: '' - type: Promise<ConversationReference> + type: Promise<> inheritanceDescription: >- Inherited From [SkillConversationIdFactoryBase.getConversationReference](xref:botbuilder-core.SkillConversationIdFactoryBase.getConversationReference) @@ -94,7 +90,6 @@ methods: Creates a conversation ID for a skill conversation based on the caller's [ConversationReference](xref:botframework-schema:ConversationReference). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,7 +113,6 @@ methods: [SkillConversationReference](xref:botbuilder-core.SkillConversationReference) from the storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -138,7 +132,6 @@ methods: Gets the ConversationReference created using createSkillConversationId() for a skillConversationId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryBase.yml index 747fa035..7c15d6b9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryBase.yml @@ -7,7 +7,6 @@ summary: >- IDs for skill conversations. fullName: SkillConversationIdFactoryBase remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -22,7 +21,6 @@ methods: should not contain special characters. Returns A unique conversation ID used to communicate with the skill. - isPreview: false isDeprecated: true customDeprecatedMessage: >- Method is deprecated, please use createSkillConversationIdWithOptions() @@ -33,7 +31,7 @@ methods: ConversationReference): Promise parameters: - id: _conversationReference - type: ConversationReference + type: description: The skill's caller ConversationReference. return: description: '' @@ -50,7 +48,6 @@ methods: should not contain special characters. Returns A unique conversation ID used to communicate with the skill. - isPreview: false isDeprecated: false syntax: content: >- @@ -71,7 +68,6 @@ methods: package: botbuilder-core summary: Deletes a ConversationReference. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -80,8 +76,7 @@ methods: parameters: - id: skillConversationId type: string - description: | - A skill conversationId created using createSkillConversationId(). + description: A skill conversationId created using createSkillConversationId(). return: description: '' type: Promise<void> @@ -94,9 +89,8 @@ methods: remarks: >- Returns The caller's ConversationReference for a skillConversationId. null if not found. - isPreview: false isDeprecated: true - customDeprecatedMessage: 'Method is deprecated, please use getSkillConversationReference() instead.' + customDeprecatedMessage: Method is deprecated, please use getSkillConversationReference() instead. syntax: content: >- function getConversationReference(_skillConversationId: string): @@ -107,7 +101,7 @@ methods: description: A skill conversationId created using createSkillConversationId(). return: description: '' - type: Promise<ConversationReference> + type: Promise<> - name: getSkillConversationReference(string) uid: >- botbuilder-core.SkillConversationIdFactoryBase.getSkillConversationReference @@ -116,7 +110,6 @@ methods: Gets the SkillConversationReference created using createSkillConversationId() for a skillConversationId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -125,7 +118,7 @@ methods: parameters: - id: _skillConversationId type: string - description: > + description: >- Gets the SkillConversationReference used during createSkillConversationId for a skillConversationId. return: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryOptions.yml index c62a2199..e57455aa 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationIdFactoryOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: SkillConversationIdFactoryOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: The activity which will be sent to the skill. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity: Activity' return: description: '' - type: Activity + type: - name: botFrameworkSkill uid: botbuilder-core.SkillConversationIdFactoryOptions.botFrameworkSkill package: botbuilder-core summary: The skill to create the conversation Id for. fullName: botFrameworkSkill remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botFrameworkSkill: BotFrameworkSkill' @@ -41,7 +38,6 @@ properties: summary: The id of the parent bot that is messaging the skill. fullName: fromBotId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fromBotId: string' @@ -57,7 +53,6 @@ properties: another skill). fullName: fromBotOAuthScope remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fromBotOAuthScope: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationReference.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationReference.yml index ac7b10ff..5cfcb7cf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationReference.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkillConversationReference.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: SkillConversationReference remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: conversationReference remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationReference: ConversationReference' return: description: '' - type: ConversationReference + type: - name: oAuthScope uid: botbuilder-core.SkillConversationReference.oAuthScope package: botbuilder-core summary: '' fullName: oAuthScope remarks: '' - isPreview: false isDeprecated: false syntax: content: 'oAuthScope: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkypeMentionNormalizeMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkypeMentionNormalizeMiddleware.yml index bf12372e..5df4bd0b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkypeMentionNormalizeMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SkypeMentionNormalizeMiddleware.yml @@ -17,7 +17,6 @@ remarks: >- the entity from Activity.Text. This will remove the nodes, leaving just the name. -isPreview: false isDeprecated: false type: class methods: @@ -26,17 +25,16 @@ methods: package: botbuilder-core summary: Performs the normalization of Skype mention Entities. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function normalizeSkypeMentionText(activity: Activity)' parameters: - id: activity - type: Activity - description: > - (xref:botframework-schema.Activity) containing the mentions to - normalize. - - name: 'onTurn(TurnContext, () => Promise)' + type: + description: >- + [Activity](xref:botframework-schema.Activity) containing the + mentions to normalize. + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.SkypeMentionNormalizeMiddleware.onTurn package: botbuilder-core summary: >- @@ -45,7 +43,6 @@ methods: [removeMentionText](xref:botbuilder-core.TurnContext.removeMentionText) can work with. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -55,12 +52,11 @@ methods: - id: turnContext type: description: >- - (xref:botbuilder-core.TurnContext) for the current turn of - conversation. + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation. - id: next type: () => Promise<void> - description: | - Delegate to call to continue the bot middleware pipeline. + description: Delegate to call to continue the bot middleware pipeline. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SpeechConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SpeechConstants.yml new file mode 100644 index 00000000..9aef7d7c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SpeechConstants.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: SpeechConstants +uid: botbuilder-core.SpeechConstants +package: botbuilder-core +summary: Defines constants that can be used in the processing of speech interactions. +fullName: SpeechConstants +remarks: '' +isDeprecated: false +type: class +properties: + - name: EmptySpeakTag + uid: botbuilder-core.SpeechConstants.EmptySpeakTag + package: botbuilder-core + summary: >- + The xml tag structure to indicate an empty speak tag, to be used in the + 'speak' property of an Activity. When set this indicates to the channel + that speech should not be generated. + fullName: EmptySpeakTag + remarks: '' + isDeprecated: false + syntax: + content: 'static EmptySpeakTag: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatePropertyAccessor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatePropertyAccessor.yml index 41deeed7..9be1d35e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatePropertyAccessor.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatePropertyAccessor.yml @@ -9,7 +9,6 @@ fullName: StatePropertyAccessor remarks: |- To create a state property in a state management objet, use the [createProperty\](xref:botbuilder-core.BotState.createProperty) method. -isPreview: false isDeprecated: false type: interface methods: @@ -27,15 +26,13 @@ methods: await myProperty.delete(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' parameters: - id: context type: - description: | - Context for the current turn of conversation with the user. + description: Context for the current turn of conversation with the user. return: description: '' type: Promise<void> @@ -63,23 +60,21 @@ methods: const value = await myProperty.get(context, { count: 0 }); ``` - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): Promise' + content: 'function get(context: TurnContext): Promise' parameters: - id: context type: description: Context for the current turn of conversation with the user. return: description: '' - type: Promise<T | undefined> - - name: 'get(TurnContext, T)' + type: Promise<undefined | T> + - name: get(TurnContext, T) uid: botbuilder-core.StatePropertyAccessor.get_1 package: botbuilder-core summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(context: TurnContext, defaultValue: T): Promise' @@ -93,7 +88,7 @@ methods: return: description: '' type: Promise<T> - - name: 'set(TurnContext, T)' + - name: set(TurnContext, T) uid: botbuilder-core.StatePropertyAccessor.set package: botbuilder-core summary: Assigns a new value to the properties backing storage object. @@ -113,7 +108,6 @@ methods: await myProperty.set(context, value); ``` - isPreview: false isDeprecated: false syntax: content: 'function set(context: TurnContext, value: T): Promise' @@ -123,8 +117,7 @@ methods: description: Context for the current turn of conversation with the user. - id: value type: T - description: | - Value to assign. + description: Value to assign. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatusCodes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatusCodes.yml new file mode 100644 index 00000000..0dc2db73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StatusCodes.yml @@ -0,0 +1,76 @@ +### YamlMime:TSEnum +name: StatusCodes +uid: botbuilder-core.StatusCodes +package: botbuilder-core +summary: |- + Defines values for StatusCodes. + Possible values include: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 +fullName: StatusCodes +remarks: '' +isDeprecated: false +fields: + - name: OK + uid: botbuilder-core.StatusCodes.OK + package: botbuilder-core + summary: '' + numericValue: 200 + - name: CREATED + uid: botbuilder-core.StatusCodes.CREATED + package: botbuilder-core + summary: '' + numericValue: 201 + - name: MULTIPLE_CHOICES + uid: botbuilder-core.StatusCodes.MULTIPLE_CHOICES + package: botbuilder-core + summary: '' + numericValue: 300 + - name: BAD_REQUEST + uid: botbuilder-core.StatusCodes.BAD_REQUEST + package: botbuilder-core + summary: '' + numericValue: 400 + - name: UNAUTHORIZED + uid: botbuilder-core.StatusCodes.UNAUTHORIZED + package: botbuilder-core + summary: '' + numericValue: 401 + - name: NOT_FOUND + uid: botbuilder-core.StatusCodes.NOT_FOUND + package: botbuilder-core + summary: '' + numericValue: 404 + - name: METHOD_NOT_ALLOWED + uid: botbuilder-core.StatusCodes.METHOD_NOT_ALLOWED + package: botbuilder-core + summary: '' + numericValue: 405 + - name: CONFLICT + uid: botbuilder-core.StatusCodes.CONFLICT + package: botbuilder-core + summary: '' + numericValue: 409 + - name: PRECONDITION_FAILED + uid: botbuilder-core.StatusCodes.PRECONDITION_FAILED + package: botbuilder-core + summary: '' + numericValue: 412 + - name: UPGRADE_REQUIRED + uid: botbuilder-core.StatusCodes.UPGRADE_REQUIRED + package: botbuilder-core + summary: '' + numericValue: 426 + - name: INTERNAL_SERVER_ERROR + uid: botbuilder-core.StatusCodes.INTERNAL_SERVER_ERROR + package: botbuilder-core + summary: '' + numericValue: 500 + - name: NOT_IMPLEMENTED + uid: botbuilder-core.StatusCodes.NOT_IMPLEMENTED + package: botbuilder-core + summary: '' + numericValue: 501 + - name: BAD_GATEWAY + uid: botbuilder-core.StatusCodes.BAD_GATEWAY + package: botbuilder-core + summary: '' + numericValue: 502 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Storage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Storage.yml index 8def4871..881cf10a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Storage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Storage.yml @@ -7,11 +7,10 @@ summary: >- objects. fullName: Storage remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'delete(string[])' + - name: delete(string[]) uid: botbuilder-core.Storage.delete package: botbuilder-core summary: Removes store items from storage @@ -21,19 +20,17 @@ methods: ```JavaScript await storage.delete(['botState']); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' - description: | - Array of item keys to remove from the store. + type: string[] + description: Array of item keys to remove from the store. return: description: '' type: Promise<void> - - name: 'read(string[])' + - name: read(string[]) uid: botbuilder-core.Storage.read package: botbuilder-core summary: Loads store items from storage @@ -44,15 +41,13 @@ methods: const items = await storage.read(['botState']); const state = items['botState'] || {}; ``` - isPreview: false isDeprecated: false syntax: content: 'function read(keys: string[]): Promise' parameters: - id: keys - type: 'string[]' - description: | - Array of item keys to read from the store. + type: string[] + description: Array of item keys to read from the store. return: description: '' type: Promise<> @@ -67,15 +62,13 @@ methods: state.topic = 'someTopic'; await storage.write({ 'botState': state }); ``` - isPreview: false isDeprecated: false syntax: content: 'function write(changes: StoreItems): Promise' parameters: - id: changes type: - description: | - Map of items to write to storage. + description: Map of items to write to storage. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StorageKeyFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StorageKeyFactory.yml index 8bac61aa..8a29d169 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StorageKeyFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StorageKeyFactory.yml @@ -2,14 +2,14 @@ name: StorageKeyFactory uid: botbuilder-core.StorageKeyFactory package: botbuilder-core -summary: | +summary: |- Callback to calculate a storage key. + ```TypeScript type StorageKeyFactory = (context: TurnContext) => Promise; ``` fullName: StorageKeyFactory remarks: '' -isPreview: false isDeprecated: false syntax: | type StorageKeyFactory = (context: TurnContext) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItem.yml index 4f47738a..b037e6cc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItem.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItem.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Object which is stored in Storage with an optional eTag. fullName: StoreItem remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: (Optional) eTag field for stores that support optimistic concurrency. fullName: eTag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eTag?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItems.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItems.yml index 2258734f..e7ed3fdf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItems.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StoreItems.yml @@ -5,6 +5,5 @@ package: botbuilder-core summary: Map of named `StoreItem` objects. fullName: StoreItems remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StringUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StringUtils.yml index 50485dd8..41759a46 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StringUtils.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/StringUtils.yml @@ -5,16 +5,14 @@ package: botbuilder-core summary: Helper class containing string utility methods. fullName: StringUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'ellipsis(string, number)' + - name: ellipsis(string, number) uid: botbuilder-core.StringUtils.ellipsis package: botbuilder-core summary: Truncate string with ... remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function ellipsis(text: string, length: number): string' @@ -28,14 +26,13 @@ methods: return: description: Original string modified. type: string - - name: 'ellipsisHash(string, number)' + - name: ellipsisHash(string, number) uid: botbuilder-core.StringUtils.ellipsisHash package: botbuilder-core summary: >- EllipsisHash - create truncated string with unique hash for the truncated part. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function ellipsisHash(text: string, length: number): string' @@ -58,7 +55,6 @@ methods: https://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/ - isPreview: false isDeprecated: false syntax: content: 'static function hash(text: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Style.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Style.yml new file mode 100644 index 00000000..671085ad --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Style.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Style +uid: botbuilder-core.Style +package: botbuilder-core +summary: |- + Defines values for Style. + Possible values include: 'compact', 'expanded' +fullName: Style +remarks: '' +isDeprecated: false +syntax: | + type Style = "compact" | "expanded" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardAction.yml new file mode 100644 index 00000000..d6029d0b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SubmitCardAction +uid: botbuilder-core.SubmitCardAction +package: botbuilder-core +summary: SharePoint `Action.Submit` event. +fullName: SubmitCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: confirmationDialog + uid: botbuilder-core.SubmitCardAction.confirmationDialog + package: botbuilder-core + summary: Confirmation dialog option passed to the submit handler. + fullName: confirmationDialog + remarks: '' + isDeprecated: false + syntax: + content: 'confirmationDialog?: ConfirmationDialog' + return: + description: '' + type: + - name: parameters + uid: botbuilder-core.SubmitCardAction.parameters + package: botbuilder-core + summary: Parameters passed to the Submit event handler. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: SubmitCardParameters' + return: + description: '' + type: + - name: type + uid: botbuilder-core.SubmitCardAction.type + package: botbuilder-core + summary: Indicates this is a Submit button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "Submit"' + return: + description: '' + type: '"Submit"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardParameters.yml new file mode 100644 index 00000000..743e8f44 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SubmitCardParameters.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: SubmitCardParameters +uid: botbuilder-core.SubmitCardParameters +package: botbuilder-core +summary: Parameters for SharePoint Action.Submit card action. +fullName: SubmitCardParameters +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SuggestedActions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SuggestedActions.yml new file mode 100644 index 00000000..2ef9081f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/SuggestedActions.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: SuggestedActions +uid: botbuilder-core.SuggestedActions +package: botbuilder-core +summary: SuggestedActions that can be performed +fullName: SuggestedActions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder-core.SuggestedActions.actions + package: botbuilder-core + summary: Actions that can be shown to the user + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: CardAction[]' + return: + description: '' + type: [] + - name: to + uid: botbuilder-core.SuggestedActions.to + package: botbuilder-core + summary: >- + Ids of the recipients that the actions should be shown to. These Ids are + relative to the + + channelId and a subset of all recipients of the activity + fullName: to + remarks: '' + isDeprecated: false + syntax: + content: 'to: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabContext.yml new file mode 100644 index 00000000..da31b808 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabContext.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabContext +uid: botbuilder-core.TabContext +package: botbuilder-core +summary: '' +fullName: TabContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: theme + uid: botbuilder-core.TabContext.theme + package: botbuilder-core + summary: The current user's theme. + fullName: theme + remarks: '' + isDeprecated: false + syntax: + content: 'theme?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabEntityContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabEntityContext.yml new file mode 100644 index 00000000..24e3cc44 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabEntityContext.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabEntityContext +uid: botbuilder-core.TabEntityContext +package: botbuilder-core +summary: '' +fullName: TabEntityContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: tabEntityId + uid: botbuilder-core.TabEntityContext.tabEntityId + package: botbuilder-core + summary: The entity id of the tab. + fullName: tabEntityId + remarks: '' + isDeprecated: false + syntax: + content: 'tabEntityId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabRequest.yml new file mode 100644 index 00000000..04767a41 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TabRequest +uid: botbuilder-core.TabRequest +package: botbuilder-core +summary: '' +fullName: TabRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder-core.TabRequest.context + package: botbuilder-core + summary: The current user context, i.e., the current theme. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TabContext' + return: + description: '' + type: + - name: state + uid: botbuilder-core.TabRequest.state + package: botbuilder-core + summary: The magic code for OAuth flow. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string + - name: tabContext + uid: botbuilder-core.TabRequest.tabContext + package: botbuilder-core + summary: The current tab entity request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponse.yml new file mode 100644 index 00000000..c7b5b84f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabResponse +uid: botbuilder-core.TabResponse +package: botbuilder-core +summary: '' +fullName: TabResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: tab + uid: botbuilder-core.TabResponse.tab + package: botbuilder-core + summary: The response to the tab/fetch message. + fullName: tab + remarks: '' + isDeprecated: false + syntax: + content: 'tab: TabResponsePayload' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCard.yml new file mode 100644 index 00000000..ffaf2616 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCard.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabResponseCard +uid: botbuilder-core.TabResponseCard +package: botbuilder-core +summary: '' +fullName: TabResponseCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: botbuilder-core.TabResponseCard.card + package: botbuilder-core + summary: The adaptive card for this card tab response. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card: Record' + return: + description: '' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCards.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCards.yml new file mode 100644 index 00000000..2360f045 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponseCards.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabResponseCards +uid: botbuilder-core.TabResponseCards +package: botbuilder-core +summary: '' +fullName: TabResponseCards +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cards + uid: botbuilder-core.TabResponseCards.cards + package: botbuilder-core + summary: Adaptive cards for this card tab response. + fullName: cards + remarks: '' + isDeprecated: false + syntax: + content: 'cards: TabResponseCard[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponsePayload.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponsePayload.yml new file mode 100644 index 00000000..6732a654 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabResponsePayload.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TabResponsePayload +uid: botbuilder-core.TabResponsePayload +package: botbuilder-core +summary: '' +fullName: TabResponsePayload +remarks: '' +isDeprecated: false +type: interface +properties: + - name: suggestedActions + uid: botbuilder-core.TabResponsePayload.suggestedActions + package: botbuilder-core + summary: The Suggested Actions for this card tab. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: TabSuggestedActions' + return: + description: '' + type: + - name: type + uid: botbuilder-core.TabResponsePayload.type + package: botbuilder-core + summary: Choice of action options when responding to the tab/fetch message. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: "auth" | "continue" | "silentAuth"' + return: + description: '' + type: '"auth" | "continue" | "silentAuth"' + - name: value + uid: botbuilder-core.TabResponsePayload.value + package: botbuilder-core + summary: The TabResponseCards to send when responding to + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: TabResponseCards' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmit.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmit.yml new file mode 100644 index 00000000..0f96a198 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmit.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TabSubmit +uid: botbuilder-core.TabSubmit +package: botbuilder-core +summary: '' +fullName: TabSubmit +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder-core.TabSubmit.context + package: botbuilder-core + summary: The current user context, i.e., the current theme. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TabContext' + return: + description: '' + type: + - name: data + uid: botbuilder-core.TabSubmit.data + package: botbuilder-core + summary: User input. Free payload containing properties of key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: TabSubmitData' + return: + description: '' + type: + - name: tabContext + uid: botbuilder-core.TabSubmit.tabContext + package: botbuilder-core + summary: The current tab's entity request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmitData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmitData.yml new file mode 100644 index 00000000..c90e96f1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSubmitData.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabSubmitData +uid: botbuilder-core.TabSubmitData +package: botbuilder-core +summary: '' +fullName: TabSubmitData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder-core.TabSubmitData.type + package: botbuilder-core + summary: Should currently be 'tab/submit'. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSuggestedActions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSuggestedActions.yml new file mode 100644 index 00000000..0176001c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TabSuggestedActions.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabSuggestedActions +uid: botbuilder-core.TabSuggestedActions +package: botbuilder-core +summary: '' +fullName: TabSuggestedActions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder-core.TabSuggestedActions.actions + package: botbuilder-core + summary: Actions to show in the card response. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: CardAction[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotification.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotification.yml new file mode 100644 index 00000000..48709e48 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotification.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: TargetedMeetingNotification +uid: botbuilder-core.TargetedMeetingNotification +package: botbuilder-core +summary: '' +fullName: TargetedMeetingNotification +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botbuilder-core.TargetedMeetingNotification.channelData + package: botbuilder-core + summary: The channel data of the meeting notification. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: MeetingNotificationChannelData' + return: + description: '' + type: + - name: type + uid: botbuilder-core.TargetedMeetingNotification.type + package: botbuilder-core + summary: The type of meeting notification. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "targetedMeetingNotification"' + return: + description: '' + type: '"targetedMeetingNotification"' +inheritedProperties: + - name: value + uid: botbuilder-core.TargetedMeetingNotification.value + package: botbuilder-core + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: TargetedMeetingNotificationValue' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [MeetingNotificationBase.value](xref:botbuilder-core.MeetingNotificationBase.value) +extends: >- + <> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotificationValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotificationValue.yml new file mode 100644 index 00000000..2abcec89 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TargetedMeetingNotificationValue.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TargetedMeetingNotificationValue +uid: botbuilder-core.TargetedMeetingNotificationValue +package: botbuilder-core +summary: '' +fullName: TargetedMeetingNotificationValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: recipients + uid: botbuilder-core.TargetedMeetingNotificationValue.recipients + package: botbuilder-core + summary: The list of recipient meeting MRIs. + fullName: recipients + remarks: '' + isDeprecated: false + syntax: + content: 'recipients: string[]' + return: + description: '' + type: string[] + - name: surfaces + uid: botbuilder-core.TargetedMeetingNotificationValue.surfaces + package: botbuilder-core + summary: The List of notification surface configuration. + fullName: surfaces + remarks: '' + isDeprecated: false + syntax: + content: 'surfaces: MeetingSurface[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleCardResponse.yml new file mode 100644 index 00000000..2492c2bf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleCardResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: TaskModuleCardResponse +uid: botbuilder-core.TaskModuleCardResponse +package: botbuilder-core +summary: '' +fullName: TaskModuleCardResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: value + uid: botbuilder-core.TaskModuleCardResponse.value + package: botbuilder-core + summary: JSON for Adaptive cards to appear in the tab. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +inheritedProperties: + - name: type + uid: botbuilder-core.TaskModuleCardResponse.type + package: botbuilder-core + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleResponseBase.type](xref:botbuilder-core.TaskModuleResponseBase.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleContinueResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleContinueResponse.yml new file mode 100644 index 00000000..124f6237 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleContinueResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: TaskModuleContinueResponse +uid: botbuilder-core.TaskModuleContinueResponse +package: botbuilder-core +summary: '' +fullName: TaskModuleContinueResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: value + uid: botbuilder-core.TaskModuleContinueResponse.value + package: botbuilder-core + summary: The JSON for the Adaptive card to + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: TaskModuleTaskInfo' + return: + description: '' + type: +inheritedProperties: + - name: type + uid: botbuilder-core.TaskModuleContinueResponse.type + package: botbuilder-core + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleResponseBase.type](xref:botbuilder-core.TaskModuleResponseBase.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleMessageResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleMessageResponse.yml new file mode 100644 index 00000000..42f48baf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleMessageResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: TaskModuleMessageResponse +uid: botbuilder-core.TaskModuleMessageResponse +package: botbuilder-core +summary: '' +fullName: TaskModuleMessageResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: value + uid: botbuilder-core.TaskModuleMessageResponse.value + package: botbuilder-core + summary: Teams will display the value of value in a popup + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +inheritedProperties: + - name: type + uid: botbuilder-core.TaskModuleMessageResponse.type + package: botbuilder-core + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleResponseBase.type](xref:botbuilder-core.TaskModuleResponseBase.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequest.yml new file mode 100644 index 00000000..efd5a2df --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TaskModuleRequest +uid: botbuilder-core.TaskModuleRequest +package: botbuilder-core +summary: '' +fullName: TaskModuleRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder-core.TaskModuleRequest.context + package: botbuilder-core + summary: Current user context, i.e., + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TaskModuleRequestContext' + return: + description: '' + type: + - name: data + uid: botbuilder-core.TaskModuleRequest.data + package: botbuilder-core + summary: User input data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + - name: tabContext + uid: botbuilder-core.TaskModuleRequest.tabContext + package: botbuilder-core + summary: Tab request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequestContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequestContext.yml new file mode 100644 index 00000000..af4fc1da --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleRequestContext.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TaskModuleRequestContext +uid: botbuilder-core.TaskModuleRequestContext +package: botbuilder-core +summary: '' +fullName: TaskModuleRequestContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: theme + uid: botbuilder-core.TaskModuleRequestContext.theme + package: botbuilder-core + summary: '' + fullName: theme + remarks: '' + isDeprecated: false + syntax: + content: 'theme?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponse.yml new file mode 100644 index 00000000..295eaeec --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: TaskModuleResponse +uid: botbuilder-core.TaskModuleResponse +package: botbuilder-core +summary: '' +fullName: TaskModuleResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder-core.TaskModuleResponse.cacheInfo + package: botbuilder-core + summary: The cache info for this response + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: task + uid: botbuilder-core.TaskModuleResponse.task + package: botbuilder-core + summary: The JSON for the response to + fullName: task + remarks: '' + isDeprecated: false + syntax: + content: 'task?: TaskModuleContinueResponse | TaskModuleMessageResponse' + return: + description: '' + type: >- + | diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponseBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponseBase.yml new file mode 100644 index 00000000..98af88c6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleResponseBase.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TaskModuleResponseBase +uid: botbuilder-core.TaskModuleResponseBase +package: botbuilder-core +summary: '' +fullName: TaskModuleResponseBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder-core.TaskModuleResponseBase.type + package: botbuilder-core + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleTaskInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleTaskInfo.yml new file mode 100644 index 00000000..1853b919 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TaskModuleTaskInfo.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: TaskModuleTaskInfo +uid: botbuilder-core.TaskModuleTaskInfo +package: botbuilder-core +summary: '' +fullName: TaskModuleTaskInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: botbuilder-core.TaskModuleTaskInfo.card + package: botbuilder-core + summary: The JSON for the Adaptive card to appear in + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: Attachment' + return: + description: '' + type: + - name: completionBotId + uid: botbuilder-core.TaskModuleTaskInfo.completionBotId + package: botbuilder-core + summary: If a client does not support the task + fullName: completionBotId + remarks: '' + isDeprecated: false + syntax: + content: 'completionBotId?: string' + return: + description: '' + type: string + - name: fallbackUrl + uid: botbuilder-core.TaskModuleTaskInfo.fallbackUrl + package: botbuilder-core + summary: If a client does not support the task + fullName: fallbackUrl + remarks: '' + isDeprecated: false + syntax: + content: 'fallbackUrl?: string' + return: + description: '' + type: string + - name: height + uid: botbuilder-core.TaskModuleTaskInfo.height + package: botbuilder-core + summary: This can be a number, representing the task + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height?: number | "small" | "medium" | "large"' + return: + description: '' + type: number | "small" | "medium" | "large" + - name: title + uid: botbuilder-core.TaskModuleTaskInfo.title + package: botbuilder-core + summary: Appears below the app name and to the right of + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + - name: url + uid: botbuilder-core.TaskModuleTaskInfo.url + package: botbuilder-core + summary: The URL of what is loaded as an iframe inside the + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url?: string' + return: + description: '' + type: string + - name: width + uid: botbuilder-core.TaskModuleTaskInfo.width + package: botbuilder-core + summary: This can be a number, representing the task module's + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width?: number | "small" | "medium" | "large"' + return: + description: '' + type: number | "small" | "medium" | "large" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamDetails.yml new file mode 100644 index 00000000..c5966b9e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamDetails.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: TeamDetails +uid: botbuilder-core.TeamDetails +package: botbuilder-core +summary: '' +fullName: TeamDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadGroupId + uid: botbuilder-core.TeamDetails.aadGroupId + package: botbuilder-core + summary: Azure Active Directory (AAD) Group Id for + fullName: aadGroupId + remarks: '' + isDeprecated: false + syntax: + content: 'aadGroupId?: string' + return: + description: '' + type: string + - name: channelCount + uid: botbuilder-core.TeamDetails.channelCount + package: botbuilder-core + summary: Count of channels in the team. + fullName: channelCount + remarks: '' + isDeprecated: false + syntax: + content: 'channelCount?: number' + return: + description: '' + type: number + - name: id + uid: botbuilder-core.TeamDetails.id + package: botbuilder-core + summary: Unique identifier representing a team + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: memberCount + uid: botbuilder-core.TeamDetails.memberCount + package: botbuilder-core + summary: Count of members in the team. + fullName: memberCount + remarks: '' + isDeprecated: false + syntax: + content: 'memberCount?: number' + return: + description: '' + type: number + - name: name + uid: botbuilder-core.TeamDetails.name + package: botbuilder-core + summary: Name of team. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.TeamDetails.type + package: botbuilder-core + summary: >- + The type of the team. Valid values are standard, sharedChannel and + privateChannel. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamInfo.yml new file mode 100644 index 00000000..b4de4c7c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TeamInfo +uid: botbuilder-core.TeamInfo +package: botbuilder-core +summary: '' +fullName: TeamInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadGroupId + uid: botbuilder-core.TeamInfo.aadGroupId + package: botbuilder-core + summary: The Azure AD Teams group ID. + fullName: aadGroupId + remarks: '' + isDeprecated: false + syntax: + content: 'aadGroupId?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.TeamInfo.id + package: botbuilder-core + summary: Unique identifier representing a team + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder-core.TeamInfo.name + package: botbuilder-core + summary: Name of team. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsAttachment.yml new file mode 100644 index 00000000..4b1e22c2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsAttachment.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: TeamsAttachment +uid: botbuilder-core.TeamsAttachment +package: botbuilder-core +summary: An attachment within an activity +fullName: TeamsAttachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder-core.TeamsAttachment.content + package: botbuilder-core + summary: Embedded content + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content: ContentType' + return: + description: '' + type: ContentType +inheritedProperties: + - name: contentType + uid: botbuilder-core.TeamsAttachment.contentType + package: botbuilder-core + summary: mimetype/Contenttype for the file + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentType](xref:botbuilder-core.Attachment.contentType) + - name: contentUrl + uid: botbuilder-core.TeamsAttachment.contentUrl + package: botbuilder-core + summary: Content Url + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentUrl](xref:botbuilder-core.Attachment.contentUrl) + - name: name + uid: botbuilder-core.TeamsAttachment.name + package: botbuilder-core + summary: (OPTIONAL) The name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.name](xref:botbuilder-core.Attachment.name) + - name: thumbnailUrl + uid: botbuilder-core.TeamsAttachment.thumbnailUrl + package: botbuilder-core + summary: (OPTIONAL) Thumbnail associated with attachment + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.thumbnailUrl](xref:botbuilder-core.Attachment.thumbnailUrl) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelAccount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelAccount.yml new file mode 100644 index 00000000..83110363 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelAccount.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: TeamsChannelAccount +uid: botbuilder-core.TeamsChannelAccount +package: botbuilder-core +summary: '' +fullName: TeamsChannelAccount +remarks: '' +isDeprecated: false +type: interface +properties: + - name: email + uid: botbuilder-core.TeamsChannelAccount.email + package: botbuilder-core + summary: Email Id of the user. + fullName: email + remarks: '' + isDeprecated: false + syntax: + content: 'email?: string' + return: + description: '' + type: string + - name: givenName + uid: botbuilder-core.TeamsChannelAccount.givenName + package: botbuilder-core + summary: Given name part of the user name. + fullName: givenName + remarks: '' + isDeprecated: false + syntax: + content: 'givenName?: string' + return: + description: '' + type: string + - name: surname + uid: botbuilder-core.TeamsChannelAccount.surname + package: botbuilder-core + summary: Surname part of the user name. + fullName: surname + remarks: '' + isDeprecated: false + syntax: + content: 'surname?: string' + return: + description: '' + type: string + - name: tenantId + uid: botbuilder-core.TeamsChannelAccount.tenantId + package: botbuilder-core + summary: Tenant Id of the user. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string + - name: userPrincipalName + uid: botbuilder-core.TeamsChannelAccount.userPrincipalName + package: botbuilder-core + summary: Unique user principal name. + fullName: userPrincipalName + remarks: '' + isDeprecated: false + syntax: + content: 'userPrincipalName?: string' + return: + description: '' + type: string + - name: userRole + uid: botbuilder-core.TeamsChannelAccount.userRole + package: botbuilder-core + summary: User Role of the user. + fullName: userRole + remarks: '' + isDeprecated: false + syntax: + content: 'userRole?: string' + return: + description: '' + type: string +inheritedProperties: + - name: aadObjectId + uid: botbuilder-core.TeamsChannelAccount.aadObjectId + package: botbuilder-core + summary: This account's object ID within Azure Active Directory (AAD) + fullName: aadObjectId + remarks: '' + isDeprecated: false + syntax: + content: 'aadObjectId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.aadObjectId](xref:botbuilder-core.ChannelAccount.aadObjectId) + - name: id + uid: botbuilder-core.TeamsChannelAccount.id + package: botbuilder-core + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.id](xref:botbuilder-core.ChannelAccount.id) + - name: name + uid: botbuilder-core.TeamsChannelAccount.name + package: botbuilder-core + summary: Display friendly name + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.name](xref:botbuilder-core.ChannelAccount.name) + - name: properties + uid: botbuilder-core.TeamsChannelAccount.properties + package: botbuilder-core + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [ChannelAccount.properties](xref:botbuilder-core.ChannelAccount.properties) + - name: role + uid: botbuilder-core.TeamsChannelAccount.role + package: botbuilder-core + summary: >- + Role of the entity behind the account (Example: User, Bot, etc.). Possible + values include: + + 'user', 'bot', 'skill' + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.role](xref:botbuilder-core.ChannelAccount.role) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelData.yml new file mode 100644 index 00000000..6f6c82c7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelData.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: TeamsChannelData +uid: botbuilder-core.TeamsChannelData +package: botbuilder-core +summary: '' +fullName: TeamsChannelData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channel + uid: botbuilder-core.TeamsChannelData.channel + package: botbuilder-core + summary: Information about the channel in which the + fullName: channel + remarks: '' + isDeprecated: false + syntax: + content: 'channel?: ChannelInfo' + return: + description: '' + type: + - name: eventType + uid: botbuilder-core.TeamsChannelData.eventType + package: botbuilder-core + summary: Type of event. + fullName: eventType + remarks: '' + isDeprecated: false + syntax: + content: 'eventType?: string' + return: + description: '' + type: string + - name: meeting + uid: botbuilder-core.TeamsChannelData.meeting + package: botbuilder-core + summary: Information about the tenant in which the + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting?: TeamsMeetingInfo' + return: + description: '' + type: + - name: notification + uid: botbuilder-core.TeamsChannelData.notification + package: botbuilder-core + summary: Notification settings for the + fullName: notification + remarks: '' + isDeprecated: false + syntax: + content: 'notification?: NotificationInfo' + return: + description: '' + type: + - name: onBehalfOf + uid: botbuilder-core.TeamsChannelData.onBehalfOf + package: botbuilder-core + summary: The OnBehalfOf information of the message. + fullName: onBehalfOf + remarks: '' + isDeprecated: false + syntax: + content: 'onBehalfOf?: OnBehalfOf[]' + return: + description: '' + type: [] + - name: settings + uid: botbuilder-core.TeamsChannelData.settings + package: botbuilder-core + summary: Information about the settings in which the + fullName: settings + remarks: '' + isDeprecated: false + syntax: + content: 'settings?: TeamsChannelDataSettings' + return: + description: '' + type: + - name: team + uid: botbuilder-core.TeamsChannelData.team + package: botbuilder-core + summary: Information about the team in which the message + fullName: team + remarks: '' + isDeprecated: false + syntax: + content: 'team?: TeamInfo' + return: + description: '' + type: + - name: tenant + uid: botbuilder-core.TeamsChannelData.tenant + package: botbuilder-core + summary: Information about the tenant in which the + fullName: tenant + remarks: '' + isDeprecated: false + syntax: + content: 'tenant?: TenantInfo' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelDataSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelDataSettings.yml new file mode 100644 index 00000000..afb857c6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsChannelDataSettings.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TeamsChannelDataSettings +uid: botbuilder-core.TeamsChannelDataSettings +package: botbuilder-core +summary: '' +fullName: TeamsChannelDataSettings +remarks: '' +isDeprecated: false +type: interface +properties: + - name: selectedChannel + uid: botbuilder-core.TeamsChannelDataSettings.selectedChannel + package: botbuilder-core + summary: Information about the selected Teams channel. + fullName: selectedChannel + remarks: '' + isDeprecated: false + syntax: + content: 'selectedChannel?: ChannelInfo' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingInfo.yml new file mode 100644 index 00000000..fc3fdf73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingInfo.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TeamsMeetingInfo +uid: botbuilder-core.TeamsMeetingInfo +package: botbuilder-core +summary: '' +fullName: TeamsMeetingInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.TeamsMeetingInfo.id + package: botbuilder-core + summary: Unique identifier representing a meeting + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingMember.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingMember.yml new file mode 100644 index 00000000..1e198553 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingMember.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TeamsMeetingMember +uid: botbuilder-core.TeamsMeetingMember +package: botbuilder-core +summary: '' +fullName: TeamsMeetingMember +remarks: '' +isDeprecated: false +type: interface +properties: + - name: meeting + uid: botbuilder-core.TeamsMeetingMember.meeting + package: botbuilder-core + summary: The participants info. + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting: UserMeetingDetails' + return: + description: '' + type: + - name: user + uid: botbuilder-core.TeamsMeetingMember.user + package: botbuilder-core + summary: The participant account. + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingParticipant.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingParticipant.yml new file mode 100644 index 00000000..20403c5d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMeetingParticipant.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TeamsMeetingParticipant +uid: botbuilder-core.TeamsMeetingParticipant +package: botbuilder-core +summary: '' +fullName: TeamsMeetingParticipant +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversation + uid: botbuilder-core.TeamsMeetingParticipant.conversation + package: botbuilder-core + summary: The conversation account for the meeting. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation?: ConversationAccount' + return: + description: '' + type: + - name: meeting + uid: botbuilder-core.TeamsMeetingParticipant.meeting + package: botbuilder-core + summary: The meeting details. + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting?: Meeting' + return: + description: '' + type: + - name: user + uid: botbuilder-core.TeamsMeetingParticipant.user + package: botbuilder-core + summary: The user details + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMember.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMember.yml new file mode 100644 index 00000000..868b07e5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsMember.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: TeamsMember +uid: botbuilder-core.TeamsMember +package: botbuilder-core +summary: '' +fullName: TeamsMember +remarks: '' +isDeprecated: false +syntax: | + type TeamsMember = { id: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsPagedMembersResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsPagedMembersResult.yml new file mode 100644 index 00000000..8f31b97a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TeamsPagedMembersResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TeamsPagedMembersResult +uid: botbuilder-core.TeamsPagedMembersResult +package: botbuilder-core +summary: '' +fullName: TeamsPagedMembersResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder-core.TeamsPagedMembersResult.continuationToken + package: botbuilder-core + summary: Paging token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: members + uid: botbuilder-core.TeamsPagedMembersResult.members + package: botbuilder-core + summary: The Channel Accounts. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: TeamsChannelAccount[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryConstants.yml deleted file mode 100644 index 693137f1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryConstants.yml +++ /dev/null @@ -1,208 +0,0 @@ -### YamlMime:TSType -name: TelemetryConstants -uid: botbuilder-core.TelemetryConstants -package: botbuilder-core -summary: >- - Defines names of common properties for use with a - [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) object. -fullName: TelemetryConstants -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: activityTypeProperty - uid: botbuilder-core.TelemetryConstants.activityTypeProperty - package: botbuilder-core - summary: The telemetry property value for activity type. - fullName: activityTypeProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static activityTypeProperty: string' - return: - description: '' - type: string - - name: attachmentsProperty - uid: botbuilder-core.TelemetryConstants.attachmentsProperty - package: botbuilder-core - summary: The telemetry property value for attachments. - fullName: attachmentsProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static attachmentsProperty: string' - return: - description: '' - type: string - - name: channelIdProperty - uid: botbuilder-core.TelemetryConstants.channelIdProperty - package: botbuilder-core - summary: The telemetry property value for channel id. - fullName: channelIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static channelIdProperty: string' - return: - description: '' - type: string - - name: conversationIdProperty - uid: botbuilder-core.TelemetryConstants.conversationIdProperty - package: botbuilder-core - summary: The telemetry property value for conversation id. - fullName: conversationIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static conversationIdProperty: string' - return: - description: '' - type: string - - name: conversationNameProperty - uid: botbuilder-core.TelemetryConstants.conversationNameProperty - package: botbuilder-core - summary: The telemetry property value for conversation name. - fullName: conversationNameProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static conversationNameProperty: string' - return: - description: '' - type: string - - name: dialogIdProperty - uid: botbuilder-core.TelemetryConstants.dialogIdProperty - package: botbuilder-core - summary: The telemetry property value for dialog id. - fullName: dialogIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static dialogIdProperty: string' - return: - description: '' - type: string - - name: fromIdProperty - uid: botbuilder-core.TelemetryConstants.fromIdProperty - package: botbuilder-core - summary: The telemetry property value for from id. - fullName: fromIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static fromIdProperty: string' - return: - description: '' - type: string - - name: fromNameProperty - uid: botbuilder-core.TelemetryConstants.fromNameProperty - package: botbuilder-core - summary: The telemetry property value for from name. - fullName: fromNameProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static fromNameProperty: string' - return: - description: '' - type: string - - name: localeProperty - uid: botbuilder-core.TelemetryConstants.localeProperty - package: botbuilder-core - summary: The telemetry property value for locale. - fullName: localeProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static localeProperty: string' - return: - description: '' - type: string - - name: recipientIdProperty - uid: botbuilder-core.TelemetryConstants.recipientIdProperty - package: botbuilder-core - summary: The telemetry property value for recipient id. - fullName: recipientIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static recipientIdProperty: string' - return: - description: '' - type: string - - name: recipientNameProperty - uid: botbuilder-core.TelemetryConstants.recipientNameProperty - package: botbuilder-core - summary: The telemetry property value for recipient name. - fullName: recipientNameProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static recipientNameProperty: string' - return: - description: '' - type: string - - name: replyActivityIdProperty - uid: botbuilder-core.TelemetryConstants.replyActivityIdProperty - package: botbuilder-core - summary: The telemetry property value for reply activity id. - fullName: replyActivityIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static replyActivityIdProperty: string' - return: - description: '' - type: string - - name: speakProperty - uid: botbuilder-core.TelemetryConstants.speakProperty - package: botbuilder-core - summary: The telemetry property value for speak. - fullName: speakProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static speakProperty: string' - return: - description: '' - type: string - - name: textProperty - uid: botbuilder-core.TelemetryConstants.textProperty - package: botbuilder-core - summary: The telemetry property value for text. - fullName: textProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static textProperty: string' - return: - description: '' - type: string - - name: userIdProperty - uid: botbuilder-core.TelemetryConstants.userIdProperty - package: botbuilder-core - summary: The telemetry property value for user id. - fullName: userIdProperty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static userIdProperty: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryDependency.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryDependency.yml index 69e2ac86..ee3c6a1b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryDependency.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryDependency.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: TelemetryDependency remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: dependencyTypeName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dependencyTypeName: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: duration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'duration: number' @@ -54,7 +50,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -67,7 +62,6 @@ properties: summary: '' fullName: resultCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultCode: number' @@ -80,7 +74,6 @@ properties: summary: '' fullName: success remarks: '' - isPreview: false isDeprecated: false syntax: content: 'success: boolean' @@ -93,7 +86,6 @@ properties: summary: '' fullName: target remarks: '' - isPreview: false isDeprecated: false syntax: content: 'target: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryEvent.yml index 318a232e..0c88ac8f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryEvent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryEvent.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: TelemetryEvent remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: metrics remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'metrics?: [key: string]: number' + content: 'metrics?: {[key: string]: number}' return: description: '' - type: '[key: string]\: number' + type: '{[key: string]: number}' - name: name uid: botbuilder-core.TelemetryEvent.name package: botbuilder-core summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -41,10 +38,9 @@ properties: summary: '' fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties?: [key: string]: any' + content: 'properties?: {[key: string]: any}' return: description: '' - type: '[key: string]\: any' + type: '{[key: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryException.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryException.yml index 7cf9f3de..c7666e49 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryException.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryException.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: TelemetryException remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception: Error' @@ -28,7 +26,6 @@ properties: summary: '' fullName: handledAt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'handledAt?: string' @@ -41,33 +38,30 @@ properties: summary: '' fullName: measurements remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'measurements?: [key: string]: number' + content: 'measurements?: {[key: string]: number}' return: description: '' - type: '[key: string]\: number' + type: '{[key: string]: number}' - name: properties uid: botbuilder-core.TelemetryException.properties package: botbuilder-core summary: '' fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties?: [key: string]: string' + content: 'properties?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: severityLevel uid: botbuilder-core.TelemetryException.severityLevel package: botbuilder-core summary: '' fullName: severityLevel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'severityLevel?: Severity' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryLoggerMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryLoggerMiddleware.yml index a8de628e..e42db67b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryLoggerMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryLoggerMiddleware.yml @@ -9,16 +9,14 @@ summary: >- Uses the botTelemetryClient interface. fullName: TelemetryLoggerMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TelemetryLoggerMiddleware(BotTelemetryClient, boolean)' + - name: TelemetryLoggerMiddleware(BotTelemetryClient, boolean) uid: botbuilder-core.TelemetryLoggerMiddleware.constructor package: botbuilder-core summary: Initializes a new instance of the TelemetryLoggerMiddleware class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +28,7 @@ constructors: description: The BotTelemetryClient used for logging. - id: logPersonalInformation type: boolean - description: > + description: >- (Optional) Enable/Disable logging original message name within Application Insights. properties: @@ -40,7 +38,6 @@ properties: summary: The name of the event when a message is deleted by the bot. fullName: botMsgDeleteEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static botMsgDeleteEvent: string' @@ -53,7 +50,6 @@ properties: summary: The name of the event when when new message is received from the user. fullName: botMsgReceiveEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static botMsgReceiveEvent: string' @@ -66,7 +62,6 @@ properties: summary: The name of the event when a message is updated by the bot. fullName: botMsgSendEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static botMsgSendEvent: string' @@ -79,7 +74,6 @@ properties: summary: The name of the event when a message is updated by the bot. fullName: botMsgUpdateEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static botMsgUpdateEvent: string' @@ -94,7 +88,6 @@ properties: the user. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean logPersonalInformation @@ -107,7 +100,6 @@ properties: summary: Gets the currently configured botTelemetryClient that logs the events. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -118,14 +110,13 @@ properties: logs the events. type: methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.TelemetryLoggerMiddleware.onTurn package: botbuilder-core summary: >- Logs events based on incoming and outgoing activities using the botTelemetryClient class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -137,8 +128,7 @@ methods: description: The context object for this turn. - id: next type: () => Promise<void> - description: | - The delegate to call to continue the bot middleware pipeline + description: The delegate to call to continue the bot middleware pipeline return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryPageView.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryPageView.yml index c3dd3d34..2db462fa 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryPageView.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryPageView.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: TelemetryPageView remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: metrics remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'metrics?: [key: string]: number' + content: 'metrics?: {[key: string]: number}' return: description: '' - type: '[key: string]\: number' + type: '{[key: string]: number}' - name: name uid: botbuilder-core.TelemetryPageView.name package: botbuilder-core summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -41,10 +38,9 @@ properties: summary: '' fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties?: [key: string]: string' + content: 'properties?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryTrace.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryTrace.yml index 72720d4f..ec0fa0e2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryTrace.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TelemetryTrace.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: '' fullName: TelemetryTrace remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -28,20 +26,18 @@ properties: summary: '' fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties?: [key: string]: string' + content: 'properties?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: severityLevel uid: botbuilder-core.TelemetryTrace.severityLevel package: botbuilder-core summary: '' fullName: severityLevel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'severityLevel?: Severity' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TenantInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TenantInfo.yml new file mode 100644 index 00000000..189f92ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TenantInfo.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TenantInfo +uid: botbuilder-core.TenantInfo +package: botbuilder-core +summary: '' +fullName: TenantInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.TenantInfo.id + package: botbuilder-core + summary: Unique identifier representing a tenant + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestActivityInspector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestActivityInspector.yml index 77c91fa6..7093dfcc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestActivityInspector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestActivityInspector.yml @@ -2,12 +2,13 @@ name: TestActivityInspector uid: botbuilder-core.TestActivityInspector package: botbuilder-core -summary: > +summary: >- Signature for a function that can be used to inspect individual activities returned by a bot that's being tested using the `TestAdapter`. + ```TypeScript type TestActivityInspector = (activity: Partial, description: @@ -16,7 +17,6 @@ summary: > ``` fullName: TestActivityInspector remarks: '' -isPreview: false isDeprecated: false syntax: | type TestActivityInspector = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestAdapter.yml index 3f5cfa99..8979f1ea 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestAdapter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestAdapter.yml @@ -26,38 +26,36 @@ remarks: >- adapter.test(`hi`, `Hello World`) .then(() => done()); ``` -isPreview: false isDeprecated: false type: class constructors: - name: >- - TestAdapter((context: TurnContext) => Promise | - ConversationReference, Partial, boolean) + TestAdapter(ConversationReference | (context: TurnContext) => + Promise, Partial, boolean) uid: botbuilder-core.TestAdapter.constructor package: botbuilder-core summary: Creates a new TestAdapter instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TestAdapter(logicOrConversation?: (context: TurnContext) => - Promise | ConversationReference, template?: Partial, + new TestAdapter(logicOrConversation?: ConversationReference | (context: + TurnContext) => Promise, template?: Partial, sendTraceActivity?: boolean) parameters: - id: logicOrConversation type: >- - (context: TurnContext) => Promise<void> | - ConversationReference + | (context: + TurnContext) => Promise<void> description: The bots logic that's under test. - id: template - type: Partial<Activity> + type: Partial<> description: >- (Optional) activity containing default values to assign to all test messages received. - id: sendTraceActivity type: boolean - description: > + description: >- Indicates whether the adapter should add to its queue any trace activities generated by the bot. properties: @@ -67,35 +65,30 @@ properties: summary: Gets the queue of responses from the bot. fullName: activeQueue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activeQueue: Partial[]' return: description: '' - type: 'Partial<Activity>[]' + type: Partial<>[] - name: conversation uid: botbuilder-core.TestAdapter.conversation package: botbuilder-core summary: Gets or sets a reference to the current conversation. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationReference' return: description: '' - type: ConversationReference + type: - name: enableTrace uid: botbuilder-core.TestAdapter.enableTrace package: botbuilder-core - summary: |- - Gets a value indicating whether to send trace activities. - Sets a value inidicating whether to send trace activities. + summary: Gets a value indicating whether to send trace activities. fullName: enableTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean enableTrace @@ -108,7 +101,6 @@ properties: summary: Gets or sets the locale for the conversation. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale: string' @@ -121,23 +113,8 @@ properties: summary: >- Gets or sets an error handler that can catch exceptions in the middleware or application. - - Sets an error handler that can catch exceptions in the middleware or - application. fullName: onTurnError - remarks: >- - The error handler is called with these parameters: - - - | Name | Type | Description | - - | :--- | :--- | :--- | - - | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The - context object for the turn. | - - | `error` | `Error` | The Node.js error thrown. | - isPreview: false + remarks: '' isDeprecated: false syntax: content: '(context: TurnContext, error: Error) => Promise onTurnError' @@ -152,13 +129,12 @@ properties: logic under test. fullName: template remarks: '' - isPreview: false isDeprecated: false syntax: content: 'template: Partial' return: description: '' - type: Partial<Activity> + type: Partial<> inheritedProperties: - name: BotIdentityKey uid: botbuilder-core.TestAdapter.BotIdentityKey @@ -166,7 +142,6 @@ inheritedProperties: summary: '' fullName: BotIdentityKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'BotIdentityKey: symbol' @@ -182,7 +157,6 @@ inheritedProperties: summary: '' fullName: ConnectorClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorClientKey: symbol' @@ -198,7 +172,6 @@ inheritedProperties: summary: '' fullName: OAuthScopeKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'OAuthScopeKey: symbol' @@ -218,7 +191,6 @@ inheritedMethods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -232,7 +204,7 @@ inheritedMethods: A [ClaimsIdentity](xref:botframework-connector) for the conversation. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -255,7 +227,6 @@ inheritedMethods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -269,7 +240,7 @@ inheritedMethods: A [ClaimsIdentity](xref:botframework-connector) for the conversation. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -295,7 +266,6 @@ inheritedMethods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -310,7 +280,7 @@ inheritedMethods: tenant the Adapters (Console,Test, etc) but is critical to the BotFrameworkAdapter which is multi-tenant aware. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -348,7 +318,6 @@ inheritedMethods: activity's converstion will contain the ID of the new conversation. - isPreview: false isDeprecated: false syntax: content: >- @@ -372,7 +341,7 @@ inheritedMethods: The audience for the connector. - id: _conversationParameters - type: ConversationParameters + type: description: The conversation information to use to create the conversation - id: _logic type: '(context: TurnContext) => Promise<void>' @@ -383,9 +352,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotAdapter.createConversationAsync](xref:botbuilder-core.BotAdapter.createConversationAsync) - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) + - name: use((MiddlewareHandler | Middleware)[]) uid: botbuilder-core.TestAdapter.use package: botbuilder-core summary: Adds middleware to the adapter's pipeline. @@ -394,31 +361,29 @@ inheritedMethods: Each turn, the adapter calls its middleware in the order in which you added it. - isPreview: false isDeprecated: false syntax: content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this + function use(middlewares: (MiddlewareHandler | Middleware)[]): + TestAdapter parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | [] + ( | )[] description: The middleware or middleware handlers to add. return: description: The updated adapter object. - type: this + type: inheritanceDescription: >- Inherited From [BotAdapter.use](xref:botbuilder-core.BotAdapter.use) methods: - - name: 'addExchangeableToken(string, string, string, string, string)' + - name: addExchangeableToken(string, string, string, string, string) uid: botbuilder-core.TestAdapter.addExchangeableToken package: botbuilder-core summary: Adds a fake exchangeable token so it can be exchanged later. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -439,14 +404,12 @@ methods: description: Exchangeable token or resource URI. - id: token type: string - description: | - Token to store. - - name: 'addUserToken(string, string, string, string, string)' + description: Token to store. + - name: addUserToken(string, string, string, string, string) uid: botbuilder-core.TestAdapter.addUserToken package: botbuilder-core summary: Adds a fake user token so it can later be retrieved. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -467,8 +430,7 @@ methods: description: The token to store. - id: magicCode type: string - description: | - (Optional) The optional magic code to associate with this token. + description: (Optional) The optional magic code to associate with this token. - name: >- continueConversation(Partial, (revocableContext: TurnContext) => Promise) @@ -480,7 +442,6 @@ methods: called. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -489,7 +450,7 @@ methods: => Promise): Promise parameters: - id: _reference - type: Partial<ConversationReference> + type: Partial<> description: A reference to the conversation to continue. - id: _logic type: '(revocableContext: TurnContext) => Promise<void>' @@ -497,12 +458,11 @@ methods: return: description: A promise representing the async operation. type: Promise<void> - - name: 'createConversation(string, string, string)' + - name: createConversation(string, string, string) uid: botbuilder-core.TestAdapter.createConversation package: botbuilder-core summary: Create a ConversationReference. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -522,13 +482,12 @@ methods: description: >- The [ConversationReference](xref:botframework-schema.ConversationReference). - type: ConversationReference - - name: 'exchangeToken(TurnContext, string, string, TokenExchangeRequest)' + type: + - name: exchangeToken(TurnContext, string, string, TokenExchangeRequest) uid: botbuilder-core.TestAdapter.exchangeToken package: botbuilder-core summary: Performs a token exchange operation such as for single sign-on. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -539,8 +498,8 @@ methods: - id: context type: description: >- - (xref:botbuilder-core.TurnContext) for the current turn of - conversation with the user. + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation with the user. - id: connectionName type: string description: Name of the auth connection to use. @@ -548,24 +507,24 @@ methods: type: string description: User id associated with the token. - id: tokenExchangeRequest - type: TokenExchangeRequest + type: description: >- Exchange request details, either a token to exchange or a uri to exchange. return: - description: 'If the promise completes, the exchanged token is returned.' - type: Promise<TokenResponse> - - name: 'getAadTokens(TurnContext, string, string[])' + description: If the promise completes, the exchanged token is returned. + type: Promise<> + - name: getAadTokens(TurnContext, string, string[]) uid: botbuilder-core.TestAdapter.getAadTokens package: botbuilder-core summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAadTokens(_context: TurnContext, _connectionName: string, - _resourceUrls: string[]): Promise<[key: string]: TokenResponse> + _resourceUrls: string[]): Promise<{[propertyName: string]: + TokenResponse}> parameters: - id: _context type: @@ -574,31 +533,31 @@ methods: type: string description: Name of the auth connection to use. - id: _resourceUrls - type: 'string[]' + type: string[] description: The list of resource URLs to retrieve tokens for. return: description: A Dictionary of resourceUrl to the corresponding TokenResponse. - type: 'Promise<[key: string]: TokenResponse>' + type: >- + Promise<{[propertyName: string]: }> - name: getNextReply() uid: botbuilder-core.TestAdapter.getNextReply package: botbuilder-core summary: Dequeues and returns the next bot response from the activeQueue. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getNextReply(): Partial' return: - description: 'The next activity in the queue; or undefined, if the queue is empty.' - type: Partial<Activity> - - name: 'getSignInLink(TurnContext, string)' + description: The next activity in the queue; or undefined, if the queue is empty. + type: Partial<> + - name: getSignInLink(TurnContext, string) uid: botbuilder-core.TestAdapter.getSignInLink package: botbuilder-core summary: >- Gets a signin link from the token server that can be sent as part of a SigninCard. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -616,12 +575,11 @@ methods: A signin link from the token server that can be sent as part of a SigninCard. type: Promise<string> - - name: 'getSignInResource(TurnContext, string, string, string)' + - name: getSignInResource(TurnContext, string, string, string) uid: botbuilder-core.TestAdapter.getSignInResource package: botbuilder-core summary: Gets a sign-in resource. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -631,8 +589,8 @@ methods: - id: context type: description: >- - (xref:botbuilder-core.TurnContext) for the current turn of - conversation with the user. + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation with the user. - id: connectionName type: string description: Name of the auth connection to use. @@ -647,8 +605,8 @@ methods: A `Promise` with a new [SignInUrlResponse](xref:botframework-schema.SignInUrlResponse) object. - type: Promise<SignInUrlResponse> - - name: 'getTokenStatus(TurnContext, string, string, any)' + type: Promise<> + - name: getTokenStatus(TurnContext, string, string, any) uid: botbuilder-core.TestAdapter.getTokenStatus package: botbuilder-core summary: >- @@ -658,7 +616,6 @@ methods: In testAdapter, retrieves tokens which were previously added via addUserToken. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -679,19 +636,17 @@ methods: the `includeFilter` parameter limits the tokens this method returns. - id: _oAuthAppCredentials type: any - description: | - AppCredentials for OAuth. + description: AppCredentials for OAuth. return: description: >- The [TokenStatus](xref:botframework-connector.TokenStatus) objects retrieved. - type: 'Promise<any[]>' - - name: 'getUserToken(TurnContext, string, string)' + type: Promise<any[]> + - name: getUserToken(TurnContext, string, string) uid: botbuilder-core.TestAdapter.getUserToken package: botbuilder-core summary: Retrieves the OAuth token for a user that is in a sign-in flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -709,7 +664,7 @@ methods: description: (Optional) Optional user entered code to validate. return: description: The OAuth token for a user that is in a sign-in flow. - type: Promise<TokenResponse> + type: Promise<> - name: makeActivity(string) uid: botbuilder-core.TestAdapter.makeActivity package: botbuilder-core @@ -717,7 +672,6 @@ methods: Creates a message activity from text and the current conversational context. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function makeActivity(text?: string): Partial' @@ -727,7 +681,7 @@ methods: description: The message text. return: description: An appropriate message activity. - type: Partial<Activity> + type: Partial<> - name: >- processActivity(string | Partial, (context: TurnContext) => Promise) @@ -735,7 +689,6 @@ methods: package: botbuilder-core summary: Receives an activity and runs it through the middleware pipeline. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -743,7 +696,7 @@ methods: callback?: (context: TurnContext) => Promise): Promise parameters: - id: activity - type: string | Partial<Activity> + type: string | Partial<> description: The activity to process. - id: callback type: '(context: TurnContext) => Promise<any>' @@ -771,13 +724,12 @@ methods: .assertReply('Hello World') .then(() => done()); ``` - isPreview: false isDeprecated: false syntax: content: 'function send(userSays: string | Partial): TestFlow' parameters: - id: userSays - type: string | Partial<Activity> + type: string | Partial<> description: Text or activity simulating user input. return: description: >- @@ -791,7 +743,6 @@ methods: package: botbuilder-core summary: Processes a message activity from a user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -807,12 +758,11 @@ methods: return: description: A promise representing the async operation. type: Promise<any> - - name: 'signOutUser(TurnContext, string, string)' + - name: signOutUser(TurnContext, string, string) uid: botbuilder-core.TestAdapter.signOutUser package: botbuilder-core summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -827,8 +777,7 @@ methods: description: Name of the auth connection to use. - id: userId type: string - description: | - User ID to sign out. + description: User ID to sign out. return: description: '' type: Promise<void> @@ -852,7 +801,6 @@ methods: adapter.test('hi', 'Hello World') .then(() => done()); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -861,12 +809,12 @@ methods: => void, description?: string, _timeout?: number): TestFlow parameters: - id: userSays - type: string | Partial<Activity> + type: string | Partial<> description: Text or activity simulating user input. - id: expected type: >- - string | Partial<Activity> | (activity: - Partial<Activity>, description?: string) => void + string | Partial<> | + (activity: Partial<Activity>, description?: string) => void description: Expected text or activity of the reply sent by the bot. - id: description type: string @@ -883,7 +831,7 @@ methods: A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends this exchange to the modeled exchange. type: - - name: 'testActivities(Partial[], string, number)' + - name: testActivities(Partial[], string, number) uid: botbuilder-core.TestAdapter.testActivities package: botbuilder-core summary: Test a list of activities. @@ -892,7 +840,6 @@ methods: every other activity will be processed as a user message with send(). - isPreview: false isDeprecated: false syntax: content: >- @@ -900,7 +847,7 @@ methods: string, timeout?: number): TestFlow parameters: - id: activities - type: 'Partial<Activity>[]' + type: Partial<>[] description: Array of activities. - id: description type: string @@ -917,12 +864,11 @@ methods: A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends this exchange to the modeled exchange. type: - - name: 'throwOnExchangeRequest(string, string, string, string)' + - name: throwOnExchangeRequest(string, string, string, string) uid: botbuilder-core.TestAdapter.throwOnExchangeRequest package: botbuilder-core summary: Adds an instruction to throw an exception during exchange requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -940,6 +886,5 @@ methods: description: The user id. - id: exchangeableItem type: string - description: | - The exchangeable token or resource URI. + description: The exchangeable token or resource URI. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestFlow.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestFlow.yml index 9bf4ac4f..d3e685d7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestFlow.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TestFlow.yml @@ -31,7 +31,6 @@ remarks: >- .test(`bye`, `Goodbye`) .then(() => done()); ``` -isPreview: false isDeprecated: false type: class properties: @@ -41,7 +40,6 @@ properties: summary: '' fullName: previous remarks: '' - isPreview: false isDeprecated: false syntax: content: 'previous: Promise' @@ -49,14 +47,13 @@ properties: description: '' type: Promise<void> methods: - - name: 'assertNoReply(string, number)' + - name: assertNoReply(string, number) uid: botbuilder-core.TestFlow.assertNoReply package: botbuilder-core summary: >- Generates an assertion that the turn processing logic did not generate a reply from the bot, as expected. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function assertNoReply(description?: string, timeout?: number): TestFlow' @@ -85,7 +82,6 @@ methods: Generates an assertion if the bots response doesn't match the expected text/activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -94,8 +90,8 @@ methods: parameters: - id: expected type: >- - string | Partial<Activity> | + string | Partial<> | + description: >- Expected text or activity from the bot. Can be a callback to inspect the response using custom logic. @@ -114,14 +110,13 @@ methods: A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends this exchange to the modeled exchange. type: - - name: 'assertReplyOneOf(string[], string, number)' + - name: assertReplyOneOf(string[], string, number) uid: botbuilder-core.TestFlow.assertReplyOneOf package: botbuilder-core summary: >- Generates an assertion if the bots response is not one of the candidate strings. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -129,7 +124,7 @@ methods: timeout?: number): TestFlow parameters: - id: candidates - type: 'string[]' + type: string[] description: List of candidate responses. - id: description type: string @@ -151,7 +146,6 @@ methods: package: botbuilder-core summary: Adds a `catch()` clause to the tests promise chain. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function catch(onRejected?: (reason: any) => void): TestFlow' @@ -169,7 +163,6 @@ methods: package: botbuilder-core summary: Inserts a delay before continuing. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delay(ms: number): TestFlow' @@ -187,7 +180,6 @@ methods: package: botbuilder-core summary: Adds a finally clause. Note that you can't keep chaining afterwards. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function finally(onFinally: () => void): Promise' @@ -203,13 +195,12 @@ methods: package: botbuilder-core summary: Sends something to the bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(userSays: string | Partial): TestFlow' parameters: - id: userSays - type: string | Partial<Activity> + type: string | Partial<> description: Text or activity simulating user input. return: description: >- @@ -221,7 +212,6 @@ methods: package: botbuilder-core summary: Creates a conversation update activity and process the activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function sendConversationUpdate(): TestFlow' @@ -231,9 +221,8 @@ methods: - name: startTest() uid: botbuilder-core.TestFlow.startTest package: botbuilder-core - summary: 'Start the test sequence, returning a promise to await.' + summary: Start the test sequence, returning a promise to await. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function startTest(): Promise' @@ -254,7 +243,6 @@ methods: helper is provided. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -263,12 +251,12 @@ methods: => void, description?: string, timeout?: number): TestFlow parameters: - id: userSays - type: string | Partial<Activity> + type: string | Partial<> description: Text or activity simulating user input. - id: expected type: >- - string | Partial<Activity> | (activity: - Partial<Activity>, description?: string) => void + string | Partial<> | + (activity: Partial<Activity>, description?: string) => void description: Expected text or activity of the reply sent by the bot. - id: description type: string @@ -290,7 +278,6 @@ methods: package: botbuilder-core summary: Adds a `then()` step to the tests promise chain. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextCardViewParameters.yml new file mode 100644 index 00000000..0626c832 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextCardViewParameters.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: TextCardViewParameters +uid: botbuilder-core.TextCardViewParameters +package: botbuilder-core +summary: The parameters for the card view with text or empty body. +fullName: TextCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.TextCardViewParameters.body + package: botbuilder-core + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: undefined | [CardTextComponent]' + return: + description: '' + type: undefined | [CardTextComponent] + - name: cardViewType + uid: botbuilder-core.TextCardViewParameters.cardViewType + package: botbuilder-core + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "text"' + return: + description: '' + type: '"text"' + - name: footer + uid: botbuilder-core.TextCardViewParameters.footer + package: botbuilder-core + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: CardViewFooterParameters' + return: + description: '' + type: + - name: header + uid: botbuilder-core.TextCardViewParameters.header + package: botbuilder-core + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' + - name: image + uid: botbuilder-core.TextCardViewParameters.image + package: botbuilder-core + summary: Image displayed on the card. + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: cardBar + uid: botbuilder-core.TextCardViewParameters.cardBar + package: botbuilder-core + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder-core.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextFormatTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextFormatTypes.yml new file mode 100644 index 00000000..693f5644 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextFormatTypes.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: TextFormatTypes +uid: botbuilder-core.TextFormatTypes +package: botbuilder-core +summary: |- + Defines values for TextFormatTypes. + Possible values include: 'markdown', 'plain', 'xml' +fullName: TextFormatTypes +remarks: '' +isDeprecated: false +fields: + - name: Markdown + uid: botbuilder-core.TextFormatTypes.Markdown + package: botbuilder-core + summary: '' + - name: Plain + uid: botbuilder-core.TextFormatTypes.Plain + package: botbuilder-core + summary: '' + - name: Xml + uid: botbuilder-core.TextFormatTypes.Xml + package: botbuilder-core + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextHighlight.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextHighlight.yml new file mode 100644 index 00000000..c9a6c3d2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextHighlight.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: TextHighlight +uid: botbuilder-core.TextHighlight +package: botbuilder-core +summary: Refers to a substring of content within another field +fullName: TextHighlight +remarks: '' +isDeprecated: false +type: interface +properties: + - name: occurrence + uid: botbuilder-core.TextHighlight.occurrence + package: botbuilder-core + summary: >- + Occurrence of the text field within the referenced text, if multiple + exist. + fullName: occurrence + remarks: '' + isDeprecated: false + syntax: + content: 'occurrence: number' + return: + description: '' + type: number + - name: text + uid: botbuilder-core.TextHighlight.text + package: botbuilder-core + summary: Defines the snippet of text to highlight + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextInputCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextInputCardViewParameters.yml new file mode 100644 index 00000000..c4858a8b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TextInputCardViewParameters.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: TextInputCardViewParameters +uid: botbuilder-core.TextInputCardViewParameters +package: botbuilder-core +summary: The parameters for the card view with text input in the body. +fullName: TextInputCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder-core.TextInputCardViewParameters.body + package: botbuilder-core + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: [CardTextInputComponent]' + return: + description: '' + type: '[CardTextInputComponent]' + - name: cardViewType + uid: botbuilder-core.TextInputCardViewParameters.cardViewType + package: botbuilder-core + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "textInput"' + return: + description: '' + type: '"textInput"' + - name: footer + uid: botbuilder-core.TextInputCardViewParameters.footer + package: botbuilder-core + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: CardViewActionsFooterParameters' + return: + description: '' + type: + - name: header + uid: botbuilder-core.TextInputCardViewParameters.header + package: botbuilder-core + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' + - name: image + uid: botbuilder-core.TextInputCardViewParameters.image + package: botbuilder-core + summary: Image displayed on the card. + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: cardBar + uid: botbuilder-core.TextInputCardViewParameters.cardBar + package: botbuilder-core + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder-core.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Thing.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Thing.yml new file mode 100644 index 00000000..482ea381 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Thing.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: Thing +uid: botbuilder-core.Thing +package: botbuilder-core +summary: 'Thing (entity type: "https://schema.org/Thing")' +fullName: Thing +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder-core.Thing.name + package: botbuilder-core + summary: The name of the thing + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder-core.Thing.type + package: botbuilder-core + summary: The type of the thing + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailCard.yml new file mode 100644 index 00000000..81c8aac7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: ThumbnailCard +uid: botbuilder-core.ThumbnailCard +package: botbuilder-core +summary: A thumbnail card (card with a single, small thumbnail image) +fullName: ThumbnailCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder-core.ThumbnailCard.buttons + package: botbuilder-core + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder-core.ThumbnailCard.images + package: botbuilder-core + summary: Array of images for the card + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images: CardImage[]' + return: + description: '' + type: [] + - name: subtitle + uid: botbuilder-core.ThumbnailCard.subtitle + package: botbuilder-core + summary: Subtitle of the card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder-core.ThumbnailCard.tap + package: botbuilder-core + summary: This action will be activated when user taps on the card itself + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder-core.ThumbnailCard.text + package: botbuilder-core + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.ThumbnailCard.title + package: botbuilder-core + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailUrl.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailUrl.yml new file mode 100644 index 00000000..d018ccda --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ThumbnailUrl.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ThumbnailUrl +uid: botbuilder-core.ThumbnailUrl +package: botbuilder-core +summary: Thumbnail URL +fullName: ThumbnailUrl +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alt + uid: botbuilder-core.ThumbnailUrl.alt + package: botbuilder-core + summary: HTML alt text to include on this thumbnail image + fullName: alt + remarks: '' + isDeprecated: false + syntax: + content: 'alt: string' + return: + description: '' + type: string + - name: url + uid: botbuilder-core.ThumbnailUrl.url + package: botbuilder-core + summary: URL pointing to the thumbnail to use for media content + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeRequest.yml new file mode 100644 index 00000000..d0890d04 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TokenExchangeInvokeRequest +uid: botbuilder-core.TokenExchangeInvokeRequest +package: botbuilder-core +summary: A request to exchange a token. +fullName: TokenExchangeInvokeRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: connectionName + uid: botbuilder-core.TokenExchangeInvokeRequest.connectionName + package: botbuilder-core + summary: The connection name. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.TokenExchangeInvokeRequest.id + package: botbuilder-core + summary: The id from the OAuthCard. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: token + uid: botbuilder-core.TokenExchangeInvokeRequest.token + package: botbuilder-core + summary: The user token that can be exchanged. + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeResponse.yml new file mode 100644 index 00000000..14677300 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeInvokeResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: TokenExchangeInvokeResponse +uid: botbuilder-core.TokenExchangeInvokeResponse +package: botbuilder-core +summary: The response object of a token exchange invoke. +fullName: TokenExchangeInvokeResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: connectionName + uid: botbuilder-core.TokenExchangeInvokeResponse.connectionName + package: botbuilder-core + summary: The connection name. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: failureDetail + uid: botbuilder-core.TokenExchangeInvokeResponse.failureDetail + package: botbuilder-core + summary: The details of why the token exchange failed. + fullName: failureDetail + remarks: '' + isDeprecated: false + syntax: + content: 'failureDetail: string' + return: + description: '' + type: string + - name: id + uid: botbuilder-core.TokenExchangeInvokeResponse.id + package: botbuilder-core + summary: The id from the OAuthCard. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder-core.TokenExchangeInvokeResponse.properties + package: botbuilder-core + summary: Extension data for overflow of properties. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: Record' + return: + description: '' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeRequest.yml new file mode 100644 index 00000000..d32b190d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TokenExchangeRequest +uid: botbuilder-core.TokenExchangeRequest +package: botbuilder-core +summary: '' +fullName: TokenExchangeRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: token + uid: botbuilder-core.TokenExchangeRequest.token + package: botbuilder-core + summary: '' + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token?: string' + return: + description: '' + type: string + - name: uri + uid: botbuilder-core.TokenExchangeRequest.uri + package: botbuilder-core + summary: '' + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeResource.yml new file mode 100644 index 00000000..c562a658 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeResource.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TokenExchangeResource +uid: botbuilder-core.TokenExchangeResource +package: botbuilder-core +summary: '' +fullName: TokenExchangeResource +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder-core.TokenExchangeResource.id + package: botbuilder-core + summary: '' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: providerId + uid: botbuilder-core.TokenExchangeResource.providerId + package: botbuilder-core + summary: '' + fullName: providerId + remarks: '' + isDeprecated: false + syntax: + content: 'providerId?: string' + return: + description: '' + type: string + - name: uri + uid: botbuilder-core.TokenExchangeResource.uri + package: botbuilder-core + summary: '' + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeState.yml new file mode 100644 index 00000000..14c07736 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenExchangeState.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TokenExchangeState +uid: botbuilder-core.TokenExchangeState +package: botbuilder-core +summary: State object passed to the bot token service. +fullName: TokenExchangeState +remarks: '' +isDeprecated: false +syntax: | + type TokenExchangeState = { + connectionName: string + conversation: ConversationReference + msAppId: string + relatesTo: ConversationReference + } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPollingSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPollingSettings.yml index 39cb9bcc..c0cd3c25 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPollingSettings.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPollingSettings.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Provides details for token polling. fullName: TokenPollingSettings remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Time Interval in milliseconds between token polling requests. fullName: interval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interval?: number' @@ -30,7 +28,6 @@ properties: timeout. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPostResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPostResource.yml new file mode 100644 index 00000000..841dafc6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenPostResource.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TokenPostResource +uid: botbuilder-core.TokenPostResource +package: botbuilder-core +summary: '' +fullName: TokenPostResource +remarks: '' +isDeprecated: false +type: interface +properties: + - name: sasUrl + uid: botbuilder-core.TokenPostResource.sasUrl + package: botbuilder-core + summary: '' + fullName: sasUrl + remarks: '' + isDeprecated: false + syntax: + content: 'sasUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenRequest.yml new file mode 100644 index 00000000..d81074d9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TokenRequest +uid: botbuilder-core.TokenRequest +package: botbuilder-core +summary: A request to receive a user token +fullName: TokenRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: provider + uid: botbuilder-core.TokenRequest.provider + package: botbuilder-core + summary: The provider to request a user token from + fullName: provider + remarks: '' + isDeprecated: false + syntax: + content: 'provider: string' + return: + description: '' + type: string + - name: settings + uid: botbuilder-core.TokenRequest.settings + package: botbuilder-core + summary: A collection of settings for the specific provider for this request + fullName: settings + remarks: '' + isDeprecated: false + syntax: + content: 'settings: {[propertyName: string]: any}' + return: + description: '' + type: '{[propertyName: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenResponse.yml new file mode 100644 index 00000000..b7542257 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenResponse.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: TokenResponse +uid: botbuilder-core.TokenResponse +package: botbuilder-core +summary: A response that includes a user token +fullName: TokenResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: botbuilder-core.TokenResponse.channelId + package: botbuilder-core + summary: '' + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string + - name: connectionName + uid: botbuilder-core.TokenResponse.connectionName + package: botbuilder-core + summary: The connection name + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: expiration + uid: botbuilder-core.TokenResponse.expiration + package: botbuilder-core + summary: Expiration for the token, in ISO 8601 format (e.g. "2007-04-05T14:30Z") + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder-core.TokenResponse.properties + package: botbuilder-core + summary: >- + A collection of properties about this response, such as token polling + parameters + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: {[propertyName: string]: any}' + return: + description: '' + type: '{[propertyName: string]: any}' + - name: token + uid: botbuilder-core.TokenResponse.token + package: botbuilder-core + summary: The user token + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenStatus.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenStatus.yml new file mode 100644 index 00000000..2c2070a6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TokenStatus.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TokenStatus +uid: botbuilder-core.TokenStatus +package: botbuilder-core +summary: The status of a particular token. +fullName: TokenStatus +remarks: '' +isDeprecated: false +syntax: | + type TokenStatus = { + channelId: string + connectionName: string + hasToken: boolean + serviceProviderDisplayName: string + } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Transcript.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Transcript.yml new file mode 100644 index 00000000..0654534b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Transcript.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: Transcript +uid: botbuilder-core.Transcript +package: botbuilder-core +summary: Transcript +fullName: Transcript +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activities + uid: botbuilder-core.Transcript.activities + package: botbuilder-core + summary: A collection of Activities that conforms to the Transcript schema. + fullName: activities + remarks: '' + isDeprecated: false + syntax: + content: 'activities: Activity[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptInfo.yml index 2e61e134..469c4eb1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptInfo.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Metadata for a stored transcript. fullName: TranscriptInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: ChannelId that the transcript was taken from. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -28,7 +26,6 @@ properties: summary: Date conversation was started. fullName: created remarks: '' - isPreview: false isDeprecated: false syntax: content: 'created: Date' @@ -41,7 +38,6 @@ properties: summary: Conversation Id. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLogger.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLogger.yml index b876ccf7..49740df2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLogger.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLogger.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Transcript logger stores activities for conversations for recall. fullName: TranscriptLogger remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,15 +13,13 @@ methods: package: botbuilder-core summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logActivity(activity: Activity): void | Promise' parameters: - id: activity - type: Activity - description: | - Activity being logged. + type: + description: Activity being logged. return: description: '' type: void | Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLoggerMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLoggerMiddleware.yml index df15b520..96465ced 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLoggerMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptLoggerMiddleware.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Logs incoming and outgoing activities to a TranscriptStore. fullName: TranscriptLoggerMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,22 +15,19 @@ constructors: Middleware for logging incoming and outgoing activities to a transcript store. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TranscriptLoggerMiddleware(logger: TranscriptLogger)' parameters: - id: logger type: - description: | - Transcript logger + description: Transcript logger methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-core.TranscriptLoggerMiddleware.onTurn package: botbuilder-core summary: Initialization for middleware turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -43,8 +39,7 @@ methods: description: Context for the current turn of conversation with the user. - id: next type: () => Promise<void> - description: | - Function to call at the end of the middleware chain. + description: Function to call at the end of the middleware chain. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptStore.yml index b2ef1296..65e5a1b7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptStore.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TranscriptStore.yml @@ -5,7 +5,6 @@ package: botbuilder-core summary: Transcript logger stores activities for conversations for recall. fullName: TranscriptStore remarks: '' -isPreview: false isDeprecated: false type: interface inheritedMethods: @@ -14,15 +13,13 @@ inheritedMethods: package: botbuilder-core summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logActivity(activity: Activity): void | Promise' parameters: - id: activity - type: Activity - description: | - Activity being logged. + type: + description: Activity being logged. return: description: '' type: void | Promise<void> @@ -30,12 +27,11 @@ inheritedMethods: Inherited From [TranscriptLogger.logActivity](xref:botbuilder-core.TranscriptLogger.logActivity) methods: - - name: 'deleteTranscript(string, string)' + - name: deleteTranscript(string, string) uid: botbuilder-core.TranscriptStore.deleteTranscript package: botbuilder-core summary: Delete a specific conversation and all of its activities. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -47,17 +43,15 @@ methods: description: Channel Id where conversation took place. - id: conversationId type: string - description: | - Id of the conversation to delete. + description: Id of the conversation to delete. return: description: '' type: Promise<void> - - name: 'getTranscriptActivities(string, string, string, Date)' + - name: getTranscriptActivities(string, string, string, Date) uid: botbuilder-core.TranscriptStore.getTranscriptActivities package: botbuilder-core summary: Get activities for a conversation (Aka the transcript) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -76,19 +70,17 @@ methods: description: Continuation token to page through results. - id: startDate type: Date - description: | - Earliest time to include. + description: Earliest time to include. return: description: '' type: >- - Promise<<Activity>> - - name: 'listTranscripts(string, string)' + Promise<<>> + - name: listTranscripts(string, string) uid: botbuilder-core.TranscriptStore.listTranscripts package: botbuilder-core summary: List conversations in the channelId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -100,8 +92,7 @@ methods: description: Channel Id. - id: continuationToken type: string - description: | - Continuation token to page through results. + description: Continuation token to page through results. return: description: '' type: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContext.yml index 24fa7df1..6af1071f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContext.yml @@ -10,18 +10,16 @@ remarks: >- created by a [BotAdapter](xref:botbuilder-core.BotAdapter) and persists for the length of the turn. -isPreview: false isDeprecated: false type: class constructors: - - name: 'TurnContext(BotAdapter, Partial)' + - name: TurnContext(BotAdapter, Partial) uid: botbuilder-core.TurnContext.constructor package: botbuilder-core summary: >- Creates an new instance of the [TurnContext](xref:xref:botbuilder-core.TurnContext) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,9 +30,8 @@ constructors: type: description: The adapter creating the context. - id: request - type: Partial<Activity> - description: | - The incoming activity for the turn. + type: Partial<> + description: The incoming activity for the turn. - name: TurnContext(TurnContext) uid: botbuilder-core.TurnContext.constructor_1 package: botbuilder-core @@ -42,44 +39,32 @@ constructors: Creates an new instance of the [TurnContext](xref:xref:botbuilder-core.TurnContext) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TurnContext(adapterOrContext: TurnContext)' parameters: - id: adapterOrContext type: - description: The adapter creating the context. + description: The context object to clone. properties: - name: activity uid: botbuilder-core.TurnContext.activity package: botbuilder-core summary: Gets the activity associated with this turn. fullName: activity - remarks: >- - This example shows how to get the users trimmed utterance from the - activity: - - - ```JavaScript - - const utterance = (context.activity.text || '').trim(); - - ``` - isPreview: false + remarks: '' isDeprecated: false syntax: content: Activity activity return: description: The activity associated with this turn. - type: Activity + type: - name: adapter uid: botbuilder-core.TurnContext.adapter package: botbuilder-core summary: Gets the bot adapter that created this context object. fullName: adapter remarks: '' - isPreview: false isDeprecated: false syntax: content: BotAdapter adapter @@ -94,58 +79,30 @@ properties: 'expectReplies'`. fullName: bufferedReplyActivities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bufferedReplyActivities: Partial[]' return: description: '' - type: 'Partial<Activity>[]' + type: Partial<>[] - name: locale uid: botbuilder-core.TurnContext.locale package: botbuilder-core - summary: |- - Gets the locale stored in the turnState. - Sets the locale stored in the turnState. + summary: Gets the locale stored in the turnState. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: - content: string | undefined locale + content: undefined | string locale return: description: The locale stored in the turnState. - type: string | undefined + type: undefined | string - name: responded uid: botbuilder-core.TurnContext.responded package: botbuilder-core - summary: |- - Indicates whether the bot has replied to the user this turn. - Sets the response flag on the current turn context. + summary: Indicates whether the bot has replied to the user this turn. fullName: responded - remarks: >- - **true** if at least one response was sent for the current turn; - otherwise, **false**. - - Use this to determine if your bot needs to run fallback logic after other - normal processing. - - - Trace activities do not set this flag. - - - for example: - - ```JavaScript - - await routeActivity(context); - - if (!context.responded) { - await context.sendActivity(`I'm sorry. I didn't understand.`); - } - - ``` - isPreview: false + remarks: '' isDeprecated: false syntax: content: boolean responded @@ -159,37 +116,7 @@ properties: package: botbuilder-core summary: Gets the services registered on this context object. fullName: turnState - remarks: >- - Middleware, other components, and services will typically use this to - cache information - - that could be asked for by a bot multiple times during a turn. You can use - this cache to - - pass information between components of your bot. - - - For example: - - ```JavaScript - - const cartKey = Symbol(); - - const cart = await loadUsersShoppingCart(context); - - context.turnState.set(cartKey, cart); - - ``` - - - > [!TIP] - - > When creating middleware or a third-party component, use a unique symbol - for your cache key - - > to avoid state naming collisions with the bot or other middleware or - components. - isPreview: false + remarks: '' isDeprecated: false syntax: content: TurnContextStateCollection turnState @@ -213,7 +140,6 @@ methods: can then use to update an outgoing activity with the correct delivery information. - isPreview: false isDeprecated: false syntax: content: >- @@ -222,10 +148,10 @@ methods: Partial parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The activity to update. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: The conversation reference to copy delivery information from. - id: isIncoming type: boolean @@ -235,8 +161,8 @@ methods: bot is the recipient; otherwise, `false`. Default is `false`, and the activity will show the bot as the sender. return: - description: 'This activity, updated with the delivery information.' - type: Partial<Activity> + description: This activity, updated with the delivery information. + type: Partial<> - name: deleteActivity(string | Partial) uid: botbuilder-core.TurnContext.deleteActivity package: botbuilder-core @@ -271,7 +197,6 @@ methods: - [getReplyConversationReference](xref:botbuilder-core.TurnContext.getReplyConversationReference) - isPreview: false isDeprecated: false syntax: content: >- @@ -279,7 +204,9 @@ methods: Partial): Promise parameters: - id: idOrReference - type: string | Partial<ConversationReference> + type: >- + string | Partial<> description: ID or conversation reference for the activity to delete. return: description: A promise representing the async operation. @@ -307,7 +234,6 @@ methods: - [BotAdapter.continueConversation](xref:botbuilder-core.BotAdapter.continueConversation) - isPreview: false isDeprecated: false syntax: content: >- @@ -315,13 +241,13 @@ methods: Partial parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The activity to get the information from. return: description: >- A conversation reference for the conversation that contains this activity. - type: Partial<ConversationReference> + type: Partial<> - name: getMentions(Partial) uid: botbuilder-core.TurnContext.getMentions package: botbuilder-core @@ -345,18 +271,17 @@ methods: const mentions = TurnContext.getMentions(turnContext.request); ``` - isPreview: false isDeprecated: false syntax: content: 'static function getMentions(activity: Partial): Mention[]' parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The activity. return: description: All the at-mention entities included in an activity. - type: 'Mention[]' - - name: 'getReplyConversationReference(Partial, ResourceResponse)' + type: [] + - name: getReplyConversationReference(Partial, ResourceResponse) uid: botbuilder-core.TurnContext.getReplyConversationReference package: botbuilder-core summary: >- @@ -385,7 +310,6 @@ methods: - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) - isPreview: false isDeprecated: false syntax: content: >- @@ -394,10 +318,10 @@ methods: Partial parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The sent activity. - id: reply - type: ResourceResponse + type: description: |- The resource response for the activity, returned by the [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or @@ -406,7 +330,7 @@ methods: description: >- A ConversationReference that can be stored and used later to delete or update the activity. - type: Partial<ConversationReference> + type: Partial<> - name: onDeleteActivity(DeleteActivityHandler) uid: botbuilder-core.TurnContext.onDeleteActivity package: botbuilder-core @@ -438,17 +362,16 @@ methods: }); ``` - isPreview: false isDeprecated: false syntax: - content: 'function onDeleteActivity(handler: DeleteActivityHandler): this' + content: 'function onDeleteActivity(handler: DeleteActivityHandler): TurnContext' parameters: - id: handler type: description: The handler to add to the context object. return: description: The updated context object. - type: this + type: - name: onSendActivities(SendActivitiesHandler) uid: botbuilder-core.TurnContext.onSendActivities package: botbuilder-core @@ -483,17 +406,16 @@ methods: }); ``` - isPreview: false isDeprecated: false syntax: - content: 'function onSendActivities(handler: SendActivitiesHandler): this' + content: 'function onSendActivities(handler: SendActivitiesHandler): TurnContext' parameters: - id: handler type: description: The handler to add to the context object. return: description: The updated context object. - type: this + type: - name: onUpdateActivity(UpdateActivityHandler) uid: botbuilder-core.TurnContext.onUpdateActivity package: botbuilder-core @@ -525,18 +447,17 @@ methods: }); ``` - isPreview: false isDeprecated: false syntax: - content: 'function onUpdateActivity(handler: UpdateActivityHandler): this' + content: 'function onUpdateActivity(handler: UpdateActivityHandler): TurnContext' parameters: - id: handler type: description: The handler to add to the context object. return: description: The updated context object. - type: this - - name: 'removeMentionText(Partial, string)' + type: + - name: removeMentionText(Partial, string) uid: botbuilder-core.TurnContext.removeMentionText package: botbuilder-core summary: >- @@ -592,7 +513,6 @@ methods: - [removeRecipientMention](xref:botbuilder-core.TurnContext.removeRecipientMention) - isPreview: false isDeprecated: false syntax: content: >- @@ -600,7 +520,7 @@ methods: string): string parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The activity to remove at mentions from. - id: id type: string @@ -645,7 +565,6 @@ methods: **See also** - [removeMentionText](xref:botbuilder-core.TurnContext.removeMentionText) - isPreview: false isDeprecated: false syntax: content: >- @@ -653,12 +572,12 @@ methods: string parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The activity to remove at mentions from. return: description: The updated activity's text. type: string - - name: 'sendActivities(Partial[])' + - name: sendActivities(Partial[]) uid: botbuilder-core.TurnContext.sendActivities package: botbuilder-core summary: >- @@ -700,7 +619,6 @@ methods: - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) - isPreview: false isDeprecated: false syntax: content: >- @@ -708,12 +626,12 @@ methods: Promise parameters: - id: activities - type: 'Partial<Activity>[]' + type: Partial<>[] description: The activities to send. return: description: A promise with a ResourceResponse. - type: 'Promise<ResourceResponse[]>' - - name: 'sendActivity(string | Partial, string, string)' + type: Promise<[]> + - name: sendActivity(string | Partial, string, string) uid: botbuilder-core.TurnContext.sendActivity package: botbuilder-core summary: Asynchronously sends an activity to the sender of the incoming activity. @@ -754,16 +672,15 @@ methods: - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) - isPreview: false isDeprecated: false syntax: content: >- function sendActivity(activityOrText: string | Partial, - speak?: string, inputHint?: string): Promise + speak?: string, inputHint?: string): Promise parameters: - id: activityOrText - type: string | Partial<Activity> + type: string | Partial<> description: The activity or text to send. - id: speak type: string @@ -779,8 +696,10 @@ methods: or 'expectingInput'. Default is 'acceptingInput'. return: description: A promise with a ResourceResponse. - type: Promise<ResourceResponse | undefined> - - name: 'sendTraceActivity(string, any, string, string)' + type: >- + Promise<undefined | > + - name: sendTraceActivity(string, any, string, string) uid: botbuilder-core.TurnContext.sendTraceActivity package: botbuilder-core summary: Asynchronously sends an activity to the sender of the incoming activity. @@ -803,12 +722,11 @@ methods: - [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) - isPreview: false isDeprecated: false syntax: content: >- function sendTraceActivity(name: string, value?: any, valueType?: - string, label?: string): Promise + string, label?: string): Promise parameters: - id: name type: string @@ -830,7 +748,9 @@ methods: ignoring user return: description: A promise with a ResourceResponse. - type: Promise<ResourceResponse | undefined> + type: >- + Promise<undefined | > - name: updateActivity(Partial) uid: botbuilder-core.TurnContext.updateActivity package: botbuilder-core @@ -865,16 +785,15 @@ methods: - [getReplyConversationReference](xref:botbuilder-core.TurnContext.getReplyConversationReference) - isPreview: false isDeprecated: false syntax: content: >- - function updateActivity(activity: Partial): - Promise + function updateActivity(activity: Partial): Promise parameters: - id: activity - type: Partial<Activity> + type: Partial<> description: The replacement for the original activity. return: description: A promise with a ResourceResponse. - type: Promise<ResourceResponse | void> + type: Promise<void | > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContextStateCollection.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContextStateCollection.yml index 1ab481cc..5239c257 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContextStateCollection.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/TurnContextStateCollection.yml @@ -15,9 +15,212 @@ remarks: >- [ConversationState](xref:botbuilder-core.ConversationState), [LanguageGenerator](xref:botbuilder-dialogs-adaptive.LanguageGenerator), [ResourceExplorer](xref:botbuilder-dialogs-declarative.ResourceExplorer), etc. -isPreview: false isDeprecated: false type: class +constructors: + - name: TurnContextStateCollection(null | (readonly (readonly [any, any])[])) + uid: botbuilder-core.TurnContextStateCollection.constructor + package: botbuilder-core + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TurnContextStateCollection(entries?: null | (readonly (readonly + [any, any])[])) + parameters: + - id: entries + type: null | (readonly (readonly [any, any])[]) + description: '' + - name: TurnContextStateCollection(null | Iterable) + uid: botbuilder-core.TurnContextStateCollection.constructor_1 + package: botbuilder-core + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TurnContextStateCollection(iterable?: null | Iterable) + parameters: + - id: iterable + type: null | Iterable<readonly [any, any]> + description: '' +inheritedProperties: + - name: size + uid: botbuilder-core.TurnContextStateCollection.size + package: botbuilder-core + summary: '' + fullName: size + remarks: '' + isDeprecated: false + syntax: + content: 'size: number' + return: + description: the number of elements in the Map. + type: number + inheritanceDescription: Inherited From Map.size + - name: '[species]' + uid: botbuilder-core.TurnContextStateCollection.[species] + package: botbuilder-core + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: MapConstructor' + return: + description: '' + type: MapConstructor + inheritanceDescription: Inherited From Map.__@species@1747 + - name: '[toStringTag]' + uid: botbuilder-core.TurnContextStateCollection.[toStringTag] + package: botbuilder-core + summary: '' + fullName: '[toStringTag]' + remarks: '' + isDeprecated: false + syntax: + content: '[toStringTag]: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Map.__@toStringTag@123 +inheritedMethods: + - name: clear() + uid: botbuilder-core.TurnContextStateCollection.clear + package: botbuilder-core + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function clear() + inheritanceDescription: Inherited From Map.clear + - name: delete(any) + uid: botbuilder-core.TurnContextStateCollection.delete + package: botbuilder-core + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(key: any): boolean' + parameters: + - id: key + type: any + description: '' + return: + description: >- + true if an element in the Map existed and has been removed, or false + if the element does not exist. + type: boolean + inheritanceDescription: Inherited From Map.delete + - name: entries() + uid: botbuilder-core.TurnContextStateCollection.entries + package: botbuilder-core + summary: Returns an iterable of key, value pairs for every entry in the map. + remarks: '' + isDeprecated: false + syntax: + content: 'function entries(): IterableIterator<[any, any]>' + return: + description: '' + type: IterableIterator<[any, any]> + inheritanceDescription: Inherited From Map.entries + - name: 'forEach((value: any, key: any, map: Map) => void, any)' + uid: botbuilder-core.TurnContextStateCollection.forEach + package: botbuilder-core + summary: >- + Executes a provided function once per each key/value pair in the Map, in + insertion order. + remarks: '' + isDeprecated: false + syntax: + content: >- + function forEach(callbackfn: (value: any, key: any, map: Map) + => void, thisArg?: any) + parameters: + - id: callbackfn + type: '(value: any, key: any, map: Map<any, any>) => void' + description: '' + - id: thisArg + type: any + description: '' + inheritanceDescription: Inherited From Map.forEach + - name: has(any) + uid: botbuilder-core.TurnContextStateCollection.has + package: botbuilder-core + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function has(key: any): boolean' + parameters: + - id: key + type: any + description: '' + return: + description: >- + boolean indicating whether an element with the specified key exists or + not. + type: boolean + inheritanceDescription: Inherited From Map.has + - name: keys() + uid: botbuilder-core.TurnContextStateCollection.keys + package: botbuilder-core + summary: Returns an iterable of keys in the map + remarks: '' + isDeprecated: false + syntax: + content: 'function keys(): IterableIterator' + return: + description: '' + type: IterableIterator<any> + inheritanceDescription: Inherited From Map.keys + - name: set(any, any) + uid: botbuilder-core.TurnContextStateCollection.set + package: botbuilder-core + summary: >- + Adds a new element with a specified key and value to the Map. If an + element with the same key already exists, the element will be updated. + remarks: '' + isDeprecated: false + syntax: + content: 'function set(key: any, value: any): TurnContextStateCollection' + parameters: + - id: key + type: any + description: '' + - id: value + type: any + description: '' + return: + description: '' + type: + inheritanceDescription: Inherited From Map.set + - name: values() + uid: botbuilder-core.TurnContextStateCollection.values + package: botbuilder-core + summary: Returns an iterable of values in the map + remarks: '' + isDeprecated: false + syntax: + content: 'function values(): IterableIterator' + return: + description: '' + type: IterableIterator<any> + inheritanceDescription: Inherited From Map.values + - name: '[iterator]()' + uid: botbuilder-core.TurnContextStateCollection.[iterator] + package: botbuilder-core + summary: Returns an iterable of entries in the map. + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator<[any, any]>' + return: + description: '' + type: IterableIterator<[any, any]> + inheritanceDescription: Inherited From Map.__@iterator@727 methods: - name: get(any) uid: botbuilder-core.TurnContextStateCollection.get_1 @@ -26,15 +229,13 @@ methods: Gets a value from the [TurnContextStateCollection](xref:botbuilder-core.TurnContextStateCollection). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(key: any): any' parameters: - id: key type: any - description: | - The values key. + description: The values key. return: description: '' type: any @@ -45,24 +246,21 @@ methods: Gets a typed value from the [TurnContextStateCollection](xref:botbuilder-core.TurnContextStateCollection). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(key: any): T' parameters: - id: key type: any - description: | - The values key. + description: The values key. return: description: '' type: T - name: pop(any) uid: botbuilder-core.TurnContextStateCollection.pop package: botbuilder-core - summary: 'Restores a keys previous value, and returns the value that was removed.' + summary: Restores a keys previous value, and returns the value that was removed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function pop(key: any): any' @@ -73,14 +271,13 @@ methods: return: description: The removed value. type: any - - name: 'push(any, any)' + - name: push(any, any) uid: botbuilder-core.TurnContextStateCollection.push package: botbuilder-core summary: Push a value by key to the turn's context. remarks: >- The keys current value (if any) will be saved and can be restored by calling [pop()](#pop). - isPreview: false isDeprecated: false syntax: content: 'function push(key: any, value: any)' @@ -90,6 +287,5 @@ methods: description: The values key. - id: value type: any - description: | - The new value. -extends: any + description: The new value. +extends: Map<any, any> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type.yml new file mode 100644 index 00000000..e2c5ea21 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Type +uid: botbuilder-core.Type +package: botbuilder-core +summary: |- + Defines values for Type. + Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' +fullName: Type +remarks: '' +isDeprecated: false +syntax: | + type Type = "ViewAction" | "OpenUri" | "HttpPOST" | "ActionCard" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type1.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type1.yml new file mode 100644 index 00000000..b3f7ef0f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type1.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Type1 +uid: botbuilder-core.Type1 +package: botbuilder-core +summary: '' +fullName: Type1 +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use O365ConnectorCardInputBaseType instead. +syntax: | + type Type1 = O365ConnectorCardInputBaseType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type2.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type2.yml new file mode 100644 index 00000000..7507e16b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type2.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Type2 +uid: botbuilder-core.Type2 +package: botbuilder-core +summary: '' +fullName: Type2 +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use BotMessagePreviewType +syntax: | + type Type2 = BotMessagePreviewType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type3.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type3.yml new file mode 100644 index 00000000..4440c7ea --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/Type3.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Type3 +uid: botbuilder-core.Type3 +package: botbuilder-core +summary: '' +fullName: Type3 +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use MessagingExtensionResultType instead +syntax: | + type Type3 = MessagingExtensionResultType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UpdateActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UpdateActivityHandler.yml index c208a614..2fbea861 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UpdateActivityHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UpdateActivityHandler.yml @@ -48,7 +48,6 @@ remarks: >- - [TurnContext.onUpdateActivity](xref:botbuilder-core.TurnContext.onUpdateActivity) -isPreview: false isDeprecated: false syntax: | type UpdateActivityHandler = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserIdentityType.yml new file mode 100644 index 00000000..dbf68ca8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserIdentityType.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: UserIdentityType +uid: botbuilder-core.UserIdentityType +package: botbuilder-core +summary: >- + Defines values for UserIdentityType. + + Possible values include: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', + 'federatedUser' +fullName: UserIdentityType +remarks: '' +isDeprecated: false +syntax: | + type UserIdentityType = + | "aadUser" + | "onPremiseAadUser" + | "anonymousGuest" + | "federatedUser" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserMeetingDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserMeetingDetails.yml new file mode 100644 index 00000000..ac7d5114 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserMeetingDetails.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: UserMeetingDetails +uid: botbuilder-core.UserMeetingDetails +package: botbuilder-core +summary: '' +fullName: UserMeetingDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: inMeeting + uid: botbuilder-core.UserMeetingDetails.inMeeting + package: botbuilder-core + summary: The user in meeting indicator. + fullName: inMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'inMeeting: boolean' + return: + description: '' + type: boolean + - name: role + uid: botbuilder-core.UserMeetingDetails.role + package: botbuilder-core + summary: The user's role. + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserState.yml index 0fc65358..4717fc6f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/UserState.yml @@ -20,16 +20,14 @@ remarks: >- const userState = new UserState(new MemoryStorage()); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'UserState(Storage, string)' + - name: UserState(Storage, string) uid: botbuilder-core.UserState.constructor package: botbuilder-core summary: Creates a new UserState instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new UserState(storage: Storage, namespace?: string)' @@ -39,7 +37,7 @@ constructors: description: Storage provider to persist user state to. - id: namespace type: string - description: > + description: >- (Optional) namespace to append to storage keys. Defaults to an empty string. inheritedMethods: @@ -61,7 +59,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function clear(context: TurnContext): Promise' @@ -84,7 +81,6 @@ inheritedMethods: states storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createProperty(name: string): StatePropertyAccessor' @@ -114,7 +110,6 @@ inheritedMethods: await botState.delete(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' @@ -142,19 +137,18 @@ inheritedMethods: const state = botState.get(context); ``` - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): any | undefined' + content: 'function get(context: TurnContext): any' parameters: - id: context type: description: Context for current turn of conversation with the user. return: description: A cached state object or undefined if not cached. - type: any | undefined - inheritanceDescription: 'Inherited From [BotState.get](xref:botbuilder-core.BotState.get)' - - name: 'load(TurnContext, boolean)' + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder-core.BotState.get) + - name: load(TurnContext, boolean) uid: botbuilder-core.UserState.load package: botbuilder-core summary: Reads in and caches the backing state object for a turn. @@ -174,7 +168,6 @@ inheritedMethods: const state = await botState.load(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function load(context: TurnContext, force?: boolean): Promise' @@ -190,8 +183,8 @@ inheritedMethods: return: description: The cached state. type: Promise<any> - inheritanceDescription: 'Inherited From [BotState.load](xref:botbuilder-core.BotState.load)' - - name: 'saveChanges(TurnContext, boolean)' + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder-core.BotState.load) + - name: saveChanges(TurnContext, boolean) uid: botbuilder-core.UserState.saveChanges package: botbuilder-core summary: Saves the cached state object if it's been changed. @@ -210,7 +203,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -237,15 +229,14 @@ methods: package: botbuilder-core summary: Returns the storage key for the current user state. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getStorageKey(context: TurnContext): string | undefined' + content: 'function getStorageKey(context: TurnContext): undefined | string' parameters: - id: context type: description: Context for current turn of conversation with the user. return: description: The storage key for the current user state. - type: string | undefined + type: undefined | string extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/VideoCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/VideoCard.yml new file mode 100644 index 00000000..17563f5f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/VideoCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: VideoCard +uid: botbuilder-core.VideoCard +package: botbuilder-core +summary: Video card +fullName: VideoCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder-core.VideoCard.aspect + package: botbuilder-core + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder-core.VideoCard.autoloop + package: botbuilder-core + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder-core.VideoCard.autostart + package: botbuilder-core + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder-core.VideoCard.buttons + package: botbuilder-core + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder-core.VideoCard.duration + package: botbuilder-core + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder-core.VideoCard.image + package: botbuilder-core + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder-core.VideoCard.media + package: botbuilder-core + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder-core.VideoCard.shareable + package: botbuilder-core + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder-core.VideoCard.subtitle + package: botbuilder-core + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder-core.VideoCard.text + package: botbuilder-core + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder-core.VideoCard.title + package: botbuilder-core + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder-core.VideoCard.value + package: botbuilder-core + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ViewResponseType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ViewResponseType.yml new file mode 100644 index 00000000..9eb8c57c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/ViewResponseType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ViewResponseType +uid: botbuilder-core.ViewResponseType +package: botbuilder-core +summary: The type of the view in the handle action response. +fullName: ViewResponseType +remarks: '' +isDeprecated: false +syntax: | + type ViewResponseType = "Card" | "QuickView" | "NoOp" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/index.yml index 38badd77..9c1bf5be 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-core/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-core/index.yml @@ -3,6 +3,28 @@ uid: botbuilder-core name: botbuilder-core summary: '' type: package +enums: + - botbuilder-core.ActionTypes + - botbuilder-core.ActivityEventNames + - botbuilder-core.ActivityImportance + - botbuilder-core.ActivityTypes + - botbuilder-core.AttachmentLayoutTypes + - botbuilder-core.Channels + - botbuilder-core.ContactRelationUpdateActionTypes + - botbuilder-core.DeliveryModes + - botbuilder-core.DropDownOptionType + - botbuilder-core.EndOfConversationCodes + - botbuilder-core.FieldType + - botbuilder-core.InputHints + - botbuilder-core.InstallationUpdateActionTypes + - botbuilder-core.MediaType + - botbuilder-core.MessageReactionTypes + - botbuilder-core.PopupWindowPosition + - botbuilder-core.RoleTypes + - botbuilder-core.SemanticActionStateTypes + - botbuilder-core.Severity + - botbuilder-core.StatusCodes + - botbuilder-core.TextFormatTypes classes: - botbuilder-core.ActivityFactory - botbuilder-core.ActivityHandler @@ -13,20 +35,22 @@ classes: - botbuilder-core.BotState - botbuilder-core.BotStatePropertyAccessor - botbuilder-core.BotStateSet - - botbuilder-core.NullTelemetryClient - botbuilder-core.BrowserLocalStorage - botbuilder-core.BrowserSessionStorage + - botbuilder-core.CallerIdConstants - botbuilder-core.CardFactory - botbuilder-core.CloudAdapterBase - botbuilder-core.ComponentRegistration - botbuilder-core.ConfigurationBotFrameworkAuthentication - botbuilder-core.ConfigurationServiceClientCredentialFactory + - botbuilder-core.ConsoleTranscriptLogger - botbuilder-core.ConversationState - botbuilder-core.InvokeException - botbuilder-core.MemoryStorage - botbuilder-core.MemoryTranscriptStore - botbuilder-core.MessageFactory - botbuilder-core.MiddlewareSet + - botbuilder-core.NullTelemetryClient - botbuilder-core.PrivateConversationState - botbuilder-core.QueueStorage - botbuilder-core.RegisterClassMiddleware @@ -34,111 +58,629 @@ classes: - botbuilder-core.SkillConversationIdFactory - botbuilder-core.SkillConversationIdFactoryBase - botbuilder-core.SkypeMentionNormalizeMiddleware + - botbuilder-core.SpeechConstants - botbuilder-core.StringUtils - - botbuilder-core.TelemetryConstants - botbuilder-core.TelemetryLoggerMiddleware - botbuilder-core.TestAdapter - botbuilder-core.TestFlow - - botbuilder-core.ConsoleTranscriptLogger - botbuilder-core.TranscriptLoggerMiddleware - botbuilder-core.TurnContext - botbuilder-core.TurnContextStateCollection - botbuilder-core.UserState +interfaces: + - botbuilder-core.AceData + - botbuilder-core.AceRequest + - botbuilder-core.Activity + - botbuilder-core.ActivityTimestamps + - botbuilder-core.AdaptiveCardAuthentication + - botbuilder-core.AdaptiveCardInvokeAction + - botbuilder-core.AdaptiveCardInvokeResponse + - botbuilder-core.AdaptiveCardInvokeValue + - botbuilder-core.AnimationCard + - botbuilder-core.AppBasedLinkQuery + - botbuilder-core.Attachment + - botbuilder-core.AttachmentData + - botbuilder-core.AttachmentInfo + - botbuilder-core.AttachmentView + - botbuilder-core.AudioCard + - botbuilder-core.BaseCardComponent + - botbuilder-core.BaseCardViewParameters + - botbuilder-core.BaseHandleActionResponse + - botbuilder-core.BasicCard + - botbuilder-core.BatchFailedEntriesResponse + - botbuilder-core.BatchFailedEntry + - botbuilder-core.BatchOperationRequest + - botbuilder-core.BatchOperationResponse + - botbuilder-core.BatchOperationStateResponse + - botbuilder-core.BotConfigAuth + - botbuilder-core.BotFrameworkClient + - botbuilder-core.BotFrameworkSkill + - botbuilder-core.BotPageViewTelemetryClient + - botbuilder-core.BotTelemetryClient + - botbuilder-core.CacheInfo + - botbuilder-core.CachedBotState + - botbuilder-core.CardAction + - botbuilder-core.CardBarComponent + - botbuilder-core.CardButtonBase + - botbuilder-core.CardButtonComponent + - botbuilder-core.CardImage + - botbuilder-core.CardSearchBoxComponent + - botbuilder-core.CardSearchFooterComponent + - botbuilder-core.CardTextComponent + - botbuilder-core.CardTextInputComponent + - botbuilder-core.CardViewHandleActionResponse + - botbuilder-core.CardViewResponse + - botbuilder-core.ChannelAccount + - botbuilder-core.ChannelInfo + - botbuilder-core.CommandResultValue + - botbuilder-core.CommandValue + - botbuilder-core.ConfigResponse + - botbuilder-core.ConfirmationDialog + - botbuilder-core.ConversationAccount + - botbuilder-core.ConversationList + - botbuilder-core.ConversationMembers + - botbuilder-core.ConversationParameters + - botbuilder-core.ConversationReference + - botbuilder-core.ConversationResourceResponse + - botbuilder-core.ConversationsResult + - botbuilder-core.CoreAppCredentials + - botbuilder-core.Entity + - botbuilder-core.ErrorModel + - botbuilder-core.ErrorResponse + - botbuilder-core.ExecuteCardAction + - botbuilder-core.ExecuteCardParameters + - botbuilder-core.ExpectedReplies + - botbuilder-core.ExtendedUserTokenProvider + - botbuilder-core.ExternalLinkActionParameters + - botbuilder-core.ExternalLinkCardAction + - botbuilder-core.Fact + - botbuilder-core.FileConsentCard + - botbuilder-core.FileConsentCardResponse + - botbuilder-core.FileDownloadInfo + - botbuilder-core.FileInfoCard + - botbuilder-core.FileUploadInfo + - botbuilder-core.FocusParameters + - botbuilder-core.GeoCoordinates + - botbuilder-core.GetLocationActionParameters + - botbuilder-core.GetLocationCardAction + - botbuilder-core.GetPropertyPaneConfigurationResponse + - botbuilder-core.HeroCard + - botbuilder-core.IActivity + - botbuilder-core.ICardSearchBoxButton + - botbuilder-core.ICardTextInputIconButton + - botbuilder-core.ICardTextInputTitleButton + - botbuilder-core.ICommandActivity + - botbuilder-core.ICommandResultActivity + - botbuilder-core.IContactRelationUpdateActivity + - botbuilder-core.IConversationUpdateActivity + - botbuilder-core.IEndOfConversationActivity + - botbuilder-core.IEventActivity + - botbuilder-core.IInstallationUpdateActivity + - botbuilder-core.IInvokeActivity + - botbuilder-core.IMessageActivity + - botbuilder-core.IMessageReactionActivity + - botbuilder-core.IMessageUpdateActivity + - botbuilder-core.IStatusCodeError + - botbuilder-core.ISuggestionActivity + - botbuilder-core.ITraceActivity + - botbuilder-core.IUserTokenProvider + - botbuilder-core.InnerHttpError + - botbuilder-core.IntentScore + - botbuilder-core.InvokeResponse + - botbuilder-core.Location + - botbuilder-core.MediaCard + - botbuilder-core.MediaEventValue + - botbuilder-core.MediaUrl + - botbuilder-core.Meeting + - botbuilder-core.MeetingDetails + - botbuilder-core.MeetingEndEventDetails + - botbuilder-core.MeetingEventDetails + - botbuilder-core.MeetingInfo + - botbuilder-core.MeetingNotificationBase + - botbuilder-core.MeetingNotificationChannelData + - botbuilder-core.MeetingNotificationRecipientFailureInfo + - botbuilder-core.MeetingNotificationResponse + - botbuilder-core.MeetingParticipantsEventDetails + - botbuilder-core.MeetingStageSurface + - botbuilder-core.MeetingStartEventDetails + - botbuilder-core.MeetingTabIconSurface + - botbuilder-core.Mention + - botbuilder-core.MessageActionsPayload + - botbuilder-core.MessageActionsPayloadApp + - botbuilder-core.MessageActionsPayloadAttachment + - botbuilder-core.MessageActionsPayloadBody + - botbuilder-core.MessageActionsPayloadConversation + - botbuilder-core.MessageActionsPayloadFrom + - botbuilder-core.MessageActionsPayloadMention + - botbuilder-core.MessageActionsPayloadReaction + - botbuilder-core.MessageActionsPayloadUser + - botbuilder-core.MessageReaction + - botbuilder-core.MessagingExtensionAction + - botbuilder-core.MessagingExtensionActionResponse + - botbuilder-core.MessagingExtensionAttachment + - botbuilder-core.MessagingExtensionParameter + - botbuilder-core.MessagingExtensionQuery + - botbuilder-core.MessagingExtensionQueryOptions + - botbuilder-core.MessagingExtensionResponse + - botbuilder-core.MessagingExtensionResult + - botbuilder-core.MessagingExtensionSuggestedAction + - botbuilder-core.MicrosoftPayMethodData + - botbuilder-core.Middleware + - botbuilder-core.NoOpHandleActionResponse + - botbuilder-core.NotificationInfo + - botbuilder-core.O365ConnectorCard + - botbuilder-core.O365ConnectorCardActionBase + - botbuilder-core.O365ConnectorCardActionCard + - botbuilder-core.O365ConnectorCardActionQuery + - botbuilder-core.O365ConnectorCardDateInput + - botbuilder-core.O365ConnectorCardFact + - botbuilder-core.O365ConnectorCardHttpPOST + - botbuilder-core.O365ConnectorCardImage + - botbuilder-core.O365ConnectorCardInputBase + - botbuilder-core.O365ConnectorCardMultichoiceInput + - botbuilder-core.O365ConnectorCardMultichoiceInputChoice + - botbuilder-core.O365ConnectorCardOpenUri + - botbuilder-core.O365ConnectorCardOpenUriTarget + - botbuilder-core.O365ConnectorCardSection + - botbuilder-core.O365ConnectorCardTextInput + - botbuilder-core.O365ConnectorCardViewAction + - botbuilder-core.OAuthCard + - botbuilder-core.OnBehalfOf + - botbuilder-core.PagedMembersResult + - botbuilder-core.PagedResult + - botbuilder-core.PaymentAddress + - botbuilder-core.PaymentCurrencyAmount + - botbuilder-core.PaymentDetails + - botbuilder-core.PaymentDetailsModifier + - botbuilder-core.PaymentItem + - botbuilder-core.PaymentMethodData + - botbuilder-core.PaymentOptions + - botbuilder-core.PaymentRequest + - botbuilder-core.PaymentRequestComplete + - botbuilder-core.PaymentRequestCompleteResult + - botbuilder-core.PaymentRequestUpdate + - botbuilder-core.PaymentRequestUpdateResult + - botbuilder-core.PaymentResponse + - botbuilder-core.PaymentShippingOption + - botbuilder-core.Place + - botbuilder-core.PropertyManager + - botbuilder-core.PropertyPaneCheckboxProperties + - botbuilder-core.PropertyPaneChoiceGroupIconProperties + - botbuilder-core.PropertyPaneChoiceGroupImageSize + - botbuilder-core.PropertyPaneChoiceGroupOption + - botbuilder-core.PropertyPaneChoiceGroupProperties + - botbuilder-core.PropertyPaneDropDownOption + - botbuilder-core.PropertyPaneDropDownProperties + - botbuilder-core.PropertyPaneFieldProperties + - botbuilder-core.PropertyPaneGroup + - botbuilder-core.PropertyPaneGroupField + - botbuilder-core.PropertyPaneGroupOrConditionalGroup + - botbuilder-core.PropertyPaneLabelProperties + - botbuilder-core.PropertyPaneLinkPopupWindowProperties + - botbuilder-core.PropertyPaneLinkProperties + - botbuilder-core.PropertyPanePage + - botbuilder-core.PropertyPanePageHeader + - botbuilder-core.PropertyPaneSliderProperties + - botbuilder-core.PropertyPaneTextFieldProperties + - botbuilder-core.PropertyPaneToggleProperties + - botbuilder-core.QuickViewCardAction + - botbuilder-core.QuickViewData + - botbuilder-core.QuickViewHandleActionResponse + - botbuilder-core.QuickViewParameters + - botbuilder-core.QuickViewResponse + - botbuilder-core.ReceiptCard + - botbuilder-core.ReceiptItem + - botbuilder-core.RecognizerResult + - botbuilder-core.ResourceResponse + - botbuilder-core.SearchCardViewParameters + - botbuilder-core.SearchInvokeOptions + - botbuilder-core.SearchInvokeResponse + - botbuilder-core.SearchInvokeValue + - botbuilder-core.SelectMediaActionParameters + - botbuilder-core.SelectMediaCardAction + - botbuilder-core.SemanticAction + - botbuilder-core.ShowLocationActionParameters + - botbuilder-core.ShowLocationCardAction + - botbuilder-core.SignInCardViewParameters + - botbuilder-core.SignInUrlResponse + - botbuilder-core.SigninCard + - botbuilder-core.SigninStateVerificationQuery + - botbuilder-core.SkillConversationIdFactoryOptions + - botbuilder-core.SkillConversationReference + - botbuilder-core.StatePropertyAccessor + - botbuilder-core.Storage + - botbuilder-core.StoreItem + - botbuilder-core.StoreItems + - botbuilder-core.SubmitCardAction + - botbuilder-core.SubmitCardParameters + - botbuilder-core.SuggestedActions + - botbuilder-core.TabContext + - botbuilder-core.TabEntityContext + - botbuilder-core.TabRequest + - botbuilder-core.TabResponse + - botbuilder-core.TabResponseCard + - botbuilder-core.TabResponseCards + - botbuilder-core.TabResponsePayload + - botbuilder-core.TabSubmit + - botbuilder-core.TabSubmitData + - botbuilder-core.TabSuggestedActions + - botbuilder-core.TargetedMeetingNotification + - botbuilder-core.TargetedMeetingNotificationValue + - botbuilder-core.TaskModuleCardResponse + - botbuilder-core.TaskModuleContinueResponse + - botbuilder-core.TaskModuleMessageResponse + - botbuilder-core.TaskModuleRequest + - botbuilder-core.TaskModuleRequestContext + - botbuilder-core.TaskModuleResponse + - botbuilder-core.TaskModuleResponseBase + - botbuilder-core.TaskModuleTaskInfo + - botbuilder-core.TeamDetails + - botbuilder-core.TeamInfo + - botbuilder-core.TeamsAttachment + - botbuilder-core.TeamsChannelAccount + - botbuilder-core.TeamsChannelData + - botbuilder-core.TeamsChannelDataSettings + - botbuilder-core.TeamsMeetingInfo + - botbuilder-core.TeamsMeetingMember + - botbuilder-core.TeamsMeetingParticipant + - botbuilder-core.TeamsPagedMembersResult + - botbuilder-core.TelemetryDependency + - botbuilder-core.TelemetryEvent + - botbuilder-core.TelemetryException + - botbuilder-core.TelemetryPageView + - botbuilder-core.TelemetryTrace + - botbuilder-core.TenantInfo + - botbuilder-core.TextCardViewParameters + - botbuilder-core.TextHighlight + - botbuilder-core.TextInputCardViewParameters + - botbuilder-core.Thing + - botbuilder-core.ThumbnailCard + - botbuilder-core.ThumbnailUrl + - botbuilder-core.TokenExchangeInvokeRequest + - botbuilder-core.TokenExchangeInvokeResponse + - botbuilder-core.TokenExchangeRequest + - botbuilder-core.TokenExchangeResource + - botbuilder-core.TokenPollingSettings + - botbuilder-core.TokenPostResource + - botbuilder-core.TokenRequest + - botbuilder-core.TokenResponse + - botbuilder-core.Transcript + - botbuilder-core.TranscriptInfo + - botbuilder-core.TranscriptLogger + - botbuilder-core.TranscriptStore + - botbuilder-core.UserMeetingDetails + - botbuilder-core.VideoCard typeAliases: + - botbuilder-core.AceCardSize + - botbuilder-core.Action + - botbuilder-core.ActivityImageType + - botbuilder-core.ApplicationIdentityType + - botbuilder-core.AttachmentLayout + - botbuilder-core.BotConfigAuthType - botbuilder-core.BotHandler + - botbuilder-core.BotMessagePreviewActionType + - botbuilder-core.BotMessagePreviewType + - botbuilder-core.CardComponentName + - botbuilder-core.CardViewActionsFooterParameters + - botbuilder-core.CardViewFooterParameters + - botbuilder-core.CardViewParameters + - botbuilder-core.CommandContext + - botbuilder-core.ConfigResponseConfig - botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions - botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions + - botbuilder-core.ContentType + - botbuilder-core.ConversationIdentityType + - botbuilder-core.DeleteActivityHandler + - botbuilder-core.FileDownloadInfoAttachment + - botbuilder-core.HandleActionResponse + - botbuilder-core.IHandoffActivity + - botbuilder-core.IMessageDeleteActivity + - botbuilder-core.ITypingActivity + - botbuilder-core.Importance + - botbuilder-core.MeetingNotification + - botbuilder-core.MeetingSurface + - botbuilder-core.MessageType + - botbuilder-core.MessagingExtensionResultType - botbuilder-core.MiddlewareHandler + - botbuilder-core.O365ConnectorCardActionType + - botbuilder-core.O365ConnectorCardInputBaseType + - botbuilder-core.O365ConnectorCardInputType + - botbuilder-core.OnCardSelectionAction + - botbuilder-core.Os + - botbuilder-core.ReactionType + - botbuilder-core.SendActivitiesHandler + - botbuilder-core.SetPropertyPaneConfigurationResponse - botbuilder-core.StorageKeyFactory + - botbuilder-core.Style + - botbuilder-core.TeamsMember - botbuilder-core.TestActivityInspector - - botbuilder-core.DeleteActivityHandler - - botbuilder-core.SendActivitiesHandler + - botbuilder-core.TokenExchangeState + - botbuilder-core.TokenStatus + - botbuilder-core.Type + - botbuilder-core.Type1 + - botbuilder-core.Type2 + - botbuilder-core.Type3 - botbuilder-core.UpdateActivityHandler + - botbuilder-core.UserIdentityType + - botbuilder-core.ViewResponseType functions: - - name: 'useBotState(BotAdapter, BotState[])' - uid: botbuilder-core.useBotState + - name: >- + BasicCardView(CardBarComponent, CardTextComponent, + CardViewFooterParameters) + uid: botbuilder-core.BasicCardView package: botbuilder-core summary: >- - Adds middleware to the adapter to register one or more BotState objects on - the turn context. + Helper method to create a Basic Card View. - The middleware registers the state objects on the turn context at the - start of each turn. + The Basic Text card view displays the following: + + - Card bar + + - One primary text field + + - Zero or one button in the Medium card size, up to two buttons in Large + card size; or text input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function useBotState(botAdapter: BotAdapter, botStates: BotState[]): - BotAdapter + function BasicCardView(cardBar: CardBarComponent, header: + CardTextComponent, footer?: CardViewFooterParameters): + TextCardViewParameters parameters: - - id: botAdapter - type: - description: The adapter on which to register the state objects. - - id: botStates - type: '[]' - description: The state objects to register. + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: footer + type: + description: up to two buttons or text input to display as footer return: - description: The updated adapter. - type: - - name: 'assertBotComponent(unknown, unknown[])' - uid: botbuilder-core.assertBotComponent + description: basic card view parameters. + type: + - name: >- + ImageCardView(CardBarComponent, CardTextComponent, CardImage, + CardViewFooterParameters) + uid: botbuilder-core.ImageCardView package: botbuilder-core - summary: '' + summary: >- + Helper method to create an Image Card View. + + The Image Card view displays the following: + + - Card bar + + - One primary text field + + - One image + + - Zero buttons in the Medium card size, up to two buttons in Large card + size; or text input. remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: Use `BotComponent.z.parse()` instead. + isDeprecated: false syntax: - content: 'function assertBotComponent(val: unknown, _args: unknown[]): asserts' + content: >- + function ImageCardView(cardBar: CardBarComponent, header: + CardTextComponent, image: CardImage, footer?: CardViewFooterParameters): + TextCardViewParameters parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: image + type: CardImage + description: image to display + - id: footer + type: + description: up to two buttons or text input to display as footer return: - description: '' - type: asserts + description: image card view parameters + type: - name: >- - telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, - [key: string]: number) - uid: botbuilder-core.telemetryTrackDialogView + PrimaryTextCardView(CardBarComponent, CardTextComponent, + CardTextComponent, CardViewFooterParameters) + uid: botbuilder-core.PrimaryTextCardView package: botbuilder-core summary: >- - Logs a DialogView using the - [trackPageView](xref:botbuilder-core.BotTelemetryClient.trackPageView) - method on the - [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) if - [BotPageViewTelemetryClient](xref:botbuilder-core.BotPageViewTelemetryClient) - has been implemented. + Helper method to create a Primary Text Card View. - Alternatively logs the information out via TrackTrace. + The Primary Text card view displays the following: + + - Card bar + + - One primary text field + + - One description text field + + - Zero or one button in the Medium card size, up to two buttons in Large + card size; or text input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, - dialogName: string, properties?: [key: string]: any, metrics?: [key: - string]: number) + function PrimaryTextCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextComponent, footer?: + CardViewFooterParameters): TextCardViewParameters parameters: - - id: telemetryClient - type: - description: >- - TelemetryClient that implements - [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient). - - id: dialogName - type: string - description: Name of the dialog to log the entry / start for. - - id: properties - type: '[key: string]\: any' - description: Named string values you can use to search and classify events. - - id: metrics - type: '[key: string]\: number' - description: | - Measurements associated with this event. + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text component to display as body + - id: footer + type: + description: up to two buttons or text input to display as footer + return: + description: primary text card view parameters. + type: + - name: >- + SearchCardView(CardBarComponent, CardTextComponent, + CardSearchBoxComponent, CardSearchFooterComponent) + uid: botbuilder-core.SearchCardView + package: botbuilder-core + summary: |- + Helper method to create a Search Card View. + The Search Card view displays the following: + - Card bar + - One primary text field + - One search box + - One search footer + remarks: '' + isDeprecated: false + syntax: + content: >- + function SearchCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardSearchBoxComponent, footer: + CardSearchFooterComponent): SearchCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: search box component to display as body + - id: footer + type: + description: search footer component to display as footer + return: + description: search card view parameters + type: + - name: >- + SignInCardView(CardBarComponent, CardTextComponent, CardTextComponent, + CardButtonComponent) + uid: botbuilder-core.SignInCardView + package: botbuilder-core + summary: |- + Helper method to create a Sign In Card View. + The Sign In Card view displays the following: + - Card bar + - One primary text field + - One description text field + - Two buttons. + remarks: >- + The first button (sign in button) is always displayed based on the + signInText property of the Adaptive Card Extension. Here you should + specify the second button (sign in complete button) to display. + isDeprecated: false + syntax: + content: >- + function SignInCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextComponent, footer: + CardButtonComponent): SignInCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text component to display as body + - id: footer + type: + description: sign in complete button to display as footer + return: + description: sign in card view parameters + type: + - name: >- + TextInputCardView(CardBarComponent, CardTextComponent, + CardTextInputComponent, CardViewActionsFooterParameters) + uid: botbuilder-core.TextInputCardView + package: botbuilder-core + summary: >- + Helper method to create an Text Input Card View. + + The Text Input Card view displays the following: + + - Card bar + + - One primary text field + + - Zero or one image + + - Zero text input in Medium card size if image is presented, one text + input in Medium card size if no image is presented, one text input in + Large card size + + - Zero buttons in the Medium card size if image is presented, one button + in Medium card size if no image is presented, up to two buttons in Large + card size; or text input. + remarks: '' + isDeprecated: false + syntax: + content: >- + function TextInputCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextInputComponent, footer?: + CardViewActionsFooterParameters): TextInputCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text input component to display as body + - id: footer + type: + description: up to two buttons to display as footer + return: + description: text input card view parameters + type: + - name: calculateChangeHash(StoreItem) + uid: botbuilder-core.calculateChangeHash + package: botbuilder-core + summary: Utility function to calculate a change hash for a `StoreItem`. + remarks: >- + This example calculates a change hash for an object that's been read in + and then only writes it + + back out if it's been modified: + + + ```JavaScript + + // Calculate state objects initial hash + + const hash = calculateChangeHash(state); + + + // Process the received activity + + await processActivity(context, state); + + + // Save state if changed + + if (calculateChangeHash(state) !== hash) { + await storage.write({ 'botState': state }); + } + + ``` + isDeprecated: false + syntax: + content: 'function calculateChangeHash(item: StoreItem): string' + parameters: + - id: item + type: + description: Item to calculate the change hash for. + return: + description: change hash string + type: string - name: >- createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: @@ -159,7 +701,6 @@ functions: properties of [ConfigurationBotFrameworkAuthenticationOptions](xref:botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions) as its keys. - isPreview: false isDeprecated: false syntax: content: >- @@ -224,7 +765,6 @@ functions: properties of [ConfigurationServiceClientCredentialFactoryOptions](xref:botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions) as its keys. - isPreview: false isDeprecated: false syntax: content: >- @@ -246,95 +786,81 @@ functions: type: >- - - name: 'assertStoreItems(unknown, unknown[])' - uid: botbuilder-core.assertStoreItems + - name: getTopScoringIntent(RecognizerResult) + uid: botbuilder-core.getTopScoringIntent package: botbuilder-core summary: '' remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: Use `zod.record(zod.unknown())` instead. + isDeprecated: false syntax: - content: 'function assertStoreItems(val: unknown, _args: unknown[]): asserts' + content: >- + function getTopScoringIntent(result: RecognizerResult): { intent: + string, score: number } parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' + - id: result + type: description: '' return: description: '' - type: asserts - - name: calculateChangeHash(StoreItem) - uid: botbuilder-core.calculateChangeHash + type: '{ intent: string, score: number }' + - name: >- + telemetryTrackDialogView(BotTelemetryClient, string, {[key: string]: any}, + {[key: string]: number}) + uid: botbuilder-core.telemetryTrackDialogView package: botbuilder-core - summary: Utility function to calculate a change hash for a `StoreItem`. - remarks: >- - This example calculates a change hash for an object that's been read in - and then only writes it - - back out if it's been modified: - - - ```JavaScript - - // Calculate state objects initial hash - - const hash = calculateChangeHash(state); - - - // Process the received activity - - await processActivity(context, state); - - - // Save state if changed + summary: >- + Logs a DialogView using the + [trackPageView](xref:botbuilder-core.BotTelemetryClient.trackPageView) + method on the + [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) if + [BotPageViewTelemetryClient](xref:botbuilder-core.BotPageViewTelemetryClient) + has been implemented. - if (calculateChangeHash(state) !== hash) { - await storage.write({ 'botState': state }); - } + Alternatively logs the information out via TrackTrace. + remarks: '' + isDeprecated: false + syntax: + content: >- + function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, + dialogName: string, properties?: {[key: string]: any}, metrics?: {[key: + string]: number}) + parameters: + - id: telemetryClient + type: + description: >- + TelemetryClient that implements + [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient). + - id: dialogName + type: string + description: Name of the dialog to log the entry / start for. + - id: properties + type: '{[key: string]: any}' + description: Named string values you can use to search and classify events. + - id: metrics + type: '{[key: string]: number}' + description: Measurements associated with this event. + - name: useBotState(BotAdapter, BotState[]) + uid: botbuilder-core.useBotState + package: botbuilder-core + summary: >- + Adds middleware to the adapter to register one or more BotState objects on + the turn context. - ``` - isPreview: false + The middleware registers the state objects on the turn context at the + start of each turn. + remarks: '' isDeprecated: false syntax: - content: 'function calculateChangeHash(item: StoreItem): string' + content: >- + function useBotState(botAdapter: BotAdapter, botStates: BotState[]): + BotAdapter parameters: - - id: item - type: - description: Item to calculate the change hash for. + - id: botAdapter + type: + description: The adapter on which to register the state objects. + - id: botStates + type: [] + description: The state objects to register. return: - description: change hash string - type: string -interfaces: - - botbuilder-core.CachedBotState - - botbuilder-core.StatePropertyAccessor - - botbuilder-core.BotPageViewTelemetryClient - - botbuilder-core.BotTelemetryClient - - botbuilder-core.TelemetryDependency - - botbuilder-core.TelemetryEvent - - botbuilder-core.TelemetryException - - botbuilder-core.TelemetryPageView - - botbuilder-core.TelemetryTrace - - botbuilder-core.CoreAppCredentials - - botbuilder-core.CoreWebResource - - botbuilder-core.ExtendedUserTokenProvider - - botbuilder-core.IntentScore - - botbuilder-core.Middleware - - botbuilder-core.PropertyManager - - botbuilder-core.RecognizerResult - - botbuilder-core.BotFrameworkSkill - - botbuilder-core.SkillConversationIdFactoryOptions - - botbuilder-core.SkillConversationReference - - botbuilder-core.Storage - - botbuilder-core.StoreItem - - botbuilder-core.StoreItems - - botbuilder-core.PagedResult - - botbuilder-core.TranscriptInfo - - botbuilder-core.TranscriptLogger - - botbuilder-core.TranscriptStore - - botbuilder-core.IUserTokenProvider - - botbuilder-core.TokenPollingSettings -enums: - - botbuilder-core.Severity + description: The updated adapter. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Configuration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Configuration.yml index 4aa3b0b7..e2679971 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Configuration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Configuration.yml @@ -5,40 +5,36 @@ package: botbuilder-dialogs-adaptive-runtime-core summary: Configuration is an interface that is used to obtain configurable values fullName: Configuration remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'get(string[])' + - name: get(string[]) uid: botbuilder-dialogs-adaptive-runtime-core.Configuration.get package: botbuilder-dialogs-adaptive-runtime-core summary: Look up a value by path. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function get(path?: string[]): T | undefined' + content: 'function get(path?: string[]): undefined | T' parameters: - id: path - type: 'string[]' + type: string[] description: path to get return: - description: 'the value, or undefined' - type: T | undefined - - name: 'set(string[], unknown)' + description: the value, or undefined + type: undefined | T + - name: set(string[], unknown) uid: botbuilder-dialogs-adaptive-runtime-core.Configuration.set package: botbuilder-dialogs-adaptive-runtime-core summary: Set a value by path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function set(path: string[], value: unknown)' parameters: - id: path - type: 'string[]' + type: string[] description: path to get - id: value type: unknown - description: | - path to get + description: path to get diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/DependencyFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/DependencyFactory.yml index 73e516f3..1f357da9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/DependencyFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/DependencyFactory.yml @@ -7,10 +7,11 @@ summary: >- depends on a set of other services. The type is generic over a few parameters: -fullName: 'DependencyFactory' +fullName: DependencyFactory remarks: '' -isPreview: false isDeprecated: false -syntax: >- - type DependencyFactory = (dependencies: - Dependencies, initialValue: Initial extends true ? Type : Type) => Type +syntax: | + type DependencyFactory = ( + dependencies: Dependencies, + initialValue: Initial extends true ? Type : Type | undefined + ) => Type diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Factory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Factory.yml index eb8b187b..841242b5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Factory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/Factory.yml @@ -5,10 +5,10 @@ package: botbuilder-dialogs-adaptive-runtime-core summary: >- Factory describes a generic factory function signature. The type is generic over a few parameters: -fullName: 'Factory' +fullName: Factory remarks: '' -isPreview: false isDeprecated: false -syntax: >- - type Factory = (initialValue: Initial extends true ? Type : - Type) => Type +syntax: | + type Factory = ( + initialValue: Initial extends true ? Type : Type | undefined + ) => Type diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/ServiceCollection.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/ServiceCollection.yml index 2c4990c1..faa08517 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/ServiceCollection.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/ServiceCollection.yml @@ -10,24 +10,21 @@ summary: >- for instances rather than types. fullName: ServiceCollection remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ServiceCollection(Record)' + - name: ServiceCollection(Record) uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.constructor package: botbuilder-dialogs-adaptive-runtime-core summary: Construct a Providers instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ServiceCollection(defaultServices?: Record)' parameters: - id: defaultServices - type: 'Record<string, unknown>' - description: | - default set of services + type: Record<string, unknown> + description: default set of services methods: - name: >- addFactory(string, string[], @@ -36,19 +33,18 @@ methods: package: botbuilder-dialogs-adaptive-runtime-core summary: Register a factory for a key with a set of dependencies. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function addFactory(key: string, dependencies: string[], factory: DependencyFactory): this + Dependencies, false>): ServiceCollection parameters: - id: key type: string description: key that factory will provide - id: dependencies - type: 'string[]' + type: string[] description: >- set of things this instance depends on. Will be provided to factory function via `services`. @@ -60,18 +56,19 @@ methods: description: function that creates an instance to provide return: description: this for chaining - type: this - - name: 'addFactory(string, Factory)' + type: >- + + - name: addFactory(string, Factory) uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.addFactory package: botbuilder-dialogs-adaptive-runtime-core summary: Register a factory for a key. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function addFactory(key: string, factory: - Factory): this + Factory): ServiceCollection parameters: - id: key type: string @@ -83,18 +80,19 @@ methods: description: function that creates an instance to provide return: description: this for chaining - type: this - - name: 'addInstance(string, InstanceType)' + type: >- + + - name: addInstance(string, InstanceType) uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.addInstance package: botbuilder-dialogs-adaptive-runtime-core summary: Register an instance by key. This will overwrite existing instances. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function addInstance(key: string, instance: InstanceType): - this + ServiceCollection parameters: - id: key type: string @@ -104,7 +102,9 @@ methods: description: instance to provide return: description: this for chaining - type: this + type: >- + - name: >- composeFactory(string, string[], DependencyFactory) @@ -117,19 +117,18 @@ methods: with a set of dependencies. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function composeFactory(key: string, dependencies: string[], factory: DependencyFactory): this + Dependencies, true>): ServiceCollection parameters: - id: key type: string description: key that factory will provide - id: dependencies - type: 'string[]' + type: string[] description: >- set of things this instance depends on. Will be provided to factory function via `services`. @@ -141,20 +140,21 @@ methods: description: function that creates an instance to provide return: description: this for chaining - type: this - - name: 'composeFactory(string, Factory)' + type: >- + + - name: composeFactory(string, Factory) uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.composeFactory package: botbuilder-dialogs-adaptive-runtime-core summary: >- Register a factory (that expects the initial value that is not undefined) for a key. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function composeFactory(key: string, factory: - Factory): this + Factory): ServiceCollection parameters: - id: key type: string @@ -166,18 +166,19 @@ methods: description: '' return: description: this for chaining - type: this - - name: 'makeInstance(string, boolean)' + type: >- + + - name: makeInstance(string, boolean) uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.makeInstance package: botbuilder-dialogs-adaptive-runtime-core summary: Build a single service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function makeInstance(key: string, deep?: boolean): - InstanceType | undefined + undefined | InstanceType parameters: - id: key type: string @@ -186,27 +187,25 @@ methods: type: boolean description: reconstruct all dependencies return: - description: 'the service instance, or undefined' - type: InstanceType | undefined + description: the service instance, or undefined + type: undefined | InstanceType - name: makeInstances() uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.makeInstances package: botbuilder-dialogs-adaptive-runtime-core summary: Build the full set of services. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function makeInstances(): InstancesType' return: description: all resolved services type: InstancesType - - name: 'mustMakeInstance(string, boolean)' + - name: mustMakeInstance(string, boolean) uid: >- botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.mustMakeInstance package: botbuilder-dialogs-adaptive-runtime-core summary: Build a single service and assert that it is not undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,7 +221,7 @@ methods: return: description: the service instance type: InstanceType - - name: 'mustMakeInstances(string[])' + - name: mustMakeInstances(string[]) uid: >- botbuilder-dialogs-adaptive-runtime-core.ServiceCollection.mustMakeInstances package: botbuilder-dialogs-adaptive-runtime-core @@ -230,13 +229,12 @@ methods: Build the full set of services, asserting that the specified keys are not undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function mustMakeInstances(keys: string[]): InstancesType' parameters: - id: keys - type: 'string[]' + type: string[] description: instances that must be not undefined return: description: all resolve services diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/index.yml index a6c7b0f5..17e19d77 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-core/index.yml @@ -3,10 +3,10 @@ uid: botbuilder-dialogs-adaptive-runtime-core name: botbuilder-dialogs-adaptive-runtime-core summary: '' type: package -interfaces: - - botbuilder-dialogs-adaptive-runtime-core.Configuration classes: - botbuilder-dialogs-adaptive-runtime-core.ServiceCollection +interfaces: + - botbuilder-dialogs-adaptive-runtime-core.Configuration typeAliases: - botbuilder-dialogs-adaptive-runtime-core.DependencyFactory - botbuilder-dialogs-adaptive-runtime-core.Factory diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/Options.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/Options.yml index 2fc0146d..57761005 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/Options.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/Options.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-runtime-integration-azure-functions summary: Options for runtime Azure Functions adapter fullName: Options remarks: '' -isPreview: false isDeprecated: false syntax: | - type Options = z.infer + type Options = z.infer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/index.yml index 88b25b0d..91ee222a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/index.yml @@ -8,46 +8,44 @@ typeAliases: functions: - name: >- makeTriggers(() => Promise<[ServiceCollection, Configuration]>, string, - Partial) + Partial<{ logErrors: boolean, staticDirectory: string }>) uid: >- botbuilder-dialogs-adaptive-runtime-integration-azure-functions.makeTriggers package: botbuilder-dialogs-adaptive-runtime-integration-azure-functions summary: Create azure function triggers using the azure restify integration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function makeTriggers(runtimeServices: () => Promise<[ServiceCollection, - Configuration]>, applicationRoot: string, options?: Partial): - Record + Configuration]>, applicationRoot: string, options?: Partial<{ logErrors: + boolean, staticDirectory: string }>): Record parameters: - id: runtimeServices - type: '() => Promise<[ServiceCollection, Configuration]>' + type: () => Promise<[ServiceCollection, Configuration]> description: result of calling `once(() => getRuntimeServices(...))` - id: applicationRoot type: string description: application root directory - id: options - type: >- - Partial<> + type: 'Partial<{ logErrors: boolean, staticDirectory: string }>' description: options bag for configuring Azure Functions return: description: azure function triggers for `module.exports` - type: 'Record<string, AzureFunction>' - - name: 'triggers(string, string, Partial)' + type: Record<string, > + - name: >- + triggers(string, string, Partial<{ logErrors: boolean, staticDirectory: + string }>) uid: botbuilder-dialogs-adaptive-runtime-integration-azure-functions.triggers package: botbuilder-dialogs-adaptive-runtime-integration-azure-functions summary: Create azure function triggers using the azure restify integration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function triggers(applicationRoot: string, settingsDirectory: string, - options?: Partial): Record + options?: Partial<{ logErrors: boolean, staticDirectory: string }>): + Record parameters: - id: applicationRoot type: string @@ -56,11 +54,8 @@ functions: type: string description: settings directory - id: options - type: >- - Partial<> + type: 'Partial<{ logErrors: boolean, staticDirectory: string }>' description: options bag for configuring Azure Functions return: description: azure function triggers for `module.exports` - type: 'Record<string, AzureFunction>' + type: Record<string, > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/Options.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/Options.yml index 0b063c47..7f864a32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/Options.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/Options.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-runtime-integration-express summary: Options for runtime Express adapter fullName: Options remarks: '' -isPreview: false isDeprecated: false syntax: | - type Options = z.infer + type Options = z.infer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/index.yml index e9858b02..0ed75350 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-express/index.yml @@ -7,20 +7,23 @@ typeAliases: - botbuilder-dialogs-adaptive-runtime-integration-express.Options functions: - name: >- - makeApp(ServiceCollection, Configuration, string, Partial, - Application) + makeApp(ServiceCollection, Configuration, string, Partial<{ + connectorClientOptions: ConnectorClientOptions, logErrors: boolean, + messagingEndpointPath: string, port: string | number, + skillsEndpointPrefix: string, staticDirectory: string }>, Application) uid: botbuilder-dialogs-adaptive-runtime-integration-express.makeApp package: botbuilder-dialogs-adaptive-runtime-integration-express summary: Create an Express App using the runtime Express integration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function makeApp(services: ServiceCollection, configuration: - Configuration, applicationRoot: string, options?: Partial, - app?: Application): Promise<[Application, (callback?: () => void) => - Server]> + Configuration, applicationRoot: string, options?: Partial<{ + connectorClientOptions: ConnectorClientOptions, logErrors: boolean, + messagingEndpointPath: string, port: string | number, + skillsEndpointPrefix: string, staticDirectory: string }>, app?: + Application): Promise<[Application, (callback?: () => void) => Server]> parameters: - id: services type: ServiceCollection @@ -33,29 +36,35 @@ functions: description: application root directory - id: options type: >- - Partial<> + Partial<{ connectorClientOptions: ConnectorClientOptions, + logErrors: boolean, messagingEndpointPath: string, port: string | + number, skillsEndpointPrefix: string, staticDirectory: string }> description: options bag for configuring Express Application - id: app type: Application - description: 'optional predefined express app, useful to register middleware' + description: optional predefined express app, useful to register middleware return: description: >- the Express Application and a function to start the App & handle "upgrade" requests for Streaming type: 'Promise<[Application, (callback?: () => void) => Server]>' - - name: 'start(string, string, Partial)' + - name: >- + start(string, string, Partial<{ connectorClientOptions: + ConnectorClientOptions, logErrors: boolean, messagingEndpointPath: string, + port: string | number, skillsEndpointPrefix: string, staticDirectory: + string }>) uid: botbuilder-dialogs-adaptive-runtime-integration-express.start package: botbuilder-dialogs-adaptive-runtime-integration-express summary: Start a bot using the runtime Express integration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function start(applicationRoot: string, settingsDirectory: string, - options?: Partial): Promise + options?: Partial<{ connectorClientOptions: ConnectorClientOptions, + logErrors: boolean, messagingEndpointPath: string, port: string | + number, skillsEndpointPrefix: string, staticDirectory: string }>): + Promise parameters: - id: applicationRoot type: string @@ -65,11 +74,10 @@ functions: description: settings directory - id: options type: >- - Partial<> - description: | - options bag + Partial<{ connectorClientOptions: ConnectorClientOptions, + logErrors: boolean, messagingEndpointPath: string, port: string | + number, skillsEndpointPrefix: string, staticDirectory: string }> + description: options bag return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/Options.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/Options.yml index af411907..9f66ce1a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/Options.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/Options.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-runtime-integration-restify summary: Options for runtime restify adapter fullName: Options remarks: '' -isPreview: false isDeprecated: false syntax: | - type Options = z.infer + type Options = z.infer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/index.yml index b3197e7d..d5d02255 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime-integration-restify/index.yml @@ -7,19 +7,21 @@ typeAliases: - botbuilder-dialogs-adaptive-runtime-integration-restify.Options functions: - name: >- - makeServer(ServiceCollection, Configuration, string, Partial, - restify.Server) + makeServer(ServiceCollection, Configuration, string, Partial<{ logErrors: + boolean, messagingEndpointPath: string, port: string | number, + skillsEndpointPrefix: string, staticDirectory: string }>, any) uid: botbuilder-dialogs-adaptive-runtime-integration-restify.makeServer package: botbuilder-dialogs-adaptive-runtime-integration-restify summary: Create a server using the runtime restify integration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function makeServer(services: ServiceCollection, configuration: - Configuration, applicationRoot: string, options?: Partial, - server?: restify.Server): Promise + Configuration, applicationRoot: string, options?: Partial<{ logErrors: + boolean, messagingEndpointPath: string, port: string | number, + skillsEndpointPrefix: string, staticDirectory: string }>, server?: any): + Promise parameters: - id: services type: ServiceCollection @@ -32,27 +34,31 @@ functions: description: application root directory - id: options type: >- - Partial<> + Partial<{ logErrors: boolean, messagingEndpointPath: string, + port: string | number, skillsEndpointPrefix: string, + staticDirectory: string }> description: options bag for configuring restify Server - id: server - type: - description: 'optional predefined restify server, useful to register middleware' + type: any + description: optional predefined restify server, useful to register middleware return: description: a restify Server ready to listen for connections type: Promise<> - - name: 'start(string, string, Partial)' + - name: >- + start(string, string, Partial<{ logErrors: boolean, messagingEndpointPath: + string, port: string | number, skillsEndpointPrefix: string, + staticDirectory: string }>) uid: botbuilder-dialogs-adaptive-runtime-integration-restify.start package: botbuilder-dialogs-adaptive-runtime-integration-restify summary: Start a bot using the runtime restify integration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function start(applicationRoot: string, settingsDirectory: string, - options?: Partial): Promise + options?: Partial<{ logErrors: boolean, messagingEndpointPath: string, + port: string | number, skillsEndpointPrefix: string, staticDirectory: + string }>): Promise parameters: - id: applicationRoot type: string @@ -62,11 +68,10 @@ functions: description: settings directory - id: options type: >- - Partial<> - description: | - options bag + Partial<{ logErrors: boolean, messagingEndpointPath: string, + port: string | number, skillsEndpointPrefix: string, + staticDirectory: string }> + description: options bag return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/Configuration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/Configuration.yml deleted file mode 100644 index 19c27cc8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/Configuration.yml +++ /dev/null @@ -1,186 +0,0 @@ -### YamlMime:TSType -name: Configuration -uid: botbuilder-dialogs-adaptive-runtime.Configuration -package: botbuilder-dialogs-adaptive-runtime -summary: >- - Configuration implements the - [IConfiguration](xref:botbuilder-dialogs-adaptive-runtime-core.IConfiguration) - - interface and adds helper methods for setting values, layering sources, and - getting type checked values. -fullName: Configuration -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'Configuration(Record)' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.constructor - package: botbuilder-dialogs-adaptive-runtime - summary: Create a configuration instance - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new Configuration(initialValues?: Record)' - parameters: - - id: initialValues - type: 'Record<string, unknown>' - description: | - Optional set of default values to provide -methods: - - name: 'argv(string[])' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.argv - package: botbuilder-dialogs-adaptive-runtime - summary: Load process.arguments as a configuration source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function argv(argv?: string[]): this' - parameters: - - id: argv - type: 'string[]' - description: 'arguments to parse, defaults to `process.argv`' - return: - description: this for chaining - type: this - - name: 'bind(string[])' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.bind - package: botbuilder-dialogs-adaptive-runtime - summary: |- - Bind a path to a Configuration instance such that calls to get or set will - automatically include the bound path as a prefix. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function bind(path: string[]): Configuration' - parameters: - - id: path - type: 'string[]' - description: path to bind to new Configuration instance - return: - description: configuration instance with `path` bound as a prefix - type: - - name: 'bool(string[])' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.bool - package: botbuilder-dialogs-adaptive-runtime - summary: Get a boolean value from config - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function bool(path: string[]): boolean' - parameters: - - id: path - type: 'string[]' - description: path to boolean value - return: - description: true or false depending on flag - type: boolean - - name: env(string) - uid: botbuilder-dialogs-adaptive-runtime.Configuration.env - package: botbuilder-dialogs-adaptive-runtime - summary: Load environment variables as a configuration source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function env(separator?: string): this' - parameters: - - id: separator - type: string - description: value used to indicate nesting - return: - description: this for chaining - type: this - - name: 'file(string, boolean)' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.file - package: botbuilder-dialogs-adaptive-runtime - summary: Load a file as a configuration source. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function file(name: string, override?: boolean): this' - parameters: - - id: name - type: string - description: file name - - id: override - type: boolean - description: >- - optional flag that ensures this file takes precedence over other - files - return: - description: this for chaining - type: this - - name: 'get(string[])' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.get - package: botbuilder-dialogs-adaptive-runtime - summary: Get a value by path. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function get(path?: string[]): T | undefined' - parameters: - - id: path - type: 'string[]' - description: path to value - return: - description: 'the value, or undefined' - type: T | undefined - - name: 'set(string[], unknown)' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.set - package: botbuilder-dialogs-adaptive-runtime - summary: Set a value by path. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function set(path: string[], value: unknown)' - parameters: - - id: path - type: 'string[]' - description: path to value - - id: value - type: unknown - description: | - value to set - - name: 'string(string[])' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.string - package: botbuilder-dialogs-adaptive-runtime - summary: Get a string value from config - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function string(path: string[]): string | undefined' - parameters: - - id: path - type: 'string[]' - description: path to string value - return: - description: the string or undefined - type: string | undefined - - name: 'type(string[], ZodType)' - uid: botbuilder-dialogs-adaptive-runtime.Configuration.type - package: botbuilder-dialogs-adaptive-runtime - summary: Get a typed value from config - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function type(path: string[], t: ZodType): T | undefined' - parameters: - - id: path - type: 'string[]' - description: path to value - - id: t - type: ZodType<T> - description: zod type to use for type checking - return: - description: 'the value, or undefined' - type: T | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/ConfigurationResourceExporer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/ConfigurationResourceExporer.yml deleted file mode 100644 index e40a6b4f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/ConfigurationResourceExporer.yml +++ /dev/null @@ -1,302 +0,0 @@ -### YamlMime:TSType -name: ConfigurationResourceExporer -uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer -package: botbuilder-dialogs-adaptive-runtime -summary: >- - Class which gives access to content resources by specifying configuration and - declarativeTypes. -fullName: ConfigurationResourceExporer -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ConfigurationResourceExporer(Configuration, ComponentDeclarativeTypes[])' - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.constructor - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ConfigurationResourceExporer(configuration: Configuration, - declarativeTypes: ComponentDeclarativeTypes[]) - parameters: - - id: configuration - type: - description: Additional configuration methods. - - id: declarativeTypes - type: 'ComponentDeclarativeTypes[]' - description: | - Registered declarative types. -inheritedProperties: - - name: changed - uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.changed - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: changed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'changed: (event: ResourceChangeEvent, resources: Resource[]) => void' - return: - description: '' - type: '(event: ResourceChangeEvent, resources: Resource[]) => void' - inheritanceDescription: Inherited From ResourceExplorer.changed - - name: resourceProviders - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.resourceProviders - package: botbuilder-dialogs-adaptive-runtime - summary: Gets resource providers. - fullName: resourceProviders - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'resourceProviders: ResourceProvider[]' - return: - description: '' - type: 'ResourceProvider[]' - inheritanceDescription: Inherited From ResourceExplorer.resourceProviders - - name: resourceTypes - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.resourceTypes - package: botbuilder-dialogs-adaptive-runtime - summary: Gets resource type id extensions managed by resource explorer. - fullName: resourceTypes - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'resourceTypes: Set' - return: - description: '' - type: Set<string> - inheritanceDescription: Inherited From ResourceExplorer.resourceTypes -inheritedMethods: - - name: 'addFolder(string, boolean, boolean)' - uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.addFolder - package: botbuilder-dialogs-adaptive-runtime - summary: Add a folder resource. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addFolder(folder: string, includeSubFolders?: boolean, - monitorChanges?: boolean): ResourceExplorer - parameters: - - id: folder - type: string - description: Folder to be included as a resource. - - id: includeSubFolders - type: boolean - description: Whether to include subfolders. - - id: monitorChanges - type: boolean - description: Whether to track changes. - return: - description: >- - Resource explorer so that you can fluently call multiple methods on - the resource explorer. - type: ResourceExplorer - inheritanceDescription: Inherited From ResourceExplorer.addFolder - - name: 'addFolders(string, string[], boolean)' - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.addFolders - package: botbuilder-dialogs-adaptive-runtime - summary: Add folder resources. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addFolders(folder: string, ignoreFolders?: string[], - monitorChanges?: boolean): ResourceExplorer - parameters: - - id: folder - type: string - description: Collection of folders to be included as resources. - - id: ignoreFolders - type: 'string[]' - description: Imediate subfolders to ignore. - - id: monitorChanges - type: boolean - description: Whether to track changes. - return: - description: >- - Resource explorer so that you can fluently call multiple methods on - the resource explorer. - type: ResourceExplorer - inheritanceDescription: Inherited From ResourceExplorer.addFolders - - name: addResourceProvider(ResourceProvider) - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.addResourceProvider - package: botbuilder-dialogs-adaptive-runtime - summary: Add a resource provider to the resources managed by resource explorer. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addResourceProvider(resourceProvider: ResourceProvider): - ResourceExplorer - parameters: - - id: resourceProvider - type: ResourceProvider - description: Resource provider to be added. - return: - description: >- - Resource explorer so that you can fluently call multiple methods on - the resource explorer. - type: ResourceExplorer - inheritanceDescription: Inherited From ResourceExplorer.addResourceProvider - - name: addResourceType(string) - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.addResourceType - package: botbuilder-dialogs-adaptive-runtime - summary: Add a resource type to resource type set. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addResourceType(type: string)' - parameters: - - id: type - type: string - description: | - Resource type. - inheritanceDescription: Inherited From ResourceExplorer.addResourceType - - name: 'buildType(string, C)' - uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.buildType - package: botbuilder-dialogs-adaptive-runtime - summary: Build type for given $kind from configuration. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function buildType(kind: string, config: C): T' - parameters: - - id: kind - type: string - description: $kind. - - id: config - type: C - description: Source configuration object. - return: - description: Instantiated object. - type: T - inheritanceDescription: Inherited From ResourceExplorer.buildType - - name: getResource(string) - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.getResource - package: botbuilder-dialogs-adaptive-runtime - summary: Gets resource by id. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getResource(id: string): Resource' - parameters: - - id: id - type: string - description: Resource id. - return: - description: 'The resource, or undefined if not found.' - type: Resource - inheritanceDescription: Inherited From ResourceExplorer.getResource - - name: getResources(string) - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.getResources - package: botbuilder-dialogs-adaptive-runtime - summary: Get resources of a given type extension. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getResources(fileExtension: string): Resource[]' - parameters: - - id: fileExtension - type: string - description: File extension filter. - return: - description: The resources. - type: 'Resource[]' - inheritanceDescription: Inherited From ResourceExplorer.getResources - - name: loadType(Resource) - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.loadType_1 - package: botbuilder-dialogs-adaptive-runtime - summary: Load type from resource - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function loadType(resource: Resource): T' - parameters: - - id: resource - type: Resource - description: Resource id to bind to. - return: - description: Type created from resource. - type: T - inheritanceDescription: Inherited From ResourceExplorer.loadType - - name: loadType(string) - uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.loadType - package: botbuilder-dialogs-adaptive-runtime - summary: Load type from resource - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function loadType(resourceId: string): T' - parameters: - - id: resourceId - type: string - description: Resource id to bind to. - return: - description: Type created from resource - type: T - inheritanceDescription: Inherited From ResourceExplorer.loadType - - name: refresh() - uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.refresh - package: botbuilder-dialogs-adaptive-runtime - summary: Reload any cached data. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function refresh() - inheritanceDescription: Inherited From ResourceExplorer.refresh - - name: >- - registerType(string, Newable, CustomDeserializer>) - uid: >- - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer.registerType - package: botbuilder-dialogs-adaptive-runtime - summary: Register a declarative type with the resource loader system. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function registerType(kind: string, type: Newable, loader?: - CustomDeserializer>): ResourceExplorer - parameters: - - id: kind - type: string - description: The $kind name to map to this type. - - id: type - type: Newable<T> - description: Type of object to create. - - id: loader - type: 'CustomDeserializer<T, Record<string, unknown>>' - description: Optional custom deserializer. - return: - description: Resource explorer for fluent style multiple calls. - type: ResourceExplorer - inheritanceDescription: Inherited From ResourceExplorer.registerType -extends: ResourceExplorer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBotAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBotAdapter.yml deleted file mode 100644 index 0a794077..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBotAdapter.yml +++ /dev/null @@ -1,420 +0,0 @@ -### YamlMime:TSType -name: CoreBotAdapter -uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter -package: botbuilder-dialogs-adaptive-runtime -summary: >- - An adapter that implements the Core Bot and can be hosted in different cloud - environments both public and private. -fullName: CoreBotAdapter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'CoreBotAdapter(BotFrameworkAuthentication, ConversationState, UserState)' - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.constructor - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new CoreBotAdapter(botFrameworkAuthentication: - BotFrameworkAuthentication, conversationState: ConversationState, - userState: UserState) - parameters: - - id: botFrameworkAuthentication - type: BotFrameworkAuthentication - description: >- - BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) - instance. - - id: conversationState - type: ConversationState - description: State management object for conversation state. - - id: userState - type: UserState - description: | - Stored user state. -inheritedProperties: - - name: BotIdentityKey - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.BotIdentityKey - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: BotIdentityKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'BotIdentityKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From BotAdapter.BotIdentityKey - - name: ConnectorClientKey - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.ConnectorClientKey - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: ConnectorClientKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ConnectorClientKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From BotAdapter.ConnectorClientKey - - name: ConnectorFactoryKey - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.ConnectorFactoryKey - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: ConnectorFactoryKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ConnectorFactoryKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapterBase.ConnectorFactoryKey - - name: OAuthScopeKey - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.OAuthScopeKey - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: OAuthScopeKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'OAuthScopeKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From BotAdapter.OAuthScopeKey - - name: onTurnError - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.onTurnError - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: onTurnError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onTurnError: (context: TurnContext, error: Error) => Promise' - return: - description: '' - type: '(context: TurnContext, error: Error) => Promise<void>' - inheritanceDescription: Inherited From BotAdapter.onTurnError - - name: UserTokenClientKey - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.UserTokenClientKey - package: botbuilder-dialogs-adaptive-runtime - summary: '' - fullName: UserTokenClientKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'UserTokenClientKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapterBase.UserTokenClientKey -inheritedMethods: - - name: >- - connectNamedPipe(string, (context: TurnContext) => Promise, string, - string, string, number) - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.connectNamedPipe - package: botbuilder-dialogs-adaptive-runtime - summary: Used to connect the adapter to a named pipe. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function connectNamedPipe(pipeName: string, logic: (context: - TurnContext) => Promise, appId: string, audience: string, - callerId?: string, retryCount?: number): Promise - parameters: - - id: pipeName - type: string - description: >- - Pipe name to connect to (note: yields two named pipe servers by - appending ".incoming" and ".outgoing" to this name) - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: The logic function to call for resulting bot turns. - - id: appId - type: string - description: The Bot application ID - - id: audience - type: string - description: >- - The audience to use for outbound communication. The will vary by - cloud environment. - - id: callerId - type: string - description: 'Optional, the caller ID' - - id: retryCount - type: number - description: > - Optional, the number of times to retry a failed connection (defaults - to 7) - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.connectNamedPipe - - name: >- - continueConversation(Partial, (context: - TurnContext) => Promise) - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.continueConversation - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '' - syntax: - content: >- - function continueConversation(_reference: - Partial, _logic: (context: TurnContext) => - Promise): Promise - parameters: - - id: _reference - type: Partial<ConversationReference> - description: '' - - id: _logic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.continueConversation - - name: >- - continueConversationAsync(string | ClaimsIdentity, - Partial, (context: TurnContext) => Promise | - string, (context: TurnContext) => Promise) - uid: >- - botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.continueConversationAsync - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function continueConversationAsync(botAppIdOrClaimsIdentity: string | - ClaimsIdentity, reference: Partial, - logicOrAudience: (context: TurnContext) => Promise | string, - maybeLogic?: (context: TurnContext) => Promise): Promise - parameters: - - id: botAppIdOrClaimsIdentity - type: string | ClaimsIdentity - description: '' - - id: reference - type: Partial<ConversationReference> - description: '' - - id: logicOrAudience - type: '(context: TurnContext) => Promise<void> | string' - description: '' - - id: maybeLogic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.continueConversationAsync - - name: >- - createConversationAsync(string, string, string, string, - ConversationParameters, (context: TurnContext) => Promise) - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.createConversationAsync - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createConversationAsync(botAppId: string, channelId: string, - serviceUrl: string, audience: string, conversationParameters: - ConversationParameters, logic: (context: TurnContext) => Promise): - Promise - parameters: - - id: botAppId - type: string - description: '' - - id: channelId - type: string - description: '' - - id: serviceUrl - type: string - description: '' - - id: audience - type: string - description: '' - - id: conversationParameters - type: ConversationParameters - description: '' - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.createConversationAsync - - name: 'deleteActivity(TurnContext, Partial)' - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.deleteActivity - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteActivity(context: TurnContext, reference: - Partial): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: reference - type: Partial<ConversationReference> - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.deleteActivity - - name: >- - process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => - Promise) - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.process_1 - package: botbuilder-dialogs-adaptive-runtime - summary: |- - Handle a web socket connection by applying a logic function to - each streaming request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function process(req: Request, socket: INodeSocket, head: INodeBuffer, - logic: (context: TurnContext) => Promise): Promise - parameters: - - id: req - type: Request - description: 'An incoming HTTP [Request](xref:botbuilder.Request)' - - id: socket - type: INodeSocket - description: >- - The corresponding - [INodeSocket](xref:botframework-streaming.INodeSocket) - - id: head - type: INodeBuffer - description: >- - The corresponding - [INodeBuffer](xref:botframework-streaming.INodeBuffer) - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: The logic function to apply - return: - description: a promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.process - - name: 'process(Request, Response, (context: TurnContext) => Promise)' - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.process - package: botbuilder-dialogs-adaptive-runtime - summary: Process a web request by applying a logic function. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function process(req: Request, res: Response, logic: (context: - TurnContext) => Promise): Promise - parameters: - - id: req - type: Request - description: 'The corresponding HTTP [Response](xref:botbuilder.Response)' - - id: res - type: Response - description: '' - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: The logic function to apply - return: - description: a promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.process - - name: 'sendActivities(TurnContext, Partial[])' - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.sendActivities - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendActivities(context: TurnContext, activities: - Partial[]): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: activities - type: 'Partial<Activity>[]' - description: '' - return: - description: '' - type: 'Promise<ResourceResponse[]>' - inheritanceDescription: Inherited From CloudAdapterBase.sendActivities - - name: 'updateActivity(TurnContext, Partial)' - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.updateActivity - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateActivity(context: TurnContext, activity: - Partial): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: activity - type: Partial<Activity> - description: '' - return: - description: '' - type: Promise<ResourceResponse | void> - inheritanceDescription: Inherited From CloudAdapterBase.updateActivity - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter.use - package: botbuilder-dialogs-adaptive-runtime - summary: Adds middleware to the adapter's pipeline. - remarks: >- - Middleware is added to the adapter at initialization time. - - Each turn, the adapter calls its middleware in the order in which you - added it. - isPreview: false - isDeprecated: false - syntax: - content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this - parameters: - - id: middlewares - type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | Middleware[] - description: The middleware or middleware handlers to add. - return: - description: The updated adapter object. - type: this - inheritanceDescription: Inherited From BotAdapter.use -extends: CloudAdapter diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/index.yml index 7f1bd045..8fd9c9f1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/index.yml @@ -3,13 +3,8 @@ uid: botbuilder-dialogs-adaptive-runtime name: botbuilder-dialogs-adaptive-runtime summary: '' type: package -classes: - - botbuilder-dialogs-adaptive-runtime.Configuration - - botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer - - botbuilder-dialogs-adaptive-runtime.CoreBot - - botbuilder-dialogs-adaptive-runtime.CoreBotAdapter functions: - - name: 'getRuntimeServices(string, string)' + - name: getRuntimeServices(string, string, Record) uid: botbuilder-dialogs-adaptive-runtime.getRuntimeServices package: botbuilder-dialogs-adaptive-runtime summary: Construct all runtime services. @@ -85,12 +80,12 @@ functions: [ShowTypingMiddleware](xref:botbuilder-core.ShowTypingMiddleware), and [SetSpeakMiddleware](xref:botbuilder.SetSpeakMiddleware) respectively. - isPreview: false isDeprecated: false syntax: content: >- function getRuntimeServices(applicationRoot: string, settingsDirectory: - string): Promise<[ServiceCollection, Configuration]> + string, defaultServices?: Record): + Promise<[ServiceCollection, Configuration]> parameters: - id: applicationRoot type: string @@ -98,27 +93,33 @@ functions: - id: settingsDirectory type: string description: directory where settings files are located + - id: defaultServices + type: Record<string, any> + description: services to use as default return: description: service collection and configuration - type: 'Promise<[ServiceCollection, Configuration]>' - - name: 'getRuntimeServices(string, Configuration)' + type: Promise<[ServiceCollection, Configuration]> + - name: getRuntimeServices(string, Configuration, Record) uid: botbuilder-dialogs-adaptive-runtime.getRuntimeServices_1 package: botbuilder-dialogs-adaptive-runtime summary: Construct all runtime services. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getRuntimeServices(applicationRoot: string, configuration: - Configuration): Promise<[ServiceCollection, Configuration]> + Configuration, defaultServices?: Record): + Promise<[ServiceCollection, Configuration]> parameters: - id: applicationRoot type: string description: absolute path to root of application - id: configuration - type: + type: Configuration description: a fully initialized configuration instance to use + - id: defaultServices + type: Record<string, any> + description: services to use as default return: description: service collection and configuration - type: 'Promise<[ServiceCollection, Configuration]>' + type: Promise<[ServiceCollection, Configuration]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipant.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipant.yml new file mode 100644 index 00000000..8ff68480 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipant.yml @@ -0,0 +1,463 @@ +### YamlMime:TSType +name: GetMeetingParticipant +uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant +package: botbuilder-dialogs-adaptive-teams +summary: >- + Calls `TeamsInfo.getMeetingParticipant` and sets the result to a memory + property. +fullName: GetMeetingParticipant +remarks: '' +isDeprecated: false +type: class +constructors: + - name: GetMeetingParticipant(string) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new GetMeetingParticipant(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.GetMeetingParticipant" = + "Teams.GetMeetingParticipant" + return: + description: '' + type: '""' + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >+ + Gets or sets an optional expression which if is true will disable this + action. + + + **Example** + + + ```ts + + "user.age > 18". + + ``` + + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: meetingId + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.meetingId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for meeting id. + fullName: meetingId + remarks: '' + isDeprecated: false + syntax: + content: 'meetingId: StringExpression' + return: + description: '' + type: StringExpression + - name: participantId + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.participantId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for participant id. + fullName: participantId + remarks: '' + isDeprecated: false + syntax: + content: 'participantId: StringExpression' + return: + description: '' + type: StringExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient + - name: tenantId + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.tenantId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for tenant id. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId: StringExpression' + return: + description: '' + type: StringExpression +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + GetMeetingParticipant + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetMeetingParticipantConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + GetMeetingParticipantConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof GetMeetingParticipantConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipantConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipantConfiguration.yml new file mode 100644 index 00000000..141298c3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMeetingParticipantConfiguration.yml @@ -0,0 +1,104 @@ +### YamlMime:TSType +name: GetMeetingParticipantConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetMeetingParticipantConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: meetingId + uid: >- + botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.meetingId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: meetingId + remarks: '' + isDeprecated: false + syntax: + content: 'meetingId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: participantId + uid: >- + botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.participantId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: participantId + remarks: '' + isDeprecated: false + syntax: + content: 'participantId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: property + uid: >- + botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: tenantId + uid: >- + botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.tenantId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMember.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMember.yml new file mode 100644 index 00000000..28e3115c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMember.yml @@ -0,0 +1,432 @@ +### YamlMime:TSType +name: GetMember +uid: botbuilder-dialogs-adaptive-teams.GetMember +package: botbuilder-dialogs-adaptive-teams +summary: Calls `TeamsInfo.getMember` and sets the result to a memory property. +fullName: GetMember +remarks: '' +isDeprecated: false +type: class +constructors: + - name: GetMember(string) + uid: botbuilder-dialogs-adaptive-teams.GetMember.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new GetMember(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetMember.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.GetMember" = "Teams.GetMember"' + return: + description: '' + type: '""' + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetMember.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >+ + Gets or sets an optional expression which if is true will disable this + action. + + + **Example** + + + ```ts + + "user.age > 18". + + ``` + + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetMember.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: memberId + uid: botbuilder-dialogs-adaptive-teams.GetMember.memberId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for member id. + fullName: memberId + remarks: '' + isDeprecated: false + syntax: + content: 'memberId: StringExpression' + return: + description: '' + type: StringExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetMember.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetMember.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetMember.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetMember.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): GetMember' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.GetMember.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetMember.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.GetMember.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetMember.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetMember.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetMember.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetMember.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetMemberConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetMember.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof GetMemberConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof GetMemberConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMemberConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMemberConfiguration.yml new file mode 100644 index 00000000..3d1cb0e8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetMemberConfiguration.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: GetMemberConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetMemberConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: memberId + uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration.memberId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: memberId + remarks: '' + isDeprecated: false + syntax: + content: 'memberId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembers.yml new file mode 100644 index 00000000..654f99ac --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembers.yml @@ -0,0 +1,439 @@ +### YamlMime:TSType +name: GetPagedMembers +uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers +package: botbuilder-dialogs-adaptive-teams +summary: >- + Calls TeamsInfo.getPagedMembers to retrieve a paginated list of members of + + one-on-one, group, or team conversation and sets the result to a memory + property. +fullName: GetPagedMembers +remarks: '' +isDeprecated: false +type: class +constructors: + - name: GetPagedMembers(string) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new GetPagedMembers(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.GetPagedMembers" = "Teams.GetPagedMembers"' + return: + description: '' + type: '""' + - name: continuationToken + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.continuationToken + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the expression to get the value to use for the + continuationToken. + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken?: StringExpression' + return: + description: '' + type: StringExpression + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: pageSize + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.pageSize + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for the page size. + fullName: pageSize + remarks: '' + isDeprecated: false + syntax: + content: 'pageSize?: IntExpression' + return: + description: '' + type: IntExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): GetPagedMembers' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetPagedMembersConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof GetPagedMembersConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof GetPagedMembersConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembersConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembersConfiguration.yml new file mode 100644 index 00000000..aee81b8c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedMembersConfiguration.yml @@ -0,0 +1,88 @@ +### YamlMime:TSType +name: GetPagedMembersConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetPagedMembersConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration.continuationToken + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: pageSize + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration.pageSize + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: pageSize + remarks: '' + isDeprecated: false + syntax: + content: 'pageSize?: number | Expression | IntExpression' + return: + description: '' + type: number | Expression | IntExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembers.yml similarity index 54% rename from botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBase.yml rename to botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembers.yml index 4994b0be..111accec 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembers.yml @@ -1,180 +1,172 @@ ### YamlMime:TSType -name: CancelAllDialogsBase -uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase -package: botbuilder-dialogs-adaptive +name: GetPagedTeamMembers +uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers +package: botbuilder-dialogs-adaptive-teams summary: >- - Base class for - [CancelAllDialogs](xref:botbuilder-dialogs-adaptive.CancelAllDialogs) api. -fullName: CancelAllDialogsBase + Calls TeamsInfo.getPagedTeamMembers to retrieve a paginated list of members of + a team. + + Also sets the result to a memory property. +fullName: GetPagedTeamMembers remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: CancelAllDialogsBase() - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.constructor - package: botbuilder-dialogs-adaptive + - name: GetPagedTeamMembers(string) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.constructor + package: botbuilder-dialogs-adaptive-teams summary: >- - Initializes a new instance of the - [CancelAllDialogsBase](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase) + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: new CancelAllDialogsBase() - - name: 'CancelAllDialogsBase(string, string, boolean)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.constructor_1 - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [CancelAllDialogsBase](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new CancelAllDialogsBase(eventName: string, eventValue?: string, - isCancelAll?: boolean) + content: 'new GetPagedTeamMembers(dialogId?: string)' parameters: - - id: eventName + - id: dialogId type: string - description: Expression for event name. - - id: eventValue - type: string - description: Optional. Expression for event value. - - id: isCancelAll - type: boolean - description: | - Set to `true` to cancel all dialogs; `false` otherwise. + description: Optional. unique ID of the dialog. properties: - - name: activityProcessed - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.activityProcessed - package: botbuilder-dialogs-adaptive + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.GetPagedTeamMembers" = "Teams.GetPagedTeamMembers"' + return: + description: '' + type: '""' + - name: continuationToken + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.continuationToken + package: botbuilder-dialogs-adaptive-teams summary: >- - A value indicating whether to have the new dialog should process the - activity. - fullName: activityProcessed + Gets or sets the expression to get the value to use for the + continuationToken. + fullName: continuationToken remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'activityProcessed: BoolExpression' + content: 'continuationToken?: StringExpression' return: description: '' - type: BoolExpression + type: StringExpression - name: disabled - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.disabled - package: botbuilder-dialogs-adaptive - summary: An optional expression which if is true will disable this action. + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'disabled: BoolExpression' + content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression - - name: eventName - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.eventName - package: botbuilder-dialogs-adaptive - summary: Expression for event name. - fullName: eventName + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'eventName: StringExpression' + content: string id return: description: '' - type: StringExpression - - name: eventValue - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.eventValue - package: botbuilder-dialogs-adaptive - summary: Expression for event value. - fullName: eventValue + type: string + - name: pageSize + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.pageSize + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for the page size. + fullName: pageSize remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'eventValue: ValueExpression' + content: 'pageSize?: IntExpression' return: description: '' - type: ValueExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false + type: IntExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'property?: StringExpression' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id + type: StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.teamId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for team id. + fullName: teamId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'teamId: StringExpression' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: StringExpression - name: telemetryClient - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.configure - package: botbuilder-dialogs-adaptive + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.configure + package: botbuilder-dialogs-adaptive-teams summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): GetPagedTeamMembers' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.continueDialog - package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -198,22 +190,22 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: - description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + description: '' + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.endDialog - package: botbuilder-dialogs-adaptive + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.endDialog + package: botbuilder-dialogs-adaptive-teams summary: >- When overridden in a derived class, performs clean up for the dialog before it ends. @@ -240,30 +232,28 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise parameters: - - id: _context + - id: context type: TurnContext description: The context object for the turn. - - id: _instance - type: DialogInstance + - id: instance + type: DialogInstance<any> description: Current state information for this dialog. - - id: _reason + - id: reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.endDialog - name: getVersion() - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.getVersion - package: botbuilder-dialogs-adaptive + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.getVersion + package: botbuilder-dialogs-adaptive-teams summary: >- An encoded string used to aid in the detection of bot changes on re-deployment. @@ -283,24 +273,20 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' return: - description: >- - Unique string which should only change when dialog has changed in a - way that should restart the dialog. + description: '' type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.onDialogEvent - package: botbuilder-dialogs-adaptive + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.onDialogEvent + package: botbuilder-dialogs-adaptive-teams summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -319,10 +305,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.repromptDialog - package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -343,27 +329,25 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - - id: _context + - id: context type: TurnContext description: The context object for the turn. - - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.resumeDialog - package: botbuilder-dialogs-adaptive + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.resumeDialog + package: botbuilder-dialogs-adaptive-teams summary: >- When overridden in a derived class, resumes the dialog after the dialog above it on the stack completes. @@ -401,12 +385,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -418,26 +401,22 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: - description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + description: '' + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.beginDialog - package: botbuilder-dialogs-adaptive - summary: >- - Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and - pushed onto the dialog stack. + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function beginDialog(dc: DialogContext, _options: O): - Promise + function beginDialog(dc: DialogContext, _options?: Record): Promise> parameters: - id: dc type: DialogContext @@ -445,25 +424,28 @@ methods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: _options - type: O - description: Optional. Initial information to pass to the dialog. + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. return: - description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase.getConverter - package: botbuilder-dialogs-adaptive + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetPagedTeamMembersConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers.getConverter + package: botbuilder-dialogs-adaptive-teams summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof GetPagedTeamMembersConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object - description: The key of the conditional selector configuration. + type: keyof GetPagedTeamMembersConfiguration + description: '' return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory -extends: Dialog<O> + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembersConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembersConfiguration.yml new file mode 100644 index 00000000..35230387 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetPagedTeamMembersConfiguration.yml @@ -0,0 +1,103 @@ +### YamlMime:TSType +name: GetPagedTeamMembersConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetPagedTeamMembersConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.continuationToken + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: pageSize + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.pageSize + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: pageSize + remarks: '' + isDeprecated: false + syntax: + content: 'pageSize?: number | Expression | IntExpression' + return: + description: '' + type: number | Expression | IntExpression + - name: property + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.teamId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannels.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannels.yml new file mode 100644 index 00000000..567f41f3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannels.yml @@ -0,0 +1,424 @@ +### YamlMime:TSType +name: GetTeamChannels +uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels +package: botbuilder-dialogs-adaptive-teams +summary: |- + Calls TeamsInfo.getTeamChannels to retrieve a list of channels in a + Team and sets the result to a memory property. This only works in + teams scoped conversations. +fullName: GetTeamChannels +remarks: '' +isDeprecated: false +type: class +constructors: + - name: GetTeamChannels(string) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new GetTeamChannels(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.GetTeamChannels" = "Teams.GetTeamChannels"' + return: + description: '' + type: '""' + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.teamId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for team id. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): GetTeamChannels' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetTeamChannelsConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof GetTeamChannelsConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof GetTeamChannelsConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannelsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannelsConfiguration.yml new file mode 100644 index 00000000..89322ff0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamChannelsConfiguration.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: GetTeamChannelsConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetTeamChannelsConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration.teamId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetails.yml new file mode 100644 index 00000000..6cc2fa08 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetails.yml @@ -0,0 +1,421 @@ +### YamlMime:TSType +name: GetTeamDetails +uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails +package: botbuilder-dialogs-adaptive-teams +summary: Calls TeamsInfo.GetTeamDetails and sets the result to a memory property. +fullName: GetTeamDetails +remarks: '' +isDeprecated: false +type: class +constructors: + - name: GetTeamDetails(string) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new GetTeamDetails(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.GetTeamDetails" = "Teams.GetTeamDetails"' + return: + description: '' + type: '""' + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.teamId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for team id. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): GetTeamDetails' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetTeamDetailsConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof GetTeamDetailsConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof GetTeamDetailsConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetailsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetailsConfiguration.yml new file mode 100644 index 00000000..4454e267 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamDetailsConfiguration.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: GetTeamDetailsConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetTeamDetailsConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration.teamId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMember.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMember.yml new file mode 100644 index 00000000..cda54339 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMember.yml @@ -0,0 +1,446 @@ +### YamlMime:TSType +name: GetTeamMember +uid: botbuilder-dialogs-adaptive-teams.GetTeamMember +package: botbuilder-dialogs-adaptive-teams +summary: |- + Calls TeamsInfo.GetTeamMember to retrieve the list of members in a teams + scoped conversation and sets the result to a memory property. +fullName: GetTeamMember +remarks: '' +isDeprecated: false +type: class +constructors: + - name: GetTeamMember(string) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new GetTeamMember(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.GetTeamMember" = "Teams.GetTeamMember"' + return: + description: '' + type: '""' + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >+ + Gets or sets an optional expression which if is true will disable this + action. + + + **Example** + + + ```ts + + "user.age > 18". + + ``` + + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: memberId + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.memberId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for member id. + fullName: memberId + remarks: '' + isDeprecated: false + syntax: + content: 'memberId: StringExpression' + return: + description: '' + type: StringExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.property + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the value in. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.teamId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for team id. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): GetTeamMember' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetTeamMemberConfiguration) + uid: botbuilder-dialogs-adaptive-teams.GetTeamMember.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof GetTeamMemberConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof GetTeamMemberConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMemberConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMemberConfiguration.yml new file mode 100644 index 00000000..7bd1758b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/GetTeamMemberConfiguration.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: GetTeamMemberConfiguration +uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: GetTeamMemberConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: memberId + uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration.memberId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: memberId + remarks: '' + isDeprecated: false + syntax: + content: 'memberId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: property + uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: teamId + uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration.teamId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsAppBasedLinkQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsAppBasedLinkQuery.yml new file mode 100644 index 00000000..d7616645 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsAppBasedLinkQuery.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsAppBasedLinkQuery +uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with activity.name + == 'composeExtension/queryLink'. +fullName: OnTeamsAppBasedLinkQuery +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsAppBasedLinkQuery(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsAppBasedLinkQuery(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnAppBasedLinkQuery" = "Teams.OnAppBasedLinkQuery"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsAppBasedLinkQuery + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsCardAction.yml new file mode 100644 index 00000000..65eb7738 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsCardAction.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsCardAction +uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with no + activity.name. +fullName: OnTeamsCardAction +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsCardAction(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsCardAction(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnCardAction" = "Teams.OnCardAction"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsCardAction' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelCreated.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelCreated.yml new file mode 100644 index 00000000..fad6ae66 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelCreated.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsChannelCreated +uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdateActivity with + channelData.eventType == 'channelCreated'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsChannelCreated +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsChannelCreated(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsChannelCreated(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnChannelCreated" = "Teams.OnChannelCreated"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsChannelCreated + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelDeleted.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelDeleted.yml new file mode 100644 index 00000000..9805171c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelDeleted.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsChannelDeleted +uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdateActivity with + channelData.eventType == 'channelDeleted'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsChannelDeleted +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsChannelDeleted(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsChannelDeleted(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnChannelDeleted" = "Teams.OnChannelDeleted"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsChannelDeleted + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRenamed.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRenamed.yml new file mode 100644 index 00000000..b821c7b2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRenamed.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsChannelRenamed +uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdateActivity with + channelData.eventType == 'channelRenamed'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsChannelRenamed +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsChannelRenamed(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsChannelRenamed(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnChannelRenamed" = "Teams.OnChannelRenamed"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsChannelRenamed + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRestored.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRestored.yml new file mode 100644 index 00000000..fcc5d2a5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsChannelRestored.yml @@ -0,0 +1,271 @@ +### YamlMime:TSType +name: OnTeamsChannelRestored +uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdateActivity with + channelData.eventType == 'channelRestored'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsChannelRestored +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsChannelRestored(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsChannelRestored(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnChannelRestored" = "Teams.OnChannelRestored"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsChannelRestored + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsFileConsent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsFileConsent.yml new file mode 100644 index 00000000..2e8680bb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsFileConsent.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsFileConsent +uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with activity.name + == 'fileConsent/invoke'. +fullName: OnTeamsFileConsent +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsFileConsent(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsFileConsent(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnFileConsent" = "Teams.OnFileConsent"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsFileConsent' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewEdit.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewEdit.yml new file mode 100644 index 00000000..b60f9ae1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewEdit.yml @@ -0,0 +1,281 @@ +### YamlMime:TSType +name: OnTeamsMEBotMessagePreviewEdit +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/submitAction' + + and activity.value.botMessagePreviewAction == 'edit'. +fullName: OnTeamsMEBotMessagePreviewEdit +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMEBotMessagePreviewEdit(Dialog<{}>[], string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new OnTeamsMEBotMessagePreviewEdit(actions?: Dialog<{}>[], condition?: + string) + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.OnMEBotMessagePreviewEdit" = + "Teams.OnMEBotMessagePreviewEdit" + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsMEBotMessagePreviewEdit + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewSend.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewSend.yml new file mode 100644 index 00000000..b9604e84 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEBotMessagePreviewSend.yml @@ -0,0 +1,281 @@ +### YamlMime:TSType +name: OnTeamsMEBotMessagePreviewSend +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/submitAction' + + and activity.value.botMessagePreviewAction == 'send'. +fullName: OnTeamsMEBotMessagePreviewSend +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMEBotMessagePreviewSend(Dialog<{}>[], string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new OnTeamsMEBotMessagePreviewSend(actions?: Dialog<{}>[], condition?: + string) + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.OnMEBotMessagePreviewEdit" = + "Teams.OnMEBotMessagePreviewEdit" + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsMEBotMessagePreviewSend + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMECardButtonClicked.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMECardButtonClicked.yml new file mode 100644 index 00000000..f6d2a89e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMECardButtonClicked.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: OnTeamsMECardButtonClicked +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/onCardButtonClicked'. +fullName: OnTeamsMECardButtonClicked +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMECardButtonClicked(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new OnTeamsMECardButtonClicked(actions?: Dialog<{}>[], condition?: + string) + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.OnMECardButtonClicked" = + "Teams.OnMECardButtonClicked" + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsMECardButtonClicked + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigQuerySettingUrl.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigQuerySettingUrl.yml new file mode 100644 index 00000000..69b2e39d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigQuerySettingUrl.yml @@ -0,0 +1,279 @@ +### YamlMime:TSType +name: OnTeamsMEConfigQuerySettingUrl +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/querySettingUrl'. +fullName: OnTeamsMEConfigQuerySettingUrl +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMEConfigQuerySettingUrl(Dialog<{}>[], string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new OnTeamsMEConfigQuerySettingUrl(actions?: Dialog<{}>[], condition?: + string) + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.OnMEConfigQuerySettingUrl" = + "Teams.OnMEConfigQuerySettingUrl" + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsMEConfigQuerySettingUrl + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigurationSetting.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigurationSetting.yml new file mode 100644 index 00000000..61f27115 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEConfigurationSetting.yml @@ -0,0 +1,279 @@ +### YamlMime:TSType +name: OnTeamsMEConfigurationSetting +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/setting'. +fullName: OnTeamsMEConfigurationSetting +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMEConfigurationSetting(Dialog<{}>[], string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new OnTeamsMEConfigurationSetting(actions?: Dialog<{}>[], condition?: + string) + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.OnMEConfigurationSetting" = + "Teams.OnMEConfigurationSetting" + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsMEConfigurationSetting + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEFetchTask.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEFetchTask.yml new file mode 100644 index 00000000..0e564649 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEFetchTask.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsMEFetchTask +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received when + activity.name='composeExtension/fetchTask'. +fullName: OnTeamsMEFetchTask +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMEFetchTask(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsMEFetchTask(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnMEFetchTask" = "Teams.OnMEFetchTask"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsMEFetchTask' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEQuery.yml new file mode 100644 index 00000000..da12d295 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMEQuery.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsMEQuery +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/query'. +fullName: OnTeamsMEQuery +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMEQuery(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsMEQuery(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnMEQuery" = "Teams.OnMEQuery"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsMEQuery' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESelectItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESelectItem.yml new file mode 100644 index 00000000..76d26e4d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESelectItem.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsMESelectItem +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/selectItem'. +fullName: OnTeamsMESelectItem +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMESelectItem(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsMESelectItem(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnMESelectItem" = "Teams.OnMESelectItem"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsMESelectItem' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESubmitAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESubmitAction.yml new file mode 100644 index 00000000..2d0f0728 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsMESubmitAction.yml @@ -0,0 +1,267 @@ +### YamlMime:TSType +name: OnTeamsMESubmitAction +uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='composeExtension/submitAction'. +fullName: OnTeamsMESubmitAction +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsMESubmitAction(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsMESubmitAction(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnMESubmitAction" = "Teams.OnMESubmitAction"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsMESubmitAction + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsO365ConnectorCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsO365ConnectorCardAction.yml new file mode 100644 index 00000000..900b1d71 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsO365ConnectorCardAction.yml @@ -0,0 +1,279 @@ +### YamlMime:TSType +name: OnTeamsO365ConnectorCardAction +uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received for + 'actionableMessage/executeAction'. +fullName: OnTeamsO365ConnectorCardAction +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsO365ConnectorCardAction(Dialog<{}>[], string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new OnTeamsO365ConnectorCardAction(actions?: Dialog<{}>[], condition?: + string) + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.OnO365ConnectorCardAction" = + "Teams.OnO365ConnectorCardAction" + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsO365ConnectorCardAction + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabFetch.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabFetch.yml new file mode 100644 index 00000000..f480c283 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabFetch.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsTabFetch +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='tab/fetch'. +fullName: OnTeamsTabFetch +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTabFetch(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTabFetch(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTabFetch" = "Teams.OnTabFetch"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsTabFetch' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabSubmit.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabSubmit.yml new file mode 100644 index 00000000..b315676b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTabSubmit.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: OnTeamsTabSubmit +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='tab/submit'. +fullName: OnTeamsTabSubmit +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTabSubmit(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTabSubmit(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTabSubmit" = "Teams.OnTabSubmit"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsTabSubmit' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleFetch.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleFetch.yml new file mode 100644 index 00000000..6360fd0a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleFetch.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsTaskModuleFetch +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='task/fetch'. +fullName: OnTeamsTaskModuleFetch +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTaskModuleFetch(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTaskModuleFetch(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTaskModuleFetch" = "Teams.OnTaskModuleFetch"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsTaskModuleFetch + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleSubmit.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleSubmit.yml new file mode 100644 index 00000000..e2324fa6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTaskModuleSubmit.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsTaskModuleSubmit +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams InvokeActivity is received with + activity.name='task/submit'. +fullName: OnTeamsTaskModuleSubmit +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTaskModuleSubmit(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTaskModuleSubmit(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTaskModuleSubmit" = "Teams.OnTaskModuleSubmit"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnInvokeActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnInvokeActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnInvokeActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnInvokeActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnInvokeActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsTaskModuleSubmit + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnInvokeActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnInvokeActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnInvokeActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnInvokeActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnInvokeActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnInvokeActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamArchived.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamArchived.yml new file mode 100644 index 00000000..ee7cae5e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamArchived.yml @@ -0,0 +1,266 @@ +### YamlMime:TSType +name: OnTeamsTeamArchived +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdate with channelData.eventType + == 'teamArchived'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsTeamArchived +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTeamArchived(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTeamArchived(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTeamArchived" = "Teams.OnTeamArchived"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsTeamArchived' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamDeleted.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamDeleted.yml new file mode 100644 index 00000000..e8b1ba27 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamDeleted.yml @@ -0,0 +1,266 @@ +### YamlMime:TSType +name: OnTeamsTeamDeleted +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdate with channelData.eventType + == 'teamDeleted'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsTeamDeleted +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTeamDeleted(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTeamDeleted(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTeamDeleted" = "Teams.OnTeamDeleted"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsTeamDeleted' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamHardDeleted.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamHardDeleted.yml new file mode 100644 index 00000000..01f4d8ef --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamHardDeleted.yml @@ -0,0 +1,271 @@ +### YamlMime:TSType +name: OnTeamsTeamHardDeleted +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdate with channelData.eventType + == 'teamHardDeleted'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsTeamHardDeleted +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTeamHardDeleted(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTeamHardDeleted(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTeamHardDeleted" = "Teams.OnTeamHardDeleted"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsTeamHardDeleted + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRenamed.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRenamed.yml new file mode 100644 index 00000000..60e8b643 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRenamed.yml @@ -0,0 +1,266 @@ +### YamlMime:TSType +name: OnTeamsTeamRenamed +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdate with channelData.eventType + == 'teamRenamed'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsTeamRenamed +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTeamRenamed(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTeamRenamed(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTeamRenamed" = "Teams.OnTeamRenamed"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsTeamRenamed' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRestored.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRestored.yml new file mode 100644 index 00000000..c683bcbd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamRestored.yml @@ -0,0 +1,266 @@ +### YamlMime:TSType +name: OnTeamsTeamRestored +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdate with channelData.eventType + == 'teamRestored'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsTeamRestored +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTeamRestored(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTeamRestored(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTeamRestored" = "Teams.OnTeamRestored"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): OnTeamsTeamRestored' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamUnarchived.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamUnarchived.yml new file mode 100644 index 00000000..d8a69a76 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/OnTeamsTeamUnarchived.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: OnTeamsTeamUnarchived +uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived +package: botbuilder-dialogs-adaptive-teams +summary: >- + Actions triggered when a Teams ConversationUpdate with channelData.eventType + == 'teamUnarchived'. + + Note: turn.activity.channelData.Teams has team data. +fullName: OnTeamsTeamUnarchived +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnTeamsTeamUnarchived(Dialog<{}>[], string) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Initializes a new instance of the + [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new OnTeamsTeamUnarchived(actions?: Dialog<{}>[], condition?: string)' + parameters: + - id: actions + type: Dialog<{}>[] + description: >- + Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing + the actions to add to the plan when the rule constraints are met. + - id: condition + type: string + description: >- + Optional. Condition which needs to be met for the actions to be + executed. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.$kind + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.OnTeamUnarchived" = "Teams.OnTeamUnarchived"' + return: + description: '' + type: '""' +inheritedProperties: + - name: actions + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.actions + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the actions to add to the plan when the rule constraints are + met. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.actions + - name: condition + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.condition + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the condition which needs to be met for the actions to be + executed (OPTIONAL). + fullName: condition + remarks: '' + isDeprecated: false + syntax: + content: 'condition: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.condition + - name: event + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.event + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the event to fire on. + fullName: event + remarks: '' + isDeprecated: false + syntax: + content: 'event: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.event + - name: id + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.id + package: botbuilder-dialogs-adaptive-teams + summary: Id for condition. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.id + - name: priority + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.priority + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get or sets the rule priority expression where 0 is the highest and less + than 0 is ignored. + fullName: priority + remarks: '' + isDeprecated: false + syntax: + content: 'priority: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From OnConversationUpdateActivity.priority + - name: runOnce + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.runOnce + package: botbuilder-dialogs-adaptive-teams + summary: >- + A value indicating whether rule should only run once per unique set of + memory paths. + fullName: runOnce + remarks: '' + isDeprecated: false + syntax: + content: 'runOnce: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From OnConversationUpdateActivity.runOnce + - name: type + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.type + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the ActivityType which must be matched for this to trigger. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From OnConversationUpdateActivity.type +inheritedMethods: + - name: addExternalCondition(string) + uid: >- + botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.addExternalCondition + package: botbuilder-dialogs-adaptive-teams + summary: Add external condition to the OnCondition + remarks: '' + isDeprecated: false + syntax: + content: 'function addExternalCondition(condition: string)' + parameters: + - id: condition + type: string + description: >- + External constraint to add, it will be AND'ed to all other + constraints. + inheritanceDescription: Inherited From OnConversationUpdateActivity.addExternalCondition + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + OnTeamsTeamUnarchived + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From OnConversationUpdateActivity.configure + - name: currentPriority(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.currentPriority + package: botbuilder-dialogs-adaptive-teams + summary: Compute the current value of the priority expression and return it. + remarks: '' + isDeprecated: false + syntax: + content: 'function currentPriority(actionContext: ActionContext): number' + parameters: + - id: actionContext + type: ActionContext + description: Context to use for evaluation. + return: + description: Computed priority. + type: number + inheritanceDescription: Inherited From OnConversationUpdateActivity.currentPriority + - name: execute(ActionContext) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.execute + package: botbuilder-dialogs-adaptive-teams + summary: Method called to execute the condition's actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + function execute(actionContext: ActionContext): + Promise + parameters: + - id: actionContext + type: ActionContext + description: Context. + return: + description: A promise with plan change list. + type: Promise<ActionChangeList[]> + inheritanceDescription: Inherited From OnConversationUpdateActivity.execute + - name: getConverter(keyof OnConditionConfiguration) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory + parameters: + - id: property + type: keyof OnConditionConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From OnConversationUpdateActivity.getConverter + - name: getDependencies() + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.getDependencies + package: botbuilder-dialogs-adaptive-teams + summary: >- + Get child dialog dependencies so they can be added to the containers + dialogset. + remarks: '' + isDeprecated: false + syntax: + content: 'function getDependencies(): Dialog<{}>[]' + return: + description: '' + type: Dialog<{}>[] + inheritanceDescription: Inherited From OnConversationUpdateActivity.getDependencies +methods: + - name: getExpression(ExpressionParserInterface) + uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived.getExpression + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getExpression(parser: ExpressionParserInterface): Expression' + parameters: + - id: parser + type: ExpressionParserInterface + description: '' + return: + description: '' + type: Expression +extends: OnConversationUpdateActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponse.yml new file mode 100644 index 00000000..7a9c76b0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponse.yml @@ -0,0 +1,467 @@ +### YamlMime:TSType +name: SendAppBasedLinkQueryResponse +uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse +package: botbuilder-dialogs-adaptive-teams +summary: >- + Send a messaging extension 'result' response when a Teams Invoke Activity is + received with activity.name='composeExtension/queryLink'. +fullName: SendAppBasedLinkQueryResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendAppBasedLinkQueryResponse(string) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendAppBasedLinkQueryResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendAppBasedLinkQueryResponse" = + "Teams.SendAppBasedLinkQueryResponse" + return: + description: '' + type: '""' + - name: card + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.card + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets template for the attachment template of a Thumbnail or Hero + Card to send. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheType + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendAppBasedLinkQueryResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.configure + - name: continueDialog(DialogContext) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendAppBasedLinkQueryResponseConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendAppBasedLinkQueryResponseConfiguration): Converter + | ConverterFactory + parameters: + - id: property + type: keyof SendAppBasedLinkQueryResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseTeamsCacheInfoResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponseConfiguration.yml new file mode 100644 index 00000000..f0f6885b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendAppBasedLinkQueryResponseConfiguration.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: SendAppBasedLinkQueryResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendAppBasedLinkQueryResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration.card + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: property + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponse.yml new file mode 100644 index 00000000..ad9c2447 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponse.yml @@ -0,0 +1,517 @@ +### YamlMime:TSType +name: SendMEActionResponse +uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse +package: botbuilder-dialogs-adaptive-teams +summary: >- + Send a messaging extension 'result' response when a Teams Invoke Activity is + received with activity.name='composeExtension/queryLink'. +fullName: SendMEActionResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMEActionResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMEActionResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMEActionResponse" = + "Teams.SendMEActionResponse" + return: + description: '' + type: '""' + - name: card + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.card + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets template for the attachment template of a Thumbnail or Hero + Card to send. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheType + - name: completionBotId + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.completionBotId + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression for the Completion Bot Id of the Task + Module Task Info response. + + This is a bot App ID to send the result of the user's interaction with the + task module to. + + If specified, the bot will receive a task/submit invoke event with a JSON + object in the event payload. + fullName: completionBotId + remarks: '' + isDeprecated: false + syntax: + content: 'completionBotId?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.completionBotId + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.EndOfTurn + - name: height + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.height + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the height of the response. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.height + - name: title + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.title + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the text or expression to use to generate the title of the + response. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.title + - name: width + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.width + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the width of the response. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.width +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMEActionResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMEActionResponseConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMEActionResponseConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendMEActionResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseSendTaskModuleContinueResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponseConfiguration.yml new file mode 100644 index 00000000..473e2192 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEActionResponseConfiguration.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: SendMEActionResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMEActionResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration.card + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: property + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponse.yml new file mode 100644 index 00000000..ef209976 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponse.yml @@ -0,0 +1,471 @@ +### YamlMime:TSType +name: SendMEAttachmentsResponse +uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse +package: botbuilder-dialogs-adaptive-teams +summary: >- + Send a messaging extension 'result' response when a Teams Invoke Activity is + received with activity.name='composeExtension/queryLink'. +fullName: SendMEAttachmentsResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMEAttachmentsResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMEAttachmentsResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMEAttachmentsResponse" = + "Teams.SendMEAttachmentsResponse" + return: + description: '' + type: '""' + - name: attachmentLayout + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.attachmentLayout + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the Attachment Layout type for the response ('grid' or + 'list'). + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout: EnumExpression' + return: + description: '' + type: EnumExpression<AttachmentLayout> + - name: attachments + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.attachments + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the Activity containing the Attachments to send. + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheType + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMEAttachmentsResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMEAttachmentsResponseConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMEAttachmentsResponseConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendMEAttachmentsResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseTeamsCacheInfoResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponseConfiguration.yml new file mode 100644 index 00000000..ad2c9bd8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAttachmentsResponseConfiguration.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: SendMEAttachmentsResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMEAttachmentsResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: attachmentLayout + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration.attachmentLayout + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: >- + attachmentLayout?: string | Expression | + EnumExpression + return: + description: '' + type: string | Expression | EnumExpression<AttachmentLayout> + - name: attachments + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration.attachments + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: property + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAuthResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAuthResponse.yml new file mode 100644 index 00000000..5c7a6e6c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEAuthResponse.yml @@ -0,0 +1,476 @@ +### YamlMime:TSType +name: SendMEAuthResponse +uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse +package: botbuilder-dialogs-adaptive-teams +summary: >- + Send a messaging extension 'result' response when a Teams Invoke Activity is + received with activity.name='composeExtension/queryLink'. +fullName: SendMEAuthResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMEAuthResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMEAuthResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: 'static $kind: "Teams.SendMEAuthResponse" = "Teams.SendMEAuthResponse"' + return: + description: '' + type: '""' + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseAuthResponseDialog.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseAuthResponseDialog.cacheType + - name: connectionName + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.connectionName + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the name of the OAuth connection. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseAuthResponseDialog.connectionName + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseAuthResponseDialog.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseAuthResponseDialog.EndOfTurn + - name: property + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.property + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets property path to put the TokenResponse value in once + retrieved. + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseAuthResponseDialog.property + - name: title + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.title + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the response title. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseAuthResponseDialog.title +inheritedMethods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: The DialogContext for the turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: Promise representing the DialogTurnResult. + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseAuthResponseDialog.beginDialog + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: 'function configure(config: Record): SendMEAuthResponse' + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From BaseAuthResponseDialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseAuthResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseAuthResponseDialog.endDialog + - name: getConverter(string) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: string): Converter | + ConverterFactory + parameters: + - id: property + type: string + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From BaseAuthResponseDialog.getConverter + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseAuthResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseAuthResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseAuthResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseAuthResponseDialog.resumeDialog +extends: BaseAuthResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponse.yml new file mode 100644 index 00000000..fd771131 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponse.yml @@ -0,0 +1,533 @@ +### YamlMime:TSType +name: SendMEBotMessagePreviewResponse +uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse +package: botbuilder-dialogs-adaptive-teams +summary: Send a messaging extension 'botMessagePreview' response. +fullName: SendMEBotMessagePreviewResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMEBotMessagePreviewResponse(string) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMEBotMessagePreviewResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMEBotMessagePreviewResponse" = + "Teams.SendMEBotMessagePreviewResponse" + return: + description: '' + type: '""' + - name: card + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.card + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets template for the attachment template of a Thumbnail or Hero + Card to send. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheDuration + - name: cacheType + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheType + - name: completionBotId + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.completionBotId + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression for the Completion Bot Id of the Task + Module Task Info response. + + This is a bot App ID to send the result of the user's interaction with the + task module to. + + If specified, the bot will receive a task/submit invoke event with a JSON + object in the event payload. + fullName: completionBotId + remarks: '' + isDeprecated: false + syntax: + content: 'completionBotId?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.completionBotId + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.disabled + - name: EndOfTurn + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.EndOfTurn + - name: height + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.height + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the height of the response. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.height + - name: title + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.title + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the text or expression to use to generate the title of the + response. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.title + - name: width + uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.width + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the width of the response. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.width +inheritedMethods: + - name: configure(Record) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMEBotMessagePreviewResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.configure + - name: continueDialog(DialogContext) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.endDialog + - name: getVersion() + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMEBotMessagePreviewResponseConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMEBotMessagePreviewResponseConfiguration): Converter | ConverterFactory + parameters: + - id: property + type: keyof SendMEBotMessagePreviewResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseSendTaskModuleContinueResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponseConfiguration.yml new file mode 100644 index 00000000..2e262b90 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEBotMessagePreviewResponseConfiguration.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: SendMEBotMessagePreviewResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMEBotMessagePreviewResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration.card + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponse.yml new file mode 100644 index 00000000..9de917e9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponse.yml @@ -0,0 +1,479 @@ +### YamlMime:TSType +name: SendMEConfigQuerySettingUrlResponse +uid: botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse +package: botbuilder-dialogs-adaptive-teams +summary: >- + Send a messaging extension 'config' response. This is the type of response + used for a 'composeExtension/querySettingUrl' request. +fullName: SendMEConfigQuerySettingUrlResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMEConfigQuerySettingUrlResponse(string) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMEConfigQuerySettingUrlResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMEConfigQuerySettingUrlResponse" = + "Teams.SendMEConfigQuerySettingUrlResponse" + return: + description: '' + type: '""' + - name: configUrl + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.configUrl + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config url response to send. + + **Example** + + `${config.siteUrl}/searchSettings.html?settings=${escapedSettings}`. + + fullName: configUrl + remarks: '' + isDeprecated: false + syntax: + content: 'configUrl?: StringExpression' + return: + description: '' + type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheDuration + - name: cacheType + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheType + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.disabled + - name: EndOfTurn + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMEConfigQuerySettingUrlResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.configure + - name: continueDialog(DialogContext) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.endDialog + - name: getVersion() + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMEConfigQuerySettingUrlResponseConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMEConfigQuerySettingUrlResponseConfiguration): Converter | ConverterFactory + parameters: + - id: property + type: keyof SendMEConfigQuerySettingUrlResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseTeamsCacheInfoResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponseConfiguration.yml new file mode 100644 index 00000000..373e7eda --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEConfigQuerySettingUrlResponseConfiguration.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: SendMEConfigQuerySettingUrlResponseConfiguration +uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMEConfigQuerySettingUrlResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: configUrl + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration.configUrl + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: configUrl + remarks: '' + isDeprecated: false + syntax: + content: 'configUrl?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponse.yml new file mode 100644 index 00000000..655bf847 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponse.yml @@ -0,0 +1,453 @@ +### YamlMime:TSType +name: SendMEMessageResponse +uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse +package: botbuilder-dialogs-adaptive-teams +summary: Send a messaging extension 'message' response. +fullName: SendMEMessageResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMEMessageResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMEMessageResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMEMessageResponse" = + "Teams.SendMEMessageResponse" + return: + description: '' + type: '""' + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: message + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.message + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the template or text to use to generate the response message + to send. + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheType + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMEMessageResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMEMessageResponseConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMEMessageResponseConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendMEMessageResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseTeamsCacheInfoResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponseConfiguration.yml new file mode 100644 index 00000000..b7663f73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMEMessageResponseConfiguration.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: SendMEMessageResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMEMessageResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: message + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration.message + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponse.yml new file mode 100644 index 00000000..f661af5d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponse.yml @@ -0,0 +1,455 @@ +### YamlMime:TSType +name: SendMESelectItemResponse +uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse +package: botbuilder-dialogs-adaptive-teams +summary: Send a messaging extension response when an item is selected. +fullName: SendMESelectItemResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMESelectItemResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMESelectItemResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMESelectItemResponse" = + "Teams.SendMESelectItemResponse" + return: + description: '' + type: '""' + - name: card + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.card + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets template for the attachment template of a Thumbnail or Hero + Card to send. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheType + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMESelectItemResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMESelectItemResponseConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMESelectItemResponseConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendMESelectItemResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseTeamsCacheInfoResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponseConfiguration.yml new file mode 100644 index 00000000..f59b6285 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMESelectItemResponseConfiguration.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: SendMESelectItemResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMESelectItemResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: >- + botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration.card + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression +inheritedProperties: + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannel.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannel.yml new file mode 100644 index 00000000..ad3acaaa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannel.yml @@ -0,0 +1,461 @@ +### YamlMime:TSType +name: SendMessageToTeamsChannel +uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel +package: botbuilder-dialogs-adaptive-teams +summary: Calls TeamsInfo.GetTeamDetails and sets the result to a memory property. +fullName: SendMessageToTeamsChannel +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendMessageToTeamsChannel(string) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendMessageToTeamsChannel(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendMessageToTeamsChannel" = + "Teams.SendMessageToTeamsChannel" + return: + description: '' + type: '""' + - name: activity + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.activity + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets template for the activity expression containing the activity + to send. + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: activityIdProperty + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.activityIdProperty + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets property path to put the id of the activity sent. + fullName: activityIdProperty + remarks: '' + isDeprecated: false + syntax: + content: 'activityIdProperty?: StringExpression' + return: + description: '' + type: StringExpression + - name: conversationReferenceProperty + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.conversationReferenceProperty + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets property path to put the newly created activity's + Conversation Reference. + + This can be used to later send messages to this same conversation. + fullName: conversationReferenceProperty + remarks: '' + isDeprecated: false + syntax: + content: 'conversationReferenceProperty?: StringExpression' + return: + description: '' + type: StringExpression + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: teamsChannelId + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.teamsChannelId + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets the expression to get the value to use for team id. + fullName: teamsChannelId + remarks: '' + isDeprecated: false + syntax: + content: 'teamsChannelId: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendMessageToTeamsChannel + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From Dialog.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Dialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From Dialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From Dialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From Dialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendMessageToTeamsChannelConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendMessageToTeamsChannelConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendMessageToTeamsChannelConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannelConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannelConfiguration.yml new file mode 100644 index 00000000..f52b226a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendMessageToTeamsChannelConfiguration.yml @@ -0,0 +1,118 @@ +### YamlMime:TSType +name: SendMessageToTeamsChannelConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendMessageToTeamsChannelConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.activity + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: activityIdProperty + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.activityIdProperty + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: activityIdProperty + remarks: '' + isDeprecated: false + syntax: + content: 'activityIdProperty?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: conversationReferenceProperty + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.conversationReferenceProperty + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: conversationReferenceProperty + remarks: '' + isDeprecated: false + syntax: + content: 'conversationReferenceProperty?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: property + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.property + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: property + remarks: '' + isDeprecated: false + syntax: + content: 'property?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: teamsChannelId + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.teamsChannelId + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: teamsChannelId + remarks: '' + isDeprecated: false + syntax: + content: 'teamsChannelId?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponse.yml new file mode 100644 index 00000000..d6516099 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponse.yml @@ -0,0 +1,521 @@ +### YamlMime:TSType +name: SendTaskModuleCardResponse +uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse +package: botbuilder-dialogs-adaptive-teams +summary: Send a messaging extension 'message' response. +fullName: SendTaskModuleCardResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendTaskModuleCardResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendTaskModuleCardResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendTaskModuleCardResponse" = + "Teams.SendTaskModuleCardResponse" + return: + description: '' + type: '""' + - name: card + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.card + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets template for the attachment template of a Thumbnail or Hero + Card to send. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheType + - name: completionBotId + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.completionBotId + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression for the Completion Bot Id of the Task + Module Task Info response. + + This is a bot App ID to send the result of the user's interaction with the + task module to. + + If specified, the bot will receive a task/submit invoke event with a JSON + object in the event payload. + fullName: completionBotId + remarks: '' + isDeprecated: false + syntax: + content: 'completionBotId?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.completionBotId + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.EndOfTurn + - name: height + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.height + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the height of the response. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.height + - name: title + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.title + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the text or expression to use to generate the title of the + response. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.title + - name: width + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.width + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the width of the response. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.width +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendTaskModuleCardResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.configure + - name: continueDialog(DialogContext) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendTaskModuleCardResponseConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendTaskModuleCardResponseConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendTaskModuleCardResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseSendTaskModuleContinueResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponseConfiguration.yml new file mode 100644 index 00000000..e7e4b5a3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleCardResponseConfiguration.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: SendTaskModuleCardResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendTaskModuleCardResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration.card + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: TemplateInterface' + return: + description: '' + type: TemplateInterface<Activity, DialogStateManager> + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponse.yml new file mode 100644 index 00000000..24d28732 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponse.yml @@ -0,0 +1,465 @@ +### YamlMime:TSType +name: SendTaskModuleMessageResponse +uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse +package: botbuilder-dialogs-adaptive-teams +summary: Send a simple message task module response. +fullName: SendTaskModuleMessageResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendTaskModuleMessageResponse(string) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendTaskModuleMessageResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendTaskModuleMessageResponse" = + "Teams.SendTaskModuleMessageResponse" + return: + description: '' + type: '""' + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: message + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.message + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the template or text to use to generate the response message + to send. + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: StringExpression' + return: + description: '' + type: StringExpression + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient +inheritedProperties: + - name: cacheDuration + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.cacheType + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.EndOfTurn +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendTaskModuleMessageResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.configure + - name: continueDialog(DialogContext) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseTeamsCacheInfoResponseDialog.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendTaskModuleMessageResponseConfiguration) + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendTaskModuleMessageResponseConfiguration): Converter + | ConverterFactory + parameters: + - id: property + type: keyof SendTaskModuleMessageResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseTeamsCacheInfoResponseDialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponseConfiguration.yml new file mode 100644 index 00000000..d9e14dea --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleMessageResponseConfiguration.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: SendTaskModuleMessageResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendTaskModuleMessageResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: message + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration.message + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponse.yml new file mode 100644 index 00000000..57b52f0f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponse.yml @@ -0,0 +1,533 @@ +### YamlMime:TSType +name: SendTaskModuleUrlResponse +uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse +package: botbuilder-dialogs-adaptive-teams +summary: Send a simple message task module response. +fullName: SendTaskModuleUrlResponse +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SendTaskModuleUrlResponse(string) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.constructor + package: botbuilder-dialogs-adaptive-teams + summary: >- + Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) + class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SendTaskModuleUrlResponse(dialogId?: string)' + parameters: + - id: dialogId + type: string + description: Optional. unique ID of the dialog. +properties: + - name: $kind + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.$kind + package: botbuilder-dialogs-adaptive-teams + summary: Class identifier. + fullName: $kind + remarks: '' + isDeprecated: false + syntax: + content: >- + static $kind: "Teams.SendTaskModuleUrlResponse" = + "Teams.SendTaskModuleUrlResponse" + return: + description: '' + type: '""' + - name: fallbackUrl + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.fallbackUrl + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression for the Fallback Url the Task Module + Task Info response. + fullName: fallbackUrl + remarks: '' + isDeprecated: false + syntax: + content: 'fallbackUrl?: StringExpression' + return: + description: '' + type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.id + package: botbuilder-dialogs-adaptive-teams + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: '' + type: string + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: '' + type: BotTelemetryClient + - name: url + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.url + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression for the Url of the Task Module + response. + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url?: StringExpression' + return: + description: '' + type: StringExpression +inheritedProperties: + - name: cacheDuration + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.cacheDuration + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets cache duration in seconds for which the cached object should + remain in the cache. + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheDuration + - name: cacheType + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.cacheType + package: botbuilder-dialogs-adaptive-teams + summary: |+ + Gets or sets config CacheType. + + **Example** + + ```ts + "cache" or "no_cache". + ``` + + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.cacheType + - name: completionBotId + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.completionBotId + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression for the Completion Bot Id of the Task + Module Task Info response. + + This is a bot App ID to send the result of the user's interaction with the + task module to. + + If specified, the bot will receive a task/submit invoke event with a JSON + object in the event payload. + fullName: completionBotId + remarks: '' + isDeprecated: false + syntax: + content: 'completionBotId?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.completionBotId + - name: disabled + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.disabled + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets an optional expression which if is true will disable this + action. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: BoolExpression' + return: + description: '' + type: BoolExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.disabled + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.EndOfTurn + package: botbuilder-dialogs-adaptive-teams + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.EndOfTurn + - name: height + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.height + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the height of the response. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.height + - name: title + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.title + package: botbuilder-dialogs-adaptive-teams + summary: >- + Gets or sets the text or expression to use to generate the title of the + response. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: StringExpression' + return: + description: '' + type: StringExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.title + - name: width + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.width + package: botbuilder-dialogs-adaptive-teams + summary: Gets or sets an optional expression for the width of the response. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width?: IntExpression' + return: + description: '' + type: IntExpression + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.width +inheritedMethods: + - name: configure(Record) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.configure + package: botbuilder-dialogs-adaptive-teams + summary: Fluent method for configuring the object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function configure(config: Record): + SendTaskModuleUrlResponse + parameters: + - id: config + type: Record<string, unknown> + description: Configuration settings to apply. + return: + description: '' + type: >- + + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.configure + - name: continueDialog(DialogContext) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.continueDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, continues the dialog. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it continues + + the dialog. + + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) + isDeprecated: false + syntax: + content: >- + function continueDialog(dc: DialogContext): + Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.endDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, performs clean up for the dialog + before it ends. + remarks: >- + Derived dialogs that need to perform logging or cleanup before ending + should override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog is ending. + + + **See also** + + - + [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + + - + [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) + isDeprecated: false + syntax: + content: >- + function endDialog(context: TurnContext, instance: DialogInstance, + reason: DialogReason): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + - id: reason + type: DialogReason + description: The reason the dialog is ending. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.endDialog + - name: getVersion() + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.getVersion + package: botbuilder-dialogs-adaptive-teams + summary: >- + An encoded string used to aid in the detection of bot changes on + re-deployment. + remarks: >- + This defaults to returning the dialogs [id](#id) but can be overridden to + provide more + + precise change detection logic. Any dialog on the stack that has its + version change will + + result in a `versionChanged` event will be raised. If this event is not + handled by the bot, + + an error will be thrown resulting in the bots error handler logic being + run. + + + Returning an empty string will disable version tracking for the component + all together. + isDeprecated: false + syntax: + content: 'function getVersion(): string' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.onDialogEvent + package: botbuilder-dialogs-adaptive-teams + summary: >- + Called when an event has been raised, using `DialogContext.emitEvent()`, + by either the current dialog or a dialog that the current dialog started. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onDialogEvent(dc: DialogContext, e: DialogEvent): + Promise + parameters: + - id: dc + type: DialogContext + description: The dialog context for the current turn of conversation. + - id: e + type: DialogEvent + description: The event being raised. + return: + description: >- + True if the event is handled by the current dialog and bubbling should + stop. + type: Promise<boolean> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.repromptDialog + package: botbuilder-dialogs-adaptive-teams + summary: When overridden in a derived class, reprompts the user for input. + remarks: >- + Derived dialogs that support validation and re-prompt logic should + override this method. + + By default, this method has no effect. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when the current + + dialog should re-request input from the user. This method is implemented + for prompt dialogs. + + + **See also** + + - + [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) + + - [Prompt](xref:botbuilder-dialogs.Prompt) + isDeprecated: false + syntax: + content: >- + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise + parameters: + - id: context + type: TurnContext + description: The context object for the turn. + - id: instance + type: DialogInstance<any> + description: Current state information for this dialog. + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.resumeDialog + package: botbuilder-dialogs-adaptive-teams + summary: >- + When overridden in a derived class, resumes the dialog after the dialog + above it on the stack completes. + remarks: >- + Derived dialogs that support multiple-turn conversations should override + this method. + + By default, this method signals that the dialog is complete and returns. + + + The [DialogContext](xref:botbuilder-dialogs.DialogContext) calls this + method when it resumes + + the dialog. If the previous dialog on the stack returned a value, that + value is in the `result` + + parameter. + + + To start a _child_ dialog, use + [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) + + or [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt); + however, this dialog will not + + necessarily be the one that started the child dialog. + + To signal to the dialog context that this dialog has completed, await + + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + before exiting this method. + + + **See also** + + - + [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) + isDeprecated: false + syntax: + content: >- + function resumeDialog(dc: DialogContext, reason: DialogReason, result?: + any): Promise> + parameters: + - id: dc + type: DialogContext + description: The context for the current dialog turn. + - id: reason + type: DialogReason + description: |- + The reason the dialog is resuming. This will typically be + [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) + - id: result + type: any + description: Optional. The return value, if any, from the dialog that ended. + return: + description: '' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From BaseSendTaskModuleContinueResponse.resumeDialog +methods: + - name: beginDialog(DialogContext, Record) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.beginDialog + package: botbuilder-dialogs-adaptive-teams + summary: Called when the dialog is started and pushed onto the dialog stack. + remarks: '' + isDeprecated: false + syntax: + content: >- + function beginDialog(dc: DialogContext, _options?: Record): Promise> + parameters: + - id: dc + type: DialogContext + description: >- + The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. + - id: _options + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. + return: + description: A promise representing the asynchronous operation. + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendTaskModuleUrlResponseConfiguration) + uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse.getConverter + package: botbuilder-dialogs-adaptive-teams + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConverter(property: keyof + SendTaskModuleUrlResponseConfiguration): Converter | + ConverterFactory + parameters: + - id: property + type: keyof SendTaskModuleUrlResponseConfiguration + description: '' + return: + description: '' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> +extends: BaseSendTaskModuleContinueResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponseConfiguration.yml new file mode 100644 index 00000000..698da538 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/SendTaskModuleUrlResponseConfiguration.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: SendTaskModuleUrlResponseConfiguration +uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: SendTaskModuleUrlResponseConfiguration +remarks: '' +isDeprecated: false +type: interface +properties: + - name: disabled + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration.disabled + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: string | boolean | BoolExpression' + return: + description: '' + type: string | boolean | BoolExpression + - name: fallbackUrl + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration.fallbackUrl + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: fallbackUrl + remarks: '' + isDeprecated: false + syntax: + content: 'fallbackUrl?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression + - name: url + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration.url + package: botbuilder-dialogs-adaptive-teams + summary: '' + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url?: string | Expression | StringExpression' + return: + description: '' + type: string | Expression | StringExpression +inheritedProperties: + - name: id + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration.id + package: botbuilder-dialogs-adaptive-teams + summary: Static id of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From DialogConfiguration.id + - name: telemetryClient + uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration.telemetryClient + package: botbuilder-dialogs-adaptive-teams + summary: Telemetry client the dialog should use. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: 'telemetryClient?: BotTelemetryClient' + return: + description: '' + type: BotTelemetryClient + inheritanceDescription: Inherited From DialogConfiguration.telemetryClient +extends: DialogConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/TeamsComponentRegistration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/TeamsComponentRegistration.yml new file mode 100644 index 00000000..b43b9d51 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/TeamsComponentRegistration.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: TeamsComponentRegistration +uid: botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration +package: botbuilder-dialogs-adaptive-teams +summary: '' +fullName: TeamsComponentRegistration +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TeamsComponentRegistration() + uid: botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration.constructor + package: botbuilder-dialogs-adaptive-teams + summary: Initializes a new instance of `TeamsComponentRegistration`. + remarks: '' + isDeprecated: false + syntax: + content: new TeamsComponentRegistration() +properties: + - name: components + uid: botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration.components + package: botbuilder-dialogs-adaptive-teams + summary: Gets list of all ComponentRegistration objects registered. + fullName: components + remarks: '' + isDeprecated: false + syntax: + content: static ComponentRegistration[] components + return: + description: A list of ComponentRegistration objects. + type: ComponentRegistration[] +inheritedMethods: + - name: add(ComponentRegistration) + uid: botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration.add + package: botbuilder-dialogs-adaptive-teams + summary: Add a component, only one instance per type is allowed for components. + remarks: '' + isDeprecated: false + syntax: + content: 'static function add(componentRegistration: ComponentRegistration)' + parameters: + - id: componentRegistration + type: ComponentRegistration + description: The component to be registered. + inheritanceDescription: Inherited From ComponentRegistration.add +methods: + - name: getDeclarativeTypes(ResourceExplorer) + uid: >- + botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration.getDeclarativeTypes + package: botbuilder-dialogs-adaptive-teams + summary: Gets adaptive testing `DeclarativeType` resources. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getDeclarativeTypes(_resourceExplorer: ResourceExplorer): + DeclarativeType>[] + parameters: + - id: _resourceExplorer + type: ResourceExplorer + description: '`ResourceExplorer` with expected path to get all resources.' + return: + description: Adaptive testing `DeclarativeType` resources. + type: DeclarativeType<unknown, Record<string, unknown>>[] +extends: ComponentRegistration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/index.yml new file mode 100644 index 00000000..3ab879f8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-teams/index.yml @@ -0,0 +1,74 @@ +### YamlMime:TSPackage +uid: botbuilder-dialogs-adaptive-teams +name: botbuilder-dialogs-adaptive-teams +summary: '' +type: package +classes: + - botbuilder-dialogs-adaptive-teams.GetMeetingParticipant + - botbuilder-dialogs-adaptive-teams.GetMember + - botbuilder-dialogs-adaptive-teams.GetPagedMembers + - botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers + - botbuilder-dialogs-adaptive-teams.GetTeamChannels + - botbuilder-dialogs-adaptive-teams.GetTeamDetails + - botbuilder-dialogs-adaptive-teams.GetTeamMember + - botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery + - botbuilder-dialogs-adaptive-teams.OnTeamsCardAction + - botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated + - botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted + - botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed + - botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored + - botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent + - botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit + - botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend + - botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked + - botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl + - botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting + - botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask + - botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery + - botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem + - botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction + - botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction + - botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch + - botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit + - botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch + - botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit + - botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived + - botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted + - botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted + - botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed + - botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored + - botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived + - botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse + - botbuilder-dialogs-adaptive-teams.SendMEActionResponse + - botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse + - botbuilder-dialogs-adaptive-teams.SendMEAuthResponse + - botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse + - botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse + - botbuilder-dialogs-adaptive-teams.SendMEMessageResponse + - botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse + - botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel + - botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse + - botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse + - botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse + - botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration +interfaces: + - botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration + - botbuilder-dialogs-adaptive-teams.GetMemberConfiguration + - botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration + - botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration + - botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration + - botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration + - botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration + - botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration + - >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration + - >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration + - botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration + - botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AdaptiveTestBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AdaptiveTestBotComponent.yml index ee392d47..e2582463 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AdaptiveTestBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AdaptiveTestBotComponent.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Adaptive Testing of BotComponent. fullName: AdaptiveTestBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,22 +14,20 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: >- botbuilder-dialogs-adaptive-testing.AdaptiveTestBotComponent.configureServices package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -42,6 +39,5 @@ methods: description: Services collection to mimic dependency injection. - id: _configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertCondition.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertCondition.yml index f253a643..a955f71e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertCondition.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertCondition.yml @@ -5,26 +5,23 @@ package: botbuilder-dialogs-adaptive-testing summary: Dialog action which allows you to add assertions into your dialog flow. fullName: AssertCondition remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: AssertCondition(string) + - name: AssertCondition(string) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.constructor package: botbuilder-dialogs-adaptive-testing summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AssertCondition(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive-testing.AssertCondition.$kind @@ -32,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -45,7 +41,6 @@ properties: summary: Condition which must be true. fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: Expression' @@ -58,85 +53,82 @@ properties: summary: Description of assertion. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: StringExpression' return: description: '' type: StringExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive-testing.AssertCondition.EndOfTurn - package: botbuilder-dialogs-adaptive-testing - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive-testing.AssertCondition.id package: botbuilder-dialogs-adaptive-testing - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive-testing.AssertCondition.telemetryClient package: botbuilder-dialogs-adaptive-testing - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive-testing.AssertCondition.EndOfTurn + package: botbuilder-dialogs-adaptive-testing + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AssertCondition' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.continueDialog package: botbuilder-dialogs-adaptive-testing - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -160,20 +152,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.endDialog package: botbuilder-dialogs-adaptive-testing summary: >- @@ -202,23 +194,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -245,7 +235,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -255,14 +244,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.onDialogEvent package: botbuilder-dialogs-adaptive-testing summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -281,10 +269,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.repromptDialog package: botbuilder-dialogs-adaptive-testing - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -305,25 +293,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.resumeDialog package: botbuilder-dialogs-adaptive-testing summary: >- @@ -363,12 +349,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -380,24 +365,22 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.beginDialog package: botbuilder-dialogs-adaptive-testing summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -407,21 +390,24 @@ methods: description: Additional information to pass to the prompt being started. return: description: A Promise representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof AssertConditionConfiguration) uid: botbuilder-dialogs-adaptive-testing.AssertCondition.getConverter package: botbuilder-dialogs-adaptive-testing summary: Description of assertion. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof AssertConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof AssertConditionConfiguration description: Properties that extend RecognizerConfiguration. return: description: Expression converter. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertConditionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertConditionConfiguration.yml index e157e150..cf33412a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertConditionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertConditionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: AssertConditionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: string | Expression' @@ -29,7 +27,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string | Expression | StringExpression' @@ -43,7 +40,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -58,7 +54,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivity.yml index 504b93d9..9f95b685 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivity.yml @@ -7,7 +7,6 @@ summary: >- activity. fullName: AssertNoActivity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -30,7 +28,6 @@ properties: summary: Description of this assertion. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -38,49 +35,54 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.AssertNoActivity.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AssertNoActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.AssertNoActivity.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.AssertNoActivity.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -95,8 +97,7 @@ methods: description: Logic for the bot to use. - id: _inspector type: - description: | - Inspector for dialog context. + description: Inspector for dialog context. return: description: '' type: Promise<void> @@ -106,7 +107,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Gets the text to assert for an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConditionDescription(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivityConfiguration.yml index 1807f483..5f5a2c0d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertNoActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: AssertNoActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReply.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReply.yml index a5eb4d92..6231c6d3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReply.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReply.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Test Script action to assert that the bots' reply matches expectations. fullName: AssertReply remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: A value indicating whether text should be an exact match. fullName: exact remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exact: boolean' @@ -41,7 +38,6 @@ properties: summary: The text value to look for in the reply. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -55,13 +51,12 @@ inheritedProperties: summary: The expressions for assertions. fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [AssertReplyActivity.assertions](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.assertions) @@ -71,7 +66,6 @@ inheritedProperties: summary: Description of what this assertion is. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -87,7 +81,6 @@ inheritedProperties: summary: The milliseconds to wait for a reply. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout: number' @@ -98,31 +91,31 @@ inheritedProperties: Inherited From [AssertReplyActivity.timeout](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.timeout) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.AssertReply.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AssertReply' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AssertReplyActivity.configure](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.configure) - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.AssertReply.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -149,25 +142,29 @@ inheritedMethods: package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [AssertReplyActivity.getConverter](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.getConverter) methods: - name: getConditionDescription() uid: botbuilder-dialogs-adaptive-testing.AssertReply.getConditionDescription package: botbuilder-dialogs-adaptive-testing summary: Gets the text to assert for an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConditionDescription(): string' @@ -179,13 +176,11 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Validates the reply of an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateReply(activity: Activity)' parameters: - id: activity type: Activity - description: | - The activity to verify. + description: The activity to verify. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivity.yml index fe9a8e54..fec59d72 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivity.yml @@ -7,7 +7,6 @@ summary: >- activity. fullName: AssertReplyActivity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -30,20 +28,18 @@ properties: summary: The expressions for assertions. fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions: string[]' return: description: '' - type: 'string[]' + type: string[] - name: description uid: botbuilder-dialogs-adaptive-testing.AssertReplyActivity.description package: botbuilder-dialogs-adaptive-testing summary: Description of what this assertion is. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -56,7 +52,6 @@ properties: summary: The milliseconds to wait for a reply. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout: number' @@ -64,49 +59,54 @@ properties: description: '' type: number inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.AssertReplyActivity.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AssertReplyActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.AssertReplyActivity.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.AssertReplyActivity.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,7 +131,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Gets the text to assert for an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConditionDescription(): string' @@ -143,13 +142,11 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Validates the reply of an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateReply(activity: Activity)' parameters: - id: activity type: Activity - description: | - The activity to verify. + description: The activity to verify. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivityConfiguration.yml index f38e951c..857c4885 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: AssertReplyActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,13 +15,12 @@ properties: summary: '' fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: description uid: >- botbuilder-dialogs-adaptive-testing.AssertReplyActivityConfiguration.description @@ -30,7 +28,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' @@ -44,7 +41,6 @@ properties: summary: '' fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyConfiguration.yml index 4bc2aa4a..f45de4a5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: AssertReplyConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: exact remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exact?: boolean' @@ -28,7 +26,6 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -42,13 +39,12 @@ inheritedProperties: summary: '' fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [AssertReplyActivityConfiguration.assertions](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivityConfiguration.assertions) @@ -58,7 +54,6 @@ inheritedProperties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' @@ -74,7 +69,6 @@ inheritedProperties: summary: '' fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOf.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOf.yml index 7fefa7b8..45d4b24f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOf.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOf.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Assertion that reply from the bot matches one of options. fullName: AssertReplyOneOf remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: A value indicating whether exact match policy should be used. fullName: exact remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exact: boolean' @@ -41,13 +38,12 @@ properties: summary: The text variations. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: assertions uid: botbuilder-dialogs-adaptive-testing.AssertReplyOneOf.assertions @@ -55,13 +51,12 @@ inheritedProperties: summary: The expressions for assertions. fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [AssertReplyActivity.assertions](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.assertions) @@ -71,7 +66,6 @@ inheritedProperties: summary: Description of what this assertion is. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -87,7 +81,6 @@ inheritedProperties: summary: The milliseconds to wait for a reply. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout: number' @@ -98,31 +91,31 @@ inheritedProperties: Inherited From [AssertReplyActivity.timeout](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.timeout) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.AssertReplyOneOf.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AssertReplyOneOf' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AssertReplyActivity.configure](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.configure) - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.AssertReplyOneOf.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -149,18 +142,23 @@ inheritedMethods: package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [AssertReplyActivity.getConverter](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivity.getConverter) methods: - name: getConditionDescription() uid: >- @@ -168,7 +166,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Gets the text to assert for an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConditionDescription(): string' @@ -180,13 +177,11 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Validates the reply of an activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateReply(activity: Activity)' parameters: - id: activity type: Activity - description: | - The activity to verify. + description: The activity to verify. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOfConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOfConfiguration.yml index 8c295062..ab1ac6f9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOfConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertReplyOneOfConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: AssertReplyOneOfConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: exact remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exact?: boolean' @@ -28,13 +26,12 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: assertions uid: >- @@ -43,13 +40,12 @@ inheritedProperties: summary: '' fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [AssertReplyActivityConfiguration.assertions](xref:botbuilder-dialogs-adaptive-testing.AssertReplyActivityConfiguration.assertions) @@ -60,7 +56,6 @@ inheritedProperties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' @@ -76,7 +71,6 @@ inheritedProperties: summary: '' fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContains.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContains.yml index b450ee3f..90e0a7d0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContains.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContains.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Run assertions against telemetry events. fullName: AssertTelemetryContains remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: Gets or sets the description of this assertions. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -41,57 +38,65 @@ properties: summary: Gets or sets the events name should be included. fullName: events remarks: '' - isPreview: false isDeprecated: false syntax: content: 'events: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.AssertTelemetryContains.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + AssertTelemetryContains parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.AssertTelemetryContains.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.AssertTelemetryContains.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContainsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContainsConfiguration.yml index 42bbda87..f0946dd5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContainsConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssertTelemetryContainsConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: AssertTelemetryContainsConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' @@ -30,10 +28,9 @@ properties: summary: '' fullName: events remarks: '' - isPreview: false isDeprecated: false syntax: content: 'events?: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssignmentInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssignmentInput.yml deleted file mode 100644 index a3efb3eb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/AssignmentInput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: AssignmentInput -uid: botbuilder-dialogs-adaptive-testing.AssignmentInput -package: botbuilder-dialogs-adaptive-testing -summary: '' -fullName: AssignmentInput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AssignmentInput = { property: string, value: T } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/BodyMatchType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/BodyMatchType.yml deleted file mode 100644 index 0555b349..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/BodyMatchType.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: BodyMatchType -uid: botbuilder-dialogs-adaptive-testing.BodyMatchType -package: botbuilder-dialogs-adaptive-testing -summary: Type for how body matches against request's body. -fullName: BodyMatchType -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Exact - uid: botbuilder-dialogs-adaptive-testing.BodyMatchType.Exact - package: botbuilder-dialogs-adaptive-testing - summary: Exact match. - - name: Partial - uid: botbuilder-dialogs-adaptive-testing.BodyMatchType.Partial - package: botbuilder-dialogs-adaptive-testing - summary: Match as a part. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEvent.yml index 991c9739..e603565f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEvent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEvent.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Action to script sending custom event to the bot. fullName: CustomEvent remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: The event name. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -41,7 +38,6 @@ properties: summary: Event value. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: T' @@ -49,49 +45,56 @@ properties: description: '' type: T inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.CustomEvent.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): CustomEvent' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + <T> + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.CustomEvent.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.CustomEvent.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEventConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEventConfiguration.yml index 264daf52..89469a2b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEventConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/CustomEventConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: CustomEventConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: unknown' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogContextInspector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogContextInspector.yml deleted file mode 100644 index e4bd3da5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogContextInspector.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: DialogContextInspector -uid: botbuilder-dialogs-adaptive-testing.DialogContextInspector -package: botbuilder-dialogs-adaptive-testing -summary: '' -fullName: DialogContextInspector -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type DialogContextInspector = (dc: DialogContext) => void diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogInspector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogInspector.yml deleted file mode 100644 index 97205155..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/DialogInspector.yml +++ /dev/null @@ -1,140 +0,0 @@ -### YamlMime:TSType -name: DialogInspector -uid: botbuilder-dialogs-adaptive-testing.DialogInspector -package: botbuilder-dialogs-adaptive-testing -summary: Class for inspecting current dialog context. -fullName: DialogInspector -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'DialogInspector(Dialog, ResourceExplorer, string)' - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.constructor - package: botbuilder-dialogs-adaptive-testing - summary: Initializes a new instance of the `DialogInspector` class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new DialogInspector(rootDialog?: Dialog, resourceExplorer?: - ResourceExplorer, dialogStateProperty?: string) - parameters: - - id: rootDialog - type: Dialog - description: Root dialog to use. - - id: resourceExplorer - type: ResourceExplorer - description: Resource explorer for expression access to .lg templates. - - id: dialogStateProperty - type: string - description: > - Alternate name for the dialogState property. (Default is - "DialogState"). -properties: - - name: conversationState - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.conversationState - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the ConversationState. - fullName: conversationState - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'conversationState: ConversationState' - return: - description: '' - type: ConversationState - - name: dialogs - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.dialogs - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets global dialogs that you want to have be callable. - fullName: dialogs - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dialogs: DialogSet' - return: - description: '' - type: DialogSet - - name: initialTurnState - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.initialTurnState - package: botbuilder-dialogs-adaptive-testing - summary: Gets initialTurnState collection to copy into the turnState on every turn. - fullName: initialTurnState - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'initialTurnState: TurnContextStateCollection' - return: - description: '' - type: TurnContextStateCollection - - name: rootDialog - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.rootDialog - package: botbuilder-dialogs-adaptive-testing - summary: |- - Gets root dialog to use to start conversation. - Sets root dialog to use to start conversation. - fullName: rootDialog - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: Dialog | undefined rootDialog - return: - description: The root dialog. - type: Dialog | undefined - - name: stateConfiguration - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.stateConfiguration - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the DialogStateManagerConfiguration. - fullName: stateConfiguration - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stateConfiguration: DialogStateManagerConfiguration' - return: - description: '' - type: DialogStateManagerConfiguration - - name: userState - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.userState - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the UserState. - fullName: userState - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userState: UserState' - return: - description: '' - type: UserState -methods: - - name: 'inspect(TurnContext, DialogContextInspector)' - uid: botbuilder-dialogs-adaptive-testing.DialogInspector.inspect - package: botbuilder-dialogs-adaptive-testing - summary: Inspects a dialogs memory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function inspect(context: TurnContext, inspector: - DialogContextInspector): Promise - parameters: - - id: context - type: TurnContext - description: Turn context. - - id: inspector - type: >- - - description: | - Inspector for analyzing/modifying dialog context. - return: - description: '' - type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/FallbackFunc.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/FallbackFunc.yml index 250e653b..65768ebf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/FallbackFunc.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/FallbackFunc.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Fallback function. fullName: FallbackFunc remarks: '' -isPreview: false isDeprecated: false syntax: | type FallbackFunc = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMessage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMessage.yml index 6749176a..a21521ac 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMessage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMessage.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Http request message. fullName: HttpRequestMessage remarks: '' -isPreview: false isDeprecated: false syntax: | type HttpRequestMessage = ClientRequest & { headers: Record } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMock.yml deleted file mode 100644 index 9d086784..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMock.yml +++ /dev/null @@ -1,58 +0,0 @@ -### YamlMime:TSType -name: HttpRequestMock -uid: botbuilder-dialogs-adaptive-testing.HttpRequestMock -package: botbuilder-dialogs-adaptive-testing -summary: Base class for all http request mocks. -fullName: HttpRequestMock -remarks: '' -isPreview: false -isDeprecated: false -type: class -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMock.configure - package: botbuilder-dialogs-adaptive-testing - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMock.getConverter - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -methods: - - name: setup() - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMock.setup - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setup() -extends: Configurable diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMocksConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMocksConverter.yml deleted file mode 100644 index 614f4bb3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestMocksConverter.yml +++ /dev/null @@ -1,44 +0,0 @@ -### YamlMime:TSType -name: HttpRequestMocksConverter -uid: botbuilder-dialogs-adaptive-testing.HttpRequestMocksConverter -package: botbuilder-dialogs-adaptive-testing -summary: The type converters for UserTokenMock. -fullName: HttpRequestMocksConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: HttpRequestMocksConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMocksConverter.constructor - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new HttpRequestMocksConverter(_resourceExplorer: ResourceExplorer)' - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: | - The resource to access the content. -methods: - - name: 'convert(string | HttpRequestMock[])' - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMocksConverter.convert - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string | HttpRequestMock[]): HttpRequestMock[]' - parameters: - - id: value - type: >- - string | [] - description: Array of strings and Setting Mock elements. - return: - description: Array of Setting Mocks. - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMock.yml deleted file mode 100644 index f45dd2e5..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMock.yml +++ /dev/null @@ -1,137 +0,0 @@ -### YamlMime:TSType -name: HttpRequestSequenceMock -uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock -package: botbuilder-dialogs-adaptive-testing -summary: Mock http request in sequence order. The last response will be repeated. -fullName: HttpRequestSequenceMock -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: $kind - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.$kind - package: botbuilder-dialogs-adaptive-testing - summary: The type of request. - fullName: $kind - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static $kind: string' - return: - description: '' - type: string - - name: body - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.body - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the body to match against request's body. - fullName: body - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'body: string' - return: - description: '' - type: string - - name: matchType - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.matchType - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the match type for body. - fullName: matchType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'matchType: BodyMatchType' - return: - description: '' - type: - - name: method - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.method - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the http method to match. Match to any method if not defined. - fullName: method - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'method: HttpMethod' - return: - description: '' - type: HttpMethod - - name: responses - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.responses - package: botbuilder-dialogs-adaptive-testing - summary: Gets the sequence of responses to reply. The last one will be repeated. - fullName: responses - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'responses: HttpResponseMock[]' - return: - description: '' - type: '[]' - - name: url - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.url - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the url to match. - fullName: url - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'url: string' - return: - description: '' - type: string -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.configure - package: botbuilder-dialogs-adaptive-testing - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.getConverter - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -methods: - - name: setup() - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock.setup - package: botbuilder-dialogs-adaptive-testing - summary: Configures the initial conditions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setup() -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMockConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMockConfiguration.yml deleted file mode 100644 index e1ae1ada..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpRequestSequenceMockConfiguration.yml +++ /dev/null @@ -1,83 +0,0 @@ -### YamlMime:TSType -name: HttpRequestSequenceMockConfiguration -uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration -package: botbuilder-dialogs-adaptive-testing -summary: Configuration for a HttpRequestSequenceMock. -fullName: HttpRequestSequenceMockConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: body - uid: >- - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration.body - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: body - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'body?: string' - return: - description: '' - type: string - - name: matchType - uid: >- - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration.matchType - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: matchType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'matchType?: string | BodyMatchType' - return: - description: '' - type: >- - string | - - name: method - uid: >- - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration.method - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: method - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'method?: string | HttpMethod' - return: - description: '' - type: string | HttpMethod - - name: responses - uid: >- - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration.responses - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: responses - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'responses?: HttpResponseMock[]' - return: - description: '' - type: '[]' - - name: url - uid: >- - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration.url - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: url - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'url?: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMessage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMessage.yml deleted file mode 100644 index 39c4b8f2..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMessage.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: HttpResponseMessage -uid: botbuilder-dialogs-adaptive-testing.HttpResponseMessage -package: botbuilder-dialogs-adaptive-testing -summary: Http response message. -fullName: HttpResponseMessage -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: content - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMessage.content - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: content - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'content: ResponseContent' - return: - description: '' - type: - - name: statusCode - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMessage.statusCode - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: statusCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'statusCode: ResponseStatusCode' - return: - description: '' - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMock.yml deleted file mode 100644 index 19cf4002..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMock.yml +++ /dev/null @@ -1,63 +0,0 @@ -### YamlMime:TSType -name: HttpResponseMock -uid: botbuilder-dialogs-adaptive-testing.HttpResponseMock -package: botbuilder-dialogs-adaptive-testing -summary: Http response mock used in HttpRequestSequenceMock. -fullName: HttpResponseMock -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: content - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMock.content - package: botbuilder-dialogs-adaptive-testing - summary: The content. - fullName: content - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'content: ResponseContent' - return: - description: '' - type: - - name: contentType - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMock.contentType - package: botbuilder-dialogs-adaptive-testing - summary: The content type. - fullName: contentType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'contentType?: ResponseContentType' - return: - description: '' - type: - - name: reasonPhrase - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMock.reasonPhrase - package: botbuilder-dialogs-adaptive-testing - summary: The reason phrase. (Not supported yet) - fullName: reasonPhrase - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'reasonPhrase?: string' - return: - description: '' - type: string - - name: statusCode - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMock.statusCode - package: botbuilder-dialogs-adaptive-testing - summary: The status code. - fullName: statusCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'statusCode?: ResponseStatusCode' - return: - description: '' - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockContent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockContent.yml deleted file mode 100644 index 5e945961..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockContent.yml +++ /dev/null @@ -1,38 +0,0 @@ -### YamlMime:TSType -name: HttpResponseMockContent -uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockContent -package: botbuilder-dialogs-adaptive-testing -summary: Convert and store the actual content of HttpResponseMock. -fullName: HttpResponseMockContent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: HttpResponseMockContent(HttpResponseMock) - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockContent.constructor - package: botbuilder-dialogs-adaptive-testing - summary: Intiializes a new instance of the HttpResponseMockContent class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new HttpResponseMockContent(httpResponseMock?: HttpResponseMock)' - parameters: - - id: httpResponseMock - type: - description: | - The mock that provides content. -methods: - - name: getHttpContent() - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockContent.getHttpContent - package: botbuilder-dialogs-adaptive-testing - summary: Get a new ResponseContent based on content. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getHttpContent(): ResponseContent' - return: - description: A new ResponseContent. - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockMessage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockMessage.yml deleted file mode 100644 index ebe348fc..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/HttpResponseMockMessage.yml +++ /dev/null @@ -1,38 +0,0 @@ -### YamlMime:TSType -name: HttpResponseMockMessage -uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockMessage -package: botbuilder-dialogs-adaptive-testing -summary: Convert and store the actual data of HttpResponseMock. -fullName: HttpResponseMockMessage -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: HttpResponseMockMessage(HttpResponseMock) - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockMessage.constructor - package: botbuilder-dialogs-adaptive-testing - summary: Initializes a new instance of the HttpResponseMockMessage class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new HttpResponseMockMessage(httpResponseMock?: HttpResponseMock)' - parameters: - - id: httpResponseMock - type: - description: | - The mock that provides data. -methods: - - name: getMessage() - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockMessage.getMessage - package: botbuilder-dialogs-adaptive-testing - summary: Gets a new HttpResponseMessage. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMessage(): HttpResponseMessage' - return: - description: A new HttpResponseMessage. - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/Inspector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/Inspector.yml index 327fb483..a470eb32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/Inspector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/Inspector.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Allow inspecting/modifying the current dialog context. fullName: Inspector remarks: '' -isPreview: false isDeprecated: false syntax: | type Inspector = (inspector: DialogContextInspector) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertions.yml index 3bd4066c..a7883dba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Run assertions against memory. fullName: MemoryAssertions remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,20 +26,18 @@ properties: summary: Gets or sets the assertions. fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions: string[]' return: description: '' - type: 'string[]' + type: string[] - name: description uid: botbuilder-dialogs-adaptive-testing.MemoryAssertions.description package: botbuilder-dialogs-adaptive-testing summary: Gets or sets the description of this assertion. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -49,49 +45,54 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.MemoryAssertions.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): MemoryAssertions' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.MemoryAssertions.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.MemoryAssertions.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertionsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertionsConfiguration.yml index b4764755..34247314 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertionsConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MemoryAssertionsConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: MemoryAssertionsConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,13 +15,12 @@ properties: summary: '' fullName: assertions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assertions?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: description uid: >- botbuilder-dialogs-adaptive-testing.MemoryAssertionsConfiguration.description @@ -30,7 +28,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockHttpRequestMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockHttpRequestMiddleware.yml index 9d8e056a..646a6680 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockHttpRequestMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockHttpRequestMiddleware.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive-testing summary: Middleware to mock http requests with an adapter. fullName: MockHttpRequestMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MockHttpRequestMiddleware(HttpRequestMock[])' + - name: MockHttpRequestMiddleware(HttpRequestMock[]) uid: botbuilder-dialogs-adaptive-testing.MockHttpRequestMiddleware.constructor package: botbuilder-dialogs-adaptive-testing summary: >- @@ -17,22 +16,19 @@ constructors: [MockHttpRequestMiddleware](xref:botbuilder-dialogs-adaptive-testing.MockHttpRequestMiddleware) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MockHttpRequestMiddleware(httpRequestMocks?: HttpRequestMock[])' parameters: - id: httpRequestMocks - type: '[]' - description: | - Mocks to use. + type: HttpRequestMock[] + description: Mocks to use. methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-dialogs-adaptive-testing.MockHttpRequestMiddleware.onTurn package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -44,8 +40,7 @@ methods: description: The context object for this turn. - id: next type: () => Promise<void> - description: | - The delegate to call to continue the bot middleware pipeline. + description: The delegate to call to continue the bot middleware pipeline. return: description: '' type: Promise<void> @@ -54,12 +49,10 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Set fallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setFallback(fallback?: FallbackFunc)' parameters: - id: fallback type: - description: | - New fallback or undefined. + description: New fallback or undefined. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisLoader.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisLoader.yml index 02543256..52bdf68b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisLoader.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisLoader.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs-adaptive-testing summary: Custom json deserializer for mocking luis. fullName: MockLuisLoader remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MockLuisLoader(ResourceExplorer, Record)' + - name: MockLuisLoader(ResourceExplorer, Record) uid: botbuilder-dialogs-adaptive-testing.MockLuisLoader.constructor package: botbuilder-dialogs-adaptive-testing summary: Initializes a new instance of the MockLuisLoader class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -25,21 +23,21 @@ constructors: type: ResourceExplorer description: ResourceExplorer to use. - id: _configuration - type: 'Record<string, string>' - description: | - Configuration to use. + type: Record<string, string> + description: Configuration to use. methods: - - name: 'load(LuisAdaptiveRecognizerConfiguration, Newable)' + - name: >- + load(LuisAdaptiveRecognizerConfiguration, Newable) uid: botbuilder-dialogs-adaptive-testing.MockLuisLoader.load package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function load(config: LuisAdaptiveRecognizerConfiguration, type: - Newable): MockLuisRecognizer + Newable): MockLuisRecognizer parameters: - id: config type: LuisAdaptiveRecognizerConfiguration @@ -47,7 +45,8 @@ methods: - id: type type: >- Newable<> + uid="botbuilder-dialogs-adaptive-testing.MockLuisRecognizer" />, + unknown[]> description: Cached LUIS responses for testing. return: description: The new object created from the object parameter. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisRecognizer.yml index df5747d1..d82a48a2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockLuisRecognizer.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs-adaptive-testing summary: Test class for creating cached LUIS responses for testing. fullName: MockLuisRecognizer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MockLuisRecognizer(LuisAdaptiveRecognizer, string, string)' + - name: MockLuisRecognizer(LuisAdaptiveRecognizer, string, string) uid: botbuilder-dialogs-adaptive-testing.MockLuisRecognizer.constructor package: botbuilder-dialogs-adaptive-testing summary: Initializes a new instance of the MockLuisRecognizer class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,8 +27,7 @@ constructors: description: Where the settings file generated by lubuild is found. - id: name type: string - description: | - Name of the LUIS model + description: Name of the LUIS model inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive-testing.MockLuisRecognizer.id @@ -38,7 +35,6 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -54,7 +50,6 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -63,42 +58,44 @@ inheritedProperties: type: BotTelemetryClient inheritanceDescription: Inherited From Recognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.MockLuisRecognizer.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): MockLuisRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Recognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.MockLuisRecognizer.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From Recognizer.getConverter methods: - name: >- recognize(DialogContext, Activity, Record, Record- @@ -122,12 +118,12 @@ methods: type: Activity description: Activity to recognize. - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: >- Additional properties to be logged to telemetry with the LuisResult event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: >- Additional metrics to be logged to telemetry with the LuisResult event. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockSettingsMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockSettingsMiddleware.yml index e4f60f5b..39894039 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockSettingsMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/MockSettingsMiddleware.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive-testing summary: Middleware which mocks settings properties. fullName: MockSettingsMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MockSettingsMiddleware(SettingMock[])' + - name: MockSettingsMiddleware(SettingMock[]) uid: botbuilder-dialogs-adaptive-testing.MockSettingsMiddleware.constructor package: botbuilder-dialogs-adaptive-testing summary: >- @@ -17,22 +16,19 @@ constructors: [MockSettingsMiddleware](botbuilder-dialogs-adaptive-testing.MockSettingsMiddleware) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MockSettingsMiddleware(settingMocks: SettingMock[])' parameters: - id: settingMocks - type: '[]' - description: | - Settings to mock. + type: SettingMock[] + description: Settings to mock. methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-dialogs-adaptive-testing.MockSettingsMiddleware.onTurn package: botbuilder-dialogs-adaptive-testing summary: Processes an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -44,8 +40,7 @@ methods: description: The context object for this turn. - id: next type: () => Promise<void> - description: | - The delegate to call to continue the bot middleware pipeline. + description: The delegate to call to continue the bot middleware pipeline. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContent.yml deleted file mode 100644 index fe28e293..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContent.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: ResponseContent -uid: botbuilder-dialogs-adaptive-testing.ResponseContent -package: botbuilder-dialogs-adaptive-testing -summary: Http response content. -fullName: ResponseContent -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ResponseContent = string | Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContentType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContentType.yml deleted file mode 100644 index 2795ee2b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseContentType.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: ResponseContentType -uid: botbuilder-dialogs-adaptive-testing.ResponseContentType -package: botbuilder-dialogs-adaptive-testing -summary: Types of response content. -fullName: ResponseContentType -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ByteArray - uid: botbuilder-dialogs-adaptive-testing.ResponseContentType.ByteArray - package: botbuilder-dialogs-adaptive-testing - summary: '' - - name: String - uid: botbuilder-dialogs-adaptive-testing.ResponseContentType.String - package: botbuilder-dialogs-adaptive-testing - summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseStatusCode.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseStatusCode.yml deleted file mode 100644 index 22a4d510..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/ResponseStatusCode.yml +++ /dev/null @@ -1,251 +0,0 @@ -### YamlMime:TSEnum -name: ResponseStatusCode -uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode -package: botbuilder-dialogs-adaptive-testing -summary: Response status codes. -fullName: ResponseStatusCode -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Continue - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Continue - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 100 - - name: SwitchingProtocols - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.SwitchingProtocols - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 101 - - name: OK - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.OK - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 200 - - name: Created - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Created - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 201 - - name: Accepted - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Accepted - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 202 - - name: NonAuthoritativeInformation - uid: >- - botbuilder-dialogs-adaptive-testing.ResponseStatusCode.NonAuthoritativeInformation - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 203 - - name: NoContent - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.NoContent - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 204 - - name: ResetContent - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.ResetContent - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 205 - - name: PartialContent - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.PartialContent - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 206 - - name: Ambiguous - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Ambiguous - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 300 - - name: MultipleChoices - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.MultipleChoices - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 300 - - name: Moved - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Moved - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 301 - - name: MovedPermanently - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.MovedPermanently - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 301 - - name: Found - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Found - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 302 - - name: Redirect - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Redirect - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 302 - - name: RedirectMethod - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.RedirectMethod - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 303 - - name: SeeOther - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.SeeOther - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 303 - - name: NotModified - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.NotModified - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 304 - - name: UseProxy - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.UseProxy - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 305 - - name: Unused - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Unused - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 306 - - name: RedirectKeepVerb - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.RedirectKeepVerb - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 307 - - name: TemporaryRedirect - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.TemporaryRedirect - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 307 - - name: BadRequest - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.BadRequest - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 400 - - name: Unauthorized - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Unauthorized - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 401 - - name: PaymentRequired - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.PaymentRequired - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 402 - - name: Forbidden - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Forbidden - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 403 - - name: NotFound - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.NotFound - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 404 - - name: MethodNotAllowed - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.MethodNotAllowed - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 405 - - name: NotAcceptable - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.NotAcceptable - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 406 - - name: ProxyAuthenticationRequired - uid: >- - botbuilder-dialogs-adaptive-testing.ResponseStatusCode.ProxyAuthenticationRequired - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 407 - - name: RequestTimeout - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.RequestTimeout - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 408 - - name: Conflict - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Conflict - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 409 - - name: Gone - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.Gone - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 410 - - name: LengthRequired - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.LengthRequired - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 411 - - name: PreconditionFailed - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.PreconditionFailed - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 412 - - name: RequestEntityTooLarge - uid: >- - botbuilder-dialogs-adaptive-testing.ResponseStatusCode.RequestEntityTooLarge - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 413 - - name: RequestUriTooLong - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.RequestUriTooLong - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 414 - - name: UnsupportedMediaType - uid: >- - botbuilder-dialogs-adaptive-testing.ResponseStatusCode.UnsupportedMediaType - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 415 - - name: RequestedRangeNotSatisfiable - uid: >- - botbuilder-dialogs-adaptive-testing.ResponseStatusCode.RequestedRangeNotSatisfiable - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 416 - - name: ExpectationFailed - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.ExpectationFailed - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 417 - - name: UpgradeRequired - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.UpgradeRequired - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 426 - - name: InternalServerError - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.InternalServerError - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 500 - - name: NotImplemented - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.NotImplemented - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 501 - - name: BadGateway - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.BadGateway - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 502 - - name: ServiceUnavailable - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.ServiceUnavailable - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 503 - - name: GatewayTimeout - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode.GatewayTimeout - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 504 - - name: HttpVersionNotSupported - uid: >- - botbuilder-dialogs-adaptive-testing.ResponseStatusCode.HttpVersionNotSupported - package: botbuilder-dialogs-adaptive-testing - summary: '' - numericValue: 505 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SequenceResponseManager.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SequenceResponseManager.yml deleted file mode 100644 index 2e011f95..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SequenceResponseManager.yml +++ /dev/null @@ -1,40 +0,0 @@ -### YamlMime:TSType -name: SequenceResponseManager -uid: botbuilder-dialogs-adaptive-testing.SequenceResponseManager -package: botbuilder-dialogs-adaptive-testing -summary: Manage sequence response for HttpRequestSequenceMock. -fullName: SequenceResponseManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'SequenceResponseManager(HttpResponseMock[])' - uid: botbuilder-dialogs-adaptive-testing.SequenceResponseManager.constructor - package: botbuilder-dialogs-adaptive-testing - summary: Initializes a new instance of the SequenceResponseManager class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new SequenceResponseManager(responses?: HttpResponseMock[])' - parameters: - - id: responses - type: >- - [] - description: | - The list of HttpResponseMock. -methods: - - name: getMessage() - uid: botbuilder-dialogs-adaptive-testing.SequenceResponseManager.getMessage - package: botbuilder-dialogs-adaptive-testing - summary: Gets the message in sequence order. The last one will be repeated. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMessage(): HttpResponseMessage' - return: - description: The HttpResponseMessage. - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetProperties.yml index 3b588b8d..751bba25 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetProperties.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetProperties.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Mock one or more property values. fullName: SetProperties remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,40 +26,39 @@ properties: summary: Gets or sets the property assignments. fullName: assignments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assignments: PropertyAssignment[]' return: description: '' - type: 'PropertyAssignment[]' + type: PropertyAssignment[] inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.SetProperties.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SetProperties' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.SetProperties.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -80,20 +77,23 @@ methods: return: description: A Promise that represents the work queued to execute. type: Promise<void> - - name: getConverter(Object) + - name: getConverter("assignments") uid: botbuilder-dialogs-adaptive-testing.SetProperties.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: "assignments"): Converter | ConverterFactory parameters: - id: property - type: Object + type: '"assignments"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetPropertiesConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetPropertiesConfiguration.yml index 5121afe6..3434c448 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetPropertiesConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetPropertiesConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: SetPropertiesConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,12 +14,9 @@ properties: summary: '' fullName: assignments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assignments?: AssignmentInput[] | PropertyAssignment[]' return: description: '' - type: >- - <unknown>[] | PropertyAssignment[] + type: AssignmentInput<unknown>[] | PropertyAssignment[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetTestOptionsMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetTestOptionsMiddleware.yml deleted file mode 100644 index 31e2a168..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SetTestOptionsMiddleware.yml +++ /dev/null @@ -1,35 +0,0 @@ -### YamlMime:TSType -name: SetTestOptionsMiddleware -uid: botbuilder-dialogs-adaptive-testing.SetTestOptionsMiddleware -package: botbuilder-dialogs-adaptive-testing -summary: >- - Middleware that catch "SetTestOptions" event and save into - "Conversation.TestOptions". -fullName: SetTestOptionsMiddleware -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'onTurn(TurnContext, () => Promise)' - uid: botbuilder-dialogs-adaptive-testing.SetTestOptionsMiddleware.onTurn - package: botbuilder-dialogs-adaptive-testing - summary: Processes an incoming event activity. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onTurn(context: TurnContext, next: () => Promise): - Promise - parameters: - - id: context - type: TurnContext - description: The context object for this turn. - - id: next - type: () => Promise<void> - description: | - The delegate to call to continue the bot middleware pipeline - return: - description: '' - type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMock.yml deleted file mode 100644 index 955294ca..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMock.yml +++ /dev/null @@ -1,48 +0,0 @@ -### YamlMime:TSType -name: SettingMock -uid: botbuilder-dialogs-adaptive-testing.SettingMock -package: botbuilder-dialogs-adaptive-testing -summary: Abstract class for mocking settings. -fullName: SettingMock -remarks: '' -isPreview: false -isDeprecated: false -type: class -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive-testing.SettingMock.configure - package: botbuilder-dialogs-adaptive-testing - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive-testing.SettingMock.getConverter - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -extends: Configurable diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMocksConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMocksConverter.yml deleted file mode 100644 index 25ff244c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingMocksConverter.yml +++ /dev/null @@ -1,44 +0,0 @@ -### YamlMime:TSType -name: SettingMocksConverter -uid: botbuilder-dialogs-adaptive-testing.SettingMocksConverter -package: botbuilder-dialogs-adaptive-testing -summary: The type converters for SettingMock. -fullName: SettingMocksConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SettingMocksConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive-testing.SettingMocksConverter.constructor - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new SettingMocksConverter(_resourceExplorer: ResourceExplorer)' - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: | - Parameter to access content resources. -methods: - - name: 'convert(string | SettingMock[])' - uid: botbuilder-dialogs-adaptive-testing.SettingMocksConverter.convert - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string | SettingMock[]): SettingMock[]' - parameters: - - id: value - type: >- - string | [] - description: Array of strings and Setting Mock elements. - return: - description: Array of Setting Mocks. - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringAssignment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringAssignment.yml deleted file mode 100644 index 1890fd6a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringAssignment.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: SettingStringAssignment -uid: botbuilder-dialogs-adaptive-testing.SettingStringAssignment -package: botbuilder-dialogs-adaptive-testing -summary: Setting string assignment. -fullName: SettingStringAssignment -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: property - uid: botbuilder-dialogs-adaptive-testing.SettingStringAssignment.property - package: botbuilder-dialogs-adaptive-testing - summary: The property path. - fullName: property - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'property: string' - return: - description: '' - type: string - - name: value - uid: botbuilder-dialogs-adaptive-testing.SettingStringAssignment.value - package: botbuilder-dialogs-adaptive-testing - summary: Value string. - fullName: value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'value: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMock.yml deleted file mode 100644 index f35ea3ee..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMock.yml +++ /dev/null @@ -1,79 +0,0 @@ -### YamlMime:TSType -name: SettingStringMock -uid: botbuilder-dialogs-adaptive-testing.SettingStringMock -package: botbuilder-dialogs-adaptive-testing -summary: Mock one or more settings with string value. -fullName: SettingStringMock -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: $kind - uid: botbuilder-dialogs-adaptive-testing.SettingStringMock.$kind - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: $kind - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static $kind: string' - return: - description: '' - type: string - - name: assignments - uid: botbuilder-dialogs-adaptive-testing.SettingStringMock.assignments - package: botbuilder-dialogs-adaptive-testing - summary: >- - Setting assignments as settings.property=value pairs. Assign the settings - in sequence. - fullName: assignments - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'assignments: SettingStringAssignment[]' - return: - description: '' - type: >- - [] -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive-testing.SettingStringMock.configure - package: botbuilder-dialogs-adaptive-testing - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive-testing.SettingStringMock.getConverter - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMockConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMockConfiguration.yml deleted file mode 100644 index ed2a9350..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/SettingStringMockConfiguration.yml +++ /dev/null @@ -1,27 +0,0 @@ -### YamlMime:TSType -name: SettingStringMockConfiguration -uid: botbuilder-dialogs-adaptive-testing.SettingStringMockConfiguration -package: botbuilder-dialogs-adaptive-testing -summary: '' -fullName: SettingStringMockConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: assignments - uid: >- - botbuilder-dialogs-adaptive-testing.SettingStringMockConfiguration.assignments - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: assignments - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'assignments: SettingStringAssignment[]' - return: - description: '' - type: >- - [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestAction.yml index 85872bb1..a0c1ab82 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestAction.yml @@ -5,45 +5,46 @@ package: botbuilder-dialogs-adaptive-testing summary: Abstract base class for scripted actions. fullName: TestAction remarks: '' -isPreview: false isDeprecated: false type: class inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.TestAction.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TestAction' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: Inherited From Configurable.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.TestAction.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: Inherited From Configurable.getConverter methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' @@ -51,7 +52,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScript.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScript.yml index 6558a70e..414f08a3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScript.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScript.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: A mock Test Script that can be used for unit testing bot's logic. fullName: TestScript remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,20 +26,18 @@ properties: summary: Configuration to use for the test. fullName: configuration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'configuration: Record' return: description: '' - type: 'Record<string, string>' + type: Record<string, string> - name: description uid: botbuilder-dialogs-adaptive-testing.TestScript.description package: botbuilder-dialogs-adaptive-testing summary: A description of the test sequence. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -54,20 +50,18 @@ properties: summary: The dialog to use for the root dialog. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'dialog: Dialog' + content: 'dialog: Dialog<{}>' return: description: '' - type: Dialog + type: Dialog<{}> - name: enableTrace uid: botbuilder-dialogs-adaptive-testing.TestScript.enableTrace package: botbuilder-dialogs-adaptive-testing summary: If true then trace activities will be sent to the test script. fullName: enableTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enableTrace: boolean' @@ -80,20 +74,18 @@ properties: summary: Gets the mock data for Microsoft.HttpRequest. fullName: httpRequestMocks remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpRequestMocks: HttpRequestMock[]' return: description: '' - type: '[]' + type: HttpRequestMock[] - name: languagePolicy uid: botbuilder-dialogs-adaptive-testing.TestScript.languagePolicy package: botbuilder-dialogs-adaptive-testing summary: Language policy. fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy: LanguagePolicy' @@ -106,7 +98,6 @@ properties: summary: 'The locale (default: en-us).' fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale: string' @@ -119,66 +110,61 @@ properties: summary: The sequence of test actions to perform to validate the dialog behavior. fullName: script remarks: '' - isPreview: false isDeprecated: false syntax: content: 'script: TestAction[]' return: description: '' - type: '[]' + type: [] - name: settingMocks uid: botbuilder-dialogs-adaptive-testing.TestScript.settingMocks package: botbuilder-dialogs-adaptive-testing summary: The mock data for settings. fullName: settingMocks remarks: '' - isPreview: false isDeprecated: false syntax: content: 'settingMocks: SettingMock[]' return: description: '' - type: '[]' + type: SettingMock[] - name: userTokenMocks uid: botbuilder-dialogs-adaptive-testing.TestScript.userTokenMocks package: botbuilder-dialogs-adaptive-testing summary: The mock data for Microsoft.OAuthInput. fullName: userTokenMocks remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userTokenMocks: UserTokenMock[]' return: description: '' - type: '[]' + type: UserTokenMock[] inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.TestScript.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TestScript' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: Inherited From Configurable.configure methods: - - name: 'defaultTestAdapter(string, Middleware[])' + - name: defaultTestAdapter(string, Middleware[]) uid: botbuilder-dialogs-adaptive-testing.TestScript.defaultTestAdapter package: botbuilder-dialogs-adaptive-testing summary: Build default test adapter. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -189,7 +175,7 @@ methods: type: string description: Name of test. - id: middlewares - type: 'Middleware[]' + type: Middleware[] description: Middlewares to be added to the adapter. return: description: Test adapter. @@ -201,7 +187,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Starts the execution of the test sequence. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,26 +207,28 @@ methods: type: TestAdapter description: Optional test adapter. - id: middlewares - type: 'Middleware[]' - description: | - Middlewares to be added to the adapter. + type: Middleware[] + description: Middlewares to be added to the adapter. return: description: '' type: Promise<void> - - name: getConverter(Object) + - name: getConverter(keyof TestScriptConfiguration) uid: botbuilder-dialogs-adaptive-testing.TestScript.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof TestScriptConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof TestScriptConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Configurable diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScriptConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScriptConfiguration.yml index 7f4f0c7c..2f4fd17e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScriptConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestScriptConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: TestScriptConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' @@ -28,20 +26,18 @@ properties: summary: '' fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'dialog?: string | Dialog' + content: 'dialog?: string | Dialog<{}>' return: description: '' - type: string | Dialog + type: string | Dialog<{}> - name: enableTrace uid: botbuilder-dialogs-adaptive-testing.TestScriptConfiguration.enableTrace package: botbuilder-dialogs-adaptive-testing summary: '' fullName: enableTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enableTrace?: boolean' @@ -55,35 +51,30 @@ properties: summary: '' fullName: httpRequestMocks remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'httpRequestMocks?: string[] | HttpRequestMock[]' + content: 'httpRequestMocks?: HttpRequestMock[] | string[]' return: description: '' - type: >- - string[] | [] + type: HttpRequestMock[] | string[] - name: languagePolicy uid: botbuilder-dialogs-adaptive-testing.TestScriptConfiguration.languagePolicy package: botbuilder-dialogs-adaptive-testing summary: '' fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy?: Record | LanguagePolicy' return: description: '' - type: 'Record<string, string[]> | LanguagePolicy' + type: Record<string, string[]> | LanguagePolicy - name: locale uid: botbuilder-dialogs-adaptive-testing.TestScriptConfiguration.locale package: botbuilder-dialogs-adaptive-testing summary: '' fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -96,40 +87,33 @@ properties: summary: '' fullName: script remarks: '' - isPreview: false isDeprecated: false syntax: content: 'script?: TestAction[]' return: description: '' - type: '[]' + type: [] - name: settingMocks uid: botbuilder-dialogs-adaptive-testing.TestScriptConfiguration.settingMocks package: botbuilder-dialogs-adaptive-testing summary: '' fullName: settingMocks remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'settingMocks?: string[] | SettingMock[]' + content: 'settingMocks?: SettingMock[] | string[]' return: description: '' - type: >- - string[] | [] + type: SettingMock[] | string[] - name: userTokenMocks uid: botbuilder-dialogs-adaptive-testing.TestScriptConfiguration.userTokenMocks package: botbuilder-dialogs-adaptive-testing summary: '' fullName: userTokenMocks remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userTokenMocks?: string[] | UserTokenMock[]' return: description: '' - type: >- - string[] | [] + type: string[] | UserTokenMock[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestTelemetryClient.yml deleted file mode 100644 index cfc7498f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestTelemetryClient.yml +++ /dev/null @@ -1,116 +0,0 @@ -### YamlMime:TSType -name: TestTelemetryClient -uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient -package: botbuilder-dialogs-adaptive-testing -summary: >- - A test bot telemetry client that implements - [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient). -fullName: TestTelemetryClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TestTelemetryClient(any) - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.constructor - package: botbuilder-dialogs-adaptive-testing - summary: >- - Creates a new instance of the - [TestTelemetryClient](xref:botbuilder-dialogs-adaptive-testing.TestTelemetryClient) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new TestTelemetryClient(_settings?: any)' - parameters: - - id: _settings - type: any - description: | - Optional. Settings for the telemetry client. -properties: - - name: invocations - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.invocations - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: invocations - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'invocations: string[]' - return: - description: '' - type: 'string[]' -methods: - - name: flush() - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.flush - package: botbuilder-dialogs-adaptive-testing - summary: Flushes the in-memory buffer and any metrics being pre-aggregated. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function flush() - - name: trackDependency(TelemetryDependency) - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.trackDependency - package: botbuilder-dialogs-adaptive-testing - summary: >- - Sends information about an external dependency (outgoing call) in the - application. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function trackDependency(_telemetry: TelemetryDependency)' - parameters: - - id: _telemetry - type: TelemetryDependency - description: > - An object implementing - [TelemetryDependency](xref:botbuilder-core.TelemetryDependency). - - name: trackEvent(TelemetryEvent) - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.trackEvent - package: botbuilder-dialogs-adaptive-testing - summary: Logs custom events with extensible named fields. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function trackEvent(telemetry: TelemetryEvent)' - parameters: - - id: telemetry - type: TelemetryEvent - description: > - An object implementing - [TelemetryEvent](xref:botbuilder-core.TelemetryEvent). - - name: trackException(TelemetryException) - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.trackException - package: botbuilder-dialogs-adaptive-testing - summary: Logs a system exception. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function trackException(_telemetry: TelemetryException)' - parameters: - - id: _telemetry - type: TelemetryException - description: > - An object implementing - [TelemetryException](xref:botbuilder-core.TelemetryException). - - name: trackTrace(TelemetryTrace) - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient.trackTrace - package: botbuilder-dialogs-adaptive-testing - summary: Sends a trace message. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function trackTrace(_telemetry: TelemetryTrace)' - parameters: - - id: _telemetry - type: TelemetryTrace - description: > - An object implementing - [TelemetryTrace](xref:botbuilder-core.TelemetryTrace). diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestUtils.yml index 405e9e98..a5431d83 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestUtils.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/TestUtils.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: In charge of running Dialog Adaptive tests. fullName: TestUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Runs a test script with the specified name. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,12 +32,11 @@ methods: type: TestAdapter description: Test adapter. - id: configuration - type: 'Record<string, string>' + type: Record<string, string> description: Test configuration. - id: middlewares - type: 'Middleware[]' - description: | - Middlewares to be added in test. + type: Middleware[] + description: Middlewares to be added in test. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivity.yml index cc2e3ce3..a252cad9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivity.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Send an activity to the bot. fullName: UserActivity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: The activity to compare. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity: Activity' @@ -43,7 +40,6 @@ properties: from user. fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user: string' @@ -51,49 +47,54 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.UserActivity.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): UserActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.UserActivity.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.UserActivity.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivityConfiguration.yml index 66ed8836..df3f5603 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: UserActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity?: Activity' @@ -28,7 +26,6 @@ properties: summary: '' fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdate.yml index 057dd2a2..6aacadfe 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdate.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdate.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Action to script sending a conversationUpdate activity to the bot. fullName: UserConversationUpdate remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,70 +26,77 @@ properties: summary: The members added names. fullName: membersAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersAdded: string[]' return: description: '' - type: 'string[]' + type: string[] - name: membersRemoved uid: botbuilder-dialogs-adaptive-testing.UserConversationUpdate.membersRemoved package: botbuilder-dialogs-adaptive-testing summary: The members removed names. fullName: membersRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersRemoved: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.UserConversationUpdate.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + UserConversationUpdate parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.UserConversationUpdate.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.UserConversationUpdate.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdateConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdateConfiguration.yml index a1cc4fff..463e4f6a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdateConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserConversationUpdateConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: UserConversationUpdateConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,13 +15,12 @@ properties: summary: '' fullName: membersAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersAdded?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: membersRemoved uid: >- botbuilder-dialogs-adaptive-testing.UserConversationUpdateConfiguration.membersRemoved @@ -30,10 +28,9 @@ properties: summary: '' fullName: membersRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersRemoved?: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelay.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelay.yml index a19f54c6..e6abffc6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelay.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelay.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Script action to delay test script for specified timespan. fullName: UserDelay remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: The timespan in milliseconds to delay. fullName: timespan remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timespan: number' @@ -36,49 +33,54 @@ properties: description: '' type: number inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.UserDelay.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): UserDelay' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.UserDelay.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.UserDelay.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelayConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelayConfiguration.yml index eb10d108..7067a64e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelayConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserDelayConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: UserDelayConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: timespan remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timespan?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSays.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSays.yml index 300bb40d..e44b0bb3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSays.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSays.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Action to script sending text to the bot. fullName: UserSays remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: The locale of user. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale: string' @@ -41,7 +38,6 @@ properties: summary: The text to send to the bot. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -56,7 +52,6 @@ properties: from user. fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user: string' @@ -64,49 +59,54 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.UserSays.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): UserSays' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TestAction.configure](xref:botbuilder-dialogs-adaptive-testing.TestAction.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.UserSays.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TestAction.getConverter](xref:botbuilder-dialogs-adaptive-testing.TestAction.getConverter) methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' uid: botbuilder-dialogs-adaptive-testing.UserSays.execute package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSaysConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSaysConfiguration.yml index e7c4c6ba..14085869 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSaysConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserSaysConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: UserSaysConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMock.yml deleted file mode 100644 index 0c30f0b1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMock.yml +++ /dev/null @@ -1,142 +0,0 @@ -### YamlMime:TSType -name: UserTokenBasicMock -uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock -package: botbuilder-dialogs-adaptive-testing -summary: Mock UserToken with user id and token. -fullName: UserTokenBasicMock -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: $kind - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.$kind - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: $kind - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static $kind: string' - return: - description: '' - type: string - - name: channelId - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.channelId - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the channel ID. - fullName: channelId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'channelId: string' - return: - description: '' - type: string - - name: connectionName - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.connectionName - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the connection name. - fullName: connectionName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'connectionName: string' - return: - description: '' - type: string - - name: magicCode - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.magicCode - package: botbuilder-dialogs-adaptive-testing - summary: Gets or set the optional magic code to associate with this token. - fullName: magicCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'magicCode: string' - return: - description: '' - type: string - - name: token - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.token - package: botbuilder-dialogs-adaptive-testing - summary: Gets or set the token to store. - fullName: token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'token: string' - return: - description: '' - type: string - - name: userId - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.userId - package: botbuilder-dialogs-adaptive-testing - summary: Gets or sets the user ID. - fullName: userId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userId: string' - return: - description: '' - type: string -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.configure - package: botbuilder-dialogs-adaptive-testing - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.getConverter - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -methods: - - name: setup(TestAdapter) - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock.setup - package: botbuilder-dialogs-adaptive-testing - summary: Method to setup this mock for an adapter. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setup(adapter: TestAdapter)' - parameters: - - id: adapter - type: TestAdapter - description: | - The test adapter to use for mocking. -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMockConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMockConfiguration.yml deleted file mode 100644 index c3672e06..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenBasicMockConfiguration.yml +++ /dev/null @@ -1,79 +0,0 @@ -### YamlMime:TSType -name: UserTokenBasicMockConfiguration -uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration -package: botbuilder-dialogs-adaptive-testing -summary: '' -fullName: UserTokenBasicMockConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: channelId - uid: >- - botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration.channelId - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: channelId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'channelId?: string' - return: - description: '' - type: string - - name: connectionName - uid: >- - botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration.connectionName - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: connectionName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'connectionName?: string' - return: - description: '' - type: string - - name: magicCode - uid: >- - botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration.magicCode - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: magicCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'magicCode?: string' - return: - description: '' - type: string - - name: token - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration.token - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'token?: string' - return: - description: '' - type: string - - name: userId - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration.userId - package: botbuilder-dialogs-adaptive-testing - summary: '' - fullName: userId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userId?: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMock.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMock.yml deleted file mode 100644 index 5ac48481..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMock.yml +++ /dev/null @@ -1,62 +0,0 @@ -### YamlMime:TSType -name: UserTokenMock -uid: botbuilder-dialogs-adaptive-testing.UserTokenMock -package: botbuilder-dialogs-adaptive-testing -summary: Interface for mocking user token flows. -fullName: UserTokenMock -remarks: '' -isPreview: false -isDeprecated: false -type: class -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive-testing.UserTokenMock.configure - package: botbuilder-dialogs-adaptive-testing - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive-testing.UserTokenMock.getConverter - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -methods: - - name: setup(TestAdapter) - uid: botbuilder-dialogs-adaptive-testing.UserTokenMock.setup - package: botbuilder-dialogs-adaptive-testing - summary: Method to setup this mock for an adapter. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setup(adapter: TestAdapter)' - parameters: - - id: adapter - type: TestAdapter - description: '' -extends: Configurable diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMocksConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMocksConverter.yml deleted file mode 100644 index 4f1d6380..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTokenMocksConverter.yml +++ /dev/null @@ -1,44 +0,0 @@ -### YamlMime:TSType -name: UserTokenMocksConverter -uid: botbuilder-dialogs-adaptive-testing.UserTokenMocksConverter -package: botbuilder-dialogs-adaptive-testing -summary: The type converters for UserTokenMock. -fullName: UserTokenMocksConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UserTokenMocksConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive-testing.UserTokenMocksConverter.constructor - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new UserTokenMocksConverter(_resourceExplorer: ResourceExplorer)' - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: | - Parameter to access content resources. -methods: - - name: 'convert(string | UserTokenMock[])' - uid: botbuilder-dialogs-adaptive-testing.UserTokenMocksConverter.convert - package: botbuilder-dialogs-adaptive-testing - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string | UserTokenMock[]): UserTokenMock[]' - parameters: - - id: value - type: >- - string | [] - description: Array of strings and Setting Mock elements. - return: - description: Array of Setting Mocks. - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTyping.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTyping.yml index dfa6ecb9..7ba3f930 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTyping.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTyping.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: Action to script sending typing activity to the bot. fullName: UserTyping remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -30,7 +28,6 @@ properties: from user. fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user: string' @@ -38,41 +35,43 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive-testing.UserTyping.configure package: botbuilder-dialogs-adaptive-testing summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): UserTyping' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: Inherited From Configurable.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive-testing.UserTyping.getConverter package: botbuilder-dialogs-adaptive-testing summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: Inherited From Configurable.getConverter methods: - name: 'execute(TestAdapter, (context: TurnContext) => Promise, Inspector)' @@ -80,7 +79,6 @@ methods: package: botbuilder-dialogs-adaptive-testing summary: Execute the test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTypingConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTypingConfiguration.yml index adee5384..2fb86f45 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTypingConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/UserTypingConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive-testing summary: '' fullName: UserTypingConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/index.yml index 17f59831..f6ec3570 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-testing/index.yml @@ -4,24 +4,8 @@ name: botbuilder-dialogs-adaptive-testing summary: '' type: package classes: - - botbuilder-dialogs-adaptive-testing.AssertCondition - botbuilder-dialogs-adaptive-testing.AdaptiveTestBotComponent - - botbuilder-dialogs-adaptive-testing.DialogInspector - - botbuilder-dialogs-adaptive-testing.HttpRequestMock - - botbuilder-dialogs-adaptive-testing.HttpRequestMocksConverter - - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock - - botbuilder-dialogs-adaptive-testing.HttpResponseMockContent - - botbuilder-dialogs-adaptive-testing.HttpResponseMockMessage - - botbuilder-dialogs-adaptive-testing.SequenceResponseManager - - botbuilder-dialogs-adaptive-testing.MockHttpRequestMiddleware - - botbuilder-dialogs-adaptive-testing.MockLuisLoader - - botbuilder-dialogs-adaptive-testing.MockLuisRecognizer - - botbuilder-dialogs-adaptive-testing.MockSettingsMiddleware - - botbuilder-dialogs-adaptive-testing.SetTestOptionsMiddleware - - botbuilder-dialogs-adaptive-testing.SettingMock - - botbuilder-dialogs-adaptive-testing.SettingMocksConverter - - botbuilder-dialogs-adaptive-testing.SettingStringMock - - botbuilder-dialogs-adaptive-testing.TestAction + - botbuilder-dialogs-adaptive-testing.AssertCondition - botbuilder-dialogs-adaptive-testing.AssertNoActivity - botbuilder-dialogs-adaptive-testing.AssertReply - botbuilder-dialogs-adaptive-testing.AssertReplyActivity @@ -29,58 +13,45 @@ classes: - botbuilder-dialogs-adaptive-testing.AssertTelemetryContains - botbuilder-dialogs-adaptive-testing.CustomEvent - botbuilder-dialogs-adaptive-testing.MemoryAssertions + - botbuilder-dialogs-adaptive-testing.MockHttpRequestMiddleware + - botbuilder-dialogs-adaptive-testing.MockLuisLoader + - botbuilder-dialogs-adaptive-testing.MockLuisRecognizer + - botbuilder-dialogs-adaptive-testing.MockSettingsMiddleware - botbuilder-dialogs-adaptive-testing.SetProperties + - botbuilder-dialogs-adaptive-testing.TestAction + - botbuilder-dialogs-adaptive-testing.TestScript + - botbuilder-dialogs-adaptive-testing.TestUtils - botbuilder-dialogs-adaptive-testing.UserActivity - botbuilder-dialogs-adaptive-testing.UserConversationUpdate - botbuilder-dialogs-adaptive-testing.UserDelay - botbuilder-dialogs-adaptive-testing.UserSays - botbuilder-dialogs-adaptive-testing.UserTyping - - botbuilder-dialogs-adaptive-testing.TestScript - - botbuilder-dialogs-adaptive-testing.TestTelemetryClient - - botbuilder-dialogs-adaptive-testing.TestUtils - - botbuilder-dialogs-adaptive-testing.UserTokenBasicMock - - botbuilder-dialogs-adaptive-testing.UserTokenMock - - botbuilder-dialogs-adaptive-testing.UserTokenMocksConverter interfaces: - botbuilder-dialogs-adaptive-testing.AssertConditionConfiguration - - botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration - - botbuilder-dialogs-adaptive-testing.HttpResponseMessage - - botbuilder-dialogs-adaptive-testing.HttpResponseMock - - botbuilder-dialogs-adaptive-testing.SettingStringAssignment - - botbuilder-dialogs-adaptive-testing.SettingStringMockConfiguration - botbuilder-dialogs-adaptive-testing.AssertNoActivityConfiguration - - botbuilder-dialogs-adaptive-testing.AssertReplyConfiguration - botbuilder-dialogs-adaptive-testing.AssertReplyActivityConfiguration + - botbuilder-dialogs-adaptive-testing.AssertReplyConfiguration - botbuilder-dialogs-adaptive-testing.AssertReplyOneOfConfiguration - botbuilder-dialogs-adaptive-testing.AssertTelemetryContainsConfiguration - botbuilder-dialogs-adaptive-testing.CustomEventConfiguration - botbuilder-dialogs-adaptive-testing.MemoryAssertionsConfiguration - botbuilder-dialogs-adaptive-testing.SetPropertiesConfiguration + - botbuilder-dialogs-adaptive-testing.TestScriptConfiguration - botbuilder-dialogs-adaptive-testing.UserActivityConfiguration - botbuilder-dialogs-adaptive-testing.UserConversationUpdateConfiguration - botbuilder-dialogs-adaptive-testing.UserDelayConfiguration - botbuilder-dialogs-adaptive-testing.UserSaysConfiguration - botbuilder-dialogs-adaptive-testing.UserTypingConfiguration - - botbuilder-dialogs-adaptive-testing.TestScriptConfiguration - - botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration typeAliases: - - botbuilder-dialogs-adaptive-testing.DialogContextInspector - - botbuilder-dialogs-adaptive-testing.ResponseContent - botbuilder-dialogs-adaptive-testing.FallbackFunc - botbuilder-dialogs-adaptive-testing.HttpRequestMessage - botbuilder-dialogs-adaptive-testing.Inspector - - botbuilder-dialogs-adaptive-testing.AssignmentInput -enums: - - botbuilder-dialogs-adaptive-testing.BodyMatchType - - botbuilder-dialogs-adaptive-testing.ResponseContentType - - botbuilder-dialogs-adaptive-testing.ResponseStatusCode functions: - - name: 'useMockLuisSettings(string, string)' + - name: useMockLuisSettings(string, string) uid: botbuilder-dialogs-adaptive-testing.useMockLuisSettings package: botbuilder-dialogs-adaptive-testing summary: Setup configuration to utilize the settings file generated by lubuild. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -95,4 +66,4 @@ functions: description: Endpoint to use with a default of westus. return: description: Modified configuration. - type: 'Record<string, string>' + type: Record<string, string> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeList.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeList.yml deleted file mode 100644 index 328c0da8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeList.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: ActionChangeList -uid: botbuilder-dialogs-adaptive.ActionChangeList -package: botbuilder-dialogs-adaptive -summary: '' -fullName: ActionChangeList -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: actions - uid: botbuilder-dialogs-adaptive.ActionChangeList.actions - package: botbuilder-dialogs-adaptive - summary: Ordered list of actions for change. - fullName: actions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'actions?: ActionState[]' - return: - description: '' - type: '[]' - - name: changeType - uid: botbuilder-dialogs-adaptive.ActionChangeList.changeType - package: botbuilder-dialogs-adaptive - summary: Type of change being made. - fullName: changeType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'changeType: ActionChangeType' - return: - description: '' - type: - - name: turn - uid: botbuilder-dialogs-adaptive.ActionChangeList.turn - package: botbuilder-dialogs-adaptive - summary: Turn state associated with the change. - fullName: turn - remarks: The current turn state will be update when the plan change is applied. - isPreview: false - isDeprecated: false - syntax: - content: 'turn?: [key: string]: string' - return: - description: '' - type: '[key: string]\: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeType.yml deleted file mode 100644 index c0bfd4db..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionChangeType.yml +++ /dev/null @@ -1,28 +0,0 @@ -### YamlMime:TSEnum -name: ActionChangeType -uid: botbuilder-dialogs-adaptive.ActionChangeType -package: botbuilder-dialogs-adaptive -summary: |- - Copyright (c) Microsoft Corporation. All rights reserved. - Licensed under the MIT License. -fullName: ActionChangeType -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: appendActions - uid: botbuilder-dialogs-adaptive.ActionChangeType.appendActions - package: botbuilder-dialogs-adaptive - summary: Add the change actions to the tail of the sequence. - - name: endSequence - uid: botbuilder-dialogs-adaptive.ActionChangeType.endSequence - package: botbuilder-dialogs-adaptive - summary: Terminate the action sequence. - - name: insertActions - uid: botbuilder-dialogs-adaptive.ActionChangeType.insertActions - package: botbuilder-dialogs-adaptive - summary: Add the change actions to the head of the sequence. - - name: replaceSequence - uid: botbuilder-dialogs-adaptive.ActionChangeType.replaceSequence - package: botbuilder-dialogs-adaptive - summary: 'Terminate the action sequence, then add the change actions.' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionContext.yml index 42632840..b382a74c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionContext.yml @@ -10,7 +10,6 @@ summary: >- [AdaptiveDialog](xref:botbuilder-dialogs-adaptive.AdaptiveDialog). fullName: ActionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -23,7 +22,6 @@ constructors: Initializes a new instance of the [ActionContext](xref:botbuilder-dialogs-adaptive.ActionContext) class remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,12 +39,11 @@ constructors: type: DialogState description: Current dialog state. - id: actions - type: '[]' + type: ActionState[] description: Current list of remaining actions to execute. - id: changeKey type: symbol - description: | - TurnState key for where to persist any changes. + description: TurnState key for where to persist any changes. properties: - name: actions uid: botbuilder-dialogs-adaptive.ActionContext.actions @@ -54,62 +51,71 @@ properties: summary: List of actions being executed. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actions: ActionState[]' return: description: '' - type: '[]' + type: ActionState[] + - name: activeDialog + uid: botbuilder-dialogs-adaptive.ActionContext.activeDialog + package: botbuilder-dialogs-adaptive + summary: '' + fullName: activeDialog + remarks: '' + isDeprecated: false + syntax: + content: undefined | DialogInstance activeDialog + return: + description: >- + The state information for the dialog on the top of the dialog stack, + or `undefined` if + + the stack is empty. + type: undefined | DialogInstance<any> - name: changes uid: botbuilder-dialogs-adaptive.ActionContext.changes package: botbuilder-dialogs-adaptive summary: Gets list of changes that are queued to be applied. fullName: changes remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ActionChangeList[] changes' + content: ActionChangeList[] changes return: description: The list of changes queued. - type: '[]' -inheritedProperties: - - name: activeDialog - uid: botbuilder-dialogs-adaptive.ActionContext.activeDialog + type: ActionChangeList[] + - name: child + uid: botbuilder-dialogs-adaptive.ActionContext.child package: botbuilder-dialogs-adaptive summary: '' - fullName: activeDialog + fullName: child remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'activeDialog: DialogInstance | undefined' + content: undefined | DialogContext child return: - description: '' - type: DialogInstance | undefined - inheritanceDescription: Inherited From DialogContext.activeDialog - - name: child - uid: botbuilder-dialogs-adaptive.ActionContext.child + description: Dialog context for child if the active dialog is a container. + type: undefined | DialogContext + - name: dialogManager + uid: botbuilder-dialogs-adaptive.ActionContext.dialogManager package: botbuilder-dialogs-adaptive summary: '' - fullName: child + fullName: dialogManager remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'child: DialogContext | undefined' + content: DialogManager dialogManager return: - description: '' - type: DialogContext | undefined - inheritanceDescription: Inherited From DialogContext.child + description: The current dialog manager instance. This property is deprecated. + type: DialogManager +inheritedProperties: - name: context uid: botbuilder-dialogs-adaptive.ActionContext.context package: botbuilder-dialogs-adaptive summary: Gets the context object for the turn. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: TurnContext' @@ -117,27 +123,12 @@ inheritedProperties: description: '' type: TurnContext inheritanceDescription: Inherited From DialogContext.context - - name: dialogManager - uid: botbuilder-dialogs-adaptive.ActionContext.dialogManager - package: botbuilder-dialogs-adaptive - summary: '' - fullName: dialogManager - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dialogManager: DialogManager' - return: - description: '' - type: DialogManager - inheritanceDescription: Inherited From DialogContext.dialogManager - name: dialogs uid: botbuilder-dialogs-adaptive.ActionContext.dialogs package: botbuilder-dialogs-adaptive summary: Gets the dialogs that can be called directly from this context. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -161,13 +152,12 @@ inheritedProperties: in this dialog context, it searches in its parent dialog context, and so on. - isPreview: false isDeprecated: false syntax: - content: 'parent: DialogContext | undefined' + content: 'parent: undefined | DialogContext' return: description: '' - type: DialogContext | undefined + type: undefined | DialogContext inheritanceDescription: Inherited From DialogContext.parent - name: services uid: botbuilder-dialogs-adaptive.ActionContext.services @@ -175,7 +165,6 @@ inheritedProperties: summary: Gets the services collection which is contextual to this dialog context. fullName: services remarks: '' - isPreview: false isDeprecated: false syntax: content: 'services: TurnContextStateCollection' @@ -189,13 +178,12 @@ inheritedProperties: summary: Gets the current dialog stack. fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stack: DialogInstance[]' + content: 'stack: DialogInstance[]' return: description: '' - type: 'DialogInstance[]' + type: DialogInstance<any>[] inheritanceDescription: Inherited From DialogContext.stack - name: state uid: botbuilder-dialogs-adaptive.ActionContext.state @@ -203,7 +191,6 @@ inheritedProperties: summary: Gets the DialogStateManager which manages view of all memory scopes. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: DialogStateManager' @@ -212,7 +199,7 @@ inheritedProperties: type: DialogStateManager inheritanceDescription: Inherited From DialogContext.state inheritedMethods: - - name: 'beginDialog(string, object)' + - name: beginDialog(string, object) uid: botbuilder-dialogs-adaptive.ActionContext.beginDialog package: botbuilder-dialogs-adaptive summary: |- @@ -255,12 +242,11 @@ inheritedMethods: - [replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - [Dialog.beginDialog](xref:botbuilder-dialogs.Dialog.beginDialog) - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dialogId: string, options?: object): - Promise + Promise> parameters: - id: dialogId type: string @@ -270,12 +256,12 @@ inheritedMethods: description: Optional. Arguments to pass into the dialog when it starts. return: description: a promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.beginDialog - - name: 'cancelAllDialogs(boolean, string, any)' + - name: cancelAllDialogs(boolean, string, any) uid: botbuilder-dialogs-adaptive.ActionContext.cancelAllDialogs package: botbuilder-dialogs-adaptive - summary: 'Cancels all dialogs on the dialog stack, and clears stack.' + summary: Cancels all dialogs on the dialog stack, and clears stack. remarks: >- This calls each dialog's [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) method before @@ -308,12 +294,11 @@ inheritedMethods: **See also** - [endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function cancelAllDialogs(cancelParents?: boolean, eventName?: string, - eventValue?: any): Promise + eventValue?: any): Promise> parameters: - id: cancelParents type: boolean @@ -329,7 +314,7 @@ inheritedMethods: description: Optional. Value to pass along with custom cancellation event. return: description: a promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.cancelAllDialogs - name: continueDialog() uid: botbuilder-dialogs-adaptive.ActionContext.continueDialog @@ -369,22 +354,20 @@ inheritedMethods: } ``` - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(): Promise' + content: 'function continueDialog(): Promise>' return: description: a promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.continueDialog - - name: 'emitEvent(string, any, boolean, boolean)' + - name: emitEvent(string, any, boolean, boolean) uid: botbuilder-dialogs-adaptive.ActionContext.emitEvent package: botbuilder-dialogs-adaptive summary: Searches for a dialog with a given ID. remarks: >- Emits a named event for the current dialog, or someone who started it, to handle. - isPreview: false isDeprecated: false syntax: content: >- @@ -461,10 +444,9 @@ inheritedMethods: - [replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) - isPreview: false isDeprecated: false syntax: - content: 'function endDialog(result?: any): Promise' + content: 'function endDialog(result?: any): Promise>' parameters: - id: result type: any @@ -475,7 +457,7 @@ inheritedMethods: the bot's turn handler. return: description: a promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.endDialog - name: findDialog(string) uid: botbuilder-dialogs-adaptive.ActionContext.findDialog @@ -494,24 +476,22 @@ inheritedMethods: - [dialogs](xref:botbuilder-dialogs.DialogContext.dialogs) - [parent](xref:botbuilder-dialogs.DialogContext.parent) - isPreview: false isDeprecated: false syntax: - content: 'function findDialog(dialogId: string): Dialog | undefined' + content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog to search for. return: description: The dialog for the provided ID. - type: Dialog | undefined + type: undefined | Dialog<{}> inheritanceDescription: Inherited From DialogContext.findDialog - name: getLocale() uid: botbuilder-dialogs-adaptive.ActionContext.getLocale package: botbuilder-dialogs-adaptive summary: Obtain the CultureInfo in DialogContext. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLocale(): string' @@ -519,7 +499,7 @@ inheritedMethods: description: a locale string. type: string inheritanceDescription: Inherited From DialogContext.getLocale - - name: 'prompt(string, string | Partial | PromptOptions)' + - name: prompt(string, string | Partial | PromptOptions) uid: botbuilder-dialogs-adaptive.ActionContext.prompt package: botbuilder-dialogs-adaptive summary: >- @@ -539,12 +519,11 @@ inheritedMethods: quit?`); ``` - isPreview: false isDeprecated: false syntax: content: >- function prompt(dialogId: string, promptOrOptions: string | - Partial | PromptOptions): Promise + Partial | PromptOptions): Promise> parameters: - id: dialogId type: string @@ -557,11 +536,11 @@ inheritedMethods: the object with which to format the prompt dialog. return: description: '' - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.prompt - name: >- - prompt(string, string | Partial | PromptOptions, string | - Choice[]) + prompt(string, string | Partial | PromptOptions, (string | + Choice)[]) uid: botbuilder-dialogs-adaptive.ActionContext.prompt_1 package: botbuilder-dialogs-adaptive summary: >- @@ -581,13 +560,12 @@ inheritedMethods: quit?`); ``` - isPreview: false isDeprecated: false syntax: content: >- function prompt(dialogId: string, promptOrOptions: string | - Partial | PromptOptions, choices: string | Choice[]): - Promise + Partial | PromptOptions, choices: (string | Choice)[]): + Promise> parameters: - id: dialogId type: string @@ -602,15 +580,15 @@ inheritedMethods: the object with which to format the prompt dialog. - id: choices - type: 'string | Choice[]' + type: (string | Choice)[] description: |- Optional. Array of choices for the user to choose from, for use with a [ChoicePrompt](xref:botbuilder-dialogs.ChoicePrompt). return: description: '' - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.prompt - - name: 'replaceDialog(string, object)' + - name: replaceDialog(string, object) uid: botbuilder-dialogs-adaptive.ActionContext.replaceDialog package: botbuilder-dialogs-adaptive summary: Ends the active dialog and starts a new dialog in its place. @@ -636,12 +614,11 @@ inheritedMethods: - [beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) - [endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function replaceDialog(dialogId: string, options?: object): - Promise + Promise> parameters: - id: dialogId type: string @@ -651,7 +628,7 @@ inheritedMethods: description: Optional. Arguments to pass into the new dialog when it starts. return: description: a promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From DialogContext.replaceDialog - name: repromptDialog() uid: botbuilder-dialogs-adaptive.ActionContext.repromptDialog @@ -669,7 +646,6 @@ inheritedMethods: await dc.repromptDialog(); ``` - isPreview: false isDeprecated: false syntax: content: 'function repromptDialog(): Promise' @@ -683,7 +659,6 @@ methods: package: botbuilder-dialogs-adaptive summary: Applies any queued up changes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function applyChanges(): Promise' @@ -697,13 +672,11 @@ methods: Queues up a set of changes that will be applied when applyChanges() is called. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function queueChanges(changes: ActionChangeList)' parameters: - id: changes - type: - description: | - Plan changes to queue up. + type: ActionChangeList + description: Plan changes to queue up. extends: DialogContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScope.yml index c5f427bb..410eda9e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScope.yml @@ -7,24 +7,21 @@ summary: >- Continue and Break semantics. fullName: ActionScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ActionScope(Dialog[])' + - name: ActionScope(Dialog<{}>[]) uid: botbuilder-dialogs-adaptive.ActionScope.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `ActionScope` instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ActionScope(actions?: Dialog[])' + content: 'new ActionScope(actions?: Dialog<{}>[])' parameters: - id: actions - type: 'Dialog[]' - description: | - The actions for the scope. + type: Dialog<{}>[] + description: The actions for the scope. properties: - name: actions uid: botbuilder-dialogs-adaptive.ActionScope.actions @@ -32,82 +29,77 @@ properties: summary: The actions to execute. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.ActionScope.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn + type: Dialog<{}>[] - name: id uid: botbuilder-dialogs-adaptive.ActionScope.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.ActionScope.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.ActionScope.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ActionScope.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ActionScope' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: <O> + inheritanceDescription: Inherited From Dialog.configure + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ActionScope.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -136,35 +128,32 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.endDialog - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ActionScope.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -183,10 +172,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ActionScope.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -207,38 +196,35 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.ActionScope.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -250,7 +236,7 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ActionScope.continueDialog package: botbuilder-dialogs-adaptive @@ -260,10 +246,11 @@ methods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -272,23 +259,26 @@ methods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ActionScopeConfiguration) uid: botbuilder-dialogs-adaptive.ActionScope.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ActionScopeConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ActionScopeConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.ActionScope.getDependencies package: botbuilder-dialogs-adaptive @@ -297,13 +287,12 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] - name: getVersion() uid: botbuilder-dialogs-adaptive.ActionScope.getVersion package: botbuilder-dialogs-adaptive @@ -313,7 +302,6 @@ methods: changes between turns the dialog system will emit a DialogChanged event. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -322,19 +310,18 @@ methods: Unique `string` which should only change when dialog has changed in a way that should restart the dialog. type: string - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ActionScope.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -344,8 +331,8 @@ methods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- @@ -353,5 +340,5 @@ methods: of the value returned is dependent on the child dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeCommands.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeCommands.yml index 5cd14cad..b1558aa4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeCommands.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeCommands.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ActionScopeCommands remarks: '' -isPreview: false isDeprecated: false fields: - name: BreakLoop diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeConfiguration.yml index ee0c2f61..02aadd06 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ActionScopeConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,13 +14,12 @@ properties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.ActionScopeConfiguration.id @@ -29,7 +27,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeResult.yml index 6f3410e3..a9dfa672 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionScopeResult.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ActionScopeResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: actionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actionId?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: actionScopeCommand remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actionScopeCommand: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionState.yml deleted file mode 100644 index 25bc606a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActionState.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: ActionState -uid: botbuilder-dialogs-adaptive.ActionState -package: botbuilder-dialogs-adaptive -summary: '' -fullName: ActionState -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: dialogId - uid: botbuilder-dialogs-adaptive.ActionState.dialogId - package: botbuilder-dialogs-adaptive - summary: '' - fullName: dialogId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dialogId: string' - return: - description: '' - type: string - - name: options - uid: botbuilder-dialogs-adaptive.ActionState.options - package: botbuilder-dialogs-adaptive - summary: '' - fullName: options - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'options?: object' - return: - description: '' - type: object -inheritedProperties: - - name: dialogStack - uid: botbuilder-dialogs-adaptive.ActionState.dialogStack - package: botbuilder-dialogs-adaptive - summary: >- - Contains state information for each - [Dialog](xref:botbuilder-dialogs.Dialog) on the stack. - fullName: dialogStack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'dialogStack: DialogInstance[]' - return: - description: '' - type: 'DialogInstance[]' - inheritanceDescription: Inherited From DialogState.dialogStack -extends: DialogState diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplate.yml index 5f45b1f1..3c997db9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplate.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplate.yml @@ -9,7 +9,6 @@ summary: >- and processed through registered language generator. fullName: ActivityTemplate remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,15 +17,13 @@ constructors: package: botbuilder-dialogs-adaptive summary: Initialize a new instance of ActivityTemplate class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ActivityTemplate(template?: string)' parameters: - id: template type: string - description: | - The template to evaluate to create the activity. + description: The template to evaluate to create the activity. properties: - name: $kind uid: botbuilder-dialogs-adaptive.ActivityTemplate.$kind @@ -34,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -47,7 +43,6 @@ properties: summary: Gets or sets the template to evaluate to create the activity. fullName: template remarks: '' - isPreview: false isDeprecated: false syntax: content: 'template: string' @@ -60,7 +55,6 @@ properties: summary: '' fullName: toString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'toString: () => string' @@ -68,12 +62,11 @@ properties: description: '' type: () => string methods: - - name: 'bind(DialogContext, DialogStateManager)' + - name: bind(DialogContext, DialogStateManager) uid: botbuilder-dialogs-adaptive.ActivityTemplate.bind package: botbuilder-dialogs-adaptive summary: Bind data to template. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -94,10 +87,11 @@ methods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: ActivityTemplateConguration): this' + content: >- + function configure(config: ActivityTemplateConguration): + ActivityTemplate parameters: - id: config type: >- @@ -106,20 +100,23 @@ methods: description: The configuration. return: description: A object with the given configuration. - type: this - - name: getConverter(Object) + type: + - name: getConverter("template") uid: botbuilder-dialogs-adaptive.ActivityTemplate.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: Object): Converter | ConverterFactory' + content: >- + function getConverter(_property: "template"): Converter | ConverterFactory parameters: - id: _property - type: Object + type: '"template"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConguration.yml index 13824727..f8252532 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ActivityTemplateConguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: template remarks: '' - isPreview: false isDeprecated: false syntax: content: 'template?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConverter.yml deleted file mode 100644 index 22c22459..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ActivityTemplateConverter.yml +++ /dev/null @@ -1,38 +0,0 @@ -### YamlMime:TSType -name: ActivityTemplateConverter -uid: botbuilder-dialogs-adaptive.ActivityTemplateConverter -package: botbuilder-dialogs-adaptive -summary: >- - Activity template converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: ActivityTemplateConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: convert(Input | Output) - uid: botbuilder-dialogs-adaptive.ActivityTemplateConverter.convert - package: botbuilder-dialogs-adaptive - summary: >- - Converts a template to one of the following classes - [ActivityTemplate](xref:botbuilder-dialogs-adaptive.ActivityTemplate) | - [StaticActivityTemplate](xref:botbuilder-dialogs-adaptive.Static.ActivityTemplate) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: Input | Output): Output' - parameters: - - id: value - type: >- - | - description: The template to evaluate to create the activity. - return: - description: >- - A new instance that could be the following classes - [ActivityTemplate](xref:botbuilder-dialogs-adaptive.ActivityTemplate) - | - [StaticActivityTemplate](xref:botbuilder-dialogs-adaptive.Static.ActivityTemplate). - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveBotComponent.yml index 4e958145..a524b11d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveBotComponent.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '[BotComponent](xref:botbuilder-core.BotComponent) for adaptive components.' fullName: AdaptiveBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,21 +14,19 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: botbuilder-dialogs-adaptive.AdaptiveBotComponent.configureServices package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,6 +38,5 @@ methods: description: Services Collection to register. - id: _configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialog.yml index 7b06b586..f3f2d03f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialog.yml @@ -7,24 +7,21 @@ summary: >- dynamically to changing conversation flow. fullName: AdaptiveDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: AdaptiveDialog(string) + - name: AdaptiveDialog(string) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `AdaptiveDialog` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AdaptiveDialog(dialogId?: string)' parameters: - id: dialogId type: string - description: | - (Optional) unique ID of the component within its parents dialog set. + description: (Optional) unique ID of the component within its parents dialog set. properties: - name: $kind uid: botbuilder-dialogs-adaptive.AdaptiveDialog.$kind @@ -32,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -52,7 +48,6 @@ properties: simply end the turn and still be active. Defaults to a value of true. - isPreview: false isDeprecated: false syntax: content: 'autoEndDialog: BoolExpression' @@ -65,7 +60,6 @@ properties: summary: '' fullName: conditionTracker remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static conditionTracker: string' @@ -80,7 +74,6 @@ properties: no more Actions and `AutoEndDialog = true`. fullName: defaultResultProperty remarks: Defaults to a value of `dialog.result`. - isPreview: false isDeprecated: false syntax: content: 'defaultResultProperty: string' @@ -93,20 +86,32 @@ properties: summary: Optional. Language Generator override. fullName: generator remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'generator?: LanguageGenerator' + content: 'generator?: LanguageGenerator>' return: description: '' - type: + type: >- + <unknown, Record<string, unknown>> + - name: id + uid: botbuilder-dialogs-adaptive.AdaptiveDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: recognizer uid: botbuilder-dialogs-adaptive.AdaptiveDialog.recognizer package: botbuilder-dialogs-adaptive summary: Optional. Recognizer used to analyze any message utterances. fullName: recognizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizer?: Recognizer' @@ -116,12 +121,9 @@ properties: - name: schema uid: botbuilder-dialogs-adaptive.AdaptiveDialog.schema package: botbuilder-dialogs-adaptive - summary: |- - Sets the JSON Schema for the dialog. - Gets the JSON Schema for the dialog. + summary: Gets the JSON Schema for the dialog. fullName: schema remarks: '' - isPreview: false isDeprecated: false syntax: content: object schema @@ -134,26 +136,38 @@ properties: summary: Optional. The selector for picking the possible events to execute. fullName: selector remarks: '' - isPreview: false isDeprecated: false syntax: content: 'selector: TriggerSelector' return: description: '' type: + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.AdaptiveDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Get the current telemetry client. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: triggers uid: botbuilder-dialogs-adaptive.AdaptiveDialog.triggers package: botbuilder-dialogs-adaptive summary: Trigger handlers to respond to conditions which modify the executing plan. fullName: triggers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'triggers: OnCondition[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: dialogs uid: botbuilder-dialogs-adaptive.AdaptiveDialog.dialogs @@ -161,7 +175,6 @@ inheritedProperties: summary: The containers dialog set. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -180,78 +193,47 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.AdaptiveDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.AdaptiveDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From DialogContainer.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: Inherited From DialogContainer.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AdaptiveDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From DialogContainer.configure - name: findDialog(string) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.findDialog package: botbuilder-dialogs-adaptive summary: Finds a child dialog that was previously added to the container. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function findDialog(dialogId: string): Dialog | undefined' + content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog to lookup. return: description: The Dialog if found; otherwise null. - type: Dialog | undefined + type: undefined | Dialog<{}> inheritanceDescription: Inherited From DialogContainer.findDialog - name: getVersion() uid: botbuilder-dialogs-adaptive.AdaptiveDialog.getVersion @@ -275,7 +257,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -284,15 +265,14 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: Inherited From DialogContainer.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: |- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -312,17 +292,16 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: Inherited From DialogContainer.onDialogEvent methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.beginDialog package: botbuilder-dialogs-adaptive summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -331,10 +310,10 @@ methods: current turn of conversation. - id: options type: O - description: 'Optional, initial information to pass to the dialog.' + description: Optional, initial information to pass to the dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.continueDialog package: botbuilder-dialogs-adaptive @@ -344,10 +323,11 @@ methods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -356,7 +336,7 @@ methods: current turn of conversation. return: description: A Promise representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: createChildContext(DialogContext) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.createChildContext package: botbuilder-dialogs-adaptive @@ -364,7 +344,6 @@ methods: Creates a child [DialogContext](xref:botbuilder-dialogs.DialogContext) for the given context. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createChildContext(dc: DialogContext): DialogContext' @@ -381,23 +360,22 @@ methods: [AdaptiveDialogState.actions](xref:botbuilder-dialogs-adaptive.AdaptiveDialogState.actions) are found for the given context. type: DialogContext - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.endDialog package: botbuilder-dialogs-adaptive summary: Called when the dialog is ending. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(turnContext: TurnContext, instance: DialogInstance, - reason: DialogReason): Promise + function endDialog(turnContext: TurnContext, instance: + DialogInstance, reason: DialogReason): Promise parameters: - id: turnContext type: TurnContext description: The context object for this turn. - id: instance - type: DialogInstance + type: DialogInstance<any> description: >- State information associated with the instance of this dialog on the dialog stack. @@ -407,68 +385,68 @@ methods: return: description: A Promise representing the asynchronous operation. type: Promise<void> - - name: getConverter(Object) + - name: getConverter(keyof AdaptiveDialogConfiguration) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof AdaptiveDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof AdaptiveDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.AdaptiveDialog.getDependencies package: botbuilder-dialogs-adaptive - summary: 'Gets [Dialog](xref:botbuilder-dialogs.Dialog) enumerated dependencies.' + summary: Gets [Dialog](xref:botbuilder-dialogs.Dialog) enumerated dependencies. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: '(xref:botbuilder-dialogs.Dialog)''s enumerated dependencies.' - type: 'Dialog[]' - - name: 'repromptDialog(DialogContext | TurnContext, DialogInstance)' + description: '[Dialog](xref:botbuilder-dialogs.Dialog)''s enumerated dependencies.' + type: Dialog<{}>[] + - name: repromptDialog(DialogContext | TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.repromptDialog package: botbuilder-dialogs-adaptive summary: Reprompts the user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(context: DialogContext | TurnContext, instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: context type: DialogContext | TurnContext description: The context object for the turn. - id: instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. return: description: A Promise representing the asynchronous operation. type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.AdaptiveDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child dialog completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason?: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -483,5 +461,5 @@ methods: The type of the value returned is dependent on the child dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> extends: DialogContainer<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogConfiguration.yml index f4e2040f..b5b27bb5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: AdaptiveDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: autoEndDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autoEndDialog?: BoolProperty' @@ -29,7 +27,6 @@ properties: summary: '' fullName: defaultResultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultResultProperty?: string' @@ -42,33 +39,32 @@ properties: summary: '' fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'dialogs?: string[] | Dialog[] | DialogSet' + content: 'dialogs?: DialogSet | string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[] | DialogSet' + type: DialogSet | string[] | Dialog<{}>[] - name: generator uid: botbuilder-dialogs-adaptive.AdaptiveDialogConfiguration.generator package: botbuilder-dialogs-adaptive summary: '' fullName: generator remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'generator?: string | LanguageGenerator' + content: 'generator?: string | LanguageGenerator>' return: description: '' - type: string | + type: >- + string | <unknown, Record<string, unknown>> - name: recognizer uid: botbuilder-dialogs-adaptive.AdaptiveDialogConfiguration.recognizer package: botbuilder-dialogs-adaptive summary: '' fullName: recognizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizer?: string | Recognizer' @@ -81,7 +77,6 @@ properties: summary: '' fullName: schema remarks: '' - isPreview: false isDeprecated: false syntax: content: 'schema?: unknown' @@ -94,7 +89,6 @@ properties: summary: '' fullName: selector remarks: '' - isPreview: false isDeprecated: false syntax: content: 'selector?: TriggerSelector' @@ -107,13 +101,12 @@ properties: summary: '' fullName: triggers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'triggers?: OnCondition[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.AdaptiveDialogConfiguration.id @@ -121,7 +114,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -135,7 +127,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogState.yml deleted file mode 100644 index da78062a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveDialogState.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSType -name: AdaptiveDialogState -uid: botbuilder-dialogs-adaptive.AdaptiveDialogState -package: botbuilder-dialogs-adaptive -summary: '' -fullName: AdaptiveDialogState -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: actions - uid: botbuilder-dialogs-adaptive.AdaptiveDialogState.actions - package: botbuilder-dialogs-adaptive - summary: '' - fullName: actions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'actions?: ActionState[]' - return: - description: '' - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveEvents.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveEvents.yml index 3be9a719..5b30960b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveEvents.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveEvents.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Adaptive event identifier definition list. fullName: AdaptiveEvents remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: Raised when an entity should be assigned to a property. fullName: assignEntity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static assignEntity: "assignEntity" = "assignEntity"' @@ -28,7 +26,6 @@ properties: summary: Raised when there are multiple possible resolutions of an entity. fullName: chooseEntity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static chooseEntity: "chooseEntity" = "chooseEntity"' @@ -41,7 +38,6 @@ properties: summary: aised when there are multiple possible entity to property mappings. fullName: chooseProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static chooseProperty: "chooseProperty" = "chooseProperty"' @@ -54,7 +50,6 @@ properties: summary: Raised when all actions and ambiguity events have been finished. fullName: endOfActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static endOfActions: "endOfActions" = "endOfActions"' @@ -67,7 +62,6 @@ properties: summary: Raised when intent is recognized from utterance. fullName: recognizedIntent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static recognizedIntent: "recognizedIntent" = "recognizedIntent"' @@ -80,7 +74,6 @@ properties: summary: Raised when utterance is received. fullName: recognizeUtterance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static recognizeUtterance: "recognizeUtterance" = "recognizeUtterance"' @@ -93,7 +86,6 @@ properties: summary: Raised when no intent can be recognized from utterance. fullName: unknownIntent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static unknownIntent: "unknownIntent" = "unknownIntent"' @@ -109,7 +101,6 @@ inheritedProperties: reprocess an activity.) fullName: activityReceived remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static activityReceived: "activityReceived" = "activityReceived"' @@ -125,7 +116,6 @@ inheritedProperties: been called. fullName: beginDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static beginDialog: "beginDialog" = "beginDialog"' @@ -139,7 +129,6 @@ inheritedProperties: summary: Event fired when a dialog is being canceled. fullName: cancelDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static cancelDialog: "cancelDialog" = "cancelDialog"' @@ -153,7 +142,6 @@ inheritedProperties: summary: Event fired when there was an exception thrown in the system. fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static error: "error" = "error"' @@ -167,7 +155,6 @@ inheritedProperties: summary: Event fired when `DialogContext.repromptDialog()` is called. fullName: repromptDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static repromptDialog: "repromptDialog" = "repromptDialog"' @@ -183,7 +170,6 @@ inheritedProperties: the execution of dialogs between turns. fullName: versionChanged remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static versionChanged: "versionChanged" = "versionChanged"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizer.yml index d03def7c..a1377739 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Base class for adaptive recognizers. fullName: AdaptiveRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -31,7 +29,6 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -47,7 +44,6 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -56,42 +52,44 @@ inheritedProperties: type: BotTelemetryClient inheritanceDescription: Inherited From Recognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AdaptiveRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Recognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.AdaptiveRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From Recognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -99,7 +97,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,12 +111,11 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' - description: | - Additional metrics to be logged to telemetry with event. + type: Record<string, number> + description: Additional metrics to be logged to telemetry with event. return: description: '' type: Promise<RecognizerResult> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizerConfiguration.yml index 09a7c6b9..b55774fd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AdaptiveRecognizerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: AdaptiveRecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation?: BoolExpression' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AgeEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AgeEntityRecognizer.yml index 7a1df2b9..7d48af13 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AgeEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AgeEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes age input. fullName: AgeEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.AgeEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.AgeEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,52 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.AgeEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AgeEntityRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.AgeEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +110,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +124,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.AgeEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +158,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayChangeType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayChangeType.yml index e0b9210f..cfe4b1f9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayChangeType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayChangeType.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ArrayChangeType remarks: '' -isPreview: false isDeprecated: false fields: - name: clear diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayProperty.yml index 4a625b1e..54cd98b0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ArrayProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ArrayProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type ArrayProperty = T[] | ArrayExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Ask.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Ask.yml index 39e51911..8c8b1b9f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Ask.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Ask.yml @@ -15,30 +15,28 @@ summary: >- through `DialogPath.expectedProperties`. `DialogPath.retries` is updated as the same question is asked multiple times. -fullName: Ask +fullName: Ask remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Ask(string, ArrayExpression)' + - name: Ask(string, ArrayExpression) uid: botbuilder-dialogs-adaptive.Ask.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [Ask](xref:botbuilder-dialogs-adaptive.Ask) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Ask(text?: string, expectedProperties?: ArrayExpression)' parameters: - id: text type: string - description: 'Optional, text value.' + description: Optional, text value. - id: expectedProperties type: ArrayExpression<string> - description: > + description: >- Optional, [ArrayExpression](xref:adaptive-expressions.ArrayExpression) of expected properties. @@ -49,7 +47,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -64,7 +61,6 @@ properties: recognized. fullName: defaultOperation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultOperation: StringExpression' @@ -77,13 +73,38 @@ properties: summary: Gets or sets properties expected to be filled by response. fullName: expectedProperties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expectedProperties: ArrayExpression' return: description: '' type: ArrayExpression<string> + - name: id + uid: botbuilder-dialogs-adaptive.Ask.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.Ask.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activity uid: botbuilder-dialogs-adaptive.Ask.activity @@ -91,13 +112,16 @@ inheritedProperties: summary: Gets or sets template for the activity. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'activity: TemplateInterface, D & O>' + content: >- + activity: TemplateInterface, DialogStateManager & { + utterance: string }> return: description: '' - type: 'TemplateInterface<Partial<Activity>, D & O>' + type: >- + TemplateInterface<Partial<Activity>, DialogStateManager & { + utterance: string }> inheritanceDescription: >- Inherited From [SendActivity.activity](xref:botbuilder-dialogs-adaptive.SendActivity.activity) @@ -107,7 +131,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -128,66 +151,40 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.Ask.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.Ask.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [SendActivity.EndOfTurn](xref:botbuilder-dialogs-adaptive.SendActivity.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.Ask.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): Ask' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [SendActivity.configure](xref:botbuilder-dialogs-adaptive.SendActivity.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.Ask.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -211,20 +208,22 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [SendActivity.continueDialog](xref:botbuilder-dialogs-adaptive.SendActivity.continueDialog) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.Ask.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -253,27 +252,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [SendActivity.endDialog](xref:botbuilder-dialogs-adaptive.SendActivity.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.Ask.getVersion package: botbuilder-dialogs-adaptive @@ -296,7 +295,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -305,15 +303,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [SendActivity.getVersion](xref:botbuilder-dialogs-adaptive.SendActivity.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.Ask.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -331,11 +330,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [SendActivity.onDialogEvent](xref:botbuilder-dialogs-adaptive.SendActivity.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.Ask.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -356,25 +357,25 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [SendActivity.repromptDialog](xref:botbuilder-dialogs-adaptive.SendActivity.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.Ask.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -414,12 +415,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -431,24 +431,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.resumeDialog + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [SendActivity.resumeDialog](xref:botbuilder-dialogs-adaptive.SendActivity.resumeDialog) methods: - - name: 'beginDialog(DialogContext, object)' + - name: beginDialog(DialogContext, object) uid: botbuilder-dialogs-adaptive.Ask.beginDialog package: botbuilder-dialogs-adaptive summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: object): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -460,23 +460,26 @@ methods: description: (Optional) Initial information to pass to the dialog. return: description: A promise resolving to the turn result - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof AskConfiguration) uid: botbuilder-dialogs-adaptive.Ask.getConverter package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof AskConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof AskConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AskConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AskConfiguration.yml index c0644268..185b087c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AskConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AskConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: AskConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: defaultOperation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultOperation?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: expectedProperties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expectedProperties?: ArrayProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity?: TemplateInterfaceProperty, D>' @@ -60,7 +56,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -76,26 +71,28 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [SendActivityConfiguration.id](xref:botbuilder-dialogs-adaptive.SendActivityConfiguration.id) - name: telemetryClient uid: botbuilder-dialogs-adaptive.AskConfiguration.telemetryClient package: botbuilder-dialogs-adaptive summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [SendActivityConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.SendActivityConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AssignmentInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AssignmentInput.yml deleted file mode 100644 index 33b3d4c7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AssignmentInput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: AssignmentInput -uid: botbuilder-dialogs-adaptive.AssignmentInput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: AssignmentInput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AssignmentInput = { property: string, value: T } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInput.yml index a3bf9ab1..85b2cf6f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInput.yml @@ -3,32 +3,30 @@ name: AttachmentInput uid: botbuilder-dialogs-adaptive.AttachmentInput package: botbuilder-dialogs-adaptive summary: Input dialog which prompts the user to send a file. -fullName: AttachmentInput +fullName: AttachmentInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AttachmentInput(string, Partial | string)' + - name: AttachmentInput(string, string | Partial) uid: botbuilder-dialogs-adaptive.AttachmentInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new AttachmentInput(property?: string, prompt?: Partial | - string) + new AttachmentInput(property?: string, prompt?: string | + Partial) parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -41,20 +39,30 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' return: description: '' type: string + - name: id + uid: botbuilder-dialogs-adaptive.AttachmentInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: outputFormat uid: botbuilder-dialogs-adaptive.AttachmentInput.outputFormat package: botbuilder-dialogs-adaptive summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat: EnumExpression' @@ -63,6 +71,20 @@ properties: type: >- EnumExpression<> + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.AttachmentInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: allowInterruptions uid: botbuilder-dialogs-adaptive.AttachmentInput.allowInterruptions @@ -70,7 +92,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -88,7 +109,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -104,7 +124,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -122,7 +141,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,7 +148,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -140,7 +158,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -161,28 +178,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.AttachmentInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.AttachmentInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -191,13 +195,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -209,7 +212,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -225,7 +227,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -241,13 +242,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -257,7 +257,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -267,27 +266,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.AttachmentInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.AttachmentInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -303,7 +287,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -311,7 +294,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -321,13 +304,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -337,7 +319,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -353,7 +334,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -364,19 +344,18 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.AttachmentInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -392,29 +371,30 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.beginDialog](xref:botbuilder-dialogs-adaptive.InputDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.AttachmentInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AttachmentInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.AttachmentInput.continueDialog package: botbuilder-dialogs-adaptive @@ -422,10 +402,11 @@ inheritedMethods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -436,11 +417,11 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.continueDialog](xref:botbuilder-dialogs-adaptive.InputDialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.AttachmentInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -469,27 +450,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.AttachmentInput.getVersion package: botbuilder-dialogs-adaptive @@ -512,7 +493,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -521,15 +501,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.AttachmentInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -547,11 +528,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.AttachmentInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -572,37 +555,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.AttachmentInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -612,8 +594,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -625,25 +607,28 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: getConverter(Object) + - name: getConverter(keyof AttachmentInputConfiguration) uid: botbuilder-dialogs-adaptive.AttachmentInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof AttachmentInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof AttachmentInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInputConfiguration.yml index 4e56bb98..da30544b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: AttachmentInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: EnumProperty' @@ -32,7 +30,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -48,7 +45,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -64,13 +60,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -81,7 +76,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -101,7 +95,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -117,21 +110,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.AttachmentInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -151,7 +144,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -167,7 +159,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -187,7 +178,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -203,14 +193,15 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: >- botbuilder-dialogs-adaptive.AttachmentInputConfiguration.unrecognizedPrompt @@ -218,7 +209,6 @@ inheritedProperties: summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -238,13 +228,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -254,13 +243,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentOutputFormat.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentOutputFormat.yml index b746e441..a9dbde70 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentOutputFormat.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/AttachmentOutputFormat.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: AttachmentOutputFormat remarks: '' -isPreview: false isDeprecated: false fields: - name: all diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialog.yml index ad1fff2b..40c5b265 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialog.yml @@ -2,14 +2,13 @@ name: BaseInvokeDialog uid: botbuilder-dialogs-adaptive.BaseInvokeDialog package: botbuilder-dialogs-adaptive -summary: 'Action which calls another [Dialog](xref:botbuilder-dialogs.Dialog).' +summary: Action which calls another [Dialog](xref:botbuilder-dialogs.Dialog). fullName: BaseInvokeDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BaseInvokeDialog(string, O)' + - name: BaseInvokeDialog(string, O) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,7 +16,6 @@ constructors: [BaseInvokeDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BaseInvokeDialog(dialogIdToCall?: string, bindingOptions?: O)' @@ -27,8 +25,7 @@ constructors: description: The dialog id. - id: bindingOptions type: O - description: | - (optional) Binding options. + description: (optional) Binding options. properties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.activityProcessed @@ -38,7 +35,6 @@ properties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' @@ -51,26 +47,50 @@ properties: summary: The dialog to call. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog: DialogExpression' return: description: '' type: + - name: id + uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: options uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.options package: botbuilder-dialogs-adaptive summary: Configurable options for the dialog. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: ObjectExpression' return: description: '' type: ObjectExpression<object> + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.EndOfTurn @@ -83,66 +103,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): BaseInvokeDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -166,20 +156,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -208,23 +198,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -251,7 +239,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -261,14 +248,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -287,10 +273,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -311,25 +297,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -369,12 +353,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -386,21 +369,19 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: Method not implemented. - isPreview: false isDeprecated: false syntax: content: >- @@ -414,27 +395,29 @@ methods: current turn of conversation. - id: _options type: O - description: | - Optional. Initial information to pass to the dialog. + description: Optional. Initial information to pass to the dialog. return: description: '' type: Promise<DialogTurnResult<any>> - - name: getConverter(Object) + - name: getConverter(keyof BaseInvokeDialogConfiguration) uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof BaseInvokeDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof BaseInvokeDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.BaseInvokeDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -443,11 +426,10 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog<__type>[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog<__type>[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialogConfiguration.yml index 82088bb5..908c83dc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BaseInvokeDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: BaseInvokeDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed?: BoolProperty' @@ -29,7 +27,6 @@ properties: summary: '' fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog?: DialogProperty' @@ -42,7 +39,6 @@ properties: summary: '' fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options?: ObjectProperty' @@ -58,7 +54,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -72,7 +67,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialog.yml index e3df7ff8..cef2ddca 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialog.yml @@ -8,16 +8,14 @@ summary: >- the caller. fullName: BeginDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BeginDialog(string, O)' + - name: BeginDialog(string, O) uid: botbuilder-dialogs-adaptive.BeginDialog.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `BeginDialog` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BeginDialog(dialogIdToCall: string, options?: O)' @@ -27,8 +25,7 @@ constructors: description: ID of the dialog to call. - id: options type: O - description: | - (Optional) static options to pass the called dialog. + description: (Optional) static options to pass the called dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.BeginDialog.$kind @@ -36,7 +33,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -49,26 +45,50 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.BeginDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: resultProperty uid: botbuilder-dialogs-adaptive.BeginDialog.resultProperty package: botbuilder-dialogs-adaptive summary: (Optional) property path to store the dialog result in. fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty?: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.BeginDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.BeginDialog.activityProcessed @@ -78,7 +98,6 @@ inheritedProperties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' @@ -94,7 +113,6 @@ inheritedProperties: summary: The dialog to call. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog: DialogExpression' @@ -115,35 +133,21 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.BeginDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.EndOfTurn) - name: options uid: botbuilder-dialogs-adaptive.BeginDialog.options package: botbuilder-dialogs-adaptive summary: Configurable options for the dialog. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: ObjectExpression' @@ -153,44 +157,31 @@ inheritedProperties: inheritanceDescription: >- Inherited From [BaseInvokeDialog.options](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.options) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.BeginDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.BeginDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): BeginDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.configure](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.BeginDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -214,20 +205,22 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.continueDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.continueDialog) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.BeginDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -256,27 +249,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.endDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.endDialog) - name: getDependencies() uid: botbuilder-dialogs-adaptive.BeginDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -285,13 +278,12 @@ inheritedMethods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog<__type>[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog<__type>[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [BaseInvokeDialog.getDependencies](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getDependencies) @@ -317,7 +309,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -326,15 +317,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.getVersion](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.BeginDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -352,11 +344,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.BeginDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -377,38 +371,37 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.repromptDialog) methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.BeginDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -420,36 +413,38 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof BeginDialogConfiguration) uid: botbuilder-dialogs-adaptive.BeginDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof BeginDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof BeginDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - - name: 'resumeDialog(DialogContext, DialogReason, any)' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.BeginDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -459,8 +454,8 @@ methods: - id: reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- @@ -468,5 +463,5 @@ methods: of the value returned is dependent on the child dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialogConfiguration.yml index 0618755e..ad276441 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: BeginDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty?: StringProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed?: BoolProperty' @@ -58,7 +54,6 @@ inheritedProperties: summary: '' fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog?: DialogProperty' @@ -74,21 +69,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [BaseInvokeDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration.id) - name: options uid: botbuilder-dialogs-adaptive.BeginDialogConfiguration.options package: botbuilder-dialogs-adaptive summary: '' fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options?: ObjectProperty' @@ -106,12 +101,13 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [BaseInvokeDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkill.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkill.yml index 1d77d862..beb9d89d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkill.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkill.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Begin a Skill. fullName: BeginSkill remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botbuilder-dialogs-adaptive summary: Creates a new `BeginSkillDialog instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BeginSkill(options?: SkillDialogOptions)' parameters: - id: options type: SkillDialogOptions - description: | - Optional options used to configure the skill dialog. + description: Optional options used to configure the skill dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.BeginSkill.$kind @@ -30,7 +27,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -43,13 +39,12 @@ properties: summary: Template for the activity. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: activityProcessed uid: botbuilder-dialogs-adaptive.BeginSkill.activityProcessed package: botbuilder-dialogs-adaptive @@ -60,7 +55,6 @@ properties: look at the activity. You can set this to false to dispatch the activity to the new dialog. - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' @@ -73,7 +67,6 @@ properties: summary: The interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -88,7 +81,6 @@ properties: remarks: >- Defauls to a value of `=settings.MicrosoftAppId` which retrievs the bots ID from settings. - isPreview: false isDeprecated: false syntax: content: 'botId: StringExpression' @@ -101,7 +93,6 @@ properties: summary: Optional. The OAuth Connection Name for the Parent Bot. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: StringExpression' @@ -114,20 +105,30 @@ properties: summary: Optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.BeginSkill.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: resultProperty uid: botbuilder-dialogs-adaptive.BeginSkill.resultProperty package: botbuilder-dialogs-adaptive summary: Optional property path to store the dialog result in. fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty?: StringExpression' @@ -140,7 +141,6 @@ properties: summary: The Microsoft App ID for the skill. fullName: skillAppId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillAppId: StringExpression' @@ -153,7 +153,6 @@ properties: summary: The `/api/messages` endpoint for the skill. fullName: skillEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillEndpoint: StringExpression' @@ -168,13 +167,26 @@ properties: remarks: >- Defauls to a value of `=settings.SkillHostEndpoint` which retrieves the endpoint from settings. - isPreview: false isDeprecated: false syntax: content: 'skillHostEndpoint: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.BeginSkill.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.BeginSkill.EndOfTurn @@ -187,62 +199,32 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.BeginSkill.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.BeginSkill.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: Inherited From SkillDialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.BeginSkill.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): BeginSkill' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From SkillDialog.configure - name: getVersion() uid: botbuilder-dialogs-adaptive.BeginSkill.getVersion package: botbuilder-dialogs-adaptive @@ -265,7 +247,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -274,15 +255,14 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: Inherited From SkillDialog.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.BeginSkill.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -300,21 +280,20 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent + inheritanceDescription: Inherited From SkillDialog.onDialogEvent methods: - - name: 'beginDialog(DialogContext, BeginSkillDialogOptions)' + - name: beginDialog(DialogContext, BeginSkillDialogOptions) uid: botbuilder-dialogs-adaptive.BeginSkill.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: - BeginSkillDialogOptions): Promise + BeginSkillDialogOptions): Promise> parameters: - id: dc type: DialogContext @@ -326,7 +305,7 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.BeginSkill.continueDialog package: botbuilder-dialogs-adaptive @@ -336,10 +315,11 @@ methods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -348,86 +328,89 @@ methods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.BeginSkill.endDialog package: botbuilder-dialogs-adaptive - summary: 'Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is ending.' + summary: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is ending. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(turnContext: TurnContext, instance: DialogInstance, - reason: DialogReason): Promise + function endDialog(turnContext: TurnContext, instance: + DialogInstance, reason: DialogReason): Promise parameters: - id: turnContext type: TurnContext description: >- - (xref:botbuilder-core.TurnContext), the context object for this - turn. + [TurnContext](xref:botbuilder-core.TurnContext), the context object + for this turn. - id: instance - type: DialogInstance + type: DialogInstance<any> description: >- - (xref:botbuilder-dialogs.DialogInstance), state information - associated with the instance of this dialog on the dialog stack. + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), state + information associated with the instance of this dialog on the + dialog stack. - id: reason type: DialogReason - description: '(xref:botbuilder-dialogs.DialogReason), reason why the dialog ended.' + description: >- + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog ended. return: description: A `Promise` representing the asynchronous operation. type: Promise<void> - - name: getConverter(Object) + - name: getConverter(keyof BeginSkillConfiguration) uid: botbuilder-dialogs-adaptive.BeginSkill.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof BeginSkillConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof BeginSkillConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - - name: 'repromptDialog(TurnContext, DialogInstance)' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.BeginSkill.repromptDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) should re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(turnContext: TurnContext, instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: turnContext type: TurnContext description: >- - (xref:botbuilder-core.TurnContext), the context object for this - turn. + [TurnContext](xref:botbuilder-core.TurnContext), the context object + for this turn. - id: instance - type: DialogInstance + type: DialogInstance<any> description: >- - (xref:botbuilder-dialogs.DialogInstance), state information for this - dialog. + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), state + information for this dialog. return: description: A `Promise` representing the asynchronous operation. type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.BeginSkill.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -442,8 +425,8 @@ methods: - id: reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkillConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkillConfiguration.yml index 6e3b9738..82c1d268 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkillConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BeginSkillConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: BeginSkillConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,7 +30,6 @@ properties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed?: BoolProperty' @@ -45,7 +42,6 @@ properties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -58,7 +54,6 @@ properties: summary: '' fullName: botId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botId?: StringProperty' @@ -71,7 +66,6 @@ properties: summary: '' fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName?: StringProperty' @@ -84,7 +78,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -97,7 +90,6 @@ properties: summary: '' fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty?: StringProperty' @@ -110,7 +102,6 @@ properties: summary: '' fullName: skillAppId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillAppId?: StringProperty' @@ -123,7 +114,6 @@ properties: summary: '' fullName: skillEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillEndpoint?: StringProperty' @@ -136,7 +126,6 @@ properties: summary: '' fullName: skillHostEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillHostEndpoint?: StringProperty' @@ -150,7 +139,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -164,7 +152,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BoolProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BoolProperty.yml index b1fdaab2..118d4a55 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BoolProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BoolProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: BoolProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type BoolProperty = boolean | BoolExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoop.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoop.yml index c27b50c7..24f46f33 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoop.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoop.yml @@ -5,26 +5,23 @@ package: botbuilder-dialogs-adaptive summary: Break out of a loop. fullName: BreakLoop remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: BreakLoop(string) + - name: BreakLoop(string) uid: botbuilder-dialogs-adaptive.BreakLoop.constructor package: botbuilder-dialogs-adaptive summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BreakLoop(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.BreakLoop.$kind @@ -32,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -45,85 +41,80 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.BreakLoop.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.BreakLoop.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.BreakLoop.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.BreakLoop.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.BreakLoop.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): BreakLoop' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.BreakLoop.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -147,20 +138,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.BreakLoop.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -189,23 +180,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -232,7 +221,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -242,14 +230,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.BreakLoop.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -268,10 +255,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.BreakLoop.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -292,25 +279,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.BreakLoop.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -350,12 +335,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -367,26 +351,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.BreakLoop.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -398,21 +380,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof BreakLoopConfiguration) uid: botbuilder-dialogs-adaptive.BreakLoop.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof BreakLoopConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof BreakLoopConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoopConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoopConfiguration.yml index e64471bd..d4d589e0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoopConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/BreakLoopConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: BreakLoopConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -29,7 +27,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogs.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogs.yml index fe411ba2..41bc75a2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogs.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogs.yml @@ -8,23 +8,10 @@ summary: >- propagating. fullName: CancelAllDialogs remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: CancelAllDialogs() - uid: botbuilder-dialogs-adaptive.CancelAllDialogs.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [CancelAllDialogs](xref:botbuilder-dialogs-adaptive.CancelAllDialogs) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new CancelAllDialogs() - - name: 'CancelAllDialogs(string, string)' + - name: CancelAllDialogs(string, string) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.constructor_1 package: botbuilder-dialogs-adaptive summary: >- @@ -32,7 +19,6 @@ constructors: [CancelAllDialogs](xref:botbuilder-dialogs-adaptive.CancelAllDialogs) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CancelAllDialogs(eventName: string, eventValue?: string)' @@ -42,8 +28,7 @@ constructors: description: Expression for event name. - id: eventValue type: string - description: | - Optional. Expression for event value. + description: Optional. Expression for event value. properties: - name: $kind uid: botbuilder-dialogs-adaptive.CancelAllDialogs.$kind @@ -51,13 +36,38 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' return: description: '' type: string + - name: id + uid: botbuilder-dialogs-adaptive.CancelAllDialogs.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.CancelAllDialogs.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.CancelAllDialogs.activityProcessed @@ -67,32 +77,26 @@ inheritedProperties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.activityProcessed](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.activityProcessed) + inheritanceDescription: Inherited From CancelAllDialogsBase.activityProcessed - name: disabled uid: botbuilder-dialogs-adaptive.CancelAllDialogs.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.disabled](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.disabled) + inheritanceDescription: Inherited From CancelAllDialogsBase.disabled - name: EndOfTurn uid: botbuilder-dialogs-adaptive.CancelAllDialogs.EndOfTurn package: botbuilder-dialogs-adaptive @@ -104,88 +108,52 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn + type: DialogTurnResult<any> + inheritanceDescription: Inherited From CancelAllDialogsBase.EndOfTurn - name: eventName uid: botbuilder-dialogs-adaptive.CancelAllDialogs.eventName package: botbuilder-dialogs-adaptive summary: Expression for event name. fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: StringExpression' return: description: '' type: StringExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.eventName](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.eventName) + inheritanceDescription: Inherited From CancelAllDialogsBase.eventName - name: eventValue uid: botbuilder-dialogs-adaptive.CancelAllDialogs.eventValue package: botbuilder-dialogs-adaptive summary: Expression for event value. fullName: eventValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventValue: ValueExpression' return: description: '' type: ValueExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.eventValue](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.eventValue) - - name: id - uid: botbuilder-dialogs-adaptive.CancelAllDialogs.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.CancelAllDialogs.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + inheritanceDescription: Inherited From CancelAllDialogsBase.eventValue inheritedMethods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -197,33 +165,30 @@ inheritedMethods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.beginDialog](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.beginDialog) - - name: 'configure(Record)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From CancelAllDialogsBase.beginDialog + - name: configure(Record) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): CancelAllDialogs' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From CancelAllDialogsBase.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -247,20 +212,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From CancelAllDialogsBase.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -289,46 +254,46 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog - - name: getConverter(Object) + inheritanceDescription: Inherited From CancelAllDialogsBase.endDialog + - name: getConverter(keyof CancelAllDialogsBaseConfiguration) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + CancelAllDialogsBaseConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof CancelAllDialogsBaseConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.getConverter](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.getConverter) + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From CancelAllDialogsBase.getConverter - name: getVersion() uid: botbuilder-dialogs-adaptive.CancelAllDialogs.getVersion package: botbuilder-dialogs-adaptive @@ -351,7 +316,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -360,15 +324,14 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: Inherited From CancelAllDialogsBase.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -386,11 +349,11 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: Inherited From CancelAllDialogsBase.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -411,25 +374,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: Inherited From CancelAllDialogsBase.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.CancelAllDialogs.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -469,12 +430,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -486,10 +446,9 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.resumeDialog -extends: <O> + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From CancelAllDialogsBase.resumeDialog +extends: CancelAllDialogsBase<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBaseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBaseConfiguration.yml index 01f819ff..8760fd67 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBaseConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelAllDialogsBaseConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: CancelAllDialogsBaseConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed?: BoolProperty' @@ -29,7 +27,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -42,7 +39,6 @@ properties: summary: '' fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName?: StringProperty' @@ -55,13 +51,12 @@ properties: summary: '' fullName: eventValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'eventValue?: UnknownProperty' + content: 'eventValue?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.CancelAllDialogsBaseConfiguration.id @@ -69,7 +64,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -84,7 +78,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelDialog.yml index b898fe90..de7e1028 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CancelDialog.yml @@ -8,29 +8,16 @@ summary: >- propagating. fullName: CancelDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: CancelDialog() - uid: botbuilder-dialogs-adaptive.CancelDialog.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [CancelDialog](xref:botbuilder-dialogs-adaptive.CancelDialog) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new CancelDialog() - - name: 'CancelDialog(string, string)' + - name: CancelDialog(string, string) uid: botbuilder-dialogs-adaptive.CancelDialog.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [CancelDialog](xref:botbuilder-dialogs-adaptive.CancelDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CancelDialog(eventName: string, eventValue?: string)' @@ -40,8 +27,7 @@ constructors: description: Expression for event name. - id: eventValue type: string - description: | - Optional. Expression for event value. + description: Optional. Expression for event value. properties: - name: $kind uid: botbuilder-dialogs-adaptive.CancelDialog.$kind @@ -49,13 +35,38 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' return: description: '' type: string + - name: id + uid: botbuilder-dialogs-adaptive.CancelDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.CancelDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.CancelDialog.activityProcessed @@ -65,32 +76,26 @@ inheritedProperties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.activityProcessed](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.activityProcessed) + inheritanceDescription: Inherited From CancelAllDialogsBase.activityProcessed - name: disabled uid: botbuilder-dialogs-adaptive.CancelDialog.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.disabled](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.disabled) + inheritanceDescription: Inherited From CancelAllDialogsBase.disabled - name: EndOfTurn uid: botbuilder-dialogs-adaptive.CancelDialog.EndOfTurn package: botbuilder-dialogs-adaptive @@ -102,88 +107,52 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn + type: DialogTurnResult<any> + inheritanceDescription: Inherited From CancelAllDialogsBase.EndOfTurn - name: eventName uid: botbuilder-dialogs-adaptive.CancelDialog.eventName package: botbuilder-dialogs-adaptive summary: Expression for event name. fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: StringExpression' return: description: '' type: StringExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.eventName](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.eventName) + inheritanceDescription: Inherited From CancelAllDialogsBase.eventName - name: eventValue uid: botbuilder-dialogs-adaptive.CancelDialog.eventValue package: botbuilder-dialogs-adaptive summary: Expression for event value. fullName: eventValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventValue: ValueExpression' return: description: '' type: ValueExpression - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.eventValue](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.eventValue) - - name: id - uid: botbuilder-dialogs-adaptive.CancelDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.CancelDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + inheritanceDescription: Inherited From CancelAllDialogsBase.eventValue inheritedMethods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.CancelDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -195,33 +164,30 @@ inheritedMethods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.beginDialog](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.beginDialog) - - name: 'configure(Record)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From CancelAllDialogsBase.beginDialog + - name: configure(Record) uid: botbuilder-dialogs-adaptive.CancelDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): CancelDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From CancelAllDialogsBase.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.CancelDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -245,20 +211,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From CancelAllDialogsBase.continueDialog + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.CancelDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -287,46 +253,46 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog - - name: getConverter(Object) + inheritanceDescription: Inherited From CancelAllDialogsBase.endDialog + - name: getConverter(keyof CancelAllDialogsBaseConfiguration) uid: botbuilder-dialogs-adaptive.CancelDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + CancelAllDialogsBaseConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof CancelAllDialogsBaseConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: >- - Inherited From - [CancelAllDialogsBase.getConverter](xref:botbuilder-dialogs-adaptive.CancelAllDialogsBase.getConverter) + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From CancelAllDialogsBase.getConverter - name: getVersion() uid: botbuilder-dialogs-adaptive.CancelDialog.getVersion package: botbuilder-dialogs-adaptive @@ -349,7 +315,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -358,15 +323,14 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: Inherited From CancelAllDialogsBase.getVersion + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.CancelDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -384,11 +348,11 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: Inherited From CancelAllDialogsBase.onDialogEvent + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.CancelDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -409,25 +373,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: Inherited From CancelAllDialogsBase.repromptDialog + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.CancelDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -467,12 +429,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -484,10 +445,9 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.resumeDialog -extends: <O> + type: Promise<DialogTurnResult<any>> + inheritanceDescription: Inherited From CancelAllDialogsBase.resumeDialog +extends: CancelAllDialogsBase<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Case.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Case.yml index 3756ecca..8610a304 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Case.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Case.yml @@ -3,40 +3,63 @@ name: Case uid: botbuilder-dialogs-adaptive.Case package: botbuilder-dialogs-adaptive summary: Cases of action scope. -fullName: Case +fullName: Case remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Case(string, Dialog[])' + - name: Case(string, Dialog<{}>[]) uid: botbuilder-dialogs-adaptive.Case.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [Case](xref:botbuilder-dialogs-adaptive.Case) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new Case(value?: string, actions?: Dialog[])' + content: 'new Case(value?: string, actions?: Dialog<{}>[])' parameters: - id: value type: string description: Optional. Case's string value. - id: actions - type: 'Dialog[]' - description: > + type: Dialog<{}>[] + description: >- Optional. Numerable list of [Dialog](xref:botbuilder-dialogs.Dialog) actions. properties: + - name: id + uid: botbuilder-dialogs-adaptive.Case.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.Case.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.Case.value package: botbuilder-dialogs-adaptive summary: Gets or sets value expression to be compared against condition. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' @@ -50,13 +73,12 @@ inheritedProperties: summary: The actions to execute. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [ActionScope.actions](xref:botbuilder-dialogs-adaptive.ActionScope.actions) @@ -71,56 +93,28 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.Case.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.Case.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [ActionScope.EndOfTurn](xref:botbuilder-dialogs-adaptive.ActionScope.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, {}) uid: botbuilder-dialogs-adaptive.Case.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function beginDialog(dc: DialogContext, _options?: O): - Promise + function beginDialog(dc: DialogContext, _options?: {}): + Promise> parameters: - id: dc type: DialogContext @@ -128,33 +122,34 @@ inheritedMethods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: _options - type: O + type: '{}' description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.beginDialog](xref:botbuilder-dialogs-adaptive.ActionScope.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.Case.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): Case' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [ActionScope.configure](xref:botbuilder-dialogs-adaptive.ActionScope.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.Case.continueDialog package: botbuilder-dialogs-adaptive @@ -164,10 +159,11 @@ inheritedMethods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -176,11 +172,11 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.continueDialog](xref:botbuilder-dialogs-adaptive.ActionScope.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.Case.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -209,43 +205,46 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog - - name: getConverter(Object) + inheritanceDescription: >- + Inherited From + [ActionScope.endDialog](xref:botbuilder-dialogs-adaptive.ActionScope.endDialog) + - name: getConverter(keyof ActionScopeConfiguration) uid: botbuilder-dialogs-adaptive.Case.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ActionScopeConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ActionScopeConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From [ActionScope.getConverter](xref:botbuilder-dialogs-adaptive.ActionScope.getConverter) @@ -257,13 +256,12 @@ inheritedMethods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [ActionScope.getDependencies](xref:botbuilder-dialogs-adaptive.ActionScope.getDependencies) @@ -276,7 +274,6 @@ inheritedMethods: changes between turns the dialog system will emit a DialogChanged event. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -288,14 +285,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [ActionScope.getVersion](xref:botbuilder-dialogs-adaptive.ActionScope.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.Case.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -313,11 +309,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [ActionScope.onDialogEvent](xref:botbuilder-dialogs-adaptive.ActionScope.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.Case.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -338,37 +336,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [ActionScope.repromptDialog](xref:botbuilder-dialogs-adaptive.ActionScope.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.Case.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -378,8 +375,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- @@ -387,7 +384,7 @@ inheritedMethods: of the value returned is dependent on the child dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.resumeDialog](xref:botbuilder-dialogs-adaptive.ActionScope.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CaseInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CaseInput.yml deleted file mode 100644 index 10c6e7ad..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CaseInput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: CaseInput -uid: botbuilder-dialogs-adaptive.CaseInput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: CaseInput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CaseInput = { actions: Dialog[], value: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChannelMentionEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChannelMentionEntityRecognizer.yml index 1cdb1fea..c53cb893 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChannelMentionEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChannelMentionEntityRecognizer.yml @@ -7,7 +7,6 @@ summary: >- [RecognizerResult](xref:botbuilder-core.RecognizerResult) format. fullName: ChannelMentionEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -31,14 +29,15 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.id](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.id) - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.ChannelMentionEntityRecognizer.logPersonalInformation @@ -48,7 +47,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -66,51 +64,62 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.telemetryClient](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.telemetryClient) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ChannelMentionEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + ChannelMentionEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.configure](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive.ChannelMentionEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.getConverter](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.getConverter) methods: - name: >- recognize(DialogContext, Partial, Record, @@ -119,7 +128,6 @@ methods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -134,10 +142,10 @@ methods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInput.yml index 7fdc413e..198d1bb7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInput.yml @@ -3,30 +3,28 @@ name: ChoiceInput uid: botbuilder-dialogs-adaptive.ChoiceInput package: botbuilder-dialogs-adaptive summary: ChoiceInput - Declarative input to gather choices from user. -fullName: ChoiceInput +fullName: ChoiceInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ChoiceInput(string, Partial | string)' + - name: ChoiceInput(string, string | Partial) uid: botbuilder-dialogs-adaptive.ChoiceInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ChoiceInput(property?: string, prompt?: Partial | string)' + content: 'new ChoiceInput(property?: string, prompt?: string | Partial)' parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -56,7 +53,6 @@ properties: rendered to the user. fullName: choiceOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choiceOptions?: ObjectExpression' @@ -69,7 +65,6 @@ properties: summary: List of choices to present to user. fullName: choices remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choices: ObjectExpression' @@ -84,20 +79,30 @@ properties: summary: The prompts default locale that should be recognized. fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive.ChoiceInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: outputFormat uid: botbuilder-dialogs-adaptive.ChoiceInput.outputFormat package: botbuilder-dialogs-adaptive summary: Control the format of the response (value or index of the choice). fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat: EnumExpression' @@ -112,7 +117,6 @@ properties: summary: Additional options passed to the underlying `recognizeChoices()` function. fullName: recognizerOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizerOptions?: ObjectExpression' @@ -125,13 +129,26 @@ properties: summary: Style of the "yes" and "no" choices rendered to the user when prompting. fullName: style remarks: Defaults to `ListStyle.auto`. - isPreview: false isDeprecated: false syntax: content: 'style: EnumExpression' return: description: '' type: EnumExpression<ListStyle> + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ChoiceInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: allowInterruptions uid: botbuilder-dialogs-adaptive.ChoiceInput.allowInterruptions @@ -139,7 +156,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -157,7 +173,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -173,7 +188,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -191,7 +205,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -199,7 +212,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -209,7 +222,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -230,28 +242,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ChoiceInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.ChoiceInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -260,13 +259,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -278,7 +276,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -294,7 +291,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -310,13 +306,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -326,7 +321,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -336,27 +330,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ChoiceInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.ChoiceInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -372,7 +351,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -380,7 +358,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -390,13 +368,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -406,7 +383,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -422,7 +398,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -433,19 +408,18 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.ChoiceInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -461,29 +435,30 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.beginDialog](xref:botbuilder-dialogs-adaptive.InputDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ChoiceInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ChoiceInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ChoiceInput.continueDialog package: botbuilder-dialogs-adaptive @@ -491,10 +466,11 @@ inheritedMethods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -505,11 +481,11 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.continueDialog](xref:botbuilder-dialogs-adaptive.InputDialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ChoiceInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -538,27 +514,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.ChoiceInput.getVersion package: botbuilder-dialogs-adaptive @@ -581,7 +557,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -590,15 +565,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ChoiceInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -616,11 +592,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ChoiceInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -641,37 +619,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ChoiceInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -681,8 +658,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -694,25 +671,28 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: getConverter(Object) + - name: getConverter(keyof ChoiceInputConfiguration) uid: botbuilder-dialogs-adaptive.ChoiceInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ChoiceInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ChoiceInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputConfiguration.yml index 2b14e8fd..bbbc1bab 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ChoiceInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: choiceOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choiceOptions?: ObjectProperty' @@ -30,7 +28,6 @@ properties: summary: '' fullName: choices remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choices?: ObjectProperty' @@ -45,7 +42,6 @@ properties: summary: '' fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringProperty' @@ -58,7 +54,6 @@ properties: summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: EnumProperty' @@ -73,7 +68,6 @@ properties: summary: '' fullName: recognizerOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizerOptions?: ObjectProperty' @@ -88,7 +82,6 @@ properties: summary: '' fullName: style remarks: '' - isPreview: false isDeprecated: false syntax: content: 'style?: EnumProperty' @@ -104,7 +97,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -120,7 +112,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -136,13 +127,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -152,7 +142,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -172,7 +161,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -188,21 +176,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.ChoiceInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,7 +210,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -238,7 +225,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -258,7 +244,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -274,21 +259,21 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: botbuilder-dialogs-adaptive.ChoiceInputConfiguration.unrecognizedPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -308,13 +293,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -324,13 +308,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputOptions.yml index 2df537bc..10c40f10 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceInputOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ChoiceInputOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: choices remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choices: Choice[]' return: description: '' - type: 'Choice[]' + type: Choice[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOptionsSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOptionsSet.yml index e2fcc547..f835b9ff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOptionsSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOptionsSet.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Sets the ChoiceFactoryOptions. fullName: ChoiceOptionsSet remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,15 +16,13 @@ constructors: [ChoiceOptionsSet](xref:botbuilder-dialogs-adaptive.ChoiceOptionsSet) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ChoiceOptionsSet(obj: any)' parameters: - id: obj type: any - description: | - Choice values. + description: Choice values. properties: - name: includeNumbers uid: botbuilder-dialogs-adaptive.ChoiceOptionsSet.includeNumbers @@ -33,7 +30,6 @@ properties: summary: '' fullName: includeNumbers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeNumbers?: boolean' @@ -46,7 +42,6 @@ properties: summary: '' fullName: inlineOr remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineOr?: string' @@ -59,7 +54,6 @@ properties: summary: '' fullName: inlineOrMore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineOrMore?: string' @@ -72,7 +66,6 @@ properties: summary: '' fullName: inlineSeparator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineSeparator?: string' @@ -80,12 +73,11 @@ properties: description: '' type: string methods: - - name: 'bind(DialogContext, any)' + - name: bind(DialogContext, any) uid: botbuilder-dialogs-adaptive.ChoiceOptionsSet.bind package: botbuilder-dialogs-adaptive summary: Bind data to template. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOutputFormat.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOutputFormat.yml index 28af0464..cdb79001 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOutputFormat.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceOutputFormat.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ChoiceOutputFormat remarks: '' -isPreview: false isDeprecated: false fields: - name: index diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceSet.yml index 701f4e97..0b768035 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ChoiceSet.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Defines ChoiceSet collection. fullName: ChoiceSet remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,39 +15,22 @@ constructors: Initializes a new instance of the [ChoiceSet](xref:botbuilder-dialogs-adaptive.ChoiceSet) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ChoiceSet(obj: any)' parameters: - id: obj type: any - description: | - Choice values. -properties: - - name: Array - uid: botbuilder-dialogs-adaptive.ChoiceSet.Array - package: botbuilder-dialogs-adaptive - summary: '' - fullName: Array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Array: ArrayConstructor' - return: - description: '' - type: ArrayConstructor + description: Choice values. inheritedProperties: - name: length uid: botbuilder-dialogs-adaptive.ChoiceSet.length package: botbuilder-dialogs-adaptive summary: >- Gets or sets the length of the array. This is a number one higher than the - highest element defined in an array. + highest index in the array. fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: 'length: number' @@ -56,44 +38,76 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From Array.length + - name: '[species]' + uid: botbuilder-dialogs-adaptive.ChoiceSet.[species] + package: botbuilder-dialogs-adaptive + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: ArrayConstructor' + return: + description: '' + type: ArrayConstructor + inheritanceDescription: Inherited From Array.__@species@2843 inheritedMethods: - - name: 'concat(ConcatArray[])' - uid: botbuilder-dialogs-adaptive.ChoiceSet.concat + - name: at(number) + uid: botbuilder-dialogs-adaptive.ChoiceSet.at package: botbuilder-dialogs-adaptive - summary: Combines two or more arrays. + summary: |- + Takes an integer value and returns the item at that index, + allowing for positive and negative integers. + Negative integers count back from the last item in the array. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function concat(items: ConcatArray[]): Choice[]' + content: 'function at(index: number): undefined | Choice' + parameters: + - id: index + type: number + description: '' + return: + description: '' + type: undefined | Choice + inheritanceDescription: Inherited From Array.at + - name: concat((Choice | ConcatArray)[]) + uid: botbuilder-dialogs-adaptive.ChoiceSet.concat_1 + package: botbuilder-dialogs-adaptive + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. + remarks: '' + isDeprecated: false + syntax: + content: 'function concat(items: (Choice | ConcatArray)[]): Choice[]' parameters: - id: items - type: 'ConcatArray<Choice>[]' - description: | - Additional items to add to the end of array1. + type: (Choice | ConcatArray<Choice>)[] + description: Additional arrays and/or items to add to the end of the array. return: description: '' - type: 'Choice[]' + type: Choice[] inheritanceDescription: Inherited From Array.concat - - name: 'concat(T | ConcatArray[])' - uid: botbuilder-dialogs-adaptive.ChoiceSet.concat_1 + - name: concat(ConcatArray[]) + uid: botbuilder-dialogs-adaptive.ChoiceSet.concat package: botbuilder-dialogs-adaptive - summary: Combines two or more arrays. + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function concat(items: T | ConcatArray[]): Choice[]' + content: 'function concat(items: ConcatArray[]): Choice[]' parameters: - id: items - type: 'T | ConcatArray<T>[]' - description: | - Additional items to add to the end of array1. + type: ConcatArray<Choice>[] + description: Additional arrays and/or items to add to the end of the array. return: description: '' - type: 'Choice[]' + type: Choice[] inheritanceDescription: Inherited From Array.concat - - name: 'copyWithin(number, number, number)' + - name: copyWithin(number, number, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.copyWithin package: botbuilder-dialogs-adaptive summary: >- @@ -102,10 +116,11 @@ inheritedMethods: to the same array starting at position target remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function copyWithin(target: number, start: number, end?: number): this' + content: >- + function copyWithin(target: number, start: number, end?: number): + ChoiceSet parameters: - id: target type: number @@ -123,65 +138,101 @@ inheritedMethods: is treated as length+end. - id: end type: number - description: > + description: >- If not specified, length of the this object is used as its default value. return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.copyWithin - name: entries() uid: botbuilder-dialogs-adaptive.ChoiceSet.entries package: botbuilder-dialogs-adaptive - summary: 'Returns an iterable of key, value pairs for every entry in the array' + summary: Returns an iterable of key, value pairs for every entry in the array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function entries(): IterableIterator<[number, Choice]>' return: description: '' - type: 'IterableIterator<[number, Choice]>' + type: IterableIterator<[number, Choice]> inheritanceDescription: Inherited From Array.entries - name: 'every((value: Choice, index: number, array: Choice[]) => unknown, any)' - uid: botbuilder-dialogs-adaptive.ChoiceSet.every + uid: botbuilder-dialogs-adaptive.ChoiceSet.every_1 package: botbuilder-dialogs-adaptive summary: Determines whether all the members of an array satisfy the specified test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function every(callbackfn: (value: Choice, index: number, array: + function every(predicate: (value: Choice, index: number, array: Choice[]) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn + - id: predicate type: '(value: Choice, index: number, array: Choice[]) => unknown' description: >- A function that accepts up to three arguments. The every method - calls the callbackfn function for each element in array1 until the - callbackfn returns false, or until the end of the array. + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn - function. If thisArg is omitted, undefined is used as the this - value. + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. return: description: '' type: boolean inheritanceDescription: Inherited From Array.every - - name: 'fill(Choice, number, number)' + - name: 'every((value: Choice, index: number, array: Choice[]) => value, any)' + uid: botbuilder-dialogs-adaptive.ChoiceSet.every + package: botbuilder-dialogs-adaptive + summary: Determines whether all the members of an array satisfy the specified test. + remarks: '' + isDeprecated: false + syntax: + content: >- + function every(predicate: (value: Choice, index: number, array: + Choice[]) => value, thisArg?: any): this + parameters: + - id: predicate + type: '(value: Choice, index: number, array: Choice[]) => value' + description: >- + A function that accepts up to three arguments. The every method + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: this + inheritanceDescription: Inherited From Array.every + - name: fill(Choice, number, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.fill package: botbuilder-dialogs-adaptive summary: >- - Returns the this object after filling the section identified by start and - end with value + Changes all array elements from `start` to `end` index to a static `value` + and returns the modified array remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function fill(value: Choice, start?: number, end?: number): this' + content: 'function fill(value: Choice, start?: number, end?: number): ChoiceSet' parameters: - id: value type: Choice @@ -195,14 +246,14 @@ inheritedMethods: length+start where length is the length of the array. - id: end type: number - description: > + description: >- index to stop filling the array at. If end is negative, it is treated as length+end. return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.fill - name: 'filter((value: Choice, index: number, array: Choice[]) => unknown, any)' uid: botbuilder-dialogs-adaptive.ChoiceSet.filter_1 @@ -211,70 +262,65 @@ inheritedMethods: Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: Choice, index: number, array: + function filter(predicate: (value: Choice, index: number, array: Choice[]) => unknown, thisArg?: any): Choice[] parameters: - - id: callbackfn + - id: predicate type: '(value: Choice, index: number, array: Choice[]) => unknown' description: >- A function that accepts up to three arguments. The filter method - calls the callbackfn function one time for each element in the - array. + calls the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'Choice[]' + type: Choice[] inheritanceDescription: Inherited From Array.filter - - name: 'filter((value: Choice, index: number, array: Choice[]) => boolean, any)' + - name: 'filter((value: Choice, index: number, array: Choice[]) => value, any)' uid: botbuilder-dialogs-adaptive.ChoiceSet.filter package: botbuilder-dialogs-adaptive summary: >- Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: Choice, index: number, array: - Choice[]) => boolean, thisArg?: any): S[] + function filter(predicate: (value: Choice, index: number, array: + Choice[]) => value, thisArg?: any): S[] parameters: - - id: callbackfn - type: '(value: Choice, index: number, array: Choice[]) => boolean' + - id: predicate + type: '(value: Choice, index: number, array: Choice[]) => value' description: >- A function that accepts up to three arguments. The filter method - calls the callbackfn function one time for each element in the - array. + calls the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'S[]' + type: S[] inheritanceDescription: Inherited From Array.filter - name: 'find((value: Choice, index: number, obj: Choice[]) => unknown, any)' uid: botbuilder-dialogs-adaptive.ChoiceSet.find_1 package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function find(predicate: (value: Choice, index: number, obj: Choice[]) - => unknown, thisArg?: any): Choice | undefined + => unknown, thisArg?: any): undefined | Choice parameters: - id: predicate type: '(value: Choice, index: number, obj: Choice[]) => unknown' @@ -284,11 +330,11 @@ inheritedMethods: description: '' return: description: '' - type: Choice | undefined + type: undefined | Choice inheritanceDescription: Inherited From Array.find - name: >- find((this: void, value: Choice, index: number, obj: Choice[]) => - boolean, any) + value, any) uid: botbuilder-dialogs-adaptive.ChoiceSet.find package: botbuilder-dialogs-adaptive summary: >- @@ -297,17 +343,16 @@ inheritedMethods: otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function find(predicate: (this: void, value: Choice, index: number, - obj: Choice[]) => boolean, thisArg?: any): S | undefined + obj: Choice[]) => value, thisArg?: any): undefined | S parameters: - id: predicate type: >- (this: void, value: Choice, index: number, obj: Choice[]) => - boolean + value description: >- find calls predicate once for each element of the array, in ascending @@ -319,14 +364,14 @@ inheritedMethods: undefined. - id: thisArg type: any - description: > + description: >- If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. return: description: '' - type: S | undefined + type: undefined | S inheritanceDescription: Inherited From Array.find - name: 'findIndex((value: Choice, index: number, obj: Choice[]) => unknown, any)' uid: botbuilder-dialogs-adaptive.ChoiceSet.findIndex @@ -337,7 +382,6 @@ inheritedMethods: otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -357,7 +401,7 @@ inheritedMethods: findIndex returns -1. - id: thisArg type: any - description: > + description: >- If provided, it will be used as the this value for each invocation of @@ -366,12 +410,73 @@ inheritedMethods: description: '' type: number inheritanceDescription: Inherited From Array.findIndex + - name: flat(A, D) + uid: botbuilder-dialogs-adaptive.ChoiceSet.flat + package: botbuilder-dialogs-adaptive + summary: >- + Returns a new array with all sub-array elements concatenated into it + recursively up to the + + specified depth. + remarks: '' + isDeprecated: false + syntax: + content: 'function flat(this: A, depth?: D): FlatArray[]' + parameters: + - id: this + type: A + description: '' + - id: depth + type: D + description: The maximum recursion depth + return: + description: '' + type: FlatArray<A, D>[] + inheritanceDescription: Inherited From Array.flat + - name: >- + flatMap((this: This, value: Choice, index: number, array: + Choice[]) => U | (readonly U[]), This) + uid: botbuilder-dialogs-adaptive.ChoiceSet.flatMap + package: botbuilder-dialogs-adaptive + summary: >- + Calls a defined callback function on each element of an array. Then, + flattens the result into + + a new array. + + This is identical to a map followed by flat with depth 1. + remarks: '' + isDeprecated: false + syntax: + content: >- + function flatMap(callback: (this: This, value: Choice, index: + number, array: Choice[]) => U | (readonly U[]), thisArg?: This): U[] + parameters: + - id: callback + type: >- + (this: This, value: Choice, index: number, array: Choice[]) => U + | (readonly U[]) + description: >- + A function that accepts up to three arguments. The flatMap method + calls the + + callback function one time for each element in the array. + - id: thisArg + type: This + description: >- + An object to which the this keyword can refer in the callback + function. If + + thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.flatMap - name: 'forEach((value: Choice, index: number, array: Choice[]) => void, any)' uid: botbuilder-dialogs-adaptive.ChoiceSet.forEach package: botbuilder-dialogs-adaptive summary: Performs the specified action for each element in an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -385,19 +490,98 @@ inheritedMethods: callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. inheritanceDescription: Inherited From Array.forEach - - name: 'includes(Choice, number)' + - name: 'from(ArrayLike, (v: T, k: number) => U, any)' + uid: botbuilder-dialogs-adaptive.ChoiceSet.from_1 + package: botbuilder-dialogs-adaptive + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(arrayLike: ArrayLike, mapfn: (v: T, k: + number) => U, thisArg?: any): U[] + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: 'from(Iterable | ArrayLike, (v: T, k: number) => U, any)' + uid: botbuilder-dialogs-adaptive.ChoiceSet.from_3 + package: botbuilder-dialogs-adaptive + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(iterable: Iterable | ArrayLike, mapfn: + (v: T, k: number) => U, thisArg?: any): U[] + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: from(ArrayLike) + uid: botbuilder-dialogs-adaptive.ChoiceSet.from + package: botbuilder-dialogs-adaptive + summary: Creates an array from an array-like object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(arrayLike: ArrayLike): T[]' + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: from(Iterable | ArrayLike) + uid: botbuilder-dialogs-adaptive.ChoiceSet.from_2 + package: botbuilder-dialogs-adaptive + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(iterable: Iterable | ArrayLike): T[]' + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: includes(Choice, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.includes package: botbuilder-dialogs-adaptive summary: >- Determines whether an array includes a certain element, returning true or false as appropriate. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function includes(searchElement: Choice, fromIndex?: number): boolean' @@ -407,19 +591,20 @@ inheritedMethods: description: The element to search for. - id: fromIndex type: number - description: > + description: >- The position in this array at which to begin searching for searchElement. return: description: '' type: boolean inheritanceDescription: Inherited From Array.includes - - name: 'indexOf(Choice, number)' + - name: indexOf(Choice, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.indexOf package: botbuilder-dialogs-adaptive - summary: Returns the index of the first occurrence of a value in an array. + summary: >- + Returns the index of the first occurrence of a value in an array, or -1 if + it is not present. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function indexOf(searchElement: Choice, fromIndex?: number): number' @@ -429,30 +614,45 @@ inheritedMethods: description: The value to locate in the array. - id: fromIndex type: number - description: > + description: >- The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. return: description: '' type: number inheritanceDescription: Inherited From Array.indexOf + - name: isArray(any) + uid: botbuilder-dialogs-adaptive.ChoiceSet.isArray + package: botbuilder-dialogs-adaptive + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function isArray(arg: any): arg' + parameters: + - id: arg + type: any + description: '' + return: + description: '' + type: arg + inheritanceDescription: Inherited From Array.isArray - name: join(string) uid: botbuilder-dialogs-adaptive.ChoiceSet.join package: botbuilder-dialogs-adaptive summary: >- - Adds all the elements of an array separated by the specified separator - string. + Adds all the elements of an array into a string, separated by the + specified separator string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function join(separator?: string): string' parameters: - id: separator type: string - description: > - A string used to separate one element of an array from the next in - the resulting String. If omitted, the array elements are separated + description: >- + A string used to separate one element of the array from the next in + the resulting string. If omitted, the array elements are separated with a comma. return: description: '' @@ -463,7 +663,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns an iterable of keys in the array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keys(): IterableIterator' @@ -471,12 +670,13 @@ inheritedMethods: description: '' type: IterableIterator<number> inheritanceDescription: Inherited From Array.keys - - name: 'lastIndexOf(Choice, number)' + - name: lastIndexOf(Choice, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.lastIndexOf package: botbuilder-dialogs-adaptive - summary: Returns the index of the last occurrence of a specified value in an array. + summary: >- + Returns the index of the last occurrence of a specified value in an array, + or -1 if it is not present. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function lastIndexOf(searchElement: Choice, fromIndex?: number): number' @@ -486,9 +686,9 @@ inheritedMethods: description: The value to locate in the array. - id: fromIndex type: number - description: > - The array index at which to begin the search. If fromIndex is - omitted, the search starts at the last index in the array. + description: >- + The array index at which to begin searching backward. If fromIndex + is omitted, the search starts at the last index in the array. return: description: '' type: number @@ -500,7 +700,6 @@ inheritedMethods: Calls a defined callback function on each element of an array, and returns an array that contains the results. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -514,41 +713,60 @@ inheritedMethods: the callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'U[]' + type: U[] inheritanceDescription: Inherited From Array.map + - name: of(T[]) + uid: botbuilder-dialogs-adaptive.ChoiceSet.of + package: botbuilder-dialogs-adaptive + summary: Returns a new array from a set of elements. + remarks: '' + isDeprecated: false + syntax: + content: 'static function of(items: T[]): T[]' + parameters: + - id: items + type: T[] + description: A set of elements to include in the new array object. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.of - name: pop() uid: botbuilder-dialogs-adaptive.ChoiceSet.pop package: botbuilder-dialogs-adaptive - summary: Removes the last element from an array and returns it. + summary: >- + Removes the last element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function pop(): Choice | undefined' + content: 'function pop(): undefined | Choice' return: description: '' - type: Choice | undefined + type: undefined | Choice inheritanceDescription: Inherited From Array.pop - - name: 'push(Choice[])' + - name: push(Choice[]) uid: botbuilder-dialogs-adaptive.ChoiceSet.push package: botbuilder-dialogs-adaptive - summary: 'Appends new elements to an array, and returns the new length of the array.' + summary: >- + Appends new elements to the end of an array, and returns the new length of + the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function push(items: Choice[]): number' parameters: - id: items - type: 'Choice[]' - description: | - New elements of the Array. + type: Choice[] + description: New elements to add to the array. return: description: '' type: number @@ -563,7 +781,6 @@ inheritedMethods: The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -589,7 +806,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -619,7 +835,6 @@ inheritedMethods: The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -636,7 +851,7 @@ inheritedMethods: array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @@ -655,7 +870,6 @@ inheritedMethods: accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -681,7 +895,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -712,7 +925,6 @@ inheritedMethods: accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -729,7 +941,7 @@ inheritedMethods: array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @@ -740,49 +952,63 @@ inheritedMethods: - name: reverse() uid: botbuilder-dialogs-adaptive.ChoiceSet.reverse package: botbuilder-dialogs-adaptive - summary: Reverses the elements in an Array. + summary: |- + Reverses the elements in an array in place. + This method mutates the array and returns a reference to the same array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reverse(): Choice[]' return: description: '' - type: 'Choice[]' + type: Choice[] inheritanceDescription: Inherited From Array.reverse - name: shift() uid: botbuilder-dialogs-adaptive.ChoiceSet.shift package: botbuilder-dialogs-adaptive - summary: Removes the first element from an array and returns it. + summary: >- + Removes the first element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shift(): Choice | undefined' + content: 'function shift(): undefined | Choice' return: description: '' - type: Choice | undefined + type: undefined | Choice inheritanceDescription: Inherited From Array.shift - - name: 'slice(number, number)' + - name: slice(number, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.slice package: botbuilder-dialogs-adaptive - summary: Returns a section of an array. + summary: >- + Returns a copy of a section of an array. + + For both start and end, a negative index can be used to indicate an offset + from the end of the array. + + For example, -2 refers to the second to last element of the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function slice(start?: number, end?: number): Choice[]' parameters: - id: start type: number - description: The beginning of the specified portion of the array. + description: |- + The beginning index of the specified portion of the array. + If start is undefined, then the slice begins at index 0. - id: end type: number - description: | - The end of the specified portion of the array. + description: >- + The end index of the specified portion of the array. This is + exclusive of the element at the index 'end'. + + If end is undefined, then the slice extends to the end of the array. return: description: '' - type: 'Choice[]' + type: Choice[] inheritanceDescription: Inherited From Array.slice - name: 'some((value: Choice, index: number, array: Choice[]) => unknown, any)' uid: botbuilder-dialogs-adaptive.ChoiceSet.some @@ -791,25 +1017,29 @@ inheritedMethods: Determines whether the specified callback function returns true for any element of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function some(callbackfn: (value: Choice, index: number, array: - Choice[]) => unknown, thisArg?: any): boolean + function some(predicate: (value: Choice, index: number, array: Choice[]) + => unknown, thisArg?: any): boolean parameters: - - id: callbackfn + - id: predicate type: '(value: Choice, index: number, array: Choice[]) => unknown' description: >- A function that accepts up to three arguments. The some method calls - the callbackfn function for each element in array1 until the - callbackfn returns true, or until the end of the array. + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value true, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn - function. If thisArg is omitted, undefined is used as the this - value. + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. return: description: '' type: boolean @@ -817,31 +1047,42 @@ inheritedMethods: - name: 'sort((a: Choice, b: Choice) => number)' uid: botbuilder-dialogs-adaptive.ChoiceSet.sort package: botbuilder-dialogs-adaptive - summary: Sorts an array. + summary: |- + Sorts an array in place. + This method mutates the array and returns a reference to the same array. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function sort(compareFn?: (a: Choice, b: Choice) => number): this' + content: 'function sort(compareFn?: (a: Choice, b: Choice) => number): ChoiceSet' parameters: - id: compareFn type: '(a: Choice, b: Choice) => number' - description: > - The name of the function used to determine the order of the - elements. If omitted, the elements are sorted in ascending, ASCII - character order. + description: >- + Function used to determine the order of the elements. It is expected + to return + + a negative value if the first argument is less than the second + argument, zero if they're equal, and a positive + + value otherwise. If omitted, the elements are sorted in ascending, + ASCII character order. + + ```ts + + [11,2,22,1].sort((a, b) => a - b) + + ``` return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.sort - - name: 'splice(number, number)' + - name: splice(number, number) uid: botbuilder-dialogs-adaptive.ChoiceSet.splice package: botbuilder-dialogs-adaptive summary: >- Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function splice(start: number, deleteCount?: number): Choice[]' @@ -853,20 +1094,18 @@ inheritedMethods: elements. - id: deleteCount type: number - description: | - The number of elements to remove. + description: The number of elements to remove. return: - description: '' - type: 'Choice[]' + description: An array containing the elements that were deleted. + type: Choice[] inheritanceDescription: Inherited From Array.splice - - name: 'splice(number, number, Choice[])' + - name: splice(number, number, Choice[]) uid: botbuilder-dialogs-adaptive.ChoiceSet.splice_1 package: botbuilder-dialogs-adaptive summary: >- Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -882,21 +1121,19 @@ inheritedMethods: type: number description: The number of elements to remove. - id: items - type: 'Choice[]' - description: | - Elements to insert into the array in place of the deleted elements. + type: Choice[] + description: Elements to insert into the array in place of the deleted elements. return: - description: '' - type: 'Choice[]' + description: An array containing the elements that were deleted. + type: Choice[] inheritanceDescription: Inherited From Array.splice - name: toLocaleString() uid: botbuilder-dialogs-adaptive.ChoiceSet.toLocaleString package: botbuilder-dialogs-adaptive summary: >- Returns a string representation of an array. The elements are converted to - string using their toLocalString methods. + string using their toLocaleString methods. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toLocaleString(): string' @@ -909,7 +1146,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns a string representation of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -917,20 +1153,20 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From Array.toString - - name: 'unshift(Choice[])' + - name: unshift(Choice[]) uid: botbuilder-dialogs-adaptive.ChoiceSet.unshift package: botbuilder-dialogs-adaptive - summary: Inserts new elements at the start of an array. + summary: >- + Inserts new elements at the start of an array, and returns the new length + of the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unshift(items: Choice[]): number' parameters: - id: items - type: 'Choice[]' - description: | - Elements to insert at the start of the Array. + type: Choice[] + description: Elements to insert at the start of the array. return: description: '' type: number @@ -940,7 +1176,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns an iterable of values in the array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function values(): IterableIterator' @@ -948,13 +1183,43 @@ inheritedMethods: description: '' type: IterableIterator<Choice> inheritanceDescription: Inherited From Array.values + - name: '[iterator]()' + uid: botbuilder-dialogs-adaptive.ChoiceSet.[iterator] + package: botbuilder-dialogs-adaptive + summary: Iterator + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator' + return: + description: '' + type: IterableIterator<Choice> + inheritanceDescription: Inherited From Array.__@iterator@2882 + - name: '[unscopables]()' + uid: botbuilder-dialogs-adaptive.ChoiceSet.[unscopables] + package: botbuilder-dialogs-adaptive + summary: |- + Returns an object whose properties have the value 'true' + when they will be absent when used in a 'with' statement. + remarks: '' + isDeprecated: false + syntax: + content: >- + function [unscopables](): { copyWithin: boolean, entries: boolean, fill: + boolean, find: boolean, findIndex: boolean, keys: boolean, values: + boolean } + return: + description: '' + type: >- + { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, + findIndex: boolean, keys: boolean, values: boolean } + inheritanceDescription: Inherited From Array.__@unscopables@2884 methods: - - name: 'bind(DialogContext, DialogStateManager)' + - name: bind(DialogContext, DialogStateManager) uid: botbuilder-dialogs-adaptive.ChoiceSet.bind package: botbuilder-dialogs-adaptive summary: Bind data to template. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeAction.yml index 8a4cbbb0..58b2f182 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeAction.yml @@ -2,30 +2,28 @@ name: CodeAction uid: botbuilder-dialogs-adaptive.CodeAction package: botbuilder-dialogs-adaptive -summary: 'Class representing a [Dialog](xref:botbuilder-dialogs.Dialog) code action.' +summary: Class representing a [Dialog](xref:botbuilder-dialogs.Dialog) code action. fullName: CodeAction remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: CodeAction(CodeActionHandler) + - name: CodeAction(CodeActionHandler) uid: botbuilder-dialogs-adaptive.CodeAction.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [CodeAction](xref:botbuilder-dialogs-adaptive.CodeAction) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CodeAction(codeHandler: CodeActionHandler)' parameters: - id: codeHandler type: - description: > - (xref:botbuilder-dialogs-adaptive.CodeActionHandler), code handler - for the action. + description: >- + [CodeActionHandler](xref:botbuilder-dialogs-adaptive.CodeActionHandler), + code handler for the action. properties: - name: disabled uid: botbuilder-dialogs-adaptive.CodeAction.disabled @@ -33,85 +31,80 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.CodeAction.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.CodeAction.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.CodeAction.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.CodeAction.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.CodeAction.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): CodeAction' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.CodeAction.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -135,20 +128,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.CodeAction.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -177,23 +170,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -220,7 +211,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -230,14 +220,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.CodeAction.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -256,10 +245,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.CodeAction.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -280,25 +269,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.CodeAction.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -338,12 +325,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -355,26 +341,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.CodeAction.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -386,21 +370,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof CodeActionConfiguration) uid: botbuilder-dialogs-adaptive.CodeAction.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof CodeActionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof CodeActionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionConfiguration.yml index e5578952..b67b66b1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: CodeActionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -29,7 +27,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionHandler.yml index 447d141e..d8e6188a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CodeActionHandler.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: CodeActionHandler remarks: '' -isPreview: false isDeprecated: false syntax: | type CodeActionHandler = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelector.yml index 462f9042..7f21a6fd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelector.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Select between two rule selectors based on a condition. fullName: ConditionalSelector remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: Expression that determines which selector to use. fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -41,7 +38,6 @@ properties: summary: Gets or sets selector if condition is false. fullName: ifFalse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ifFalse: TriggerSelector' @@ -54,7 +50,6 @@ properties: summary: Gets or sets selector if condition is true. fullName: ifTrue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ifTrue: TriggerSelector' @@ -67,7 +62,6 @@ properties: summary: Gets or sets the expression parser to use. fullName: parser remarks: '' - isPreview: false isDeprecated: false syntax: content: 'parser: ExpressionParserInterface' @@ -75,65 +69,66 @@ properties: description: '' type: ExpressionParserInterface inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ConditionalSelector.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ConditionalSelector' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TriggerSelector.configure](xref:botbuilder-dialogs-adaptive.TriggerSelector.configure) methods: - - name: getConverter(Object) + - name: getConverter(keyof ConditionalSelectorConfiguration) uid: botbuilder-dialogs-adaptive.ConditionalSelector.getConverter package: botbuilder-dialogs-adaptive summary: Gets the converter for the selector configuration. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ConditionalSelectorConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ConditionalSelectorConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - - name: 'initialize(OnCondition[], boolean)' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + - name: initialize(OnCondition[], boolean) uid: botbuilder-dialogs-adaptive.ConditionalSelector.initialize package: botbuilder-dialogs-adaptive summary: Initialize the selector with the set of rules. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(conditionals: OnCondition[], evaluate: boolean)' parameters: - id: conditionals - type: '[]' + type: [] description: Possible rules to match. - id: evaluate type: boolean - description: | - True if rules should be evaluated on select. + description: True if rules should be evaluated on select. - name: select(ActionContext) uid: botbuilder-dialogs-adaptive.ConditionalSelector.select package: botbuilder-dialogs-adaptive summary: Select the best rule to execute. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function select(actionContext: ActionContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelectorConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelectorConfiguration.yml index 245c3955..642462f1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelectorConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConditionalSelectorConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ConditionalSelectorConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: ifFalse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ifFalse?: TriggerSelector' @@ -41,7 +38,6 @@ properties: summary: '' fullName: ifTrue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ifTrue?: TriggerSelector' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInput.yml index f5989473..8db95516 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInput.yml @@ -5,30 +5,28 @@ package: botbuilder-dialogs-adaptive summary: >- Declarative input control that will gather yes/no confirmation input from a set of choices. -fullName: ConfirmInput +fullName: ConfirmInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ConfirmInput(string, Partial | string)' + - name: ConfirmInput(string, string | Partial) uid: botbuilder-dialogs-adaptive.ConfirmInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ConfirmInput(property?: string, prompt?: Partial | string)' + content: 'new ConfirmInput(property?: string, prompt?: string | Partial)' parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -41,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -58,7 +55,6 @@ properties: rendered to the user. fullName: choiceOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choiceOptions?: ObjectExpression' @@ -71,7 +67,6 @@ properties: summary: Custom list of choices to send for the prompt. fullName: confirmChoices remarks: '' - isPreview: false isDeprecated: false syntax: content: 'confirmChoices?: ObjectExpression' @@ -86,20 +81,30 @@ properties: summary: The prompts default locale that should be recognized. fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive.ConfirmInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: outputFormat uid: botbuilder-dialogs-adaptive.ConfirmInput.outputFormat package: botbuilder-dialogs-adaptive summary: The expression of output format. fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat: StringExpression' @@ -112,13 +117,26 @@ properties: summary: Style of the "yes" and "no" choices rendered to the user when prompting. fullName: style remarks: Defaults to `ListStyle.auto`. - isPreview: false isDeprecated: false syntax: content: 'style: EnumExpression' return: description: '' type: EnumExpression<ListStyle> + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ConfirmInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: allowInterruptions uid: botbuilder-dialogs-adaptive.ConfirmInput.allowInterruptions @@ -126,7 +144,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -144,7 +161,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -160,7 +176,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -178,7 +193,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -186,7 +200,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -196,7 +210,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -217,28 +230,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ConfirmInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.ConfirmInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -247,13 +247,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -265,7 +264,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -281,7 +279,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -297,13 +294,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -313,7 +309,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -323,27 +318,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ConfirmInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.ConfirmInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -359,7 +339,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -367,7 +346,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -377,13 +356,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -393,7 +371,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -409,7 +386,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -420,19 +396,18 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.ConfirmInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -448,29 +423,30 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.beginDialog](xref:botbuilder-dialogs-adaptive.InputDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ConfirmInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ConfirmInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ConfirmInput.continueDialog package: botbuilder-dialogs-adaptive @@ -478,10 +454,11 @@ inheritedMethods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -492,11 +469,11 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.continueDialog](xref:botbuilder-dialogs-adaptive.InputDialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ConfirmInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -525,27 +502,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.ConfirmInput.getVersion package: botbuilder-dialogs-adaptive @@ -568,7 +545,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -577,15 +553,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ConfirmInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -603,11 +580,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ConfirmInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -628,37 +607,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ConfirmInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -668,8 +646,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -681,25 +659,28 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: getConverter(Object) + - name: getConverter(keyof ConfirmInputConfiguration) uid: botbuilder-dialogs-adaptive.ConfirmInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ConfirmInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ConfirmInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInputConfiguration.yml index 19451614..408d0165 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ConfirmInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: choiceOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choiceOptions?: ObjectProperty' @@ -30,7 +28,6 @@ properties: summary: '' fullName: confirmChoices remarks: '' - isPreview: false isDeprecated: false syntax: content: 'confirmChoices?: ObjectProperty' @@ -45,7 +42,6 @@ properties: summary: '' fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringProperty' @@ -58,7 +54,6 @@ properties: summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: StringProperty' @@ -71,7 +66,6 @@ properties: summary: '' fullName: style remarks: '' - isPreview: false isDeprecated: false syntax: content: 'style?: EnumProperty' @@ -87,7 +81,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -103,7 +96,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -119,13 +111,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -135,7 +126,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -155,7 +145,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -171,21 +160,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.ConfirmInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -205,7 +194,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -221,7 +209,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,7 +228,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -257,21 +243,21 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: botbuilder-dialogs-adaptive.ConfirmInputConfiguration.unrecognizedPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -291,13 +277,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -307,13 +292,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmationEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmationEntityRecognizer.yml index 7dfc685e..9dcfc96d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmationEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ConfirmationEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes yes/no confirmation style input. fullName: ConfirmationEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,56 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + ConfirmationEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +115,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +129,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +163,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversation.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversation.yml index 4bb9f6c5..08b2e527 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversation.yml @@ -3,9 +3,8 @@ name: ContinueConversation uid: botbuilder-dialogs-adaptive.ContinueConversation package: botbuilder-dialogs-adaptive summary: Action which continues a conversation using a Conversation reference. -fullName: ContinueConversation +fullName: ContinueConversation remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,15 +15,13 @@ constructors: Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ContinueConversation(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.ContinueConversation.$kind @@ -32,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -45,7 +41,6 @@ properties: summary: Gets or sets the conversationReference for the target conversation. fullName: conversationReference remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationReference: ObjectExpression' @@ -60,20 +55,44 @@ properties: action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.ContinueConversation.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ContinueConversation.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.ContinueConversation.value package: botbuilder-dialogs-adaptive summary: Gets or sets an optional value to use for EventActivity.Value. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -92,66 +111,38 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ContinueConversation.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ContinueConversation.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ContinueConversation.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + ContinueConversation parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ContinueConversation.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -175,20 +166,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ContinueConversation.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -217,23 +208,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -260,7 +249,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -270,14 +258,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ContinueConversation.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -296,10 +283,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ContinueConversation.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -320,25 +307,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ContinueConversation.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -378,12 +363,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -395,24 +379,22 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, Record)' + - name: beginDialog(DialogContext, Record) uid: botbuilder-dialogs-adaptive.ContinueConversation.beginDialog package: botbuilder-dialogs-adaptive summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: Record): Promise + unknown>): Promise> parameters: - id: dc type: DialogContext @@ -420,25 +402,29 @@ methods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: _options - type: 'Record<string, unknown>' - description: 'Optional, initial information to pass to the dialog.' + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. return: description: A promise representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ContinueConversationConfiguration) uid: botbuilder-dialogs-adaptive.ContinueConversation.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + ContinueConversationConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof ContinueConversationConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationConfiguration.yml index 622963de..ff482ae3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ContinueConversationConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: conversationReference remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationReference?: ObjectProperty' @@ -31,7 +29,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -44,13 +41,12 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.ContinueConversationConfiguration.id @@ -58,7 +54,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -73,7 +68,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLater.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLater.yml index b7c32544..f2dbdd08 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLater.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLater.yml @@ -5,9 +5,8 @@ package: botbuilder-dialogs-adaptive summary: >- Action which schedules the current conversation to be continued at a later time. -fullName: ContinueConversationLater +fullName: ContinueConversationLater remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,15 +17,13 @@ constructors: Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ContinueConversationLater(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.ContinueConversationLater.$kind @@ -34,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -49,7 +45,6 @@ properties: the conversation. fullName: date remarks: '' - isPreview: false isDeprecated: false syntax: content: 'date: StringExpression' @@ -64,20 +59,44 @@ properties: action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.ContinueConversationLater.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ContinueConversationLater.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.ContinueConversationLater.value package: botbuilder-dialogs-adaptive summary: Gets or sets an optional value to use for EventActivity.Value. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -96,66 +115,38 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ContinueConversationLater.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ContinueConversationLater.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + ContinueConversationLater parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -179,20 +170,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -221,23 +212,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -264,7 +253,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -274,14 +262,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -300,10 +287,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -324,25 +311,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -382,12 +367,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -399,26 +383,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, Record)' + - name: beginDialog(DialogContext, Record) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: Record): Promise + unknown>): Promise> parameters: - id: dc type: DialogContext @@ -426,25 +408,29 @@ methods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: _options - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ContinueConversationLaterConfiguration) uid: botbuilder-dialogs-adaptive.ContinueConversationLater.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + ContinueConversationLaterConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof ContinueConversationLaterConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLaterConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLaterConfiguration.yml index 7bae1093..b79f30d6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLaterConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueConversationLaterConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ContinueConversationLaterConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: date remarks: '' - isPreview: false isDeprecated: false syntax: content: 'date?: StringProperty' @@ -29,7 +27,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -42,13 +39,12 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.ContinueConversationLaterConfiguration.id @@ -56,7 +52,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -71,7 +66,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoop.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoop.yml index 1134f0c6..5257bd6b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoop.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoop.yml @@ -5,26 +5,23 @@ package: botbuilder-dialogs-adaptive summary: Continue the loop. fullName: ContinueLoop remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: ContinueLoop(string) + - name: ContinueLoop(string) uid: botbuilder-dialogs-adaptive.ContinueLoop.constructor package: botbuilder-dialogs-adaptive summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ContinueLoop(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.ContinueLoop.$kind @@ -32,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -45,85 +41,80 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.ContinueLoop.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.ContinueLoop.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.ContinueLoop.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.ContinueLoop.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ContinueLoop.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ContinueLoop' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ContinueLoop.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -147,20 +138,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ContinueLoop.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -189,23 +180,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -232,7 +221,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -242,14 +230,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ContinueLoop.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -268,10 +255,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ContinueLoop.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -292,25 +279,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ContinueLoop.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -350,12 +335,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -367,26 +351,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.ContinueLoop.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -398,21 +380,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ContinueLoopConfiguration) uid: botbuilder-dialogs-adaptive.ContinueLoop.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ContinueLoopConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ContinueLoopConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoopConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoopConfiguration.yml index 68571ddc..0fc4f5cb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoopConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ContinueLoopConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ContinueLoopConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -29,7 +27,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSet.yml index f467b78b..873f081c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSet.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizer for selecting between cross trained recognizers. fullName: CrossTrainedRecognizerSet remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,13 +26,12 @@ properties: summary: Gets or sets the input recognizers. fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizers: Recognizer[]' return: description: '' - type: 'Recognizer[]' + type: Recognizer[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.CrossTrainedRecognizerSet.id @@ -42,14 +39,15 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.id](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.id) - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.CrossTrainedRecognizerSet.logPersonalInformation @@ -59,7 +57,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -77,51 +74,59 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.telemetryClient](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.telemetryClient) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.CrossTrainedRecognizerSet.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + CrossTrainedRecognizerSet parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.configure](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure) methods: - - name: getConverter(Object) + - name: getConverter(keyof CrossTrainedRecognizerSetConfiguration) uid: botbuilder-dialogs-adaptive.CrossTrainedRecognizerSet.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + CrossTrainedRecognizerSetConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof CrossTrainedRecognizerSetConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- recognize(DialogContext, Activity, Record, Record) @@ -129,7 +134,6 @@ methods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -144,12 +148,12 @@ methods: type: Activity description: The activity. - id: telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: >- Optional. Additional properties to be logged to telemetry with the recognizer result event. - id: telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: >- Optional. Additional metrics to be logged to telemetry with the recognizer result event. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSetConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSetConfiguration.yml index f568f69e..ac774f1a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSetConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CrossTrainedRecognizerSetConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: CrossTrainedRecognizerSetConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,13 +15,12 @@ properties: summary: '' fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizers?: string[] | Recognizer[]' return: description: '' - type: 'string[] | Recognizer[]' + type: string[] | Recognizer[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.CrossTrainedRecognizerSetConfiguration.id @@ -30,7 +28,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -45,7 +42,6 @@ inheritedProperties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CurrencyEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CurrencyEntityRecognizer.yml index d83a0047..6d12bc94 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CurrencyEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/CurrencyEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes currency input. fullName: CurrencyEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.CurrencyEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.CurrencyEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.CurrencyEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + CurrencyEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.CurrencyEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +113,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +127,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.CurrencyEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +161,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/D.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/D.yml deleted file mode 100644 index 4d6de1fc..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/D.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: D -uid: botbuilder-dialogs-adaptive.D -package: botbuilder-dialogs-adaptive -summary: '' -fullName: D -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type D = DialogStateManager & { utterance: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeEntityRecognizer.yml index 2361e79f..3eebdd04 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes DateTime input. fullName: DateTimeEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.DateTimeEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.DateTimeEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DateTimeEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + DateTimeEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.DateTimeEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +113,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +127,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.DateTimeEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +161,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInput.yml index 77ce8efe..ad65ff9f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInput.yml @@ -3,32 +3,30 @@ name: DateTimeInput uid: botbuilder-dialogs-adaptive.DateTimeInput package: botbuilder-dialogs-adaptive summary: Input dialog to collect a datetime from the user. -fullName: DateTimeInput +fullName: DateTimeInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DateTimeInput(string, Partial | string)' + - name: DateTimeInput(string, string | Partial) uid: botbuilder-dialogs-adaptive.DateTimeInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new DateTimeInput(property?: string, prompt?: Partial | - string) + new DateTimeInput(property?: string, prompt?: string | + Partial) parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -41,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,26 +51,50 @@ properties: summary: '' fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive.DateTimeInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: outputFormat uid: botbuilder-dialogs-adaptive.DateTimeInput.outputFormat package: botbuilder-dialogs-adaptive summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.DateTimeInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: allowInterruptions uid: botbuilder-dialogs-adaptive.DateTimeInput.allowInterruptions @@ -81,7 +102,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -99,7 +119,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -115,7 +134,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -133,7 +151,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -141,7 +158,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -151,7 +168,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -172,28 +188,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.DateTimeInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.DateTimeInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -202,13 +205,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -220,7 +222,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -236,7 +237,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -252,13 +252,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -268,7 +267,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -278,27 +276,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.DateTimeInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.DateTimeInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -314,7 +297,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -322,7 +304,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -332,13 +314,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -348,7 +329,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -364,7 +344,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -375,19 +354,18 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.DateTimeInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -403,29 +381,30 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.beginDialog](xref:botbuilder-dialogs-adaptive.InputDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DateTimeInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DateTimeInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.DateTimeInput.continueDialog package: botbuilder-dialogs-adaptive @@ -433,10 +412,11 @@ inheritedMethods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -447,11 +427,11 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.continueDialog](xref:botbuilder-dialogs-adaptive.InputDialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.DateTimeInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -480,27 +460,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.DateTimeInput.getVersion package: botbuilder-dialogs-adaptive @@ -523,7 +503,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -532,15 +511,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.DateTimeInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -558,11 +538,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.DateTimeInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -583,37 +565,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.DateTimeInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -623,8 +604,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -636,25 +617,28 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: getConverter(Object) + - name: getConverter(keyof DateTimeInputConfiguration) uid: botbuilder-dialogs-adaptive.DateTimeInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof DateTimeInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof DateTimeInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInputConfiguration.yml index 0c931e4c..8d37d0a2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DateTimeInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: DateTimeInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: StringProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -58,7 +54,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -74,13 +69,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -91,7 +85,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -111,7 +104,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -127,21 +119,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.DateTimeInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -161,7 +153,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -177,7 +168,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -197,7 +187,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -213,21 +202,21 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: botbuilder-dialogs-adaptive.DateTimeInputConfiguration.unrecognizedPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -247,13 +236,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -263,13 +251,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivity.yml index f73ac9bf..4833b798 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivity.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Ends and deletes an activity. fullName: DeleteActivity remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: DeleteActivity() - uid: botbuilder-dialogs-adaptive.DeleteActivity.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DeleteActivity() properties: - name: $kind uid: botbuilder-dialogs-adaptive.DeleteActivity.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,7 +26,6 @@ properties: summary: The expression which resolves to the activityId to update. fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId: StringExpression' @@ -51,85 +38,80 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.DeleteActivity.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.DeleteActivity.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.DeleteActivity.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.DeleteActivity.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DeleteActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DeleteActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.DeleteActivity.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -153,20 +135,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.DeleteActivity.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -195,23 +177,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -238,7 +218,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -248,14 +227,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.DeleteActivity.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -274,10 +252,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.DeleteActivity.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -298,25 +276,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.DeleteActivity.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -356,12 +332,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -373,26 +348,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.DeleteActivity.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -404,21 +377,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof DeleteActivityConfiguration) uid: botbuilder-dialogs-adaptive.DeleteActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof DeleteActivityConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof DeleteActivityConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivityConfiguration.yml index 13c3f354..e1b10a66 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: DeleteActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperties.yml index 278376a7..c635539d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperties.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperties.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Deletes a collection of properties from memory. fullName: DeleteProperties remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: DeleteProperties() - uid: botbuilder-dialogs-adaptive.DeleteProperties.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DeleteProperties() properties: - name: $kind uid: botbuilder-dialogs-adaptive.DeleteProperties.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,26 +26,50 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.DeleteProperties.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: properties uid: botbuilder-dialogs-adaptive.DeleteProperties.properties package: botbuilder-dialogs-adaptive summary: Collection of property paths to remove. fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'properties: StringExpression[]' return: description: '' - type: 'StringExpression[]' + type: StringExpression[] + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.DeleteProperties.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.DeleteProperties.EndOfTurn @@ -70,66 +82,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.DeleteProperties.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.DeleteProperties.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DeleteProperties.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DeleteProperties' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.DeleteProperties.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -153,20 +135,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.DeleteProperties.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -195,23 +177,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -238,7 +218,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -248,14 +227,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.DeleteProperties.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -274,10 +252,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.DeleteProperties.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -298,25 +276,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.DeleteProperties.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -356,12 +332,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -373,26 +348,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.DeleteProperties.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -404,21 +377,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof DeletePropertiesConfiguration) uid: botbuilder-dialogs-adaptive.DeleteProperties.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof DeletePropertiesConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof DeletePropertiesConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertiesConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertiesConfiguration.yml index 40543d3a..a8ba0142 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertiesConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertiesConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: DeletePropertiesConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,13 +26,12 @@ properties: summary: '' fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties?: Array' + content: 'properties?: (string | StringExpression)[]' return: description: '' - type: Array<string | StringExpression> + type: (string | StringExpression)[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.DeletePropertiesConfiguration.id @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperty.yml index b6151d7e..e916dbc1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeleteProperty.yml @@ -5,24 +5,21 @@ package: botbuilder-dialogs-adaptive summary: Deletes a property from memory. fullName: DeleteProperty remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: DeleteProperty(string) + - name: DeleteProperty(string) uid: botbuilder-dialogs-adaptive.DeleteProperty.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `DeleteProperty` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DeleteProperty(property?: string)' parameters: - id: property type: string - description: | - (Optional) property to delete. + description: (Optional) property to delete. properties: - name: $kind uid: botbuilder-dialogs-adaptive.DeleteProperty.$kind @@ -30,7 +27,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -43,26 +39,50 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.DeleteProperty.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: property uid: botbuilder-dialogs-adaptive.DeleteProperty.property package: botbuilder-dialogs-adaptive summary: The property to delete. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.DeleteProperty.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.DeleteProperty.EndOfTurn @@ -75,66 +95,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.DeleteProperty.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.DeleteProperty.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DeleteProperty.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DeleteProperty' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.DeleteProperty.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -158,20 +148,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.DeleteProperty.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -200,23 +190,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -243,7 +231,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -253,14 +240,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.DeleteProperty.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -279,10 +265,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.DeleteProperty.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -303,25 +289,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.DeleteProperty.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -361,12 +345,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -378,26 +361,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.DeleteProperty.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -409,21 +390,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof DeletePropertyConfiguration) uid: botbuilder-dialogs-adaptive.DeleteProperty.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof DeletePropertyConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof DeletePropertyConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertyConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertyConfiguration.yml index 005cd067..94ceaa1d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertyConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DeletePropertyConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: DeletePropertyConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpression.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpression.yml index 2da750b3..95bb2c90 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpression.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpression.yml @@ -12,11 +12,10 @@ remarks: >- has '=' prefix or not. The result is interpreted as a resource Id or dialogId. -isPreview: false isDeprecated: false type: class constructors: - - name: DialogExpression(Dialog | string | Expression) + - name: DialogExpression(string | Dialog<{}> | Expression) uid: botbuilder-dialogs-adaptive.DialogExpression.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -24,14 +23,13 @@ constructors: [DialogExpression](xref:botbuilder-dialogs-adaptive.DialogExpression) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new DialogExpression(value?: Dialog | string | Expression)' + content: 'new DialogExpression(value?: string | Dialog<{}> | Expression)' parameters: - id: value - type: Dialog | string | Expression - description: > + type: string | Dialog<{}> | Expression + description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog), a `string` that is interpreted as a resource Id or dialogId, or an [Expression](xref:adaptive-expressions.Expression). @@ -42,7 +40,6 @@ inheritedProperties: summary: Getes or sets the expression text to evaluate to get the value. fullName: expressionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionText: string' @@ -56,13 +53,12 @@ inheritedProperties: summary: Gets or sets the raw value of the expression property. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value: Dialog' + content: 'value: Dialog<{}>' return: description: '' - type: Dialog + type: Dialog<{}> inheritanceDescription: Inherited From ExpressionProperty.value inheritedMethods: - name: getValue(object) @@ -70,24 +66,22 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Get the value. remarks: An error will be thrown if value is an invalid expression. - isPreview: false isDeprecated: false syntax: - content: 'function getValue(data: object): Dialog' + content: 'function getValue(data: object): Dialog<{}>' parameters: - id: data type: object description: Data to use for expression binding. return: description: The value. - type: Dialog + type: Dialog<{}> inheritanceDescription: Inherited From ExpressionProperty.getValue - name: toExpression() uid: botbuilder-dialogs-adaptive.DialogExpression.toExpression package: botbuilder-dialogs-adaptive summary: This will return the existing expression if the value is non-complex type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toExpression(): Expression' @@ -100,7 +94,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Convert an expression property to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -113,32 +106,30 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Try to Get the value. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetValue(data: object): { error: Error, value: Dialog }' + content: 'function tryGetValue(data: object): { error: Error, value: Dialog<{}> }' parameters: - id: data type: object description: Data to use for expression binding. return: description: the value or an error. - type: '{ error: Error, value: Dialog }' + type: '{ error: Error, value: Dialog<{}> }' inheritanceDescription: Inherited From ExpressionProperty.tryGetValue methods: - - name: setValue(Dialog | string | Expression) + - name: setValue(string | Dialog<{}> | Expression) uid: botbuilder-dialogs-adaptive.DialogExpression.setValue package: botbuilder-dialogs-adaptive summary: Sets the raw value of the expression property. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setValue(value: Dialog | string | Expression)' + content: 'function setValue(value: string | Dialog<{}> | Expression)' parameters: - id: value - type: Dialog | string | Expression - description: > + type: string | Dialog<{}> | Expression + description: >- A [Dialog](xref:botbuilder-dialogs.Dialog), a `string` that is interpreted as a resource Id or dialogId, or an [Expression](xref:adaptive-expressions.Expression). diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpressionConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpressionConverter.yml index d9ceb3c7..40cef6da 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpressionConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogExpressionConverter.yml @@ -7,7 +7,6 @@ summary: >- [Converter](xref:botbuilder-dialogs-declarative.Converter). fullName: DialogExpressionConverter remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,15 +18,13 @@ constructors: [DialogExpressionConverter](xref:botbuilder-dialogs-adaptive.DialogExpressionConverter) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DialogExpressionConverter(_resourceExplorer: ResourceExplorer)' parameters: - id: _resourceExplorer type: ResourceExplorer - description: | - Resource explorer to use for resolving references. + description: Resource explorer to use for resolving references. methods: - name: convert(Input | DialogExpression) uid: botbuilder-dialogs-adaptive.DialogExpressionConverter.convert @@ -37,15 +34,12 @@ methods: [DialogExpression](xref:botbuilder-dialogs-adaptive.DialogExpression) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: Input | DialogExpression): DialogExpression' parameters: - id: value - type: >- - | + type: Input | description: An object or string value. return: description: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogListConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogListConverter.yml deleted file mode 100644 index 5bcc398c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogListConverter.yml +++ /dev/null @@ -1,45 +0,0 @@ -### YamlMime:TSType -name: DialogListConverter -uid: botbuilder-dialogs-adaptive.DialogListConverter -package: botbuilder-dialogs-adaptive -summary: Converter which allows json to be expression to object or static object. -fullName: DialogListConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DialogListConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive.DialogListConverter.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [DialogListConverter](xref:botbuilder-dialogs-adaptive.DialogListConverter) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new DialogListConverter(_resourceExplorer: ResourceExplorer)' - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: | - Resource explorer to use for resolving references. -methods: - - name: 'convert(string[] | Dialog[])' - uid: botbuilder-dialogs-adaptive.DialogListConverter.convert - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string[] | Dialog[]): Dialog[]' - parameters: - - id: value - type: 'string[] | Dialog[]' - description: 'A list of strings representing dialogs, or a list of dialogs.' - return: - description: 'A new list of [Dialog](xref:botbuilder-dialogs.Dialog) instance.' - type: 'Dialog[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogProperty.yml index 4fd1724b..349b015d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: DialogProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type DialogProperty = Dialog | DialogExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogSetConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogSetConverter.yml deleted file mode 100644 index 0f60dbf7..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DialogSetConverter.yml +++ /dev/null @@ -1,49 +0,0 @@ -### YamlMime:TSType -name: DialogSetConverter -uid: botbuilder-dialogs-adaptive.DialogSetConverter -package: botbuilder-dialogs-adaptive -summary: >- - DialogSet converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: DialogSetConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DialogSetConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive.DialogSetConverter.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [DialogSetConverter](xref:botbuilder-dialogs-adaptive.DialogSetConverter) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new DialogSetConverter(_resourceExplorer: ResourceExplorer)' - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: | - Resource explorer to use for resolving references. -methods: - - name: 'convert(string[] | Dialog[] | DialogSet)' - uid: botbuilder-dialogs-adaptive.DialogSetConverter.convert - package: botbuilder-dialogs-adaptive - summary: >- - Converts an array of dialog or dialog name to a - [DialogSet](xref:botbuilder-dialogs.DialogSet) instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string[] | Dialog[] | DialogSet): DialogSet' - parameters: - - id: value - type: 'string[] | Dialog[] | DialogSet' - description: An array of dialog or dialog name. - return: - description: 'A new [DialogSet](xref:botbuilder-dialogs.DialogSet) instance.' - type: DialogSet diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DimensionEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DimensionEntityRecognizer.yml index aa7b521a..9fc245e2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DimensionEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DimensionEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes dimension input. fullName: DimensionEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.DimensionEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.DimensionEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DimensionEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + DimensionEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.DimensionEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +113,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +127,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.DimensionEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +161,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialog.yml index c7d2090a..9fa469e3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialog.yml @@ -5,29 +5,26 @@ package: botbuilder-dialogs-adaptive summary: >- Internal `BeginDialog` action which dynamically binds x.schema/x.dialog to invoke the x.dialog resource with properties as the options. -fullName: DynamicBeginDialog +fullName: DynamicBeginDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DynamicBeginDialog(string, O)' + - name: DynamicBeginDialog(string, {}) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `BeginDialog` instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new DynamicBeginDialog(dialogIdToCall: string, options?: O)' + content: 'new DynamicBeginDialog(dialogIdToCall: string, options?: {})' parameters: - id: dialogIdToCall type: string description: ID of the dialog to call. - id: options - type: O - description: | - (Optional) static options to pass the called dialog. + type: '{}' + description: (Optional) static options to pass the called dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.$kind @@ -35,13 +32,38 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' return: description: '' type: string + - name: id + uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.activityProcessed @@ -51,7 +73,6 @@ inheritedProperties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' @@ -60,14 +81,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [BaseInvokeDialog.activityProcessed](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.activityProcessed) + [BeginDialog.activityProcessed](xref:botbuilder-dialogs-adaptive.BeginDialog.activityProcessed) - name: dialog uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.dialog package: botbuilder-dialogs-adaptive summary: The dialog to call. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog: DialogExpression' @@ -76,14 +96,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [BaseInvokeDialog.dialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.dialog) + [BeginDialog.dialog](xref:botbuilder-dialogs-adaptive.BeginDialog.dialog) - name: disabled uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -104,35 +123,21 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [BeginDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.BeginDialog.EndOfTurn) - name: options uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.options package: botbuilder-dialogs-adaptive summary: Configurable options for the dialog. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: ObjectExpression' @@ -141,14 +146,13 @@ inheritedProperties: type: ObjectExpression<object> inheritanceDescription: >- Inherited From - [BaseInvokeDialog.options](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.options) + [BeginDialog.options](xref:botbuilder-dialogs-adaptive.BeginDialog.options) - name: resultProperty uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.resultProperty package: botbuilder-dialogs-adaptive summary: (Optional) property path to store the dialog result in. fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty?: StringExpression' @@ -158,34 +162,19 @@ inheritedProperties: inheritanceDescription: >- Inherited From [BeginDialog.resultProperty](xref:botbuilder-dialogs-adaptive.BeginDialog.resultProperty) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, {}) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function beginDialog(dc: DialogContext, options?: O): - Promise + function beginDialog(dc: DialogContext, options?: {}): + Promise> parameters: - id: dc type: DialogContext @@ -193,37 +182,38 @@ inheritedMethods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: options - type: O + type: '{}' description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [BeginDialog.beginDialog](xref:botbuilder-dialogs-adaptive.BeginDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DynamicBeginDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [BeginDialog.configure](xref:botbuilder-dialogs-adaptive.BeginDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -247,20 +237,22 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [BeginDialog.continueDialog](xref:botbuilder-dialogs-adaptive.BeginDialog.continueDialog) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -289,43 +281,46 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog - - name: getConverter(Object) + inheritanceDescription: >- + Inherited From + [BeginDialog.endDialog](xref:botbuilder-dialogs-adaptive.BeginDialog.endDialog) + - name: getConverter(keyof BeginDialogConfiguration) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof BeginDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof BeginDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From [BeginDialog.getConverter](xref:botbuilder-dialogs-adaptive.BeginDialog.getConverter) @@ -337,16 +332,15 @@ inheritedMethods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog<__type>[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog<__type>[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [BaseInvokeDialog.getDependencies](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getDependencies) + [BeginDialog.getDependencies](xref:botbuilder-dialogs-adaptive.BeginDialog.getDependencies) - name: getVersion() uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.getVersion package: botbuilder-dialogs-adaptive @@ -369,7 +363,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -378,15 +371,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [BeginDialog.getVersion](xref:botbuilder-dialogs-adaptive.BeginDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -404,11 +398,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [BeginDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.BeginDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -429,37 +425,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [BeginDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.BeginDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.DynamicBeginDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -469,8 +464,8 @@ inheritedMethods: - id: reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- @@ -478,7 +473,7 @@ inheritedMethods: of the value returned is dependent on the child dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [BeginDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.BeginDialog.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialogDeserializer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialogDeserializer.yml deleted file mode 100644 index e4e0121f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/DynamicBeginDialogDeserializer.yml +++ /dev/null @@ -1,56 +0,0 @@ -### YamlMime:TSType -name: DynamicBeginDialogDeserializer -uid: botbuilder-dialogs-adaptive.DynamicBeginDialogDeserializer -package: botbuilder-dialogs-adaptive -summary: >- - Internal serializer for `DynamicBeginDialog` which bind the x.dialog - resourceId to the DynamicBeginDialog.dialog property. -fullName: DynamicBeginDialogDeserializer -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'DynamicBeginDialogDeserializer(ResourceExplorer, string)' - uid: botbuilder-dialogs-adaptive.DynamicBeginDialogDeserializer.constructor - package: botbuilder-dialogs-adaptive - summary: Intializes an instance of `DynamicBeginDialogDeserializer`. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new DynamicBeginDialogDeserializer(_resourceExplorer: ResourceExplorer, - _resourceId: string) - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: The `ResourceExplorer` used by the deserializer. - - id: _resourceId - type: string - description: | - The resource id of the dynamic dialog. -methods: - - name: 'load(BeginDialogConfiguration, { })' - uid: botbuilder-dialogs-adaptive.DynamicBeginDialogDeserializer.load - package: botbuilder-dialogs-adaptive - summary: >- - The method that loads the configuration object to a `DynamicBeginDialog` - object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function load(config: BeginDialogConfiguration, type: { }): - DynamicBeginDialog - parameters: - - id: config - type: - description: The configuration object to deserialize. - - id: type - type: '{ }' - description: The object type that the configuration will be deserialized to. - return: - description: A `DynamicBeginDialog` object created from the configuration. - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActions.yml index 9367d4c1..d92b455d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActions.yml @@ -5,41 +5,28 @@ package: botbuilder-dialogs-adaptive summary: Class which allows you to edit the current actions. fullName: EditActions remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: EditActions() - uid: botbuilder-dialogs-adaptive.EditActions.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [EditActions](xref:botbuilder-dialogs-adaptive.EditActions) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new EditActions() - - name: 'EditActions(ActionChangeType, Dialog[])' + - name: EditActions(ActionChangeType, Dialog<{}>[]) uid: botbuilder-dialogs-adaptive.EditActions.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [EditActions](xref:botbuilder-dialogs-adaptive.EditActions) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new EditActions(changeType: ActionChangeType, actions?: Dialog[])' + content: 'new EditActions(changeType: ActionChangeType, actions?: Dialog<{}>[])' parameters: - id: changeType - type: + type: ActionChangeType description: >- - (xref:botbuilder-dialogs-adaptive.ActionChangeType), type of change - to apply to the active actions. + [ActionChangeType](xref:botbuilder-dialogs-adaptive.ActionChangeType), + type of change to apply to the active actions. - id: actions - type: 'Dialog[]' - description: > + type: Dialog<{}>[] + description: >- Optional. Child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies so they can be added to the containers dialogset. properties: @@ -49,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -62,113 +48,104 @@ properties: summary: The actions to update the dialog with. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] - name: changeType uid: botbuilder-dialogs-adaptive.EditActions.changeType package: botbuilder-dialogs-adaptive summary: The type of change to make to the dialogs list of actions. fullName: changeType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'changeType: EnumExpression' return: description: '' - type: >- - EnumExpression<> + type: EnumExpression<ActionChangeType> - name: disabled uid: botbuilder-dialogs-adaptive.EditActions.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.EditActions.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.EditActions.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.EditActions.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.EditActions.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EditActions.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): EditActions' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.EditActions.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -192,20 +169,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.EditActions.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -234,23 +211,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -277,7 +252,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -287,14 +261,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.EditActions.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -313,10 +286,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.EditActions.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -337,25 +310,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.EditActions.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -395,12 +366,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -412,26 +382,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.EditActions.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -443,23 +411,26 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof EditActionsConfiguration) uid: botbuilder-dialogs-adaptive.EditActions.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof EditActionsConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof EditActionsConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.EditActions.getDependencies package: botbuilder-dialogs-adaptive @@ -468,11 +439,10 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActionsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActionsConfiguration.yml index 9cc3cc97..82d12649 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActionsConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditActionsConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: EditActionsConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,35 +14,32 @@ properties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] - name: changeType uid: botbuilder-dialogs-adaptive.EditActionsConfiguration.changeType package: botbuilder-dialogs-adaptive summary: '' fullName: changeType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'changeType?: EnumProperty' return: description: '' type: >- - <> + <ActionChangeType> - name: disabled uid: botbuilder-dialogs-adaptive.EditActionsConfiguration.disabled package: botbuilder-dialogs-adaptive summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -57,7 +53,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -71,7 +66,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArray.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArray.yml index 7ca9809f..d01c6d7f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArray.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArray.yml @@ -5,29 +5,16 @@ package: botbuilder-dialogs-adaptive summary: Lets you modify an array in memory. fullName: EditArray remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: EditArray() - uid: botbuilder-dialogs-adaptive.EditArray.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [EditArray](xref:botbuilder-dialogs-adaptive.EditArray) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new EditArray() - - name: 'EditArray(ArrayChangeType, string, any, string)' + - name: EditArray(ArrayChangeType, string, any, string) uid: botbuilder-dialogs-adaptive.EditArray.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [EditArray](xref:botbuilder-dialogs-adaptive.EditArray) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +23,9 @@ constructors: parameters: - id: changeType type: - description: '(xref:botbuilder-dialogs-adaptive.ArrayChangeType), change type.' + description: >- + [ArrayChangeType](xref:botbuilder-dialogs-adaptive.ArrayChangeType), + change type. - id: itemsProperty type: string description: Array property. @@ -45,8 +34,7 @@ constructors: description: Optional. Value to insert. - id: resultProperty type: string - description: | - Optional. Output property to put Pop/Take into. + description: Optional. Output property to put Pop/Take into. properties: - name: $kind uid: botbuilder-dialogs-adaptive.EditArray.$kind @@ -54,7 +42,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -67,7 +54,6 @@ properties: summary: Type of change being applied. fullName: changeType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'changeType: EnumExpression' @@ -82,20 +68,30 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.EditArray.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: itemsProperty uid: botbuilder-dialogs-adaptive.EditArray.itemsProperty package: botbuilder-dialogs-adaptive summary: Property path expression to the collection of items. fullName: itemsProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'itemsProperty: StringExpression' @@ -108,20 +104,32 @@ properties: summary: The path expression to store the result of action. fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.EditArray.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.EditArray.value package: botbuilder-dialogs-adaptive summary: The expression of the value to put onto the array. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -140,66 +148,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.EditArray.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.EditArray.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EditArray.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): EditArray' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.EditArray.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -223,20 +201,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.EditArray.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -265,23 +243,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -308,7 +284,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -318,14 +293,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.EditArray.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -344,10 +318,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.EditArray.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -368,25 +342,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.EditArray.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -426,12 +398,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -443,26 +414,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.EditArray.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -474,21 +443,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof EditArrayConfiguration) uid: botbuilder-dialogs-adaptive.EditArray.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof EditArrayConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof EditArrayConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArrayConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArrayConfiguration.yml index e04f1402..1f164891 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArrayConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EditArrayConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: EditArrayConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: changeType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'changeType?: EnumProperty' @@ -30,7 +28,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -43,7 +40,6 @@ properties: summary: '' fullName: itemsProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'itemsProperty?: StringProperty' @@ -56,7 +52,6 @@ properties: summary: '' fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty?: StringProperty' @@ -69,13 +64,12 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.EditArrayConfiguration.id @@ -83,7 +77,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -97,7 +90,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmailEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmailEntityRecognizer.yml index 3b80cead..8b1c84f0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmailEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmailEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes email input. fullName: EmailEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.EmailEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.EmailEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EmailEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + EmailEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.EmailEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +112,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +126,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.EmailEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +160,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEvent.yml index be6cb9c3..630eb714 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEvent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEvent.yml @@ -5,29 +5,16 @@ package: botbuilder-dialogs-adaptive summary: Action which emits an event declaratively. fullName: EmitEvent remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: EmitEvent() - uid: botbuilder-dialogs-adaptive.EmitEvent.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [EmitEvent](xref:botbuilder-dialogs-adaptive.EmitEvent) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new EmitEvent() - - name: 'EmitEvent(string, string, boolean)' + - name: EmitEvent(string, string, boolean) uid: botbuilder-dialogs-adaptive.EmitEvent.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [EmitEvent](xref:botbuilder-dialogs-adaptive.EmitEvent) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -44,7 +31,7 @@ constructors: part of the event. - id: bubbleEvent type: boolean - description: > + description: >- Default = `false`. Value indicating whether the event should bubble to parents or not. properties: @@ -54,7 +41,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -69,7 +55,6 @@ properties: not. fullName: bubbleEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bubbleEvent: BoolExpression' @@ -82,7 +67,6 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -95,7 +79,6 @@ properties: summary: The name of the event to emit. fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: StringExpression' @@ -110,7 +93,6 @@ properties: event. fullName: eventValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventValue: ValueExpression' @@ -123,85 +105,80 @@ properties: summary: The property path to store whether the event was handled or not. fullName: handledProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'handledProperty: StringExpression' return: description: '' type: StringExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.EmitEvent.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.EmitEvent.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.EmitEvent.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.EmitEvent.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EmitEvent.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): EmitEvent' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.EmitEvent.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -225,20 +202,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.EmitEvent.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -267,23 +244,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -310,7 +285,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -320,14 +294,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.EmitEvent.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -346,10 +319,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.EmitEvent.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -370,25 +343,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.EmitEvent.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -428,12 +399,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -445,26 +415,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.EmitEvent.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -476,21 +444,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof EmitEventConfiguration) uid: botbuilder-dialogs-adaptive.EmitEvent.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof EmitEventConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof EmitEventConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEventConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEventConfiguration.yml index 6beb5231..9c7b717c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEventConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EmitEventConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: EmitEventConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: bubbleEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bubbleEvent?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName?: StringProperty' @@ -54,20 +50,18 @@ properties: summary: '' fullName: eventValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'eventValue?: UnknownProperty' + content: 'eventValue?: unknown' return: description: '' - type: + type: unknown - name: handledProperty uid: botbuilder-dialogs-adaptive.EmitEventConfiguration.handledProperty package: botbuilder-dialogs-adaptive summary: '' fullName: handledProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'handledProperty?: StringProperty' @@ -81,7 +75,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -95,7 +88,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialog.yml index 41579105..871b587f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialog.yml @@ -7,23 +7,21 @@ summary: >- the `resultProperty` as the result of the dialog. fullName: EndDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: EndDialog(any) + - name: EndDialog(any) uid: botbuilder-dialogs-adaptive.EndDialog.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `EndDialog` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new EndDialog(value?: any)' parameters: - id: value type: any - description: > + description: >- Optional, a value expression for the result to be returned to the caller. properties: @@ -33,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -46,20 +43,44 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.EndDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.EndDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.EndDialog.value package: botbuilder-dialogs-adaptive summary: A value expression for the result to be returned to the caller. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -78,66 +99,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.EndDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.EndDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EndDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): EndDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.EndDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -161,20 +152,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.EndDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -203,23 +194,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -246,7 +235,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -256,14 +244,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.EndDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -282,10 +269,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.EndDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -306,25 +293,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.EndDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -364,12 +349,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -381,26 +365,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.EndDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -412,21 +394,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof EndDialogConfiguration) uid: botbuilder-dialogs-adaptive.EndDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof EndDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof EndDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialogConfiguration.yml index 9160ed2a..fde27bcb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: EndDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,13 +26,12 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.EndDialogConfiguration.id @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurn.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurn.yml index 35c4f203..88e29567 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurn.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurn.yml @@ -7,26 +7,23 @@ summary: >- [Dialog](xref:botbuilder-dialogs.Dialog). fullName: EndTurn remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: EndTurn(string) + - name: EndTurn(string) uid: botbuilder-dialogs-adaptive.EndTurn.constructor package: botbuilder-dialogs-adaptive summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new EndTurn(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.EndTurn.$kind @@ -34,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -47,82 +43,77 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.EndTurn.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.EndTurn.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.EndTurn.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.EndTurn.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EndTurn.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): EndTurn' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: <O> + inheritanceDescription: Inherited From Dialog.configure + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.EndTurn.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -151,23 +142,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -194,7 +183,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -204,14 +192,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.EndTurn.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -230,10 +217,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.EndTurn.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -254,25 +241,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.EndTurn.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -312,12 +297,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -329,26 +313,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.EndTurn.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -360,7 +342,7 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.EndTurn.continueDialog package: botbuilder-dialogs-adaptive @@ -370,10 +352,11 @@ methods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -382,21 +365,24 @@ methods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof EndTurnConfiguration) uid: botbuilder-dialogs-adaptive.EndTurn.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof EndTurnConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof EndTurnConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurnConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurnConfiguration.yml index 98fcfb55..b630ee47 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurnConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EndTurnConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: EndTurnConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -29,7 +27,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignment.yml deleted file mode 100644 index b4156a5f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignment.yml +++ /dev/null @@ -1,178 +0,0 @@ -### YamlMime:TSType -name: EntityAssignment -uid: botbuilder-dialogs-adaptive.EntityAssignment -package: botbuilder-dialogs-adaptive -summary: Static methods for working with `EntityAssignment` objects. -fullName: EntityAssignment -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: EntityAssignment(Partial) - uid: botbuilder-dialogs-adaptive.EntityAssignment.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [EntityAssignment](xref:botbuilder-dialogs-adaptive.EntityAssignment) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new EntityAssignment(assignment: Partial)' - parameters: - - id: assignment - type: >- - Partial<> - description: | - The entity assignment properties to set for this instance. -properties: - - name: alternative - uid: botbuilder-dialogs-adaptive.EntityAssignment.alternative - package: botbuilder-dialogs-adaptive - summary: Alternative assignment. - fullName: alternative - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'alternative: EntityAssignment' - return: - description: '' - type: - - name: alternatives - uid: botbuilder-dialogs-adaptive.EntityAssignment.alternatives - package: botbuilder-dialogs-adaptive - summary: Gets the alternative entity assignments. - fullName: alternatives - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'EntityAssignment[] alternatives' - return: - description: The alternative entity assigment. - type: '[]' - - name: event - uid: botbuilder-dialogs-adaptive.EntityAssignment.event - package: botbuilder-dialogs-adaptive - summary: Event name to surface - fullName: event - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'event: string' - return: - description: '' - type: string - - name: expectedProperties - uid: botbuilder-dialogs-adaptive.EntityAssignment.expectedProperties - package: botbuilder-dialogs-adaptive - summary: The expected properties when assignment was made. - fullName: expectedProperties - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'expectedProperties: string[]' - return: - description: '' - type: 'string[]' - - name: isExpected - uid: botbuilder-dialogs-adaptive.EntityAssignment.isExpected - package: botbuilder-dialogs-adaptive - summary: >- - Value indicating whether this entity was in - `DialogPath.ExpectedProperties`. - fullName: isExpected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isExpected: boolean' - return: - description: '' - type: boolean - - name: operation - uid: botbuilder-dialogs-adaptive.EntityAssignment.operation - package: botbuilder-dialogs-adaptive - summary: Operation to assign entity to property. - fullName: operation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'operation: string' - return: - description: '' - type: string - - name: property - uid: botbuilder-dialogs-adaptive.EntityAssignment.property - package: botbuilder-dialogs-adaptive - summary: Name of property being assigned. - fullName: property - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'property: string' - return: - description: '' - type: string - - name: raisedCount - uid: botbuilder-dialogs-adaptive.EntityAssignment.raisedCount - package: botbuilder-dialogs-adaptive - summary: The number of times event has been raised. - fullName: raisedCount - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'raisedCount: number' - return: - description: '' - type: number - - name: value - uid: botbuilder-dialogs-adaptive.EntityAssignment.value - package: botbuilder-dialogs-adaptive - summary: Recognized entity value. - fullName: value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'value: Partial' - return: - description: '' - type: Partial<> -methods: - - name: 'addAlternatives(EntityAssignment[])' - uid: botbuilder-dialogs-adaptive.EntityAssignment.addAlternatives - package: botbuilder-dialogs-adaptive - summary: Add alternatives to a single assignment. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addAlternatives(alternatives: EntityAssignment[])' - parameters: - - id: alternatives - type: '[]' - description: | - Alternatives to add. - - name: toString() - uid: botbuilder-dialogs-adaptive.EntityAssignment.toString - package: botbuilder-dialogs-adaptive - summary: Print an assignment as a string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function toString(): string' - return: - description: A string that represents the current object. - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentComparer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentComparer.yml deleted file mode 100644 index 45e7fa98..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentComparer.yml +++ /dev/null @@ -1,62 +0,0 @@ -### YamlMime:TSType -name: EntityAssignmentComparer -uid: botbuilder-dialogs-adaptive.EntityAssignmentComparer -package: botbuilder-dialogs-adaptive -summary: Compare two entity assignments to determine their relative priority. -fullName: EntityAssignmentComparer -remarks: |- - Compare by event: assignEntity, chooseProperty, chooseEntity - Then by operations in order from schema (usually within assignEntity). - Then by unexpected before expected. - Then by oldest turn first. - Then by minimum position in utterance. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'EntityAssignmentComparer(string[])' - uid: botbuilder-dialogs-adaptive.EntityAssignmentComparer.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [EntityAssignmentComparer](xref:botbuilder-dialogs-adaptive.EntityAssignmentComparer) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new EntityAssignmentComparer(operationPreference: string[])' - parameters: - - id: operationPreference - type: 'string[]' - description: | - Preference on operations. -methods: - - name: 'compare(Partial, Partial)' - uid: botbuilder-dialogs-adaptive.EntityAssignmentComparer.compare - package: botbuilder-dialogs-adaptive - summary: >- - Compares - [EntityAssignment](xref:botbuilder-dialogs-adaptive.EntityAssignment) x - against y to determine its relative priority. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function compare(x: Partial, y: - Partial): number - parameters: - - id: x - type: >- - Partial<> - description: First entity assigment to compare. - - id: 'y' - type: >- - Partial<> - description: Second entity assigment to compare. - return: - description: Numerical value representing x's relative priority. - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentConfiguration.yml deleted file mode 100644 index 0a978706..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentConfiguration.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: EntityAssignmentConfiguration -uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration -package: botbuilder-dialogs-adaptive -summary: '' -fullName: EntityAssignmentConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: alternative - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.alternative - package: botbuilder-dialogs-adaptive - summary: Alternative assignment. - fullName: alternative - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'alternative: EntityAssignment' - return: - description: '' - type: - - name: event - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.event - package: botbuilder-dialogs-adaptive - summary: Event name to surface - fullName: event - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'event: string' - return: - description: '' - type: string - - name: expectedProperties - uid: >- - botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.expectedProperties - package: botbuilder-dialogs-adaptive - summary: The expected properties when assignment was made. - fullName: expectedProperties - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'expectedProperties: string[]' - return: - description: '' - type: 'string[]' - - name: isExpected - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.isExpected - package: botbuilder-dialogs-adaptive - summary: >- - Value indicating whether this entity was in - `DialogPath.ExpectedProperties`. - fullName: isExpected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isExpected: boolean' - return: - description: '' - type: boolean - - name: operation - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.operation - package: botbuilder-dialogs-adaptive - summary: Operation to apply to property and value. - fullName: operation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'operation: string' - return: - description: '' - type: string - - name: property - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.property - package: botbuilder-dialogs-adaptive - summary: Name of property being assigned. - fullName: property - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'property: string' - return: - description: '' - type: string - - name: raisedCount - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.raisedCount - package: botbuilder-dialogs-adaptive - summary: The number of times event has been raised. - fullName: raisedCount - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'raisedCount: number' - return: - description: '' - type: number - - name: value - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration.value - package: botbuilder-dialogs-adaptive - summary: Recognized entity value. - fullName: value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'value: Partial' - return: - description: '' - type: Partial<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignments.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignments.yml deleted file mode 100644 index a2cb6f28..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignments.yml +++ /dev/null @@ -1,108 +0,0 @@ -### YamlMime:TSType -name: EntityAssignments -uid: botbuilder-dialogs-adaptive.EntityAssignments -package: botbuilder-dialogs-adaptive -summary: Tracks entity related events to surface. -fullName: EntityAssignments -remarks: >- - When processing entities possible ambiguities are identified and when resolved - they turn into assign events. - - This tracking persists across multiple input utterances. -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'EntityAssignments(EntityAssignment[])' - uid: botbuilder-dialogs-adaptive.EntityAssignments.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [EntityAssignments](xref:botbuilder-dialogs-adaptive.EntityAssignments) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new EntityAssignments(assignments?: EntityAssignment[])' - parameters: - - id: assignments - type: '[]' - description: > - A list of - [EntityAssignments](xref:botbuilder-dialogs-adaptive.EntityAssignments) - to use. -properties: - - name: assignments - uid: botbuilder-dialogs-adaptive.EntityAssignments.assignments - package: botbuilder-dialogs-adaptive - summary: '' - fullName: assignments - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'assignments: EntityAssignment[]' - return: - description: '' - type: '[]' - - name: nextAssignment - uid: botbuilder-dialogs-adaptive.EntityAssignments.nextAssignment - package: botbuilder-dialogs-adaptive - summary: Gets the next entity event to surface. - fullName: nextAssignment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: EntityAssignment nextAssignment - return: - description: The next entity event to surface. - type: -methods: - - name: dequeue(ActionContext) - uid: botbuilder-dialogs-adaptive.EntityAssignments.dequeue - package: botbuilder-dialogs-adaptive - summary: Remove the current event and update the memory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function dequeue(actionContext: ActionContext): EntityAssignment' - parameters: - - id: actionContext - type: - description: Memory context. - return: - description: Removed event. - type: - - name: read(ActionContext) - uid: botbuilder-dialogs-adaptive.EntityAssignments.read - package: botbuilder-dialogs-adaptive - summary: Read entity event queue from memory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function read(actionContext: ActionContext): EntityAssignments' - parameters: - - id: actionContext - type: - description: Memory context. - return: - description: Entity event queue. - type: - - name: write(ActionContext) - uid: botbuilder-dialogs-adaptive.EntityAssignments.write - package: botbuilder-dialogs-adaptive - summary: Write state into memory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function write(actionContext: ActionContext)' - parameters: - - id: actionContext - type: - description: | - Memory context. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentsConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentsConfiguration.yml deleted file mode 100644 index 02cd5f8b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityAssignmentsConfiguration.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSType -name: EntityAssignmentsConfiguration -uid: botbuilder-dialogs-adaptive.EntityAssignmentsConfiguration -package: botbuilder-dialogs-adaptive -summary: '' -fullName: EntityAssignmentsConfiguration -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: assignments - uid: botbuilder-dialogs-adaptive.EntityAssignmentsConfiguration.assignments - package: botbuilder-dialogs-adaptive - summary: '' - fullName: assignments - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'assignments: EntityAssignment[]' - return: - description: '' - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityInfo.yml deleted file mode 100644 index d8544fc3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityInfo.yml +++ /dev/null @@ -1,310 +0,0 @@ -### YamlMime:TSType -name: EntityInfo -uid: botbuilder-dialogs-adaptive.EntityInfo -package: botbuilder-dialogs-adaptive -summary: |- - Extended information about an entity including $instance data. - Extended information about an entity including $instance data. -fullName: EntityInfo -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: coverage - uid: botbuilder-dialogs-adaptive.EntityInfo.coverage - package: botbuilder-dialogs-adaptive - summary: How much (0-1.0) of the original utterance is covered by entity. - fullName: coverage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'coverage: number' - return: - description: '' - type: number - - name: end - uid: botbuilder-dialogs-adaptive.EntityInfo.end - package: botbuilder-dialogs-adaptive - summary: Position where entity ends in utterance. - fullName: end - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'end: number' - return: - description: '' - type: number - - name: name - uid: botbuilder-dialogs-adaptive.EntityInfo.name - package: botbuilder-dialogs-adaptive - summary: Name of entity. - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: operation - uid: botbuilder-dialogs-adaptive.EntityInfo.operation - package: botbuilder-dialogs-adaptive - summary: Operation to apply to entity. - fullName: operation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'operation: string' - return: - description: '' - type: string - - name: priority - uid: botbuilder-dialogs-adaptive.EntityInfo.priority - package: botbuilder-dialogs-adaptive - summary: >- - Relative priority of entity compared to other entities with 0 being - highest priority. - fullName: priority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'priority: number' - return: - description: '' - type: number - - name: property - uid: botbuilder-dialogs-adaptive.EntityInfo.property - package: botbuilder-dialogs-adaptive - summary: Value of property if any. - fullName: property - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'property: string' - return: - description: '' - type: string - - name: rootEntity - uid: botbuilder-dialogs-adaptive.EntityInfo.rootEntity - package: botbuilder-dialogs-adaptive - summary: Root entity where this entity was found. - fullName: rootEntity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'rootEntity: string' - return: - description: '' - type: string - - name: score - uid: botbuilder-dialogs-adaptive.EntityInfo.score - package: botbuilder-dialogs-adaptive - summary: Score (0-1.0) of entity. - fullName: score - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'score: number' - return: - description: '' - type: number - - name: start - uid: botbuilder-dialogs-adaptive.EntityInfo.start - package: botbuilder-dialogs-adaptive - summary: Position where entity starts in utterance. - fullName: start - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'start: number' - return: - description: '' - type: number - - name: text - uid: botbuilder-dialogs-adaptive.EntityInfo.text - package: botbuilder-dialogs-adaptive - summary: Original text that led to entity. - fullName: text - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'text: string' - return: - description: '' - type: string - - name: type - uid: botbuilder-dialogs-adaptive.EntityInfo.type - package: botbuilder-dialogs-adaptive - summary: Type of entity. - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type: string' - return: - description: '' - type: string - - name: value - uid: botbuilder-dialogs-adaptive.EntityInfo.value - package: botbuilder-dialogs-adaptive - summary: Value of entity. - fullName: value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'value: any' - return: - description: '' - type: any - - name: whenRecognized - uid: botbuilder-dialogs-adaptive.EntityInfo.whenRecognized - package: botbuilder-dialogs-adaptive - summary: Event counter when entity was recognized. - fullName: whenRecognized - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'whenRecognized: number' - return: - description: '' - type: number -methods: - - name: 'alternative(Partial, Partial)' - uid: botbuilder-dialogs-adaptive.EntityInfo.alternative - package: botbuilder-dialogs-adaptive - summary: Returns true if entities come from exactly the same text in the utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function alternative(source: Partial, entity: - Partial): boolean - parameters: - - id: source - type: Partial<> - description: Source entity. - - id: entity - type: Partial<> - description: Entity to compare. - return: - description: >- - True if entities come from the exactly same text in utterance, - otherwise false. - type: boolean - - name: 'covers(Partial, Partial)' - uid: botbuilder-dialogs-adaptive.EntityInfo.covers - package: botbuilder-dialogs-adaptive - summary: Returns true entity text completely includes another entity text. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function covers(source: Partial, entity: - Partial): boolean - parameters: - - id: source - type: Partial<> - description: Source entity. - - id: entity - type: Partial<> - description: Entity to compare. - return: - description: >- - True if the entity text completely includes another entity text, - otherwise false. - type: boolean - - name: 'isSameEntity(Partial, Partial)' - uid: botbuilder-dialogs-adaptive.EntityInfo.isSameEntity - package: botbuilder-dialogs-adaptive - summary: Returns true if entities are the same. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isSameEntity(source: Partial, entity: - Partial): boolean - parameters: - - id: source - type: Partial<> - description: Source entity. - - id: entity - type: Partial<> - description: Entity to compare. - return: - description: 'True if entities are the same, otherwise false.' - type: boolean - - name: 'overlaps(Partial, Partial)' - uid: botbuilder-dialogs-adaptive.EntityInfo.overlaps - package: botbuilder-dialogs-adaptive - summary: Returns true if entities share text in utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function overlaps(source: Partial, entity: - Partial): boolean - parameters: - - id: source - type: Partial<> - description: Source entity. - - id: entity - type: Partial<> - description: Entity to compare. - return: - description: 'True if entities share text in utterance, otherwise false.' - type: boolean - - name: 'sharesRoot(Partial, Partial)' - uid: botbuilder-dialogs-adaptive.EntityInfo.sharesRoot - package: botbuilder-dialogs-adaptive - summary: Returns true if entities share the same root. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function sharesRoot(source: Partial, entity: - Partial): boolean - parameters: - - id: source - type: Partial<> - description: Source entity. - - id: entity - type: Partial<> - description: Entity to compare. - return: - description: 'True if entities share the same root, otherwise false.' - type: boolean - - name: toString(Partial) - uid: botbuilder-dialogs-adaptive.EntityInfo.toString - package: botbuilder-dialogs-adaptive - summary: Print an entity as a string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function toString(source: Partial): string' - parameters: - - id: source - type: Partial<> - description: Source entity. - return: - description: A string that represents the current object. - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizer.yml index 89841336..c6b8822e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Entity recognizers base class. fullName: EntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,14 +14,15 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.id](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.id) - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.EntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -31,7 +31,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -49,51 +48,58 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.telemetryClient](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.telemetryClient) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.EntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): EntityRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.configure](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive.EntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.getConverter](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.getConverter) methods: - name: >- recognize(DialogContext, Partial, Record, @@ -102,7 +108,6 @@ methods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -117,20 +122,19 @@ methods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.EntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive - summary: 'Recognizes entities from an [Entity](xref:botbuilder-core.Entity) list.' + summary: Recognizes entities from an [Entity](xref:botbuilder-core.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -149,9 +153,9 @@ methods: type: string description: Locale to use. - id: _entities - type: 'Entity[]' - description: 'The [Entity](xref:botbuilder-core.Entity) list to be recognized.' + type: Entity[] + description: The [Entity](xref:botbuilder-core.Entity) list to be recognized. return: - description: 'Recognized [Entity](xref:botbuilder-core.Entity) list.' - type: 'Promise<Entity[]>' + description: Recognized [Entity](xref:botbuilder-core.Entity) list. + type: Promise<Entity[]> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizerSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizerSet.yml index a0fc7dc1..3d69aa4d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizerSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EntityRecognizerSet.yml @@ -8,9 +8,33 @@ summary: >- instances, iterating until nobody has anything new to add. fullName: EntityRecognizerSet remarks: '' -isPreview: false isDeprecated: false type: class +constructors: + - name: EntityRecognizerSet(EntityRecognizer[]) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.constructor_1 + package: botbuilder-dialogs-adaptive + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new EntityRecognizerSet(items: EntityRecognizer[])' + parameters: + - id: items + type: [] + description: '' + - name: EntityRecognizerSet(number) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.constructor + package: botbuilder-dialogs-adaptive + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new EntityRecognizerSet(arrayLength: number)' + parameters: + - id: arrayLength + type: number + description: '' properties: - name: $kind uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.$kind @@ -18,36 +42,21 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' return: description: '' type: string - - name: Array - uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.Array - package: botbuilder-dialogs-adaptive - summary: '' - fullName: Array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Array: ArrayConstructor' - return: - description: '' - type: ArrayConstructor inheritedProperties: - name: length uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.length package: botbuilder-dialogs-adaptive summary: >- Gets or sets the length of the array. This is a number one higher than the - highest element defined in an array. + highest index in the array. fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: 'length: number' @@ -55,48 +64,87 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From Array.length + - name: '[species]' + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.[species] + package: botbuilder-dialogs-adaptive + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: ArrayConstructor' + return: + description: '' + type: ArrayConstructor + inheritanceDescription: Inherited From Array.__@species@2843 inheritedMethods: - - name: 'concat(ConcatArray[])' - uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.concat + - name: at(number) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.at + package: botbuilder-dialogs-adaptive + summary: |- + Takes an integer value and returns the item at that index, + allowing for positive and negative integers. + Negative integers count back from the last item in the array. + remarks: '' + isDeprecated: false + syntax: + content: 'function at(index: number): undefined | EntityRecognizer' + parameters: + - id: index + type: number + description: '' + return: + description: '' + type: >- + undefined | + inheritanceDescription: Inherited From Array.at + - name: concat((EntityRecognizer | ConcatArray)[]) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.concat_1 package: botbuilder-dialogs-adaptive - summary: Combines two or more arrays. + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function concat(items: ConcatArray[]): - EntityRecognizer[] + function concat(items: (EntityRecognizer | + ConcatArray)[]): EntityRecognizer[] parameters: - id: items type: >- + ( | ConcatArray<>[] - description: | - Additional items to add to the end of array1. + uid="botbuilder-dialogs-adaptive.EntityRecognizer" />>)[] + description: Additional arrays and/or items to add to the end of the array. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.concat - - name: 'concat(T | ConcatArray[])' - uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.concat_1 + - name: concat(ConcatArray[]) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.concat package: botbuilder-dialogs-adaptive - summary: Combines two or more arrays. + summary: |- + Combines two or more arrays. + This method returns a new array without modifying any existing arrays. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function concat(items: T | ConcatArray[]): EntityRecognizer[]' + content: >- + function concat(items: ConcatArray[]): + EntityRecognizer[] parameters: - id: items - type: 'T | ConcatArray<T>[]' - description: | - Additional items to add to the end of array1. + type: >- + ConcatArray<>[] + description: Additional arrays and/or items to add to the end of the array. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.concat - - name: 'copyWithin(number, number, number)' + - name: copyWithin(number, number, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.copyWithin package: botbuilder-dialogs-adaptive summary: >- @@ -105,10 +153,11 @@ inheritedMethods: to the same array starting at position target remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function copyWithin(target: number, start: number, end?: number): this' + content: >- + function copyWithin(target: number, start: number, end?: number): + EntityRecognizerSet parameters: - id: target type: number @@ -126,71 +175,111 @@ inheritedMethods: is treated as length+end. - id: end type: number - description: > + description: >- If not specified, length of the this object is used as its default value. return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.copyWithin - name: entries() uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.entries package: botbuilder-dialogs-adaptive - summary: 'Returns an iterable of key, value pairs for every entry in the array' + summary: Returns an iterable of key, value pairs for every entry in the array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function entries(): IterableIterator<[number, EntityRecognizer]>' return: description: '' - type: 'IterableIterator<[number, EntityRecognizer]>' + type: IterableIterator<[number, EntityRecognizer]> inheritanceDescription: Inherited From Array.entries - name: >- every((value: EntityRecognizer, index: number, array: EntityRecognizer[]) => unknown, any) - uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.every + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.every_1 package: botbuilder-dialogs-adaptive summary: Determines whether all the members of an array satisfy the specified test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function every(callbackfn: (value: EntityRecognizer, index: number, + function every(predicate: (value: EntityRecognizer, index: number, array: EntityRecognizer[]) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn + - id: predicate type: >- (value: EntityRecognizer, index: number, array: EntityRecognizer[]) => unknown description: >- A function that accepts up to three arguments. The every method - calls the callbackfn function for each element in array1 until the - callbackfn returns false, or until the end of the array. + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn - function. If thisArg is omitted, undefined is used as the this - value. + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. return: description: '' type: boolean inheritanceDescription: Inherited From Array.every - - name: 'fill(EntityRecognizer, number, number)' + - name: >- + every((value: EntityRecognizer, index: number, array: + EntityRecognizer[]) => value, any) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.every + package: botbuilder-dialogs-adaptive + summary: Determines whether all the members of an array satisfy the specified test. + remarks: '' + isDeprecated: false + syntax: + content: >- + function every(predicate: (value: EntityRecognizer, index: number, + array: EntityRecognizer[]) => value, thisArg?: any): this + parameters: + - id: predicate + type: >- + (value: EntityRecognizer, index: number, array: EntityRecognizer[]) + => value + description: >- + A function that accepts up to three arguments. The every method + calls + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value false, or until the end of + the array. + - id: thisArg + type: any + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: this + inheritanceDescription: Inherited From Array.every + - name: fill(EntityRecognizer, number, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.fill package: botbuilder-dialogs-adaptive summary: >- - Returns the this object after filling the section identified by start and - end with value + Changes all array elements from `start` to `end` index to a static `value` + and returns the modified array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function fill(value: EntityRecognizer, start?: number, end?: number): - this + EntityRecognizerSet parameters: - id: value type: @@ -204,14 +293,14 @@ inheritedMethods: length+start where length is the length of the array. - id: end type: number - description: > + description: >- index to stop filling the array at. If end is negative, it is treated as length+end. return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.fill - name: >- filter((value: EntityRecognizer, index: number, array: EntityRecognizer[]) @@ -222,65 +311,61 @@ inheritedMethods: Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: EntityRecognizer, index: number, + function filter(predicate: (value: EntityRecognizer, index: number, array: EntityRecognizer[]) => unknown, thisArg?: any): EntityRecognizer[] parameters: - - id: callbackfn + - id: predicate type: >- (value: EntityRecognizer, index: number, array: EntityRecognizer[]) => unknown description: >- A function that accepts up to three arguments. The filter method - calls the callbackfn function one time for each element in the - array. + calls the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.filter - name: >- filter((value: EntityRecognizer, index: number, array: - EntityRecognizer[]) => boolean, any) + EntityRecognizer[]) => value, any) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.filter package: botbuilder-dialogs-adaptive summary: >- Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: EntityRecognizer, index: number, - array: EntityRecognizer[]) => boolean, thisArg?: any): S[] + function filter(predicate: (value: EntityRecognizer, index: number, + array: EntityRecognizer[]) => value, thisArg?: any): S[] parameters: - - id: callbackfn + - id: predicate type: >- (value: EntityRecognizer, index: number, array: EntityRecognizer[]) - => boolean + => value description: >- A function that accepts up to three arguments. The filter method - calls the callbackfn function one time for each element in the - array. + calls the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'S[]' + type: S[] inheritanceDescription: Inherited From Array.filter - name: >- find((value: EntityRecognizer, index: number, obj: EntityRecognizer[]) => @@ -289,13 +374,12 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function find(predicate: (value: EntityRecognizer, index: number, obj: - EntityRecognizer[]) => unknown, thisArg?: any): EntityRecognizer | - undefined + EntityRecognizer[]) => unknown, thisArg?: any): undefined | + EntityRecognizer parameters: - id: predicate type: >- @@ -308,12 +392,12 @@ inheritedMethods: return: description: '' type: >- - | - undefined + undefined | inheritanceDescription: Inherited From Array.find - name: >- find((this: void, value: EntityRecognizer, index: number, obj: - EntityRecognizer[]) => boolean, any) + EntityRecognizer[]) => value, any) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.find package: botbuilder-dialogs-adaptive summary: >- @@ -322,18 +406,16 @@ inheritedMethods: otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function find(predicate: (this: void, value: EntityRecognizer, index: - number, obj: EntityRecognizer[]) => boolean, thisArg?: any): S | - undefined + number, obj: EntityRecognizer[]) => value, thisArg?: any): undefined | S parameters: - id: predicate type: >- (this: void, value: EntityRecognizer, index: number, obj: - EntityRecognizer[]) => boolean + EntityRecognizer[]) => value description: >- find calls predicate once for each element of the array, in ascending @@ -345,14 +427,14 @@ inheritedMethods: undefined. - id: thisArg type: any - description: > + description: >- If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. return: description: '' - type: S | undefined + type: undefined | S inheritanceDescription: Inherited From Array.find - name: >- findIndex((value: EntityRecognizer, index: number, obj: @@ -365,7 +447,6 @@ inheritedMethods: otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -387,7 +468,7 @@ inheritedMethods: findIndex returns -1. - id: thisArg type: any - description: > + description: >- If provided, it will be used as the this value for each invocation of @@ -396,6 +477,69 @@ inheritedMethods: description: '' type: number inheritanceDescription: Inherited From Array.findIndex + - name: flat(A, D) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.flat + package: botbuilder-dialogs-adaptive + summary: >- + Returns a new array with all sub-array elements concatenated into it + recursively up to the + + specified depth. + remarks: '' + isDeprecated: false + syntax: + content: 'function flat(this: A, depth?: D): FlatArray[]' + parameters: + - id: this + type: A + description: '' + - id: depth + type: D + description: The maximum recursion depth + return: + description: '' + type: FlatArray<A, D>[] + inheritanceDescription: Inherited From Array.flat + - name: >- + flatMap((this: This, value: EntityRecognizer, index: number, + array: EntityRecognizer[]) => U | (readonly U[]), This) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.flatMap + package: botbuilder-dialogs-adaptive + summary: >- + Calls a defined callback function on each element of an array. Then, + flattens the result into + + a new array. + + This is identical to a map followed by flat with depth 1. + remarks: '' + isDeprecated: false + syntax: + content: >- + function flatMap(callback: (this: This, value: + EntityRecognizer, index: number, array: EntityRecognizer[]) => U | + (readonly U[]), thisArg?: This): U[] + parameters: + - id: callback + type: >- + (this: This, value: EntityRecognizer, index: number, array: + EntityRecognizer[]) => U | (readonly U[]) + description: >- + A function that accepts up to three arguments. The flatMap method + calls the + + callback function one time for each element in the array. + - id: thisArg + type: This + description: >- + An object to which the this keyword can refer in the callback + function. If + + thisArg is omitted, undefined is used as the this value. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.flatMap - name: >- forEach((value: EntityRecognizer, index: number, array: EntityRecognizer[]) => void, any) @@ -403,7 +547,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Performs the specified action for each element in an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -419,19 +562,98 @@ inheritedMethods: callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. inheritanceDescription: Inherited From Array.forEach - - name: 'includes(EntityRecognizer, number)' + - name: 'from(ArrayLike, (v: T, k: number) => U, any)' + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.from_1 + package: botbuilder-dialogs-adaptive + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(arrayLike: ArrayLike, mapfn: (v: T, k: + number) => U, thisArg?: any): U[] + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: 'from(Iterable | ArrayLike, (v: T, k: number) => U, any)' + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.from_3 + package: botbuilder-dialogs-adaptive + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function from(iterable: Iterable | ArrayLike, mapfn: + (v: T, k: number) => U, thisArg?: any): U[] + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + - id: mapfn + type: '(v: T, k: number) => U' + description: A mapping function to call on every element of the array. + - id: thisArg + type: any + description: Value of 'this' used to invoke the mapfn. + return: + description: '' + type: U[] + inheritanceDescription: Inherited From Array.from + - name: from(ArrayLike) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.from + package: botbuilder-dialogs-adaptive + summary: Creates an array from an array-like object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(arrayLike: ArrayLike): T[]' + parameters: + - id: arrayLike + type: ArrayLike<T> + description: An array-like object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: from(Iterable | ArrayLike) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.from_2 + package: botbuilder-dialogs-adaptive + summary: Creates an array from an iterable object. + remarks: '' + isDeprecated: false + syntax: + content: 'static function from(iterable: Iterable | ArrayLike): T[]' + parameters: + - id: iterable + type: Iterable<T> | ArrayLike<T> + description: An iterable object to convert to an array. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.from + - name: includes(EntityRecognizer, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.includes package: botbuilder-dialogs-adaptive summary: >- Determines whether an array includes a certain element, returning true or false as appropriate. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -443,19 +665,20 @@ inheritedMethods: description: The element to search for. - id: fromIndex type: number - description: > + description: >- The position in this array at which to begin searching for searchElement. return: description: '' type: boolean inheritanceDescription: Inherited From Array.includes - - name: 'indexOf(EntityRecognizer, number)' + - name: indexOf(EntityRecognizer, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.indexOf package: botbuilder-dialogs-adaptive - summary: Returns the index of the first occurrence of a value in an array. + summary: >- + Returns the index of the first occurrence of a value in an array, or -1 if + it is not present. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -467,30 +690,45 @@ inheritedMethods: description: The value to locate in the array. - id: fromIndex type: number - description: > + description: >- The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. return: description: '' type: number inheritanceDescription: Inherited From Array.indexOf + - name: isArray(any) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.isArray + package: botbuilder-dialogs-adaptive + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function isArray(arg: any): arg' + parameters: + - id: arg + type: any + description: '' + return: + description: '' + type: arg + inheritanceDescription: Inherited From Array.isArray - name: join(string) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.join package: botbuilder-dialogs-adaptive summary: >- - Adds all the elements of an array separated by the specified separator - string. + Adds all the elements of an array into a string, separated by the + specified separator string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function join(separator?: string): string' parameters: - id: separator type: string - description: > - A string used to separate one element of an array from the next in - the resulting String. If omitted, the array elements are separated + description: >- + A string used to separate one element of the array from the next in + the resulting string. If omitted, the array elements are separated with a comma. return: description: '' @@ -501,7 +739,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns an iterable of keys in the array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keys(): IterableIterator' @@ -509,12 +746,13 @@ inheritedMethods: description: '' type: IterableIterator<number> inheritanceDescription: Inherited From Array.keys - - name: 'lastIndexOf(EntityRecognizer, number)' + - name: lastIndexOf(EntityRecognizer, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.lastIndexOf package: botbuilder-dialogs-adaptive - summary: Returns the index of the last occurrence of a specified value in an array. + summary: >- + Returns the index of the last occurrence of a specified value in an array, + or -1 if it is not present. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -526,9 +764,9 @@ inheritedMethods: description: The value to locate in the array. - id: fromIndex type: number - description: > - The array index at which to begin the search. If fromIndex is - omitted, the search starts at the last index in the array. + description: >- + The array index at which to begin searching backward. If fromIndex + is omitted, the search starts at the last index in the array. return: description: '' type: number @@ -542,7 +780,6 @@ inheritedMethods: Calls a defined callback function on each element of an array, and returns an array that contains the results. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -558,43 +795,62 @@ inheritedMethods: the callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. return: description: '' - type: 'U[]' + type: U[] inheritanceDescription: Inherited From Array.map + - name: of(T[]) + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.of + package: botbuilder-dialogs-adaptive + summary: Returns a new array from a set of elements. + remarks: '' + isDeprecated: false + syntax: + content: 'static function of(items: T[]): T[]' + parameters: + - id: items + type: T[] + description: A set of elements to include in the new array object. + return: + description: '' + type: T[] + inheritanceDescription: Inherited From Array.of - name: pop() uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.pop package: botbuilder-dialogs-adaptive - summary: Removes the last element from an array and returns it. + summary: >- + Removes the last element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function pop(): EntityRecognizer | undefined' + content: 'function pop(): undefined | EntityRecognizer' return: description: '' type: >- - | - undefined + undefined | inheritanceDescription: Inherited From Array.pop - - name: 'push(EntityRecognizer[])' + - name: push(EntityRecognizer[]) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.push package: botbuilder-dialogs-adaptive - summary: 'Appends new elements to an array, and returns the new length of the array.' + summary: >- + Appends new elements to the end of an array, and returns the new length of + the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function push(items: EntityRecognizer[]): number' parameters: - id: items - type: '[]' - description: | - New elements of the Array. + type: [] + description: New elements to add to the array. return: description: '' type: number @@ -609,7 +865,6 @@ inheritedMethods: The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -638,7 +893,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -670,7 +924,6 @@ inheritedMethods: The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -688,7 +941,7 @@ inheritedMethods: array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @@ -708,7 +961,6 @@ inheritedMethods: accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -737,7 +989,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -770,7 +1021,6 @@ inheritedMethods: accumulated result, and is provided as an argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -788,7 +1038,7 @@ inheritedMethods: array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @@ -799,51 +1049,65 @@ inheritedMethods: - name: reverse() uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.reverse package: botbuilder-dialogs-adaptive - summary: Reverses the elements in an Array. + summary: |- + Reverses the elements in an array in place. + This method mutates the array and returns a reference to the same array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reverse(): EntityRecognizer[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.reverse - name: shift() uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.shift package: botbuilder-dialogs-adaptive - summary: Removes the first element from an array and returns it. + summary: >- + Removes the first element from an array and returns it. + + If the array is empty, undefined is returned and the array is not + modified. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function shift(): EntityRecognizer | undefined' + content: 'function shift(): undefined | EntityRecognizer' return: description: '' type: >- - | - undefined + undefined | inheritanceDescription: Inherited From Array.shift - - name: 'slice(number, number)' + - name: slice(number, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.slice package: botbuilder-dialogs-adaptive - summary: Returns a section of an array. + summary: >- + Returns a copy of a section of an array. + + For both start and end, a negative index can be used to indicate an offset + from the end of the array. + + For example, -2 refers to the second to last element of the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function slice(start?: number, end?: number): EntityRecognizer[]' parameters: - id: start type: number - description: The beginning of the specified portion of the array. + description: |- + The beginning index of the specified portion of the array. + If start is undefined, then the slice begins at index 0. - id: end type: number - description: | - The end of the specified portion of the array. + description: >- + The end index of the specified portion of the array. This is + exclusive of the element at the index 'end'. + + If end is undefined, then the slice extends to the end of the array. return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From Array.slice - name: >- some((value: EntityRecognizer, index: number, array: EntityRecognizer[]) @@ -854,27 +1118,31 @@ inheritedMethods: Determines whether the specified callback function returns true for any element of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function some(callbackfn: (value: EntityRecognizer, index: number, - array: EntityRecognizer[]) => unknown, thisArg?: any): boolean + function some(predicate: (value: EntityRecognizer, index: number, array: + EntityRecognizer[]) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn + - id: predicate type: >- (value: EntityRecognizer, index: number, array: EntityRecognizer[]) => unknown description: >- A function that accepts up to three arguments. The some method calls - the callbackfn function for each element in array1 until the - callbackfn returns true, or until the end of the array. + + the predicate function for each element in the array until the + predicate returns a value + + which is coercible to the Boolean value true, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn - function. If thisArg is omitted, undefined is used as the this - value. + description: >- + An object to which the this keyword can refer in the predicate + function. + + If thisArg is omitted, undefined is used as the this value. return: description: '' type: boolean @@ -882,33 +1150,44 @@ inheritedMethods: - name: 'sort((a: EntityRecognizer, b: EntityRecognizer) => number)' uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.sort package: botbuilder-dialogs-adaptive - summary: Sorts an array. + summary: |- + Sorts an array in place. + This method mutates the array and returns a reference to the same array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function sort(compareFn?: (a: EntityRecognizer, b: EntityRecognizer) => - number): this + number): EntityRecognizerSet parameters: - id: compareFn type: '(a: EntityRecognizer, b: EntityRecognizer) => number' - description: > - The name of the function used to determine the order of the - elements. If omitted, the elements are sorted in ascending, ASCII - character order. + description: >- + Function used to determine the order of the elements. It is expected + to return + + a negative value if the first argument is less than the second + argument, zero if they're equal, and a positive + + value otherwise. If omitted, the elements are sorted in ascending, + ASCII character order. + + ```ts + + [11,2,22,1].sort((a, b) => a - b) + + ``` return: description: '' - type: this + type: inheritanceDescription: Inherited From Array.sort - - name: 'splice(number, number)' + - name: splice(number, number) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.splice package: botbuilder-dialogs-adaptive summary: >- Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function splice(start: number, deleteCount?: number): EntityRecognizer[]' @@ -920,20 +1199,18 @@ inheritedMethods: elements. - id: deleteCount type: number - description: | - The number of elements to remove. + description: The number of elements to remove. return: - description: '' - type: '[]' + description: An array containing the elements that were deleted. + type: [] inheritanceDescription: Inherited From Array.splice - - name: 'splice(number, number, EntityRecognizer[])' + - name: splice(number, number, EntityRecognizer[]) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.splice_1 package: botbuilder-dialogs-adaptive summary: >- Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -949,21 +1226,19 @@ inheritedMethods: type: number description: The number of elements to remove. - id: items - type: '[]' - description: | - Elements to insert into the array in place of the deleted elements. + type: [] + description: Elements to insert into the array in place of the deleted elements. return: - description: '' - type: '[]' + description: An array containing the elements that were deleted. + type: [] inheritanceDescription: Inherited From Array.splice - name: toLocaleString() uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.toLocaleString package: botbuilder-dialogs-adaptive summary: >- Returns a string representation of an array. The elements are converted to - string using their toLocalString methods. + string using their toLocaleString methods. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toLocaleString(): string' @@ -976,7 +1251,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns a string representation of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -984,20 +1258,20 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From Array.toString - - name: 'unshift(EntityRecognizer[])' + - name: unshift(EntityRecognizer[]) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.unshift package: botbuilder-dialogs-adaptive - summary: Inserts new elements at the start of an array. + summary: >- + Inserts new elements at the start of an array, and returns the new length + of the array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unshift(items: EntityRecognizer[]): number' parameters: - id: items - type: '[]' - description: | - Elements to insert at the start of the Array. + type: [] + description: Elements to insert at the start of the array. return: description: '' type: number @@ -1007,7 +1281,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns an iterable of values in the array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function values(): IterableIterator' @@ -1017,8 +1290,41 @@ inheritedMethods: IterableIterator<> inheritanceDescription: Inherited From Array.values + - name: '[iterator]()' + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.[iterator] + package: botbuilder-dialogs-adaptive + summary: Iterator + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator' + return: + description: '' + type: >- + IterableIterator<> + inheritanceDescription: Inherited From Array.__@iterator@2882 + - name: '[unscopables]()' + uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.[unscopables] + package: botbuilder-dialogs-adaptive + summary: |- + Returns an object whose properties have the value 'true' + when they will be absent when used in a 'with' statement. + remarks: '' + isDeprecated: false + syntax: + content: >- + function [unscopables](): { copyWithin: boolean, entries: boolean, fill: + boolean, find: boolean, findIndex: boolean, keys: boolean, values: + boolean } + return: + description: '' + type: >- + { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, + findIndex: boolean, keys: boolean, values: boolean } + inheritanceDescription: Inherited From Array.__@unscopables@2884 methods: - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.EntityRecognizerSet.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- @@ -1026,7 +1332,6 @@ methods: [EntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognizeEntities) by iterating against the Recognizer pool. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1036,8 +1341,8 @@ methods: - id: dialogContext type: DialogContext description: >- - (xref:botbuilder-dialogs.DialogContext) for the current turn of - conversation. + [DialogContext](xref:botbuilder-dialogs.DialogContext) for the + current turn of conversation. - id: text type: string description: Text to recognize. @@ -1045,12 +1350,12 @@ methods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. If no entities are passed in, it will generate a [TextEntity](xref:botbuilder-dialogs-adaptive.TextEntity). return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> extends: Array<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EnumProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EnumProperty.yml index 1155388c..d52479b7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EnumProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/EnumProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: EnumProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type EnumProperty = T | EnumExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/FirstSelector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/FirstSelector.yml index 3e6d0b9f..84bd5481 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/FirstSelector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/FirstSelector.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Select the first true rule implementation of TriggerSelector fullName: FirstSelector remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -23,66 +21,69 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.FirstSelector.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): FirstSelector' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TriggerSelector.configure](xref:botbuilder-dialogs-adaptive.TriggerSelector.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive.FirstSelector.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TriggerSelector.getConverter](xref:botbuilder-dialogs-adaptive.TriggerSelector.getConverter) methods: - - name: 'initialize(OnCondition[], boolean)' + - name: initialize(OnCondition[], boolean) uid: botbuilder-dialogs-adaptive.FirstSelector.initialize package: botbuilder-dialogs-adaptive summary: Initialize the selector with the set of rules. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(conditionals: OnCondition[], evaluate: boolean)' parameters: - id: conditionals - type: '[]' + type: [] description: Possible rules to match. - id: evaluate type: boolean - description: | - A boolean representing if rules should be evaluated on select. + description: A boolean representing if rules should be evaluated on select. - name: select(ActionContext) uid: botbuilder-dialogs-adaptive.FirstSelector.select package: botbuilder-dialogs-adaptive summary: Select the best rule to execute. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function select(actionContext: ActionContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEach.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEach.yml index 41a71a5a..4535066c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEach.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEach.yml @@ -7,40 +7,26 @@ summary: >- collection. fullName: ForEach remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: ForEach() - uid: botbuilder-dialogs-adaptive.ForEach.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [Foreach](xref:botbuilder-dialogs-adaptive.Foreach) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ForEach() - - name: 'ForEach(string, Dialog[])' + - name: ForEach(string, Dialog<{}>[]) uid: botbuilder-dialogs-adaptive.ForEach.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [Foreach](xref:botbuilder-dialogs-adaptive.Foreach) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ForEach(itemsProperty: string, actions: Dialog[])' + content: 'new ForEach(itemsProperty: string, actions: Dialog<{}>[])' parameters: - id: itemsProperty type: string description: Property path expression to the collection of items. - id: actions - type: 'Dialog[]' - description: | - The actions to execute. + type: Dialog<{}>[] + description: The actions to execute. properties: - name: $kind uid: botbuilder-dialogs-adaptive.ForEach.$kind @@ -48,7 +34,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -61,20 +46,30 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.ForEach.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: index uid: botbuilder-dialogs-adaptive.ForEach.index package: botbuilder-dialogs-adaptive summary: Property path expression to the item index. fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: 'index: StringExpression' @@ -87,20 +82,32 @@ properties: summary: Property path expression to the collection of items. fullName: itemsProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'itemsProperty: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ForEach.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.ForEach.value package: botbuilder-dialogs-adaptive summary: Property path expression to the item value. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: StringExpression' @@ -114,13 +121,12 @@ inheritedProperties: summary: The actions to execute. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [ActionScope.actions](xref:botbuilder-dialogs-adaptive.ActionScope.actions) @@ -135,62 +141,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ForEach.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ForEach.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [ActionScope.EndOfTurn](xref:botbuilder-dialogs-adaptive.ActionScope.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ForEach.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ForEach' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: >- + Inherited From + [ActionScope.configure](xref:botbuilder-dialogs-adaptive.ActionScope.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ForEach.continueDialog package: botbuilder-dialogs-adaptive @@ -200,10 +180,11 @@ inheritedMethods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -212,11 +193,11 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.continueDialog](xref:botbuilder-dialogs-adaptive.ActionScope.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ForEach.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -245,27 +226,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [ActionScope.endDialog](xref:botbuilder-dialogs-adaptive.ActionScope.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.ForEach.getVersion package: botbuilder-dialogs-adaptive @@ -275,7 +256,6 @@ inheritedMethods: changes between turns the dialog system will emit a DialogChanged event. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -287,14 +267,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [ActionScope.getVersion](xref:botbuilder-dialogs-adaptive.ActionScope.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ForEach.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -312,11 +291,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [ActionScope.onDialogEvent](xref:botbuilder-dialogs-adaptive.ActionScope.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ForEach.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -337,37 +318,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [ActionScope.repromptDialog](xref:botbuilder-dialogs-adaptive.ActionScope.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ForEach.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -377,8 +357,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- @@ -386,24 +366,23 @@ inheritedMethods: of the value returned is dependent on the child dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.resumeDialog](xref:botbuilder-dialogs-adaptive.ActionScope.resumeDialog) methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.ForEach.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -415,23 +394,26 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ForEachConfiguration) uid: botbuilder-dialogs-adaptive.ForEach.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ForEachConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ForEachConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.ForEach.getDependencies package: botbuilder-dialogs-adaptive @@ -440,11 +422,10 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachConfiguration.yml index 76c846af..ccbbeda8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ForEachConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: 'index?: StringProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: itemsProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'itemsProperty?: StringProperty' @@ -54,7 +50,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: StringProperty' @@ -68,13 +63,12 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From [ActionScopeConfiguration.actions](xref:botbuilder-dialogs-adaptive.ActionScopeConfiguration.actions) @@ -84,26 +78,28 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [ActionScopeConfiguration.id](xref:botbuilder-dialogs-adaptive.ActionScopeConfiguration.id) - name: telemetryClient uid: botbuilder-dialogs-adaptive.ForEachConfiguration.telemetryClient package: botbuilder-dialogs-adaptive summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [ActionScopeConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.ActionScopeConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPage.yml index 42469bf3..55083654 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPage.yml @@ -17,19 +17,8 @@ remarks: >- a `EndDialog` or `GotoDialog` action. -isPreview: false isDeprecated: false type: class -constructors: - - name: ForEachPage() - uid: botbuilder-dialogs-adaptive.ForEachPage.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ForEachPage() properties: - name: $kind uid: botbuilder-dialogs-adaptive.ForEachPage.$kind @@ -37,7 +26,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -50,20 +38,30 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.ForEachPage.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: itemsProperty uid: botbuilder-dialogs-adaptive.ForEachPage.itemsProperty package: botbuilder-dialogs-adaptive summary: Expression used to compute the list that should be enumerated. fullName: itemsProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'itemsProperty: StringExpression' @@ -76,7 +74,6 @@ properties: summary: Expression used to compute the list that should be enumerated. fullName: page remarks: '' - isPreview: false isDeprecated: false syntax: content: 'page: StringExpression' @@ -89,7 +86,6 @@ properties: summary: Expression used to compute the list that should be enumerated. fullName: pageIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pageIndex: StringExpression' @@ -99,16 +95,29 @@ properties: - name: pageSize uid: botbuilder-dialogs-adaptive.ForEachPage.pageSize package: botbuilder-dialogs-adaptive - summary: 'Page size, default to 10.' + summary: Page size, default to 10. fullName: pageSize remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pageSize: IntExpression' return: description: '' type: IntExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ForEachPage.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: actions uid: botbuilder-dialogs-adaptive.ForEachPage.actions @@ -116,13 +125,12 @@ inheritedProperties: summary: The actions to execute. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [ActionScope.actions](xref:botbuilder-dialogs-adaptive.ActionScope.actions) @@ -137,62 +145,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ForEachPage.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ForEachPage.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [ActionScope.EndOfTurn](xref:botbuilder-dialogs-adaptive.ActionScope.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ForEachPage.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ForEachPage' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: >- + Inherited From + [ActionScope.configure](xref:botbuilder-dialogs-adaptive.ActionScope.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ForEachPage.continueDialog package: botbuilder-dialogs-adaptive @@ -202,10 +184,11 @@ inheritedMethods: user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -214,11 +197,11 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.continueDialog](xref:botbuilder-dialogs-adaptive.ActionScope.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ForEachPage.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -247,27 +230,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [ActionScope.endDialog](xref:botbuilder-dialogs-adaptive.ActionScope.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.ForEachPage.getVersion package: botbuilder-dialogs-adaptive @@ -277,7 +260,6 @@ inheritedMethods: changes between turns the dialog system will emit a DialogChanged event. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -289,14 +271,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [ActionScope.getVersion](xref:botbuilder-dialogs-adaptive.ActionScope.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ForEachPage.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -314,11 +295,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [ActionScope.onDialogEvent](xref:botbuilder-dialogs-adaptive.ActionScope.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ForEachPage.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -339,37 +322,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [ActionScope.repromptDialog](xref:botbuilder-dialogs-adaptive.ActionScope.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ForEachPage.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -379,8 +361,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: result type: any description: |- @@ -388,24 +370,23 @@ inheritedMethods: of the value returned is dependent on the child dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [ActionScope.resumeDialog](xref:botbuilder-dialogs-adaptive.ActionScope.resumeDialog) methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.ForEachPage.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -417,23 +398,26 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ForEachPageConfiguration) uid: botbuilder-dialogs-adaptive.ForEachPage.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ForEachPageConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ForEachPageConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.ForEachPage.getDependencies package: botbuilder-dialogs-adaptive @@ -442,11 +426,10 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPageConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPageConfiguration.yml index f481e4e5..938ece67 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPageConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ForEachPageConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ForEachPageConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: itemsProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'itemsProperty?: StringProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: page remarks: '' - isPreview: false isDeprecated: false syntax: content: 'page?: StringProperty' @@ -54,7 +50,6 @@ properties: summary: '' fullName: pageIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pageIndex?: StringProperty' @@ -67,7 +62,6 @@ properties: summary: '' fullName: pageSize remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pageSize?: IntProperty' @@ -81,13 +75,12 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From [ActionScopeConfiguration.actions](xref:botbuilder-dialogs-adaptive.ActionScopeConfiguration.actions) @@ -97,26 +90,28 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [ActionScopeConfiguration.id](xref:botbuilder-dialogs-adaptive.ActionScopeConfiguration.id) - name: telemetryClient uid: botbuilder-dialogs-adaptive.ForEachPageConfiguration.telemetryClient package: botbuilder-dialogs-adaptive summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [ActionScopeConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.ActionScopeConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembers.yml index 3c9274d4..fc6b705f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembers.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembers.yml @@ -5,21 +5,10 @@ package: botbuilder-dialogs-adaptive summary: >- Calls `BotFrameworkAdapter.getActivityMembers()` and sets the result to a memory property. -fullName: 'GetActivityMembers' +fullName: GetActivityMembers remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: GetActivityMembers() - uid: botbuilder-dialogs-adaptive.GetActivityMembers.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetActivityMembers() properties: - name: $kind uid: botbuilder-dialogs-adaptive.GetActivityMembers.$kind @@ -27,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -40,7 +28,6 @@ properties: summary: The expression to get the value to put into property path. fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId: StringExpression' @@ -53,26 +40,50 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.GetActivityMembers.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: property uid: botbuilder-dialogs-adaptive.GetActivityMembers.property package: botbuilder-dialogs-adaptive summary: Property path to put the value in. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.GetActivityMembers.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.GetActivityMembers.EndOfTurn @@ -85,66 +96,38 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.GetActivityMembers.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.GetActivityMembers.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.GetActivityMembers.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + GetActivityMembers parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.GetActivityMembers.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -168,20 +151,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.GetActivityMembers.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -210,23 +193,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -253,7 +234,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -263,14 +243,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.GetActivityMembers.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -289,10 +268,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.GetActivityMembers.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -313,25 +292,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.GetActivityMembers.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -371,12 +348,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -388,26 +364,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.GetActivityMembers.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -419,21 +393,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetActivityMembersConfiguration) uid: botbuilder-dialogs-adaptive.GetActivityMembers.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof GetActivityMembersConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof GetActivityMembersConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembersConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembersConfiguration.yml index 2d6fc413..d46ac911 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembersConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetActivityMembersConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: GetActivityMembersConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -55,7 +51,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -70,7 +65,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembers.yml index 5e04bb41..2c96b188 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembers.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembers.yml @@ -7,19 +7,8 @@ summary: >- memory property. fullName: GetConversationMembers remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: GetConversationMembers() - uid: botbuilder-dialogs-adaptive.GetConversationMembers.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GetConversationMembers() properties: - name: $kind uid: botbuilder-dialogs-adaptive.GetConversationMembers.$kind @@ -27,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -40,26 +28,50 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.GetConversationMembers.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: property uid: botbuilder-dialogs-adaptive.GetConversationMembers.property package: botbuilder-dialogs-adaptive summary: Property path to put the value in. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.GetConversationMembers.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.GetConversationMembers.EndOfTurn @@ -72,66 +84,40 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.GetConversationMembers.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.GetConversationMembers.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.GetConversationMembers.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + GetConversationMembers parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.GetConversationMembers.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -155,20 +141,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.GetConversationMembers.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -197,23 +183,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -240,7 +224,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -250,14 +233,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.GetConversationMembers.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -276,10 +258,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.GetConversationMembers.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -300,25 +282,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.GetConversationMembers.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -358,12 +338,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -375,26 +354,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.GetConversationMembers.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -406,21 +383,25 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetConversationMembersConfiguration) uid: botbuilder-dialogs-adaptive.GetConversationMembers.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + GetConversationMembersConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof GetConversationMembersConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembersConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembersConfiguration.yml index 7ad9ac02..beffc45d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembersConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationMembersConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: GetConversationMembersConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -57,7 +53,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReference.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReference.yml index 3c3e83f9..179444da 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReference.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReference.yml @@ -5,9 +5,8 @@ package: botbuilder-dialogs-adaptive summary: >- Gets the current conversation reference and saves it to a memory property suitable to use in ContinueConversation action. -fullName: GetConversationReference +fullName: GetConversationReference remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,15 +17,13 @@ constructors: Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new GetConversationReference(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.GetConversationReference.$kind @@ -34,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -49,26 +45,50 @@ properties: action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.GetConversationReference.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: property uid: botbuilder-dialogs-adaptive.GetConversationReference.property package: botbuilder-dialogs-adaptive summary: Gets or sets property path to put the value in. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.GetConversationReference.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.GetConversationReference.EndOfTurn @@ -81,66 +101,38 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.GetConversationReference.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.GetConversationReference.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.GetConversationReference.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + GetConversationReference parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.GetConversationReference.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -164,20 +156,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.GetConversationReference.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -206,23 +198,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -249,7 +239,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -259,14 +248,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.GetConversationReference.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -285,10 +273,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.GetConversationReference.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -309,25 +297,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.GetConversationReference.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -367,12 +353,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -384,24 +369,22 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, Record)' + - name: beginDialog(DialogContext, Record) uid: botbuilder-dialogs-adaptive.GetConversationReference.beginDialog package: botbuilder-dialogs-adaptive summary: Called when the dialog is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: Record): Promise + unknown>): Promise> parameters: - id: dc type: DialogContext @@ -409,25 +392,29 @@ methods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: _options - type: 'Record<string, unknown>' - description: 'Optional, initial information to pass to the dialog.' + type: Record<string, unknown> + description: Optional, initial information to pass to the dialog. return: description: A promise representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GetConversationReferenceConfiguration) uid: botbuilder-dialogs-adaptive.GetConversationReference.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + GetConversationReferenceConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof GetConversationReferenceConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReferenceConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReferenceConfiguration.yml index a144df55..9b45b397 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReferenceConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GetConversationReferenceConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: GetConversationReferenceConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -57,7 +53,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoAction.yml index 1fa373da..820063cf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoAction.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Goto an action by Id. fullName: GotoAction remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: GotoAction() - uid: botbuilder-dialogs-adaptive.GotoAction.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new GotoAction() properties: - name: $kind uid: botbuilder-dialogs-adaptive.GotoAction.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,7 +26,6 @@ properties: summary: The action id to go. fullName: actionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actionId: StringExpression' @@ -51,85 +38,80 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.GotoAction.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.GotoAction.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.GotoAction.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.GotoAction.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.GotoAction.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): GotoAction' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.GotoAction.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -153,20 +135,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.GotoAction.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -195,23 +177,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -238,7 +218,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -248,14 +227,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.GotoAction.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -274,10 +252,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.GotoAction.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -298,25 +276,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.GotoAction.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -356,12 +332,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -373,26 +348,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.GotoAction.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -404,21 +377,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof GotoActionConfiguration) uid: botbuilder-dialogs-adaptive.GotoAction.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof GotoActionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof GotoActionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoActionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoActionConfiguration.yml index aaddec78..811934e6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoActionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GotoActionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: GotoActionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: actionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actionId?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GuidEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GuidEntityRecognizer.yml index 94e818ed..a77094db 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GuidEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/GuidEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes GUID input. fullName: GuidEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.GuidEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.GuidEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.GuidEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + GuidEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.GuidEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +112,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +126,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.GuidEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +160,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HasPendingActionsFunction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HasPendingActionsFunction.yml index c956216b..977a53b4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HasPendingActionsFunction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HasPendingActionsFunction.yml @@ -9,7 +9,6 @@ summary: >- actions. fullName: HasPendingActionsFunction remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -20,7 +19,6 @@ constructors: Initializes a new instance of the [HasPendingActionsFunction](xref:botbuilder-dialogs-adaptive.HasPendingActionsFunction). remarks: '' - isPreview: false isDeprecated: false syntax: content: new HasPendingActionsFunction() @@ -31,7 +29,6 @@ properties: summary: Function identifier name. fullName: functionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static functionName: "hasPendingActions" = "hasPendingActions"' @@ -45,7 +42,6 @@ inheritedProperties: summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'negation: ExpressionEvaluator' @@ -59,7 +55,6 @@ inheritedProperties: summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -73,7 +68,6 @@ inheritedProperties: summary: Evaluate an expression. fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -91,7 +85,6 @@ inheritedProperties: summary: Gets the expression type for evaluator. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -105,7 +98,6 @@ inheritedProperties: summary: Validate an expression. fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validateExpression: (expression: Expression) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HashtagEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HashtagEntityRecognizer.yml index 44e1969e..1cabc088 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HashtagEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HashtagEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes hashtag input. fullName: HashtagEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.HashtagEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.HashtagEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.HashtagEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + HashtagEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.HashtagEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +112,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +126,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.HashtagEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +160,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersInput.yml deleted file mode 100644 index ad5a538e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersInput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: HeadersInput -uid: botbuilder-dialogs-adaptive.HeadersInput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: HeadersInput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type HeadersInput = Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersOutput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersOutput.yml deleted file mode 100644 index f848cbd6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HeadersOutput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: HeadersOutput -uid: botbuilder-dialogs-adaptive.HeadersOutput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: HeadersOutput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type HeadersOutput = Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpMethod.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpMethod.yml index ff174cf7..a1382062 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpMethod.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpMethod.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: HttpMethod remarks: '' -isPreview: false isDeprecated: false fields: - name: DELETE @@ -16,6 +15,10 @@ fields: uid: botbuilder-dialogs-adaptive.HttpMethod.GET package: botbuilder-dialogs-adaptive summary: Http GET + - name: HEAD + uid: botbuilder-dialogs-adaptive.HttpMethod.HEAD + package: botbuilder-dialogs-adaptive + summary: Http HEAD - name: PATCH uid: botbuilder-dialogs-adaptive.HttpMethod.PATCH package: botbuilder-dialogs-adaptive diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequest.yml index 564fd7be..50633855 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequest.yml @@ -5,34 +5,21 @@ package: botbuilder-dialogs-adaptive summary: Action for performing an `HttpRequest`. fullName: HttpRequest remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: HttpRequest() - uid: botbuilder-dialogs-adaptive.HttpRequest.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [HttpRequest](xref:botbuilder-dialogs-adaptive.HttpRequest) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new HttpRequest() - - name: 'HttpRequest(HttpMethod, string, [key: string]: string, any)' + - name: 'HttpRequest(HttpMethod, string, {[key: string]: string}, any)' uid: botbuilder-dialogs-adaptive.HttpRequest.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [HttpRequest](xref:botbuilder-dialogs-adaptive.HttpRequest) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new HttpRequest(method: HttpMethod, url: string, headers: [key: string]: - string, body: any) + new HttpRequest(method: HttpMethod, url: string, headers: {[key: + string]: string}, body: any) parameters: - id: method type: @@ -43,12 +30,11 @@ constructors: type: string description: URL for the request. - id: headers - type: '[key: string]\: string' + type: '{[key: string]: string}' description: The headers of the request. - id: body type: any - description: | - The raw body of the request. + description: The raw body of the request. properties: - name: $kind uid: botbuilder-dialogs-adaptive.HttpRequest.$kind @@ -56,7 +42,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -69,7 +54,6 @@ properties: summary: Http Body fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: ValueExpression' @@ -82,7 +66,6 @@ properties: summary: Content type of request body fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType?: StringExpression' @@ -95,7 +78,6 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -108,20 +90,30 @@ properties: summary: Http Headers fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'headers?: [key: string]: StringExpression' + content: 'headers?: {[key: string]: StringExpression}' return: description: '' - type: '[key: string]\: StringExpression' + type: '{[key: string]: StringExpression}' + - name: id + uid: botbuilder-dialogs-adaptive.HttpRequest.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: method uid: botbuilder-dialogs-adaptive.HttpRequest.method package: botbuilder-dialogs-adaptive summary: Http Method fullName: method remarks: '' - isPreview: false isDeprecated: false syntax: content: 'method?: HttpMethod' @@ -134,7 +126,6 @@ properties: summary: The response type of the response fullName: responseType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'responseType?: EnumExpression' @@ -149,20 +140,32 @@ properties: summary: Gets or sets the property expression to store the HTTP response in. fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.HttpRequest.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: url uid: botbuilder-dialogs-adaptive.HttpRequest.url package: botbuilder-dialogs-adaptive summary: Http Url fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url?: StringExpression' @@ -181,66 +184,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.HttpRequest.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.HttpRequest.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.HttpRequest.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): HttpRequest' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.HttpRequest.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -264,20 +237,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.HttpRequest.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -306,23 +279,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -349,7 +320,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -359,14 +329,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.HttpRequest.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -385,10 +354,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.HttpRequest.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -409,25 +378,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.HttpRequest.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -467,12 +434,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -484,26 +450,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.HttpRequest.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -515,21 +479,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof HttpRequestConfiguration) uid: botbuilder-dialogs-adaptive.HttpRequest.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof HttpRequestConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof HttpRequestConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequestConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequestConfiguration.yml index 8ae9ed44..e74ec2e9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequestConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/HttpRequestConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: HttpRequestConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'body?: UnknownProperty' + content: 'body?: unknown' return: description: '' - type: + type: unknown - name: contentType uid: botbuilder-dialogs-adaptive.HttpRequestConfiguration.contentType package: botbuilder-dialogs-adaptive summary: '' fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType?: StringProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -54,22 +50,18 @@ properties: summary: '' fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'headers?: HeadersInput | HeadersOutput' return: description: '' - type: >- - | + type: HeadersInput | HeadersOutput - name: method uid: botbuilder-dialogs-adaptive.HttpRequestConfiguration.method package: botbuilder-dialogs-adaptive summary: '' fullName: method remarks: '' - isPreview: false isDeprecated: false syntax: content: 'method?: HttpMethod' @@ -82,7 +74,6 @@ properties: summary: '' fullName: responseType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'responseType?: EnumProperty' @@ -97,7 +88,6 @@ properties: summary: '' fullName: resultProperty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resultProperty: StringProperty' @@ -110,7 +100,6 @@ properties: summary: '' fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url?: StringProperty' @@ -124,7 +113,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -138,7 +126,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfCondition.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfCondition.yml index eb129f0c..802074a2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfCondition.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfCondition.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Conditional branch. fullName: IfCondition remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: IfCondition() - uid: botbuilder-dialogs-adaptive.IfCondition.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new IfCondition() properties: - name: $kind uid: botbuilder-dialogs-adaptive.IfCondition.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -35,23 +23,21 @@ properties: - name: actions uid: botbuilder-dialogs-adaptive.IfCondition.actions package: botbuilder-dialogs-adaptive - summary: 'The actions to run if [condition](#condition) returns true.' + summary: The actions to run if [condition](#condition) returns true. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] - name: condition uid: botbuilder-dialogs-adaptive.IfCondition.condition package: botbuilder-dialogs-adaptive summary: Conditional expression to evaluate. fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -64,7 +50,6 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -74,88 +59,83 @@ properties: - name: elseActions uid: botbuilder-dialogs-adaptive.IfCondition.elseActions package: botbuilder-dialogs-adaptive - summary: 'The actions to run if [condition](#condition) returns false.' + summary: The actions to run if [condition](#condition) returns false. fullName: elseActions remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'elseActions: Dialog[]' - return: - description: '' - type: 'Dialog[]' -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.IfCondition.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'elseActions: Dialog<{}>[]' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn + type: Dialog<{}>[] - name: id uid: botbuilder-dialogs-adaptive.IfCondition.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.IfCondition.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.IfCondition.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.IfCondition.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): IfCondition' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.IfCondition.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -179,20 +159,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.IfCondition.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -221,23 +201,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -264,7 +242,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -274,14 +251,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.IfCondition.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -300,10 +276,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.IfCondition.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -324,25 +300,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.IfCondition.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -382,12 +356,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -399,26 +372,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.IfCondition.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -430,23 +401,26 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof IfConditionConfiguration) uid: botbuilder-dialogs-adaptive.IfCondition.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof IfConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof IfConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.IfCondition.getDependencies package: botbuilder-dialogs-adaptive @@ -455,11 +429,10 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfConditionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfConditionConfiguration.yml index e1375108..8b358685 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfConditionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IfConditionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: IfConditionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] - name: condition uid: botbuilder-dialogs-adaptive.IfConditionConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -54,13 +50,12 @@ properties: summary: '' fullName: elseActions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'elseActions?: string[] | Dialog[]' + content: 'elseActions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.IfConditionConfiguration.id @@ -68,7 +63,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -82,7 +76,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Input.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Input.yml deleted file mode 100644 index 97c9ac3f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Input.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: Input -uid: botbuilder-dialogs-adaptive.Input -package: botbuilder-dialogs-adaptive -summary: '' -fullName: Input -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type Input = Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialog.yml index cdbbb48c..f1bfa231 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialog.yml @@ -3,30 +3,28 @@ name: InputDialog uid: botbuilder-dialogs-adaptive.InputDialog package: botbuilder-dialogs-adaptive summary: Defines input dialogs. -fullName: InputDialog +fullName: InputDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'InputDialog(string, Partial | string)' + - name: InputDialog(string, string | Partial) uid: botbuilder-dialogs-adaptive.InputDialog.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new InputDialog(property?: string, prompt?: Partial | string)' + content: 'new InputDialog(property?: string, prompt?: string | Partial)' parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -39,7 +37,6 @@ properties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -54,7 +51,6 @@ properties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -67,7 +63,6 @@ properties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -82,7 +77,6 @@ properties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -90,20 +84,31 @@ properties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: disabled uid: botbuilder-dialogs-adaptive.InputDialog.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.InputDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: invalidPrompt uid: botbuilder-dialogs-adaptive.InputDialog.invalidPrompt package: botbuilder-dialogs-adaptive @@ -112,13 +117,12 @@ properties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: maxTurnCount uid: botbuilder-dialogs-adaptive.InputDialog.maxTurnCount package: botbuilder-dialogs-adaptive @@ -127,7 +131,6 @@ properties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -140,7 +143,6 @@ properties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -153,33 +155,44 @@ properties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: property uid: botbuilder-dialogs-adaptive.InputDialog.property package: botbuilder-dialogs-adaptive summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.InputDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.InputDialog.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -192,7 +205,6 @@ properties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -200,27 +212,25 @@ properties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> - name: validations uid: botbuilder-dialogs-adaptive.InputDialog.validations package: botbuilder-dialogs-adaptive summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] - name: value uid: botbuilder-dialogs-adaptive.InputDialog.value package: botbuilder-dialogs-adaptive summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -233,7 +243,6 @@ properties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -252,63 +261,33 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.InputDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.InputDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.InputDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): InputDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: + inheritanceDescription: Inherited From Dialog.configure + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.InputDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -337,23 +316,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -380,7 +357,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -390,14 +366,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.InputDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -416,10 +391,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.InputDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -440,38 +415,35 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog methods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.InputDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -487,7 +459,7 @@ methods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.InputDialog.continueDialog package: botbuilder-dialogs-adaptive @@ -495,10 +467,11 @@ methods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -509,36 +482,38 @@ methods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof InputDialogConfiguration) uid: botbuilder-dialogs-adaptive.InputDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof InputDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof InputDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - - name: 'resumeDialog(DialogContext, DialogReason, any)' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.InputDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -548,8 +523,8 @@ methods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -561,5 +536,5 @@ methods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialogConfiguration.yml index ca3b6aa1..8fc53b0e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: InputDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -41,20 +38,18 @@ properties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown - name: defaultValueResponse uid: botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValueResponse package: botbuilder-dialogs-adaptive summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,7 +66,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -84,7 +78,6 @@ properties: summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -101,7 +94,6 @@ properties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -114,7 +106,6 @@ properties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,7 +122,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -144,7 +134,6 @@ properties: summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -161,26 +150,24 @@ properties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: value uid: botbuilder-dialogs-adaptive.InputDialogConfiguration.value package: botbuilder-dialogs-adaptive summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.InputDialogConfiguration.id @@ -188,7 +175,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -202,7 +188,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputState.yml index ba2fe372..7938ab33 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/InputState.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: InputState remarks: '' -isPreview: false isDeprecated: false fields: - name: invalid diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntProperty.yml index b9e3f3c1..aaf9946e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: IntProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type IntProperty = number | IntExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPattern.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPattern.yml index 94796995..b2d68f3c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPattern.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPattern.yml @@ -7,18 +7,16 @@ summary: |- Licensed under the MIT License. fullName: IntentPattern remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'IntentPattern(string, string)' + - name: IntentPattern(string, string) uid: botbuilder-dialogs-adaptive.IntentPattern.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [IntentPattern](xref:botbuilder-dialogs-adaptive.IntentPattern) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new IntentPattern(intent?: string, pattern?: string)' @@ -28,18 +26,14 @@ constructors: description: The intent. - id: pattern type: string - description: | - The regex pattern to match.. + description: The regex pattern to match.. properties: - name: intent uid: botbuilder-dialogs-adaptive.IntentPattern.intent package: botbuilder-dialogs-adaptive - summary: |- - Gets the intent. - Sets the intent. + summary: Gets the intent. fullName: intent remarks: '' - isPreview: false isDeprecated: false syntax: content: string intent @@ -49,12 +43,9 @@ properties: - name: pattern uid: botbuilder-dialogs-adaptive.IntentPattern.pattern package: botbuilder-dialogs-adaptive - summary: |- - Gets the pattern. - Sets the pattern + summary: Gets the pattern. fullName: pattern remarks: '' - isPreview: false isDeprecated: false syntax: content: string pattern @@ -67,7 +58,6 @@ properties: summary: '' fullName: regex remarks: '' - isPreview: false isDeprecated: false syntax: content: RegExp regex diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPatternInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPatternInput.yml deleted file mode 100644 index 43d26f78..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IntentPatternInput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: IntentPatternInput -uid: botbuilder-dialogs-adaptive.IntentPatternInput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: IntentPatternInput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type IntentPatternInput = { intent: string, pattern: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IpEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IpEntityRecognizer.yml index b3111156..f75601e2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IpEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IpEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes IP input. fullName: IpEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.IpEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.IpEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,52 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.IpEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): IpEntityRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.IpEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +110,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +124,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.IpEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +158,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IsDialogActiveFunction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IsDialogActiveFunction.yml index 419f89e7..7701cdeb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IsDialogActiveFunction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/IsDialogActiveFunction.yml @@ -12,19 +12,26 @@ summary: >+ **Example** + ```ts + isDialogActive('dialog1') + ``` + **Example** + ```ts + isDialogActive('dialog1', 'dialog2', 'dialog3') + ``` + fullName: IsDialogActiveFunction remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -36,7 +43,6 @@ constructors: [IsDialogActiveFunction](xref:botbuilder-dialogs-adaptive.IsDialogActiveFunction) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new IsDialogActiveFunction() @@ -47,7 +53,6 @@ properties: summary: Function identifier alias. fullName: functionAlias remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static functionAlias: "isActionActive" = "isActionActive"' @@ -60,7 +65,6 @@ properties: summary: Function identifier name. fullName: functionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static functionName: "isDialogActive" = "isDialogActive"' @@ -74,7 +78,6 @@ inheritedProperties: summary: Sets the evaluator that is a negation of this one. fullName: negation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'negation: ExpressionEvaluator' @@ -88,7 +91,6 @@ inheritedProperties: summary: Type expected by evaluating the expression. fullName: returnType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'returnType: ReturnType' @@ -102,7 +104,6 @@ inheritedProperties: summary: Evaluate an expression. fullName: tryEvaluate remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -120,7 +121,6 @@ inheritedProperties: summary: Gets the expression type for evaluator. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -134,7 +134,6 @@ inheritedProperties: summary: Validate an expression. fullName: validateExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validateExpression: (expression: Expression) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerationBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerationBotComponent.yml index 1ef04ad9..c5d3430d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerationBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerationBotComponent.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: ComponentRegistration class for language generation resources. fullName: LanguageGenerationBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,22 +14,20 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: >- botbuilder-dialogs-adaptive.LanguageGenerationBotComponent.configureServices package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -42,6 +39,5 @@ methods: description: Services Collection to register. - id: _configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerator.yml index 4cb3a1b4..91b92d85 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGenerator.yml @@ -3,18 +3,16 @@ name: LanguageGenerator uid: botbuilder-dialogs-adaptive.LanguageGenerator package: botbuilder-dialogs-adaptive summary: Defines interface for a Language Generator system to bind to text. -fullName: 'LanguageGenerator' +fullName: LanguageGenerator remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'generate(DialogContext, string, D)' + - name: generate(DialogContext, string, D) uid: botbuilder-dialogs-adaptive.LanguageGenerator.generate package: botbuilder-dialogs-adaptive summary: Method to bind data to string. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorConverter.yml deleted file mode 100644 index ad9a6fcf..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorConverter.yml +++ /dev/null @@ -1,41 +0,0 @@ -### YamlMime:TSType -name: LanguageGeneratorConverter -uid: botbuilder-dialogs-adaptive.LanguageGeneratorConverter -package: botbuilder-dialogs-adaptive -summary: >- - Language generator converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: LanguageGeneratorConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: convert(string | ResourceMultiLanguageGenerator) - uid: botbuilder-dialogs-adaptive.LanguageGeneratorConverter.convert - package: botbuilder-dialogs-adaptive - summary: >- - Creates a new - [ResourceMultiLanguageGenerator](xref:botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator) - instance from Resource id value. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function convert(value: string | ResourceMultiLanguageGenerator): - ResourceMultiLanguageGenerator - parameters: - - id: value - type: >- - string | - description: Resource id of LG file. - return: - description: >- - A new - [ResourceMultiLanguageGenerator](xref:botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator) - instance. - type: >- - diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorExtensions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorExtensions.yml index 8f2b46ec..4d3f74da 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorExtensions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorExtensions.yml @@ -5,11 +5,12 @@ package: botbuilder-dialogs-adaptive summary: Extension methods for language generator. fullName: LanguageGeneratorExtensions remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'useLanguageGeneration(DialogManager, string | LanguageGenerator)' + - name: >- + useLanguageGeneration(DialogManager, string | LanguageGenerator>) uid: >- botbuilder-dialogs-adaptive.LanguageGeneratorExtensions.useLanguageGeneration package: botbuilder-dialogs-adaptive @@ -17,12 +18,12 @@ methods: Register default LG file or a language generator as default language generator. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function useLanguageGeneration(dialogManager: DialogManager, lg?: - string | LanguageGenerator): DialogManager + string | LanguageGenerator>): + DialogManager parameters: - id: dialogManager type: DialogManager @@ -30,17 +31,16 @@ methods: - id: lg type: >- string | + /><unknown, Record<string, unknown>> description: 'LG resource id (default: main.lg) or language generator to be added.' return: description: dialog manager with language generator. type: DialogManager - - name: 'useLanguagePolicy(DialogManager, LanguagePolicy)' + - name: useLanguagePolicy(DialogManager, LanguagePolicy) uid: botbuilder-dialogs-adaptive.LanguageGeneratorExtensions.useLanguagePolicy package: botbuilder-dialogs-adaptive summary: Register language policy as default policy. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorManager.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorManager.yml index 60f5b9da..ffbbf3ca 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorManager.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageGeneratorManager.yml @@ -5,13 +5,12 @@ package: botbuilder-dialogs-adaptive summary: >- Class which manages cache of all LG resources from a [ResourceExplorer](xref:botbuilder-dialogs-declarative.ResourceExplorer). -fullName: 'LanguageGeneratorManager' +fullName: LanguageGeneratorManager remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: LanguageGeneratorManager(ResourceExplorer) + - name: LanguageGeneratorManager(ResourceExplorer) uid: botbuilder-dialogs-adaptive.LanguageGeneratorManager.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -19,15 +18,13 @@ constructors: [LanguageResourceManager](xref:botbuilder-dialogs-adaptive.LanguageResourceManager) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LanguageGeneratorManager(resourceManager: ResourceExplorer)' parameters: - id: resourceManager type: ResourceExplorer - description: | - Resource explorer to manager LG files. + description: Resource explorer to manager LG files. properties: - name: languageGenerators uid: botbuilder-dialogs-adaptive.LanguageGeneratorManager.languageGenerators @@ -35,7 +32,6 @@ properties: summary: Gets or sets language generators. fullName: languageGenerators remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languageGenerators: Map>' @@ -45,7 +41,7 @@ properties: Map<string, <T, D>> methods: - - name: 'resourceExplorerResolver(string, Map)' + - name: resourceExplorerResolver(string, Map) uid: >- botbuilder-dialogs-adaptive.LanguageGeneratorManager.resourceExplorerResolver package: botbuilder-dialogs-adaptive @@ -53,7 +49,6 @@ methods: Returns the resolver to resolve LG import id to template text based on language and a template resource loader delegate. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -64,7 +59,7 @@ methods: type: string description: Locale to identify language. - id: resourceMapping - type: 'Map<string, Resource[]>' + type: Map<string, Resource[]> description: Template resource loader delegate. return: description: The delegate to resolve the resource. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicy.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicy.yml index 1f2b1d22..06c6352f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicy.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicy.yml @@ -7,26 +7,23 @@ summary: >- en-us -> en -> default. fullName: LanguagePolicy remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'LanguagePolicy(string[])' + - name: LanguagePolicy(string[]) uid: botbuilder-dialogs-adaptive.LanguagePolicy.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [LanguagePolicy](xref:botbuilder-dialogs-adaptive.LanguagePolicy) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LanguagePolicy(defaultLanguages: string[])' parameters: - id: defaultLanguages - type: 'string[]' - description: | - Default languages to use. + type: string[] + description: Default languages to use. properties: - name: locales uid: botbuilder-dialogs-adaptive.LanguagePolicy.locales @@ -34,48 +31,58 @@ properties: summary: '' fullName: locales remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static locales: string[]' return: description: '' - type: 'string[]' - - name: Map - uid: botbuilder-dialogs-adaptive.LanguagePolicy.Map + type: string[] +inheritedProperties: + - name: size + uid: botbuilder-dialogs-adaptive.LanguagePolicy.size package: botbuilder-dialogs-adaptive summary: '' - fullName: Map + fullName: size remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static Map: MapConstructor' + content: 'size: number' + return: + description: the number of elements in the Map. + type: number + inheritanceDescription: Inherited From Map.size + - name: '[species]' + uid: botbuilder-dialogs-adaptive.LanguagePolicy.[species] + package: botbuilder-dialogs-adaptive + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: MapConstructor' return: description: '' type: MapConstructor -inheritedProperties: - - name: size - uid: botbuilder-dialogs-adaptive.LanguagePolicy.size + inheritanceDescription: Inherited From Map.__@species@2843 + - name: '[toStringTag]' + uid: botbuilder-dialogs-adaptive.LanguagePolicy.[toStringTag] package: botbuilder-dialogs-adaptive summary: '' - fullName: size + fullName: '[toStringTag]' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'size: number' + content: '[toStringTag]: string' return: description: '' - type: number - inheritanceDescription: Inherited From Map.size + type: string + inheritanceDescription: Inherited From Map.__@toStringTag@3122 inheritedMethods: - name: clear() uid: botbuilder-dialogs-adaptive.LanguagePolicy.clear package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function clear() @@ -85,7 +92,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(key: string): boolean' @@ -94,30 +100,32 @@ inheritedMethods: type: string description: '' return: - description: '' + description: >- + true if an element in the Map existed and has been removed, or false + if the element does not exist. type: boolean inheritanceDescription: Inherited From Map.delete - name: entries() uid: botbuilder-dialogs-adaptive.LanguagePolicy.entries package: botbuilder-dialogs-adaptive - summary: 'Returns an iterable of key, value pairs for every entry in the map.' + summary: Returns an iterable of key, value pairs for every entry in the map. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function entries(): IterableIterator<[string, string[]]>' return: description: '' - type: 'IterableIterator<[string, string[]]>' + type: IterableIterator<[string, string[]]> inheritanceDescription: Inherited From Map.entries - name: >- forEach((value: string[], key: string, map: Map) => void, any) uid: botbuilder-dialogs-adaptive.LanguagePolicy.forEach package: botbuilder-dialogs-adaptive - summary: '' + summary: >- + Executes a provided function once per each key/value pair in the Map, in + insertion order. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -136,26 +144,30 @@ inheritedMethods: - name: get(string) uid: botbuilder-dialogs-adaptive.LanguagePolicy.get package: botbuilder-dialogs-adaptive - summary: '' + summary: >- + Returns a specified element from the Map object. If the value that is + associated to the provided key is an object, then you will get a reference + to that object and any change made to that object will effectively modify + it inside the Map. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function get(key: string): string[] | undefined' + content: 'function get(key: string): undefined | string[]' parameters: - id: key type: string description: '' return: - description: '' - type: 'string[] | undefined' + description: >- + Returns the element associated with the specified key. If no element + is associated with the specified key, undefined is returned. + type: undefined | string[] inheritanceDescription: Inherited From Map.get - name: has(string) uid: botbuilder-dialogs-adaptive.LanguagePolicy.has package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function has(key: string): boolean' @@ -164,7 +176,9 @@ inheritedMethods: type: string description: '' return: - description: '' + description: >- + boolean indicating whether an element with the specified key exists or + not. type: boolean inheritanceDescription: Inherited From Map.has - name: keys() @@ -172,7 +186,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Returns an iterable of keys in the map remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keys(): IterableIterator' @@ -180,41 +193,53 @@ inheritedMethods: description: '' type: IterableIterator<string> inheritanceDescription: Inherited From Map.keys - - name: 'set(string, string[])' + - name: set(string, string[]) uid: botbuilder-dialogs-adaptive.LanguagePolicy.set package: botbuilder-dialogs-adaptive - summary: '' + summary: >- + Adds a new element with a specified key and value to the Map. If an + element with the same key already exists, the element will be updated. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function set(key: string, value: string[]): this' + content: 'function set(key: string, value: string[]): LanguagePolicy' parameters: - id: key type: string description: '' - id: value - type: 'string[]' + type: string[] description: '' return: description: '' - type: this + type: inheritanceDescription: Inherited From Map.set - name: values() uid: botbuilder-dialogs-adaptive.LanguagePolicy.values package: botbuilder-dialogs-adaptive summary: Returns an iterable of values in the map remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function values(): IterableIterator' return: description: '' - type: 'IterableIterator<string[]>' + type: IterableIterator<string[]> inheritanceDescription: Inherited From Map.values + - name: '[iterator]()' + uid: botbuilder-dialogs-adaptive.LanguagePolicy.[iterator] + package: botbuilder-dialogs-adaptive + summary: Returns an iterable of entries in the map. + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator<[string, string[]]>' + return: + description: '' + type: IterableIterator<[string, string[]]> + inheritanceDescription: Inherited From Map.__@iterator@2882 methods: - - name: 'defaultPolicy(string[])' + - name: defaultPolicy(string[]) uid: botbuilder-dialogs-adaptive.LanguagePolicy.defaultPolicy package: botbuilder-dialogs-adaptive summary: >+ @@ -225,6 +250,8 @@ methods: **Example** + ```ts + Example output "en-us" will generate fallback rule like this: "en-us" -> "en" -> "" @@ -236,8 +263,9 @@ methods: See commented section for full sample of output of this function. + ``` + remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -245,9 +273,9 @@ methods: string[]> parameters: - id: defaultLanguages - type: 'string[]' + type: string[] description: Default languages to use. return: description: A Map object with a string array for each key. - type: 'Map<string, string[]>' -extends: 'Map<string, string[]>' + type: Map<string, string[]> +extends: Map<string, string[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicyConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicyConverter.yml index eb5a4c20..59cdcdcb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicyConverter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguagePolicyConverter.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Language policy converter that implements `Converter`. fullName: LanguagePolicyConverter remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'convert(Record | LanguagePolicy)' + - name: convert(LanguagePolicy | Record) uid: botbuilder-dialogs-adaptive.LanguagePolicyConverter.convert package: botbuilder-dialogs-adaptive summary: >- @@ -17,17 +16,16 @@ methods: [LanguagePolicy](xref:botbuilder-dialogs-adaptive.LanguagePolicy) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function convert(value: Record | LanguagePolicy): + function convert(value: LanguagePolicy | Record): LanguagePolicy parameters: - id: value type: >- - Record<string, string[]> | + | + Record<string, string[]> description: Object. return: description: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageResourceLoader.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageResourceLoader.yml index 5478aa55..74aff93b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageResourceLoader.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LanguageResourceLoader.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs-adaptive summary: Load all LG resource and split them into different language groups. fullName: LanguageResourceLoader remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'fallbackLocale(string, string[])' + - name: fallbackLocale(string, string[]) uid: botbuilder-dialogs-adaptive.LanguageResourceLoader.fallbackLocale package: botbuilder-dialogs-adaptive summary: Get the fallback locale from optional locales. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -25,7 +23,7 @@ methods: type: string description: Current locale - id: optionalLocales - type: 'string[]' + type: string[] description: Optional locales. return: description: The final locale. @@ -35,7 +33,6 @@ methods: package: botbuilder-dialogs-adaptive summary: Group LG resource by locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -47,13 +44,12 @@ methods: description: The resource explorer to use. return: description: The dictionary of grouped locale. - type: 'Map<string, Resource[]>' + type: Map<string, Resource[]> - name: parseLGFileName(string) uid: botbuilder-dialogs-adaptive.LanguageResourceLoader.parseLGFileName package: botbuilder-dialogs-adaptive summary: Parse LG file name into prefix and language. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogAction.yml index a072abf9..6f25d901 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogAction.yml @@ -5,18 +5,16 @@ package: botbuilder-dialogs-adaptive summary: Write entry into application trace logs. fullName: LogAction remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: LogAction(string) + - name: LogAction(string) uid: botbuilder-dialogs-adaptive.LogAction.constructor package: botbuilder-dialogs-adaptive summary: >- Creates a new [LogAction](xref:botbuilder-dialogs-adaptive.LogAction) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LogAction(text: string)' @@ -31,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -44,39 +41,62 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.LogAction.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: label uid: botbuilder-dialogs-adaptive.LogAction.label package: botbuilder-dialogs-adaptive summary: A label to use when describing a trace activity. fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.LogAction.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: text uid: botbuilder-dialogs-adaptive.LogAction.text package: botbuilder-dialogs-adaptive summary: The text template to log. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: TemplateInterface' return: description: '' - type: 'TemplateInterface<string, DialogStateManager>' + type: TemplateInterface<string, DialogStateManager> - name: traceActivity uid: botbuilder-dialogs-adaptive.LogAction.traceActivity package: botbuilder-dialogs-adaptive @@ -87,7 +107,6 @@ properties: Defaults to a value of false. fullName: traceActivity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'traceActivity: BoolExpression' @@ -106,66 +125,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.LogAction.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.LogAction.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.LogAction.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): LogAction' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.LogAction.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -189,20 +178,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.LogAction.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -231,23 +220,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -274,7 +261,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -284,14 +270,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.LogAction.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -310,10 +295,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.LogAction.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -334,25 +319,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.LogAction.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -392,12 +375,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -409,26 +391,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.LogAction.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -440,21 +420,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof LogActionConfiguration) uid: botbuilder-dialogs-adaptive.LogAction.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof LogActionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof LogActionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogActionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogActionConfiguration.yml index c866c341..3548616f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogActionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/LogActionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: LogActionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label?: StringProperty' @@ -41,20 +38,18 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string | TemplateInterface' return: description: '' - type: 'string | TemplateInterface<string, DialogStateManager>' + type: string | TemplateInterface<string, DialogStateManager> - name: traceActivity uid: botbuilder-dialogs-adaptive.LogActionConfiguration.traceActivity package: botbuilder-dialogs-adaptive summary: '' fullName: traceActivity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'traceActivity?: BoolProperty' @@ -68,7 +63,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -82,7 +76,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MentionEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MentionEntityRecognizer.yml index 602f2eab..667836bd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MentionEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MentionEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes mention input. fullName: MentionEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.MentionEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.MentionEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.MentionEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + MentionEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.MentionEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +112,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +126,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.MentionEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +160,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelector.yml index dfa0b653..fbdfbf89 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelector.yml @@ -7,7 +7,6 @@ summary: >- [TriggerSelector](xref:botbuilder-dialogs-adaptive.TriggerSelector). fullName: MostSpecificSelector remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -30,7 +28,6 @@ properties: summary: '' fullName: selector remarks: '' - isPreview: false isDeprecated: false syntax: content: 'selector: TriggerSelector' @@ -38,66 +35,71 @@ properties: description: '' type: inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.MostSpecificSelector.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + MostSpecificSelector parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TriggerSelector.configure](xref:botbuilder-dialogs-adaptive.TriggerSelector.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive.MostSpecificSelector.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TriggerSelector.getConverter](xref:botbuilder-dialogs-adaptive.TriggerSelector.getConverter) methods: - - name: 'initialize(OnCondition[], boolean)' + - name: initialize(OnCondition[], boolean) uid: botbuilder-dialogs-adaptive.MostSpecificSelector.initialize package: botbuilder-dialogs-adaptive summary: Initializes the selector with the set of rules. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(conditionals: OnCondition[], _evaluate: boolean)' parameters: - id: conditionals - type: '[]' + type: [] description: Possible rules to match. - id: _evaluate type: boolean - description: | - True by default if rules should be evaluated on select. + description: True by default if rules should be evaluated on select. - name: select(ActionContext) uid: botbuilder-dialogs-adaptive.MostSpecificSelector.select package: botbuilder-dialogs-adaptive summary: Selects the best rule to execute. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function select(context: ActionContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelectorConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelectorConfiguration.yml index 78e9d999..d418cd0b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelectorConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MostSpecificSelectorConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: MostSpecificSelectorConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: selector remarks: '' - isPreview: false isDeprecated: false syntax: content: 'selector?: TriggerSelector' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGenerator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGenerator.yml index 1abdf7e6..675fa94b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGenerator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGenerator.yml @@ -7,9 +7,8 @@ summary: >- the locale and has a policy which controls fallback (try en-us -> en -> default). -fullName: 'MultiLanguageGenerator' +fullName: MultiLanguageGenerator remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -19,7 +18,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -32,15 +30,17 @@ properties: summary: Gets or sets the language generators for multiple languages. fullName: languageGenerators remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'languageGenerators: Map' + content: >- + languageGenerators: Map>> return: description: '' type: >- Map<string, > + uid="botbuilder-dialogs-adaptive.LanguageGenerator" /><unknown, + Record<string, unknown>>> inheritedProperties: - name: languagePolicy uid: botbuilder-dialogs-adaptive.MultiLanguageGenerator.languagePolicy @@ -48,7 +48,6 @@ inheritedProperties: summary: Language policy required by language generator. fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy: LanguagePolicy' @@ -59,36 +58,38 @@ inheritedProperties: Inherited From [MultiLanguageGeneratorBase.languagePolicy](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.languagePolicy) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.MultiLanguageGenerator.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + MultiLanguageGenerator parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'generate(DialogContext, string, D)' + type: + inheritanceDescription: >- + Inherited From + [MultiLanguageGeneratorBase.configure](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.configure) + - name: generate(DialogContext, string, Record) uid: botbuilder-dialogs-adaptive.MultiLanguageGenerator.generate package: botbuilder-dialogs-adaptive summary: Find a language generator that matches the current context locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function generate(dialogContext: DialogContext, template: string, data: - D): Promise + Record): Promise parameters: - id: dialogContext type: DialogContext @@ -97,45 +98,48 @@ inheritedMethods: type: string description: Template to use. - id: data - type: D + type: Record<string, unknown> description: Data to bind to. return: description: A promise representing the asynchronous operation. - type: Promise<T> + type: Promise<unknown> inheritanceDescription: >- Inherited From [MultiLanguageGeneratorBase.generate](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.generate) - - name: getConverter(Object) + - name: getConverter("languagePolicy") uid: botbuilder-dialogs-adaptive.MultiLanguageGenerator.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: "languagePolicy"): Converter | ConverterFactory parameters: - id: property - type: Object + type: '"languagePolicy"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From [MultiLanguageGeneratorBase.getConverter](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.getConverter) methods: - - name: 'tryGetGenerator(DialogContext, string)' + - name: tryGetGenerator(DialogContext, string) uid: botbuilder-dialogs-adaptive.MultiLanguageGenerator.tryGetGenerator package: botbuilder-dialogs-adaptive summary: Implementation of lookup by locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function tryGetGenerator(dialogContext: DialogContext, locale: string): - { exist: boolean, result: LanguageGenerator } + { exist: boolean, result: LanguageGenerator> } parameters: - id: dialogContext type: DialogContext @@ -145,5 +149,7 @@ methods: description: Locale to lookup. return: description: An object with a boolean showing existence and the language generator. - type: '{ exist: boolean, result: LanguageGenerator }' + type: >- + { exist: boolean, result: LanguageGenerator<unknown, + Record<string, unknown>> } extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBase.yml index d9dea475..b0787480 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBase.yml @@ -3,9 +3,8 @@ name: MultiLanguageGeneratorBase uid: botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase package: botbuilder-dialogs-adaptive summary: Base class which applies language policy to tryGetGenerator. -fullName: 'MultiLanguageGeneratorBase' +fullName: MultiLanguageGeneratorBase remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: Language policy required by language generator. fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy: LanguagePolicy' @@ -23,32 +21,34 @@ properties: description: '' type: inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + MultiLanguageGeneratorBase parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: >- + <T, D> inheritanceDescription: Inherited From Configurable.configure methods: - - name: 'generate(DialogContext, string, D)' + - name: generate(DialogContext, string, D) uid: botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.generate package: botbuilder-dialogs-adaptive summary: Find a language generator that matches the current context locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -67,28 +67,30 @@ methods: return: description: A promise representing the asynchronous operation. type: Promise<T> - - name: getConverter(Object) + - name: getConverter("languagePolicy") uid: botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: "languagePolicy"): Converter | ConverterFactory parameters: - id: property - type: Object + type: '"languagePolicy"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - - name: 'tryGetGenerator(DialogContext, string)' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + - name: tryGetGenerator(DialogContext, string) uid: botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.tryGetGenerator package: botbuilder-dialogs-adaptive summary: Abstract method to get a language generator by locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -100,8 +102,7 @@ methods: description: DialogContext. - id: locale type: string - description: | - Locale to lookup. + description: Locale to lookup. return: description: '' type: '{ exist: boolean, result: LanguageGenerator<T, D> }' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBaseConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBaseConfiguration.yml index 0319d2f5..0700cc86 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBaseConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageGeneratorBaseConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: MultiLanguageGeneratorBaseConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,12 +15,11 @@ properties: summary: '' fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'languagePolicy?: Record | LanguagePolicy' + content: 'languagePolicy?: LanguagePolicy | Record' return: description: '' type: >- - Record<string, string[]> | + | + Record<string, string[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizer.yml index c7f0363a..81ac39d3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Defines map of languages -> recognizer. fullName: MultiLanguageRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy: LanguagePolicy' @@ -41,13 +38,12 @@ properties: summary: '' fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'recognizers: [key: string]: Recognizer' + content: 'recognizers: {[locale: string]: Recognizer}' return: description: '' - type: '[key: string]\: Recognizer' + type: '{[locale: string]: Recognizer}' inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizer.id @@ -55,14 +51,15 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.id](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.id) - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -71,7 +68,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -89,67 +85,74 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.telemetryClient](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.telemetryClient) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + MultiLanguageRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.configure](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure) methods: - - name: getConverter(Object) + - name: getConverter(keyof MultiLanguageRecognizerConfiguration) uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + MultiLanguageRecognizerConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof MultiLanguageRecognizerConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- - recognize(DialogContext, Activity, [key: string]: string, [key: string]: - number) + recognize(DialogContext, Activity, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizer.recognize package: botbuilder-dialogs-adaptive summary: >- Runs current DialogContext.TurnContext.Activity through a recognizer and returns a [RecognizerResult](xref:botbuilder-core.RecognizerResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function recognize(dialogContext: DialogContext, activity: Activity, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: dialogContext type: DialogContext @@ -158,14 +161,14 @@ methods: current turn of conversation. - id: activity type: Activity - description: '(xref:botframework-schema.Activity) to recognize.' + description: '[Activity](xref:botframework-schema.Activity) to recognize.' - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional, additional properties to be logged to telemetry with the LuisResult event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional, additional metrics to be logged to telemetry with the LuisResult event. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConfiguration.yml index 34ff6a42..26a46b6a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: MultiLanguageRecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,15 +15,14 @@ properties: summary: '' fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'languagePolicy?: Record | LanguagePolicy' + content: 'languagePolicy?: LanguagePolicy | Record' return: description: '' type: >- - Record<string, string[]> | + | + Record<string, string[]> - name: recognizers uid: >- botbuilder-dialogs-adaptive.MultiLanguageRecognizerConfiguration.recognizers @@ -32,13 +30,12 @@ properties: summary: '' fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizers?: Record | Record' return: description: '' - type: 'Record<string, string> | Record<string, Recognizer>' + type: Record<string, string> | Record<string, Recognizer> inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizerConfiguration.id @@ -46,7 +43,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -61,7 +57,6 @@ inheritedProperties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConverter.yml deleted file mode 100644 index 8c956047..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/MultiLanguageRecognizerConverter.yml +++ /dev/null @@ -1,51 +0,0 @@ -### YamlMime:TSType -name: MultiLanguageRecognizerConverter -uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter -package: botbuilder-dialogs-adaptive -summary: >- - Language generator converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: MultiLanguageRecognizerConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: MultiLanguageRecognizerConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [MultiLanguageRecognizerConverter](xref:botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new MultiLanguageRecognizerConverter(resourceExplorer: ResourceExplorer)' - parameters: - - id: resourceExplorer - type: ResourceExplorer - description: | - Resource explorer to use for resolving references. -methods: - - name: convert(Input | Output) - uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter.convert - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: Input | Output): Output' - parameters: - - id: value - type: >- - | - description: >- - An [Input](xref:botbuilder-dialogs-adaptive.Input) or - [Output](xref:botbuilder-dialogs-adaptive.Output). - return: - description: 'A new [Output](xref:botbuilder-dialogs-adaptive.Output) instance.' - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberEntityRecognizer.yml index 0fc1f6a8..74cbded9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes number input. fullName: NumberEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.NumberEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.NumberEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.NumberEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + NumberEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.NumberEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +112,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +126,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.NumberEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +160,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInput.yml index 2953c701..728899af 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInput.yml @@ -3,30 +3,28 @@ name: NumberInput uid: botbuilder-dialogs-adaptive.NumberInput package: botbuilder-dialogs-adaptive summary: Input dialog for asking for numbers. -fullName: NumberInput +fullName: NumberInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NumberInput(string, Partial | string)' + - name: NumberInput(string, string | Partial) uid: botbuilder-dialogs-adaptive.NumberInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new NumberInput(property?: string, prompt?: Partial | string)' + content: 'new NumberInput(property?: string, prompt?: string | Partial)' parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -52,26 +49,50 @@ properties: summary: '' fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive.NumberInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: outputFormat uid: botbuilder-dialogs-adaptive.NumberInput.outputFormat package: botbuilder-dialogs-adaptive summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: NumberExpression' return: description: '' type: NumberExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.NumberInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: allowInterruptions uid: botbuilder-dialogs-adaptive.NumberInput.allowInterruptions @@ -79,7 +100,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -97,7 +117,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -113,7 +132,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -131,7 +149,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -139,7 +156,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -149,7 +166,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -170,28 +186,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.NumberInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.NumberInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -200,13 +203,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -218,7 +220,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -234,7 +235,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -250,13 +250,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -266,7 +265,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -276,27 +274,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.NumberInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.NumberInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -312,7 +295,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -320,7 +302,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -330,13 +312,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -346,7 +327,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -362,7 +342,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -373,19 +352,18 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.NumberInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -401,29 +379,30 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.beginDialog](xref:botbuilder-dialogs-adaptive.InputDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.NumberInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): NumberInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.NumberInput.continueDialog package: botbuilder-dialogs-adaptive @@ -431,10 +410,11 @@ inheritedMethods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -445,11 +425,11 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.continueDialog](xref:botbuilder-dialogs-adaptive.InputDialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.NumberInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -478,27 +458,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.NumberInput.getVersion package: botbuilder-dialogs-adaptive @@ -521,7 +501,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -530,15 +509,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.NumberInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -556,11 +536,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.NumberInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -581,37 +563,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.NumberInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -621,8 +602,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -634,25 +615,28 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: getConverter(Object) + - name: getConverter(keyof NumberInputConfiguration) uid: botbuilder-dialogs-adaptive.NumberInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof NumberInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof NumberInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInputConfiguration.yml index c351e519..b255d699 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: NumberInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: NumberProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -58,7 +54,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -74,13 +69,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -90,7 +84,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -110,7 +103,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -126,21 +118,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.NumberInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -160,7 +152,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -176,7 +167,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -196,7 +186,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -212,21 +201,21 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: botbuilder-dialogs-adaptive.NumberInputConfiguration.unrecognizedPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -246,13 +235,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -262,13 +250,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberProperty.yml index 9a5b8137..0a233390 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/NumberProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: NumberProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type NumberProperty = number | NumberExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInput.yml index 3b006d78..ed3f1c68 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInput.yml @@ -3,20 +3,18 @@ name: OAuthInput uid: botbuilder-dialogs-adaptive.OAuthInput package: botbuilder-dialogs-adaptive summary: OAuthInput prompts user to login. -fullName: OAuthInput +fullName: OAuthInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OAuthInput(string, string, string, number)' + - name: OAuthInput(string, string, string, number) uid: botbuilder-dialogs-adaptive.OAuthInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OAuthInput](xref:botbuilder-dialogs-adaptive.OAuthInput) class remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,7 +32,7 @@ constructors: description: Optional. Additional text to include on the signin card. - id: timeout type: number - description: > + description: >- Optional. Number of milliseconds the prompt will wait for the user to authenticate. properties: @@ -44,7 +42,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -57,20 +54,44 @@ properties: summary: Name of the OAuth connection being used. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive.OAuthInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.OAuthInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: text uid: botbuilder-dialogs-adaptive.OAuthInput.text package: botbuilder-dialogs-adaptive summary: (Optional) additional text to include on the signin card. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: StringExpression' @@ -87,7 +108,6 @@ properties: Defaults to a value `900,000` (15 minutes.) fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: IntExpression' @@ -100,7 +120,6 @@ properties: summary: Title of the cards signin button. fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: StringExpression' @@ -114,7 +133,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -132,7 +150,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -148,7 +165,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -166,7 +182,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -174,7 +189,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -184,7 +199,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -205,28 +219,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.OAuthInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.OAuthInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -235,13 +236,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -253,7 +253,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -269,7 +268,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -285,13 +283,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -301,7 +298,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -311,27 +307,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.OAuthInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.OAuthInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -347,7 +328,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -355,7 +335,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -365,13 +345,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -381,7 +360,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -397,7 +375,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -408,26 +385,27 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OAuthInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OAuthInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.OAuthInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -456,27 +434,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.OAuthInput.getVersion package: botbuilder-dialogs-adaptive @@ -499,7 +477,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -508,15 +485,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.OAuthInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -534,11 +512,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.OAuthInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -559,37 +539,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.OAuthInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -599,8 +578,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -612,24 +591,23 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs-adaptive.OAuthInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when a prompt [Dialog](xref:botbuilder-dialogs.Dialog) is pushed onto the dialog stack and is being activated. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: PromptOptions): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -645,7 +623,7 @@ methods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.OAuthInput.continueDialog package: botbuilder-dialogs-adaptive @@ -653,10 +631,11 @@ methods: Called when a prompt [Dialog](xref:botbuilder-dialogs.Dialog) is the active dialog and the user replied with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -667,34 +646,36 @@ methods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof OAuthInputConfiguration) uid: botbuilder-dialogs-adaptive.OAuthInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OAuthInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OAuthInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - - name: 'getUserToken(DialogContext, string)' + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + - name: getUserToken(DialogContext, string) uid: botbuilder-dialogs-adaptive.OAuthInput.getUserToken package: botbuilder-dialogs-adaptive summary: Attempts to retrieve the stored token for the current user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getUserToken(dc: DialogContext, code?: string): - Promise + Promise parameters: - id: dc type: DialogContext @@ -704,7 +685,7 @@ methods: description: (Optional) login code received from the user. return: description: A promise representing the asynchronous operation. - type: Promise<TokenResponse | undefined> + type: Promise<undefined | TokenResponse> - name: signOutUser(DialogContext) uid: botbuilder-dialogs-adaptive.OAuthInput.signOutUser package: botbuilder-dialogs-adaptive @@ -724,7 +705,6 @@ methods: await prompt.signOutUser(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function signOutUser(dc: DialogContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInputConfiguration.yml index b9e994b5..6ef5105d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OAuthInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OAuthInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: StringProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: IntProperty' @@ -54,7 +50,6 @@ properties: summary: '' fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: StringProperty' @@ -68,7 +63,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -84,7 +78,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -100,13 +93,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -116,7 +108,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -136,7 +127,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -152,21 +142,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.OAuthInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -186,7 +176,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -202,7 +191,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,7 +210,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -238,21 +225,21 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: botbuilder-dialogs-adaptive.OAuthInputConfiguration.unrecognizedPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -272,13 +259,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -288,13 +274,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ObjectProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ObjectProperty.yml index 94f23661..6ee1e3a5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ObjectProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ObjectProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ObjectProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type ObjectProperty = T | ObjectExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivity.yml index 9497f799..ce296eff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivity.yml @@ -7,21 +7,21 @@ summary: >- given type is received. fullName: OnActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnActivity(string, Dialog[], string)' + - name: OnActivity(string, Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnActivity.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnActivity](xref:botbuilder-dialogs-adaptive.OnActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnActivity(type?: string, actions?: Dialog[], condition?: string)' + content: >- + new OnActivity(type?: string, actions?: Dialog<{}>[], condition?: + string) parameters: - id: type type: string @@ -29,13 +29,13 @@ constructors: Optional, ActivityType which must be matched for this event to trigger. - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional, actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -45,7 +45,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -58,7 +57,6 @@ properties: summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -74,16 +72,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnActivity.condition package: botbuilder-dialogs-adaptive @@ -92,7 +89,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -101,14 +97,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -124,7 +119,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -133,7 +127,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnActivity.priority package: botbuilder-dialogs-adaptive @@ -142,7 +136,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -151,7 +144,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnActivity.runOnce package: botbuilder-dialogs-adaptive @@ -160,7 +153,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -169,51 +161,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnActivity.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -226,13 +217,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -244,31 +234,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -276,22 +267,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -300,5 +289,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivityConfiguration.yml index 2dafa0ac..7ae31959 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: string' @@ -29,23 +27,21 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnConditionConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.actions) + [OnDialogEventConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnActivityConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -54,14 +50,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.condition) + [OnDialogEventConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.condition) - name: event uid: botbuilder-dialogs-adaptive.OnActivityConfiguration.event package: botbuilder-dialogs-adaptive summary: '' fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event?: string' @@ -77,7 +72,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -86,14 +80,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnConditionConfiguration.id](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.id) + [OnDialogEventConfiguration.id](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.id) - name: priority uid: botbuilder-dialogs-adaptive.OnActivityConfiguration.priority package: botbuilder-dialogs-adaptive summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -102,14 +95,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.priority) + [OnDialogEventConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnActivityConfiguration.runOnce package: botbuilder-dialogs-adaptive summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' @@ -118,5 +110,5 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnConditionConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.runOnce) + [OnDialogEventConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.runOnce) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntity.yml index 16204eb5..a62932f4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntity.yml @@ -5,41 +5,39 @@ package: botbuilder-dialogs-adaptive summary: Triggered to assign an entity to a property. fullName: OnAssignEntity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnAssignEntity(string, string, string, Dialog[], string)' + - name: OnAssignEntity(string, string, string, Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnAssignEntity.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnAssignEntity](xref:botbuilder-dialogs-adaptive.OnAssignEntity) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new OnAssignEntity(property?: string, value?: string, operation?: - string, actions?: Dialog[], condition?: string) + string, actions?: Dialog<{}>[], condition?: string) parameters: - id: property type: string - description: 'Optional, property filter on event.' + description: Optional, property filter on event. - id: value type: string - description: 'Optional, value filter on event.' + description: Optional, value filter on event. - id: operation type: string - description: 'Optional, operation filter on event.' + description: Optional, operation filter on event. - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional, actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -49,7 +47,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -62,7 +59,6 @@ properties: summary: Gets or sets the operation filter on events. fullName: operation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'operation: string' @@ -75,7 +71,6 @@ properties: summary: Gets or sets the property filter on events. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: string' @@ -88,7 +83,6 @@ properties: summary: Gets or sets the value filter on events. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' @@ -104,16 +98,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnAssignEntity.condition package: botbuilder-dialogs-adaptive @@ -122,7 +115,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -131,14 +123,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnAssignEntity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -154,7 +145,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -163,7 +153,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnAssignEntity.priority package: botbuilder-dialogs-adaptive @@ -172,7 +162,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -181,7 +170,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnAssignEntity.runOnce package: botbuilder-dialogs-adaptive @@ -190,7 +179,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -199,51 +187,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnAssignEntity.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnAssignEntity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnAssignEntity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnAssignEntity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -256,13 +243,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnAssignEntity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -274,31 +260,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnAssignEntity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnAssignEntity.getDependencies package: botbuilder-dialogs-adaptive @@ -306,22 +293,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnAssignEntity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -330,5 +315,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntityConfiguration.yml index 619717a8..3c921008 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnAssignEntityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnAssignEntityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: operation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'operation?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' @@ -55,23 +51,21 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnConditionConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.actions) + [OnDialogEventConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnAssignEntityConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -80,14 +74,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.condition) + [OnDialogEventConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.condition) - name: event uid: botbuilder-dialogs-adaptive.OnAssignEntityConfiguration.event package: botbuilder-dialogs-adaptive summary: '' fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event?: string' @@ -103,7 +96,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -112,14 +104,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnConditionConfiguration.id](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.id) + [OnDialogEventConfiguration.id](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.id) - name: priority uid: botbuilder-dialogs-adaptive.OnAssignEntityConfiguration.priority package: botbuilder-dialogs-adaptive summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -128,14 +119,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.priority) + [OnDialogEventConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnAssignEntityConfiguration.runOnce package: botbuilder-dialogs-adaptive summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' @@ -144,5 +134,5 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnConditionConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.runOnce) + [OnDialogEventConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.runOnce) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnBeginDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnBeginDialog.yml index b1e30393..4e33be7e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnBeginDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnBeginDialog.yml @@ -5,30 +5,28 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a dialog is started via BeginDialog(). fullName: OnBeginDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnBeginDialog(Dialog[], string)' + - name: OnBeginDialog(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnBeginDialog.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnBeginDialog](xref:botbuilder-dialogs-adaptive.OnBeginDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnBeginDialog(actions?: Dialog[], condition?: string)' + content: 'new OnBeginDialog(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -38,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,16 +51,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnBeginDialog.condition package: botbuilder-dialogs-adaptive @@ -72,7 +68,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -81,14 +76,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnBeginDialog.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -104,7 +98,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -113,7 +106,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnBeginDialog.priority package: botbuilder-dialogs-adaptive @@ -122,7 +115,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -131,7 +123,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnBeginDialog.runOnce package: botbuilder-dialogs-adaptive @@ -140,7 +132,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -149,51 +140,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnBeginDialog.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnBeginDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnBeginDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnBeginDialog.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -206,13 +196,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnBeginDialog.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,31 +213,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnBeginDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnBeginDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -256,22 +246,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnBeginDialog.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -280,5 +268,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCancelDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCancelDialog.yml index 6f6e76c6..29c5a97d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCancelDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCancelDialog.yml @@ -5,30 +5,28 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an dialog was canceled. fullName: OnCancelDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnCancelDialog(Dialog[], string)' + - name: OnCancelDialog(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnCancelDialog.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnCancelDialog](xref:botbuilder-dialogs-adaptive.OnCancelDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnCancelDialog(actions?: Dialog[], condition?: string)' + content: 'new OnCancelDialog(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -38,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,16 +51,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnCancelDialog.condition package: botbuilder-dialogs-adaptive @@ -72,7 +68,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -81,14 +76,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnCancelDialog.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -104,7 +98,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -113,7 +106,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnCancelDialog.priority package: botbuilder-dialogs-adaptive @@ -122,7 +115,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -131,7 +123,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnCancelDialog.runOnce package: botbuilder-dialogs-adaptive @@ -140,7 +132,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -149,51 +140,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnCancelDialog.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnCancelDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnCancelDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnCancelDialog.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -206,13 +196,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnCancelDialog.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,31 +213,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnCancelDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnCancelDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -256,22 +246,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnCancelDialog.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -280,5 +268,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntity.yml index 4cb04f32..7ecf4934 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntity.yml @@ -5,41 +5,39 @@ package: botbuilder-dialogs-adaptive summary: Triggered to choose between different possible entity resolutions. fullName: OnChooseEntity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnChooseEntity(string, string, string, Dialog[], string)' + - name: OnChooseEntity(string, string, string, Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnChooseEntity.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnChooseEntity](xref:botbuilder-dialogs-adaptive.OnChooseEntity) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new OnChooseEntity(property?: string, value?: string, operation?: - string, actions?: Dialog[], condition?: string) + string, actions?: Dialog<{}>[], condition?: string) parameters: - id: property type: string - description: 'Optional, property for filtering events.' + description: Optional, property for filtering events. - id: value type: string - description: 'Optional, value filtering events.' + description: Optional, value filtering events. - id: operation type: string - description: 'Optional, operation for filtering events.' + description: Optional, operation for filtering events. - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional, actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -49,7 +47,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -62,7 +59,6 @@ properties: summary: Gets or sets operation filter on event. fullName: operation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'operation: string' @@ -75,7 +71,6 @@ properties: summary: Gets or sets the property filter on event. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: string' @@ -88,7 +83,6 @@ properties: summary: Gets or sets the value filter on event. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' @@ -104,16 +98,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnChooseEntity.condition package: botbuilder-dialogs-adaptive @@ -122,7 +115,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -131,14 +123,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnChooseEntity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -154,7 +145,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -163,7 +153,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnChooseEntity.priority package: botbuilder-dialogs-adaptive @@ -172,7 +162,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -181,7 +170,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnChooseEntity.runOnce package: botbuilder-dialogs-adaptive @@ -190,7 +179,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -199,51 +187,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnChooseEntity.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnChooseEntity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnChooseEntity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnChooseEntity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -256,13 +243,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnChooseEntity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -274,31 +260,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnChooseEntity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnChooseEntity.getDependencies package: botbuilder-dialogs-adaptive @@ -306,22 +293,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnChooseEntity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -330,5 +315,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntityConfiguration.yml index 1339311f..f81184f2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseEntityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnChooseEntityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: operation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'operation?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' @@ -55,23 +51,21 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnConditionConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.actions) + [OnDialogEventConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnChooseEntityConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -80,14 +74,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.condition) + [OnDialogEventConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.condition) - name: event uid: botbuilder-dialogs-adaptive.OnChooseEntityConfiguration.event package: botbuilder-dialogs-adaptive summary: '' fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event?: string' @@ -103,7 +96,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -112,14 +104,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnConditionConfiguration.id](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.id) + [OnDialogEventConfiguration.id](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.id) - name: priority uid: botbuilder-dialogs-adaptive.OnChooseEntityConfiguration.priority package: botbuilder-dialogs-adaptive summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -128,14 +119,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.priority) + [OnDialogEventConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnChooseEntityConfiguration.runOnce package: botbuilder-dialogs-adaptive summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' @@ -144,5 +134,5 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnConditionConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.runOnce) + [OnDialogEventConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.runOnce) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntent.yml index d11b57f2..6572622b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntent.yml @@ -7,30 +7,28 @@ summary: >- [Recognizer](xref:botbuilder-dialogs-adaptive.Recognizer). fullName: OnChooseIntent remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnChooseIntent(Dialog[], string)' + - name: OnChooseIntent(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnChooseIntent.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnChooseIntent](xref:botbuilder-dialogs-adaptive.OnChooseIntent) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnChooseIntent(actions?: Dialog[], condition?: string)' + content: 'new OnChooseIntent(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional, actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -40,7 +38,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -53,13 +50,12 @@ properties: summary: '' fullName: intents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intents: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: actions uid: botbuilder-dialogs-adaptive.OnChooseIntent.actions @@ -69,16 +65,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnIntent.actions](xref:botbuilder-dialogs-adaptive.OnIntent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnChooseIntent.condition package: botbuilder-dialogs-adaptive @@ -87,7 +82,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -96,20 +90,19 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnIntent.condition](xref:botbuilder-dialogs-adaptive.OnIntent.condition) - name: entities uid: botbuilder-dialogs-adaptive.OnChooseIntent.entities package: botbuilder-dialogs-adaptive summary: Gets or sets entities which must be recognized for this rule to trigger. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [OnIntent.entities](xref:botbuilder-dialogs-adaptive.OnIntent.entities) @@ -119,7 +112,6 @@ inheritedProperties: summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -128,14 +120,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnIntent.event](xref:botbuilder-dialogs-adaptive.OnIntent.event) - name: id uid: botbuilder-dialogs-adaptive.OnChooseIntent.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -144,14 +135,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnIntent.id](xref:botbuilder-dialogs-adaptive.OnIntent.id) - name: intent uid: botbuilder-dialogs-adaptive.OnChooseIntent.intent package: botbuilder-dialogs-adaptive summary: Gets or sets intent to match on. fullName: intent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intent: string' @@ -169,7 +159,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -178,7 +167,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnIntent.priority](xref:botbuilder-dialogs-adaptive.OnIntent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnChooseIntent.runOnce package: botbuilder-dialogs-adaptive @@ -187,7 +176,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -196,51 +184,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnIntent.runOnce](xref:botbuilder-dialogs-adaptive.OnIntent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnChooseIntent.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnIntent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnIntent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnChooseIntent.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnChooseIntent' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnIntent.configure](xref:botbuilder-dialogs-adaptive.OnIntent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnChooseIntent.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -253,13 +240,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnIntent.currentPriority](xref:botbuilder-dialogs-adaptive.OnIntent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnChooseIntent.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -271,31 +257,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnIntent.execute](xref:botbuilder-dialogs-adaptive.OnIntent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnChooseIntent.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnIntent.getConverter](xref:botbuilder-dialogs-adaptive.OnIntent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnChooseIntent.getDependencies package: botbuilder-dialogs-adaptive @@ -303,22 +290,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnIntent.getDependencies](xref:botbuilder-dialogs-adaptive.OnIntent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnChooseIntent.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -327,5 +312,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnIntent.getExpression](xref:botbuilder-dialogs-adaptive.OnIntent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntentConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntentConfiguration.yml index 5da3b4e7..bf1019f8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntentConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseIntentConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnChooseIntentConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,13 +14,12 @@ properties: summary: '' fullName: intents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intents?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: actions uid: botbuilder-dialogs-adaptive.OnChooseIntentConfiguration.actions @@ -29,23 +27,21 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnConditionConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.actions) + [OnIntentConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnChooseIntentConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -54,20 +50,19 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.condition) + [OnIntentConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.condition) - name: entities uid: botbuilder-dialogs-adaptive.OnChooseIntentConfiguration.entities package: botbuilder-dialogs-adaptive summary: '' fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [OnIntentConfiguration.entities](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.entities) @@ -77,7 +72,6 @@ inheritedProperties: summary: '' fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event?: string' @@ -86,14 +80,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEventConfiguration.event](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.event) + [OnIntentConfiguration.event](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.event) - name: id uid: botbuilder-dialogs-adaptive.OnChooseIntentConfiguration.id package: botbuilder-dialogs-adaptive summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -102,14 +95,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnConditionConfiguration.id](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.id) + [OnIntentConfiguration.id](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.id) - name: intent uid: botbuilder-dialogs-adaptive.OnChooseIntentConfiguration.intent package: botbuilder-dialogs-adaptive summary: '' fullName: intent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intent?: string' @@ -125,7 +117,6 @@ inheritedProperties: summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -134,14 +125,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.priority) + [OnIntentConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnChooseIntentConfiguration.runOnce package: botbuilder-dialogs-adaptive summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' @@ -150,5 +140,5 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnConditionConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.runOnce) + [OnIntentConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnIntentConfiguration.runOnce) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseProperty.yml index 550b9ce0..fcd5b2dc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnChooseProperty.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Triggered to choose which property an entity goes to. fullName: OnChooseProperty remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnChooseProperty(Dialog[], string)' + - name: OnChooseProperty(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnChooseProperty.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnChooseProperty](xref:botbuilder-dialogs-adaptive.OnChooseProperty) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnChooseProperty(actions?: Dialog[], condition?: string)' + content: 'new OnChooseProperty(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional, actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnChooseProperty.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnChooseProperty.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -105,7 +99,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnChooseProperty.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnChooseProperty.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,51 +141,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnChooseProperty.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnChooseProperty.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnChooseProperty' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnChooseProperty.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -207,13 +197,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnChooseProperty.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -225,31 +214,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnChooseProperty.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnChooseProperty.getDependencies package: botbuilder-dialogs-adaptive @@ -257,22 +247,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnChooseProperty.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -281,5 +269,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandActivity.yml index 24fc1912..a090b06e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a Command activity is received. fullName: OnCommandActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnCommandActivity(Dialog[], string)' + - name: OnCommandActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnCommandActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,17 +16,16 @@ constructors: [OnCommandActivity](xref:botbuilder-dialogs-adaptive.OnCommandActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnCommandActivity(actions?: Dialog[], condition?: string)' + content: 'new OnCommandActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' - description: 'Optional, list of actions.' + type: Dialog<{}>[] + description: Optional, list of actions. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -37,7 +35,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -53,16 +50,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnCommandActivity.condition package: botbuilder-dialogs-adaptive @@ -71,7 +67,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -80,14 +75,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnCommandActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -96,14 +90,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnCommandActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -112,7 +105,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnCommandActivity.priority package: botbuilder-dialogs-adaptive @@ -121,7 +114,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -130,7 +122,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnCommandActivity.runOnce package: botbuilder-dialogs-adaptive @@ -139,7 +131,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -148,14 +139,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnCommandActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -171,44 +161,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnCommandActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnCommandActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnCommandActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -221,13 +210,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnCommandActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -239,31 +227,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnCommandActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnCommandActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -271,22 +260,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnCommandActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -295,5 +282,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandResultActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandResultActivity.yml index 3c8733aa..8ee3e315 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandResultActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCommandResultActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a CommandResult activity is received. fullName: OnCommandResultActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnCommandResultActivity(Dialog[], string)' + - name: OnCommandResultActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,17 +16,16 @@ constructors: [OnCommandResultActivity](xref:botbuilder-dialogs-adaptive.OnCommandResultActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnCommandResultActivity(actions?: Dialog[], condition?: string)' + content: 'new OnCommandResultActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' - description: 'Optional, list of actions.' + type: Dialog<{}>[] + description: Optional, list of actions. - id: condition type: string - description: > + description: >- Optional, condition which needs to be met for the actions to be executed. properties: @@ -37,7 +35,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -53,16 +50,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.condition package: botbuilder-dialogs-adaptive @@ -71,7 +67,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -80,14 +75,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -96,14 +90,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -112,7 +105,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.priority package: botbuilder-dialogs-adaptive @@ -121,7 +114,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -130,7 +122,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.runOnce package: botbuilder-dialogs-adaptive @@ -139,7 +131,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -148,14 +139,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -171,44 +161,45 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnCommandResultActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -221,13 +212,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -239,31 +229,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -271,22 +262,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnCommandResultActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -295,5 +284,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCondition.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCondition.yml index a2dc291f..07e35513 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCondition.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnCondition.yml @@ -5,19 +5,17 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when condition is true. fullName: OnCondition remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnCondition(string, Dialog[])' + - name: OnCondition(string, Dialog<{}>[]) uid: botbuilder-dialogs-adaptive.OnCondition.constructor package: botbuilder-dialogs-adaptive summary: Create a new `OnCondition` instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnCondition(condition?: string, actions?: Dialog[])' + content: 'new OnCondition(condition?: string, actions?: Dialog<{}>[])' parameters: - id: condition type: string @@ -25,8 +23,8 @@ constructors: (Optional) The condition which needs to be met for the actions to be executed. - id: actions - type: 'Dialog[]' - description: > + type: Dialog<{}>[] + description: >- (Optional) The actions to add to the plan when the rule constraints are met. properties: @@ -36,7 +34,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -51,13 +48,12 @@ properties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] - name: condition uid: botbuilder-dialogs-adaptive.OnCondition.condition package: botbuilder-dialogs-adaptive @@ -66,7 +62,6 @@ properties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -79,7 +74,6 @@ properties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -94,7 +88,6 @@ properties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -109,7 +102,6 @@ properties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -117,24 +109,23 @@ properties: description: '' type: boolean inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnCondition.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnCondition' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: Inherited From Configurable.configure methods: - name: addExternalCondition(string) @@ -142,14 +133,13 @@ methods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. - name: currentPriority(ActionContext) @@ -157,7 +147,6 @@ methods: package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -173,7 +162,6 @@ methods: package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -185,25 +173,26 @@ methods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> - - name: getConverter(Object) + type: Promise<ActionChangeList[]> + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnCondition.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnCondition.getDependencies package: botbuilder-dialogs-adaptive @@ -211,19 +200,17 @@ methods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] - name: getExpression() uid: botbuilder-dialogs-adaptive.OnCondition.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConditionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConditionConfiguration.yml index de039ba8..184eff72 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConditionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConditionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnConditionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] - name: condition uid: botbuilder-dialogs-adaptive.OnConditionConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -54,7 +50,6 @@ properties: summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -67,7 +62,6 @@ properties: summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnContinueConversation.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnContinueConversation.yml index 8676daa9..d377f7fb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnContinueConversation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnContinueConversation.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an EventActivity is received. fullName: OnContinueConversation remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnContinueConversation(Dialog[], string)' + - name: OnContinueConversation(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnContinueConversation.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnContinueConversation](xref:botbuilder-dialogs-adaptive.OnContinueConversation) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnContinueConversation(actions?: Dialog[], condition?: string)' + content: 'new OnContinueConversation(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional, actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional, ondition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnEventActivity.actions](xref:botbuilder-dialogs-adaptive.OnEventActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnContinueConversation.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnEventActivity.condition](xref:botbuilder-dialogs-adaptive.OnEventActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnContinueConversation.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnEventActivity.event](xref:botbuilder-dialogs-adaptive.OnEventActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnContinueConversation.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnEventActivity.id](xref:botbuilder-dialogs-adaptive.OnEventActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnContinueConversation.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnEventActivity.priority](xref:botbuilder-dialogs-adaptive.OnEventActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnContinueConversation.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnEventActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnEventActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnContinueConversation.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -166,51 +156,52 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnActivity.type](xref:botbuilder-dialogs-adaptive.OnActivity.type) + [OnEventActivity.type](xref:botbuilder-dialogs-adaptive.OnEventActivity.type) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnContinueConversation.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnEventActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnEventActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnContinueConversation.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnContinueConversation parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnEventActivity.configure](xref:botbuilder-dialogs-adaptive.OnEventActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnContinueConversation.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +214,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnEventActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnEventActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnContinueConversation.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +231,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnEventActivity.execute](xref:botbuilder-dialogs-adaptive.OnEventActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnContinueConversation.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnEventActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnEventActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnContinueConversation.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +264,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnEventActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnEventActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnContinueConversation.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +286,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnEventActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnEventActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConversationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConversationUpdateActivity.yml index 5c1cf4e6..8934ae1d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConversationUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnConversationUpdateActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when ConversationUpdateActivity is received. fullName: OnConversationUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnConversationUpdateActivity(Dialog[], string)' + - name: OnConversationUpdateActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,20 @@ constructors: [OnConversationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnConversationUpdateActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnConversationUpdateActivity(actions?: Dialog[], condition?: string)' + content: >- + new OnConversationUpdateActivity(actions?: Dialog<{}>[], condition?: + string) parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +54,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +71,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +79,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +94,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +109,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +118,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +126,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +135,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +143,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -174,44 +166,47 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnConversationUpdateActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -224,13 +219,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,31 +236,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -274,22 +269,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnConversationUpdateActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -298,5 +291,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEvent.yml index de8f333c..9f901af9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEvent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEvent.yml @@ -5,33 +5,31 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a dialog event is emitted. fullName: OnDialogEvent remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnDialogEvent(string, Dialog[], string)' + - name: OnDialogEvent(string, Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnDialogEvent.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `OnDialogEvent` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new OnDialogEvent(event?: string, actions?: Dialog[], condition?: + new OnDialogEvent(event?: string, actions?: Dialog<{}>[], condition?: string) parameters: - id: event type: string description: (Optional) The event to fire on. - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- (Optional) The actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- (Optional) The condition which needs to be met for the actions to be executed. properties: @@ -41,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,7 +51,6 @@ properties: summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -70,13 +66,12 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) @@ -88,7 +83,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -104,7 +98,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -122,7 +115,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -140,7 +132,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -156,44 +147,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnDialogEvent.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnDialogEvent' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnCondition.configure](xref:botbuilder-dialogs-adaptive.OnCondition.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -212,7 +202,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,28 +213,29 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnDialogEvent.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) @@ -256,13 +246,12 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) @@ -271,7 +260,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEventConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEventConfiguration.yml index 4d6366e4..87c40f5e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEventConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnDialogEventConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnDialogEventConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event?: string' @@ -29,13 +27,12 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From [OnConditionConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.actions) @@ -45,7 +42,6 @@ inheritedProperties: summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -61,7 +57,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -77,7 +72,6 @@ inheritedProperties: summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -93,7 +87,6 @@ inheritedProperties: summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfActions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfActions.yml index ac501fad..84b73664 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfActions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfActions.yml @@ -5,28 +5,26 @@ package: botbuilder-dialogs-adaptive summary: Triggered when all actions and ambiguity events have been processed. fullName: OnEndOfActions remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnEndOfActions(Dialog[], string)' + - name: OnEndOfActions(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnEndOfActions.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `OnEndOfActions` instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnEndOfActions(actions?: Dialog[], condition?: string)' + content: 'new OnEndOfActions(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- (Optional) The actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- (Optional) The condition which needs to be met for the actions to be executed. properties: @@ -36,7 +34,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -52,16 +49,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnEndOfActions.condition package: botbuilder-dialogs-adaptive @@ -70,7 +66,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -79,14 +74,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnEndOfActions.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -102,7 +96,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -111,7 +104,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnEndOfActions.priority package: botbuilder-dialogs-adaptive @@ -120,7 +113,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -129,7 +121,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnEndOfActions.runOnce package: botbuilder-dialogs-adaptive @@ -138,7 +130,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -147,51 +138,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnEndOfActions.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnEndOfActions.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnEndOfActions' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnEndOfActions.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -204,13 +194,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnEndOfActions.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,31 +211,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnEndOfActions.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnEndOfActions.getDependencies package: botbuilder-dialogs-adaptive @@ -254,22 +244,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnEndOfActions.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -278,5 +266,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfConversationActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfConversationActivity.yml index 7aca3236..c77a8db1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfConversationActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEndOfConversationActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when EndOfConversationActivity is received. fullName: OnEndOfConversationActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnEndOfConversationActivity(Dialog[], string)' + - name: OnEndOfConversationActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,20 @@ constructors: [OnEndOfConversationActivity](xref:botbuilder-dialogs-adaptive.OnEndOfConversationActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnEndOfConversationActivity(actions?: Dialog[], condition?: string)' + content: >- + new OnEndOfConversationActivity(actions?: Dialog<{}>[], condition?: + string) parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +54,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +71,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +79,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +94,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +109,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +118,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +126,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +135,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +143,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -174,44 +166,45 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnEndOfConversationActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -224,13 +217,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,31 +234,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -274,22 +267,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnEndOfConversationActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -298,5 +289,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnError.yml index ab95f6d9..92be2c5f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnError.yml @@ -5,30 +5,28 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an error event has been emitted. fullName: OnError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnError(Dialog[], string)' + - name: OnError(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnError.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnError](xref:botbuilder-dialogs-adaptive.OnError) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnError(actions?: Dialog[], condition?: string)' + content: 'new OnError(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -38,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,16 +51,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnError.condition package: botbuilder-dialogs-adaptive @@ -72,7 +68,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -81,14 +76,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnError.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -104,7 +98,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -113,7 +106,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnError.priority package: botbuilder-dialogs-adaptive @@ -122,7 +115,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -131,7 +123,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnError.runOnce package: botbuilder-dialogs-adaptive @@ -140,7 +132,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -149,51 +140,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnError.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnError.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnError' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnError.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -206,13 +196,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnError.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,31 +213,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnError.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnError.getDependencies package: botbuilder-dialogs-adaptive @@ -256,22 +246,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnError.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -280,14 +268,13 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) methods: - - name: 'onCreateChangeList(ActionContext, any)' + - name: onCreateChangeList(ActionContext, any) uid: botbuilder-dialogs-adaptive.OnError.onCreateChangeList package: botbuilder-dialogs-adaptive summary: Called when a change list is created. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -297,8 +284,8 @@ methods: - id: actionContext type: description: >- - (xref:botbuilder-dialogs-adaptive.ActionContext) to use for - evaluation. + [ActionContext](xref:botbuilder-dialogs-adaptive.ActionContext) to + use for evaluation. - id: dialogOptions type: any description: Optional. Object with dialog options. @@ -307,5 +294,5 @@ methods: An [ActionChangeList](xref:botbuilder-dialogs-adaptive.ActionChangeList) with the list of actions. - type: + type: ActionChangeList extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEventActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEventActivity.yml index c85e8d86..955dc9ad 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEventActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnEventActivity.yml @@ -5,30 +5,28 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an EventActivity is received. fullName: OnEventActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnEventActivity(Dialog[], string)' + - name: OnEventActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnEventActivity.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnEventActivity](xref:botbuilder-dialogs-adaptive.OnEventActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnEventActivity(actions?: Dialog[], condition?: string)' + content: 'new OnEventActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -38,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,16 +51,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnEventActivity.condition package: botbuilder-dialogs-adaptive @@ -72,7 +68,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -81,14 +76,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnEventActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -97,14 +91,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnEventActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -113,7 +106,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnEventActivity.priority package: botbuilder-dialogs-adaptive @@ -122,7 +115,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -131,7 +123,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnEventActivity.runOnce package: botbuilder-dialogs-adaptive @@ -140,7 +132,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -149,14 +140,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnEventActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -172,44 +162,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnEventActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnEventActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnEventActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -222,13 +211,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnEventActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -240,31 +228,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnEventActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnEventActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -272,22 +261,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnEventActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -296,5 +283,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnHandoffActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnHandoffActivity.yml index 6d64c64a..7497e9cf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnHandoffActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnHandoffActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a HandoffActivity is received. fullName: OnHandoffActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnHandoffActivity(Dialog[], string)' + - name: OnHandoffActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnHandoffActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnHandoffActivity](xref:botbuilder-dialogs-adaptive.OnHandoffActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnHandoffActivity(actions?: Dialog[], condition?: string)' + content: 'new OnHandoffActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnHandoffActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnHandoffActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnHandoffActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnHandoffActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnHandoffActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnHandoffActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +163,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnHandoffActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnHandoffActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnHandoffActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +212,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnHandoffActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +229,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnHandoffActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnHandoffActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +262,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnHandoffActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +284,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInstallationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInstallationUpdateActivity.yml index d4e1ee9b..0c960f3e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInstallationUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInstallationUpdateActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a InstallationUpdateActivity is received. fullName: OnInstallationUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnInstallationUpdateActivity(Dialog[], string)' + - name: OnInstallationUpdateActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,20 @@ constructors: [OnInstallationUpdateActivity](xref:botbuilder-dialogs-adaptive.OnInstallationUpdateActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnInstallationUpdateActivity(actions?: Dialog[], condition?: string)' + content: >- + new OnInstallationUpdateActivity(actions?: Dialog<{}>[], condition?: + string) parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +54,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +71,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +79,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +94,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +109,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +118,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +126,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +135,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +143,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -174,44 +166,47 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnInstallationUpdateActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -224,13 +219,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,31 +236,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -274,22 +269,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnInstallationUpdateActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -298,5 +291,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntent.yml index 62afa19b..e4b4af3d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntent.yml @@ -7,38 +7,36 @@ summary: >- intents and entities match specified list of intent and entity filters. fullName: OnIntent remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnIntent(string, string[], Dialog[], string)' + - name: OnIntent(string, string[], Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnIntent.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `OnIntent` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new OnIntent(intent?: string, entities?: string[], actions?: Dialog[], - condition?: string) + new OnIntent(intent?: string, entities?: string[], actions?: + Dialog<{}>[], condition?: string) parameters: - id: intent type: string description: (Optional) Intent to match on. - id: entities - type: 'string[]' + type: string[] description: >- (Optional) Entities which must be recognized for this rule to trigger. - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- (Optional) The actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- (Optional) The condition which needs to be met for the actions to be executed. properties: @@ -48,7 +46,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -61,20 +58,18 @@ properties: summary: Gets or sets entities which must be recognized for this rule to trigger. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities: string[]' return: description: '' - type: 'string[]' + type: string[] - name: intent uid: botbuilder-dialogs-adaptive.OnIntent.intent package: botbuilder-dialogs-adaptive summary: Gets or sets intent to match on. fullName: intent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intent: string' @@ -90,16 +85,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnIntent.condition package: botbuilder-dialogs-adaptive @@ -108,7 +102,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -117,14 +110,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnIntent.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -140,7 +132,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -149,7 +140,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnIntent.priority package: botbuilder-dialogs-adaptive @@ -158,7 +149,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -167,7 +157,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnIntent.runOnce package: botbuilder-dialogs-adaptive @@ -176,7 +166,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -185,51 +174,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnIntent.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnIntent.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnIntent' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnIntent.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -242,13 +230,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnIntent.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -260,31 +247,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnIntent.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnIntent.getDependencies package: botbuilder-dialogs-adaptive @@ -292,22 +280,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnIntent.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -316,5 +302,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntentConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntentConfiguration.yml index bded68e2..5c940226 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntentConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnIntentConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: OnIntentConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: intent uid: botbuilder-dialogs-adaptive.OnIntentConfiguration.intent package: botbuilder-dialogs-adaptive summary: '' fullName: intent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intent?: string' @@ -42,23 +39,21 @@ inheritedProperties: summary: '' fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions?: string[] | Dialog[]' + content: 'actions?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnConditionConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.actions) + [OnDialogEventConfiguration.actions](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnIntentConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: BoolProperty' @@ -67,14 +62,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.condition) + [OnDialogEventConfiguration.condition](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.condition) - name: event uid: botbuilder-dialogs-adaptive.OnIntentConfiguration.event package: botbuilder-dialogs-adaptive summary: '' fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event?: string' @@ -90,7 +84,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -99,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnConditionConfiguration.id](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.id) + [OnDialogEventConfiguration.id](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.id) - name: priority uid: botbuilder-dialogs-adaptive.OnIntentConfiguration.priority package: botbuilder-dialogs-adaptive summary: '' fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority?: NumberProperty' @@ -115,14 +107,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [OnConditionConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.priority) + [OnDialogEventConfiguration.priority](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnIntentConfiguration.runOnce package: botbuilder-dialogs-adaptive summary: '' fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce?: boolean' @@ -131,5 +122,5 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnConditionConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnConditionConfiguration.runOnce) + [OnDialogEventConfiguration.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEventConfiguration.runOnce) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInvokeActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInvokeActivity.yml index 874c1d26..df12916b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInvokeActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnInvokeActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an InvokeActivity is received. fullName: OnInvokeActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnInvokeActivity(Dialog[], string)' + - name: OnInvokeActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnInvokeActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnInvokeActivity](xref:botbuilder-dialogs-adaptive.OnInvokeActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnInvokeActivity(actions?: Dialog[], condition?: string)' + content: 'new OnInvokeActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnInvokeActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnInvokeActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnInvokeActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnInvokeActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnInvokeActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnInvokeActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +163,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnInvokeActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnInvokeActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnInvokeActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +212,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnInvokeActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +229,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnInvokeActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnInvokeActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +262,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnInvokeActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +284,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageActivity.yml index adfc01e4..d470a8c5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an MessageActivity is received. fullName: OnMessageActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnMessageActivity(Dialog[], string)' + - name: OnMessageActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnMessageActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnMessageActivity](xref:botbuilder-dialogs-adaptive.OnMessageActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnMessageActivity(actions?: Dialog[], condition?: string)' + content: 'new OnMessageActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnMessageActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnMessageActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnMessageActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnMessageActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnMessageActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnMessageActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +163,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnMessageActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnMessageActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +212,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +229,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnMessageActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnMessageActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +262,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnMessageActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +284,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageDeleteActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageDeleteActivity.yml index 7026adf8..15eadc22 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageDeleteActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageDeleteActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a MessageDeleteActivity is received. fullName: OnMessageDeleteActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnMessageDeleteActivity(Dialog[], string)' + - name: OnMessageDeleteActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnMessageDeleteActivity](xref:botbuilder-dialogs-adaptive.OnMessageDeleteActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnMessageDeleteActivity(actions?: Dialog[], condition?: string)' + content: 'new OnMessageDeleteActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +163,45 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnMessageDeleteActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +214,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +231,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +264,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnMessageDeleteActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +286,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageReactionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageReactionActivity.yml index f774e835..f6f75af6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageReactionActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageReactionActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a MessageReactionActivity is received. fullName: OnMessageReactionActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnMessageReactionActivity(Dialog[], string)' + - name: OnMessageReactionActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,20 @@ constructors: [OnMessageReactionActivity](xref:botbuilder-dialogs-adaptive.OnMessageReactionActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnMessageReactionActivity(actions?: Dialog[], condition?: string)' + content: >- + new OnMessageReactionActivity(actions?: Dialog<{}>[], condition?: + string) parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +39,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +54,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +71,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +79,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +94,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +109,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +118,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +126,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +135,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +143,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +165,45 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnMessageReactionActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +216,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +233,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +266,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnMessageReactionActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +288,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageUpdateActivity.yml index 3d9d5e67..f8ab41ff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnMessageUpdateActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a MessageUpdateActivity is received. fullName: OnMessageUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnMessageUpdateActivity(Dialog[], string)' + - name: OnMessageUpdateActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnMessageUpdateActivity](xref:botbuilder-dialogs-adaptive.OnMessageUpdateActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnMessageUpdateActivity(actions?: Dialog[], condition?: string)' + content: 'new OnMessageUpdateActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +163,45 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OnMessageUpdateActivity parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +214,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +231,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +264,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnMessageUpdateActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +286,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnQnAMatch.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnQnAMatch.yml index cc0e788d..951d29af 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnQnAMatch.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnQnAMatch.yml @@ -5,30 +5,28 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a MessageUpdateActivity is received. fullName: OnQnAMatch remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnQnAMatch(Dialog[], string)' + - name: OnQnAMatch(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnQnAMatch.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [OnQnAMatch](xref:botbuilder-dialogs-adaptive.OnQnAMatch) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnQnAMatch(actions?: Dialog[], condition?: string)' + content: 'new OnQnAMatch(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -38,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -54,16 +51,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnIntent.actions](xref:botbuilder-dialogs-adaptive.OnIntent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnQnAMatch.condition package: botbuilder-dialogs-adaptive @@ -72,7 +68,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -81,20 +76,19 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnIntent.condition](xref:botbuilder-dialogs-adaptive.OnIntent.condition) - name: entities uid: botbuilder-dialogs-adaptive.OnQnAMatch.entities package: botbuilder-dialogs-adaptive summary: Gets or sets entities which must be recognized for this rule to trigger. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [OnIntent.entities](xref:botbuilder-dialogs-adaptive.OnIntent.entities) @@ -104,7 +98,6 @@ inheritedProperties: summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -113,14 +106,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnIntent.event](xref:botbuilder-dialogs-adaptive.OnIntent.event) - name: id uid: botbuilder-dialogs-adaptive.OnQnAMatch.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -129,14 +121,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnIntent.id](xref:botbuilder-dialogs-adaptive.OnIntent.id) - name: intent uid: botbuilder-dialogs-adaptive.OnQnAMatch.intent package: botbuilder-dialogs-adaptive summary: Gets or sets intent to match on. fullName: intent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intent: string' @@ -154,7 +145,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -163,7 +153,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnIntent.priority](xref:botbuilder-dialogs-adaptive.OnIntent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnQnAMatch.runOnce package: botbuilder-dialogs-adaptive @@ -172,7 +162,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -181,51 +170,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnIntent.runOnce](xref:botbuilder-dialogs-adaptive.OnIntent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnQnAMatch.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnIntent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnIntent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnQnAMatch.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnQnAMatch' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnIntent.configure](xref:botbuilder-dialogs-adaptive.OnIntent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnQnAMatch.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -238,13 +226,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnIntent.currentPriority](xref:botbuilder-dialogs-adaptive.OnIntent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnQnAMatch.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -256,31 +243,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnIntent.execute](xref:botbuilder-dialogs-adaptive.OnIntent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnQnAMatch.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnIntent.getConverter](xref:botbuilder-dialogs-adaptive.OnIntent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnQnAMatch.getDependencies package: botbuilder-dialogs-adaptive @@ -288,22 +276,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnIntent.getDependencies](xref:botbuilder-dialogs-adaptive.OnIntent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnQnAMatch.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -312,5 +298,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnIntent.getExpression](xref:botbuilder-dialogs-adaptive.OnIntent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnRepromptDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnRepromptDialog.yml index 6fe113df..f43cf41c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnRepromptDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnRepromptDialog.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when an RepromptDialog event is emitted. fullName: OnRepromptDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnRepromptDialog(Dialog[], string)' + - name: OnRepromptDialog(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnRepromptDialog.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnRepromptDialog](xref:botbuilder-dialogs-adaptive.OnRepromptDialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnRepromptDialog(actions?: Dialog[], condition?: string)' + content: 'new OnRepromptDialog(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnRepromptDialog.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnRepromptDialog.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -105,7 +99,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnRepromptDialog.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnRepromptDialog.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,51 +141,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnRepromptDialog.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnRepromptDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnRepromptDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnRepromptDialog.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -207,13 +197,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnRepromptDialog.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -225,31 +214,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnRepromptDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnRepromptDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -257,22 +247,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnRepromptDialog.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -281,5 +269,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnTypingActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnTypingActivity.yml index b4d57fd3..85ea9786 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnTypingActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnTypingActivity.yml @@ -5,11 +5,10 @@ package: botbuilder-dialogs-adaptive summary: Actions triggered when a TypingActivity is received. fullName: OnTypingActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnTypingActivity(Dialog[], string)' + - name: OnTypingActivity(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnTypingActivity.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,19 +16,18 @@ constructors: [OnTypingActivity](xref:botbuilder-dialogs-adaptive.OnTypingActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnTypingActivity(actions?: Dialog[], condition?: string)' + content: 'new OnTypingActivity(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- Optional. A [Dialog](xref:botbuilder-dialogs.Dialog) list containing the actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- Optional. Condition which needs to be met for the actions to be executed. properties: @@ -39,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -55,16 +52,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnActivity.actions](xref:botbuilder-dialogs-adaptive.OnActivity.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnTypingActivity.condition package: botbuilder-dialogs-adaptive @@ -73,7 +69,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -82,14 +77,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnActivity.condition](xref:botbuilder-dialogs-adaptive.OnActivity.condition) - name: event uid: botbuilder-dialogs-adaptive.OnTypingActivity.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -98,14 +92,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnDialogEvent.event](xref:botbuilder-dialogs-adaptive.OnDialogEvent.event) + [OnActivity.event](xref:botbuilder-dialogs-adaptive.OnActivity.event) - name: id uid: botbuilder-dialogs-adaptive.OnTypingActivity.id package: botbuilder-dialogs-adaptive summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -114,7 +107,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnActivity.id](xref:botbuilder-dialogs-adaptive.OnActivity.id) - name: priority uid: botbuilder-dialogs-adaptive.OnTypingActivity.priority package: botbuilder-dialogs-adaptive @@ -123,7 +116,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -132,7 +124,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnActivity.priority](xref:botbuilder-dialogs-adaptive.OnActivity.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnTypingActivity.runOnce package: botbuilder-dialogs-adaptive @@ -141,7 +133,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -150,14 +141,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnActivity.runOnce](xref:botbuilder-dialogs-adaptive.OnActivity.runOnce) - name: type uid: botbuilder-dialogs-adaptive.OnTypingActivity.type package: botbuilder-dialogs-adaptive summary: Gets or sets the ActivityType which must be matched for this to trigger. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -173,44 +163,43 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnActivity.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnActivity.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnTypingActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnTypingActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnActivity.configure](xref:botbuilder-dialogs-adaptive.OnActivity.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnTypingActivity.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -223,13 +212,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnActivity.currentPriority](xref:botbuilder-dialogs-adaptive.OnActivity.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnTypingActivity.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,31 +229,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnActivity.execute](xref:botbuilder-dialogs-adaptive.OnActivity.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnTypingActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnActivity.getConverter](xref:botbuilder-dialogs-adaptive.OnActivity.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnTypingActivity.getDependencies package: botbuilder-dialogs-adaptive @@ -273,22 +262,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnActivity.getDependencies](xref:botbuilder-dialogs-adaptive.OnActivity.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnTypingActivity.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -297,5 +284,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnActivity.getExpression](xref:botbuilder-dialogs-adaptive.OnActivity.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnUnknownIntent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnUnknownIntent.yml index fe164974..4f13ac78 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnUnknownIntent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OnUnknownIntent.yml @@ -20,28 +20,26 @@ remarks: >- * none of the parent dialogs handle the event This provides the parent dialogs the opportunity to handle global commands as fallback interruption. -isPreview: false isDeprecated: false type: class constructors: - - name: 'OnUnknownIntent(Dialog[], string)' + - name: OnUnknownIntent(Dialog<{}>[], string) uid: botbuilder-dialogs-adaptive.OnUnknownIntent.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `OnUnknownIntent` instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new OnUnknownIntent(actions?: Dialog[], condition?: string)' + content: 'new OnUnknownIntent(actions?: Dialog<{}>[], condition?: string)' parameters: - id: actions - type: 'Dialog[]' + type: Dialog<{}>[] description: >- (Optional) The actions to add to the plan when the rule constraints are met. - id: condition type: string - description: > + description: >- (Optional) The condition which needs to be met for the actions to be executed. properties: @@ -51,7 +49,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -67,16 +64,15 @@ inheritedProperties: met. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'actions: Dialog[]' + content: 'actions: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.actions](xref:botbuilder-dialogs-adaptive.OnCondition.actions) + [OnDialogEvent.actions](xref:botbuilder-dialogs-adaptive.OnDialogEvent.actions) - name: condition uid: botbuilder-dialogs-adaptive.OnUnknownIntent.condition package: botbuilder-dialogs-adaptive @@ -85,7 +81,6 @@ inheritedProperties: executed (OPTIONAL). fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: BoolExpression' @@ -94,14 +89,13 @@ inheritedProperties: type: BoolExpression inheritanceDescription: >- Inherited From - [OnCondition.condition](xref:botbuilder-dialogs-adaptive.OnCondition.condition) + [OnDialogEvent.condition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.condition) - name: event uid: botbuilder-dialogs-adaptive.OnUnknownIntent.event package: botbuilder-dialogs-adaptive summary: Gets or sets the event to fire on. fullName: event remarks: '' - isPreview: false isDeprecated: false syntax: content: 'event: string' @@ -117,7 +111,6 @@ inheritedProperties: summary: Id for condition. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -126,7 +119,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [OnCondition.id](xref:botbuilder-dialogs-adaptive.OnCondition.id) + [OnDialogEvent.id](xref:botbuilder-dialogs-adaptive.OnDialogEvent.id) - name: priority uid: botbuilder-dialogs-adaptive.OnUnknownIntent.priority package: botbuilder-dialogs-adaptive @@ -135,7 +128,6 @@ inheritedProperties: than 0 is ignored. fullName: priority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'priority: NumberExpression' @@ -144,7 +136,7 @@ inheritedProperties: type: NumberExpression inheritanceDescription: >- Inherited From - [OnCondition.priority](xref:botbuilder-dialogs-adaptive.OnCondition.priority) + [OnDialogEvent.priority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.priority) - name: runOnce uid: botbuilder-dialogs-adaptive.OnUnknownIntent.runOnce package: botbuilder-dialogs-adaptive @@ -153,7 +145,6 @@ inheritedProperties: memory paths. fullName: runOnce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'runOnce: boolean' @@ -162,51 +153,50 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [OnCondition.runOnce](xref:botbuilder-dialogs-adaptive.OnCondition.runOnce) + [OnDialogEvent.runOnce](xref:botbuilder-dialogs-adaptive.OnDialogEvent.runOnce) inheritedMethods: - name: addExternalCondition(string) uid: botbuilder-dialogs-adaptive.OnUnknownIntent.addExternalCondition package: botbuilder-dialogs-adaptive summary: Add external condition to the OnCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addExternalCondition(condition: string)' parameters: - id: condition type: string - description: > + description: >- External constraint to add, it will be AND'ed to all other constraints. inheritanceDescription: >- Inherited From - [OnCondition.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnCondition.addExternalCondition) - - name: 'configure(Record)' + [OnDialogEvent.addExternalCondition](xref:botbuilder-dialogs-adaptive.OnDialogEvent.addExternalCondition) + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OnUnknownIntent.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OnUnknownIntent' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [OnDialogEvent.configure](xref:botbuilder-dialogs-adaptive.OnDialogEvent.configure) - name: currentPriority(ActionContext) uid: botbuilder-dialogs-adaptive.OnUnknownIntent.currentPriority package: botbuilder-dialogs-adaptive summary: Compute the current value of the priority expression and return it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function currentPriority(actionContext: ActionContext): number' @@ -219,13 +209,12 @@ inheritedMethods: type: number inheritanceDescription: >- Inherited From - [OnCondition.currentPriority](xref:botbuilder-dialogs-adaptive.OnCondition.currentPriority) + [OnDialogEvent.currentPriority](xref:botbuilder-dialogs-adaptive.OnDialogEvent.currentPriority) - name: execute(ActionContext) uid: botbuilder-dialogs-adaptive.OnUnknownIntent.execute package: botbuilder-dialogs-adaptive summary: Method called to execute the condition's actions. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -237,31 +226,32 @@ inheritedMethods: description: Context. return: description: A promise with plan change list. - type: >- - Promise<[]> + type: Promise<ActionChangeList[]> inheritanceDescription: >- Inherited From - [OnCondition.execute](xref:botbuilder-dialogs-adaptive.OnCondition.execute) - - name: getConverter(Object) + [OnDialogEvent.execute](xref:botbuilder-dialogs-adaptive.OnDialogEvent.execute) + - name: getConverter(keyof OnConditionConfiguration) uid: botbuilder-dialogs-adaptive.OnUnknownIntent.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof OnConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof OnConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From - [OnCondition.getConverter](xref:botbuilder-dialogs-adaptive.OnCondition.getConverter) + [OnDialogEvent.getConverter](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getConverter) - name: getDependencies() uid: botbuilder-dialogs-adaptive.OnUnknownIntent.getDependencies package: botbuilder-dialogs-adaptive @@ -269,22 +259,20 @@ inheritedMethods: Get child dialog dependencies so they can be added to the containers dialogset. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'A list of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: 'Dialog[]' + description: A list of [Dialog](xref:botbuilder-dialogs.Dialog). + type: Dialog<{}>[] inheritanceDescription: >- Inherited From - [OnCondition.getDependencies](xref:botbuilder-dialogs-adaptive.OnCondition.getDependencies) + [OnDialogEvent.getDependencies](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getDependencies) - name: getExpression() uid: botbuilder-dialogs-adaptive.OnUnknownIntent.getExpression package: botbuilder-dialogs-adaptive summary: Get the cached expression for this condition. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpression(): Expression' @@ -293,5 +281,5 @@ inheritedMethods: type: Expression inheritanceDescription: >- Inherited From - [OnCondition.getExpression](xref:botbuilder-dialogs-adaptive.OnCondition.getExpression) + [OnDialogEvent.getExpression](xref:botbuilder-dialogs-adaptive.OnDialogEvent.getExpression) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OrdinalEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OrdinalEntityRecognizer.yml index b9376af2..358cc6d8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OrdinalEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/OrdinalEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes ordinal input. fullName: OrdinalEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.OrdinalEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.OrdinalEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.OrdinalEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + OrdinalEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.OrdinalEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +112,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +126,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.OrdinalEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +160,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Output.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Output.yml deleted file mode 100644 index 43edf315..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Output.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: Output -uid: botbuilder-dialogs-adaptive.Output -package: botbuilder-dialogs-adaptive -summary: '' -fullName: Output -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type Output = Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PercentageEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PercentageEntityRecognizer.yml index f21bf5f0..24d882a1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PercentageEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PercentageEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes percentage input. fullName: PercentageEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.PercentageEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.PercentageEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.PercentageEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + PercentageEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.PercentageEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +113,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +127,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.PercentageEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +161,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PhoneNumberEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PhoneNumberEntityRecognizer.yml index 1596db78..ebf3a594 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PhoneNumberEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PhoneNumberEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes phone number input. fullName: PhoneNumberEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + PhoneNumberEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +113,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +127,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +161,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesInput.yml deleted file mode 100644 index 15aec4dc..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesInput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: PropertiesInput -uid: botbuilder-dialogs-adaptive.PropertiesInput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: PropertiesInput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type PropertiesInput = Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesOutput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesOutput.yml deleted file mode 100644 index 201a6b21..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertiesOutput.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: PropertiesOutput -uid: botbuilder-dialogs-adaptive.PropertiesOutput -package: botbuilder-dialogs-adaptive -summary: '' -fullName: PropertiesOutput -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type PropertiesOutput = Record diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Property.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Property.yml index 6821ea3d..61f7b530 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Property.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Property.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: Property remarks: '' -isPreview: false isDeprecated: false syntax: | type Property = string | Expression diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertyAssignment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertyAssignment.yml index 110f2611..ea249b46 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertyAssignment.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertyAssignment.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: PropertyAssignment remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -28,7 +26,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertySchema.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertySchema.yml index 6c7b66d7..b13dc941 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertySchema.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/PropertySchema.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs-adaptive summary: Represents a property found in a JSON schema. fullName: PropertySchema remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'PropertySchema(string, object, PropertySchema[])' + - name: PropertySchema(string, object, PropertySchema[]) uid: botbuilder-dialogs-adaptive.PropertySchema.constructor package: botbuilder-dialogs-adaptive summary: Creates a new `PropertySchema` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -28,9 +26,8 @@ constructors: type: object description: JSON schema fragment for this property. - id: children - type: '[]' - description: | - Optional. Child properties. + type: [] + description: Optional. Child properties. properties: - name: children uid: botbuilder-dialogs-adaptive.PropertySchema.children @@ -38,46 +35,42 @@ properties: summary: Child properties if there are any. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'PropertySchema[] children' + content: PropertySchema[] children return: description: The child properties if there are any. - type: '[]' + type: [] - name: entities uid: botbuilder-dialogs-adaptive.PropertySchema.entities package: botbuilder-dialogs-adaptive summary: List of entity names. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] entities' + content: string[] entities return: description: A list of entity names. - type: 'string[]' + type: string[] - name: expectedOnly uid: botbuilder-dialogs-adaptive.PropertySchema.expectedOnly package: botbuilder-dialogs-adaptive summary: List of expected only entity names. fullName: expectedOnly remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] expectedOnly' + content: string[] expectedOnly return: description: A List of expected only entity names. - type: 'string[]' + type: string[] - name: name uid: botbuilder-dialogs-adaptive.PropertySchema.name package: botbuilder-dialogs-adaptive summary: Name for this property. fullName: name - remarks: 'Array brackets `[]` will have been removed.' - isPreview: false + remarks: '' isDeprecated: false syntax: content: string name @@ -90,20 +83,18 @@ properties: summary: Parent property schema if any. fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: PropertySchema | undefined parent + content: undefined | PropertySchema parent return: description: The parent property schema if any. - type: | undefined + type: undefined | - name: path uid: botbuilder-dialogs-adaptive.PropertySchema.path package: botbuilder-dialogs-adaptive summary: Path to schema. fullName: path - remarks: 'Contains `[]` for arrays and `.` for path segments.' - isPreview: false + remarks: Contains `[]` for arrays and `.` for path segments. isDeprecated: false syntax: content: 'path: string' @@ -116,7 +107,6 @@ properties: summary: JSON Schema object for this property. fullName: schema remarks: '' - isPreview: false isDeprecated: false syntax: content: 'schema: object' @@ -129,7 +119,6 @@ properties: summary: JSON Schema type. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: string type @@ -142,7 +131,6 @@ methods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isArray(): boolean' @@ -154,7 +142,6 @@ methods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isEnum(): boolean' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RandomSelector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RandomSelector.yml index 3155b7d0..cbfaf4c9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RandomSelector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RandomSelector.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Select a random true rule implementation of TriggerSelector. fullName: RandomSelector remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -23,66 +21,69 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.RandomSelector.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): RandomSelector' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TriggerSelector.configure](xref:botbuilder-dialogs-adaptive.TriggerSelector.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive.RandomSelector.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TriggerSelector.getConverter](xref:botbuilder-dialogs-adaptive.TriggerSelector.getConverter) methods: - - name: 'initialize(OnCondition[], boolean)' + - name: initialize(OnCondition[], boolean) uid: botbuilder-dialogs-adaptive.RandomSelector.initialize package: botbuilder-dialogs-adaptive summary: Initialize the selector with the set of rules. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(conditionals: OnCondition[], evaluate: boolean)' parameters: - id: conditionals - type: '[]' + type: [] description: Possible rules to match. - id: evaluate type: boolean - description: | - A boolean representing if rules should be evaluated on select. + description: A boolean representing if rules should be evaluated on select. - name: select(ActionContext) uid: botbuilder-dialogs-adaptive.RandomSelector.select package: botbuilder-dialogs-adaptive summary: Select the best rule to execute. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function select(actionContext: ActionContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerConverter.yml deleted file mode 100644 index ff2b3b99..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerConverter.yml +++ /dev/null @@ -1,51 +0,0 @@ -### YamlMime:TSType -name: RecognizerConverter -uid: botbuilder-dialogs-adaptive.RecognizerConverter -package: botbuilder-dialogs-adaptive -summary: >- - Recognizer converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: RecognizerConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: RecognizerConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive.RecognizerConverter.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [RecognizerConverter](xref:botbuilder-dialogs-adaptive.RecognizerConverter) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new RecognizerConverter(_resourceExplorer: ResourceExplorer)' - parameters: - - id: _resourceExplorer - type: ResourceExplorer - description: | - Resource explorer to use for resolving references. -methods: - - name: convert(string | Recognizer) - uid: botbuilder-dialogs-adaptive.RecognizerConverter.convert - package: botbuilder-dialogs-adaptive - summary: >- - Converts an object or string to a - [Recognizer](xref:botbuilder-dialogs-adaptive.Recognizer) instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string | Recognizer): Recognizer' - parameters: - - id: value - type: string | Recognizer - description: An object or string value. - return: - description: >- - A new [Recognizer](xref:botbuilder-dialogs-adaptive.Recognizer) - instance. - type: Recognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerListConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerListConverter.yml deleted file mode 100644 index a3b2d1bb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerListConverter.yml +++ /dev/null @@ -1,51 +0,0 @@ -### YamlMime:TSType -name: RecognizerListConverter -uid: botbuilder-dialogs-adaptive.RecognizerListConverter -package: botbuilder-dialogs-adaptive -summary: >- - Recognizer list converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: RecognizerListConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: RecognizerListConverter(ResourceExplorer) - uid: botbuilder-dialogs-adaptive.RecognizerListConverter.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [MultiLanguageRecognizerConverter](xref:botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new RecognizerListConverter(resourceExplorer: ResourceExplorer)' - parameters: - - id: resourceExplorer - type: ResourceExplorer - description: | - Resource explorer to use for resolving references. -methods: - - name: 'convert(string[] | Recognizer[])' - uid: botbuilder-dialogs-adaptive.RecognizerListConverter.convert - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string[] | Recognizer[]): Recognizer[]' - parameters: - - id: value - type: 'string[] | Recognizer[]' - description: >- - A list of string or a list of - [Recognizer](xref:botbuilder-dialogs.Recognizer). - return: - description: >- - A new list of [Recognizer](xref:botbuilder-dialogs.Recognizer) - instances. - type: 'Recognizer[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSet.yml index 2a35e608..6cbb9d65 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSet.yml @@ -7,7 +7,6 @@ summary: >- recognizers into one RecognizerResult. fullName: RecognizerSet remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -30,13 +28,12 @@ properties: summary: '' fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizers: Recognizer[]' return: description: '' - type: 'Recognizer[]' + type: Recognizer[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.RecognizerSet.id @@ -44,14 +41,15 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.id](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.id) - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.RecognizerSet.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -60,7 +58,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -78,67 +75,71 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.telemetryClient](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.telemetryClient) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.RecognizerSet.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): RecognizerSet' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.configure](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure) methods: - - name: getConverter(Object) + - name: getConverter(keyof RecognizerSetConfiguration) uid: botbuilder-dialogs-adaptive.RecognizerSet.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof RecognizerSetConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof RecognizerSetConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- - recognize(DialogContext, Activity, [key: string]: string, [key: string]: - number) + recognize(DialogContext, Activity, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-dialogs-adaptive.RecognizerSet.recognize package: botbuilder-dialogs-adaptive summary: >- Runs current DialogContext.TurnContext.Activity through a recognizer and returns a [RecognizerResult](xref:botbuilder-core.RecognizerResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function recognize(dialogContext: DialogContext, activity: Activity, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: dialogContext type: DialogContext @@ -147,14 +148,14 @@ methods: current turn of conversation. - id: activity type: Activity - description: '(xref:botframework-schema.Activity) to recognize.' + description: '[Activity](xref:botframework-schema.Activity) to recognize.' - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional, additional properties to be logged to telemetry with the LuisResult event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional, additional metrics to be logged to telemetry with the LuisResult event. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSetConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSetConfiguration.yml index ad6f2ded..d9206c13 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSetConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RecognizerSetConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: RecognizerSetConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,13 +14,12 @@ properties: summary: '' fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizers?: string[] | Recognizer[]' return: description: '' - type: 'string[] | Recognizer[]' + type: string[] | Recognizer[] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.RecognizerSetConfiguration.id @@ -29,7 +27,6 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizer.yml index 8d5a126d..5f057e98 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizer.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Matches input against a regular expression. fullName: RegexEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: RegexEntityRecognizer() - uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new RegexEntityRecognizer() properties: - name: $kind uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,7 +26,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -48,12 +35,9 @@ properties: - name: pattern uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.pattern package: botbuilder-dialogs-adaptive - summary: |- - Gets the regular expression pattern value. - Sets the pattern. + summary: Gets the regular expression pattern value. fullName: pattern remarks: '' - isPreview: false isDeprecated: false syntax: content: string pattern @@ -67,14 +51,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -83,16 +66,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -101,51 +81,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + RegexEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -153,7 +136,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,25 +150,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.RegexEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -205,14 +184,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizerConfiguration.yml index 70bf6369..993aa734 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexEntityRecognizerConfiguration.yml @@ -7,7 +7,6 @@ summary: |- Licensed under the MIT License. fullName: RegexEntityRecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -30,7 +28,6 @@ properties: summary: '' fullName: pattern remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pattern?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizer.yml index 6e559433..561d92e6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizer implementation which uses regex expressions to identify intents. fullName: RegexRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -28,26 +26,24 @@ properties: summary: The entity recognizers. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities: EntityRecognizer[]' return: description: '' - type: '[]' + type: [] - name: intents uid: botbuilder-dialogs-adaptive.RegexRecognizer.intents package: botbuilder-dialogs-adaptive summary: Array of patterns -> intent names. fullName: intents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intents: IntentPattern[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.RegexRecognizer.id @@ -55,14 +51,15 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.id](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.id) - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.RegexRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -71,7 +68,6 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' @@ -89,67 +85,71 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.telemetryClient](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.telemetryClient) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.RegexRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): RegexRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [AdaptiveRecognizer.configure](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.configure) methods: - - name: getConverter(Object) + - name: getConverter(keyof RegexRecognizerConfiguration) uid: botbuilder-dialogs-adaptive.RegexRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof RegexRecognizerConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof RegexRecognizerConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: >- - recognize(DialogContext, Activity, [key: string]: string, [key: string]: - number) + recognize(DialogContext, Activity, {[key: string]: string}, {[key: + string]: number}) uid: botbuilder-dialogs-adaptive.RegexRecognizer.recognize package: botbuilder-dialogs-adaptive summary: >- Runs current DialogContext.TurnContext.Activity through a recognizer and returns a [RecognizerResult](xref:botbuilder-core.RecognizerResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function recognize(dialogContext: DialogContext, activity: Activity, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise + telemetryProperties?: {[key: string]: string}, telemetryMetrics?: {[key: + string]: number}): Promise parameters: - id: dialogContext type: DialogContext @@ -158,14 +158,14 @@ methods: current turn of conversation. - id: activity type: Activity - description: '(xref:botframework-schema.Activity) to recognize.' + description: '[Activity](xref:botframework-schema.Activity) to recognize.' - id: telemetryProperties - type: '[key: string]\: string' + type: '{[key: string]: string}' description: >- Optional, additional properties to be logged to telemetry with the LuisResult event. - id: telemetryMetrics - type: '[key: string]\: number' + type: '{[key: string]: number}' description: >- Optional, additional metrics to be logged to telemetry with the LuisResult event. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizerConfiguration.yml index 15bb8640..87c3de86 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RegexRecognizerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: RegexRecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,15 +14,14 @@ properties: summary: '' fullName: intents remarks: '' - isPreview: false isDeprecated: false syntax: content: 'intents?: IntentPatternInput[] | IntentPattern[]' return: description: '' type: >- - [] | - [] + IntentPatternInput[] | [] inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.RegexRecognizerConfiguration.id @@ -31,27 +29,27 @@ inheritedProperties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From RecognizerConfiguration.id + inheritanceDescription: >- + Inherited From + [RecognizerSetConfiguration.id](xref:botbuilder-dialogs-adaptive.RecognizerSetConfiguration.id) - name: recognizers uid: botbuilder-dialogs-adaptive.RegexRecognizerConfiguration.recognizers package: botbuilder-dialogs-adaptive summary: '' fullName: recognizers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizers?: string[] | Recognizer[]' return: description: '' - type: 'string[] | Recognizer[]' + type: string[] | Recognizer[] inheritanceDescription: >- Inherited From [RecognizerSetConfiguration.recognizers](xref:botbuilder-dialogs-adaptive.RecognizerSetConfiguration.recognizers) @@ -61,12 +59,13 @@ inheritedProperties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From RecognizerConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [RecognizerSetConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.RecognizerSetConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialog.yml index 11491793..87e39b13 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialog.yml @@ -7,19 +7,8 @@ summary: >- (restarting it). fullName: RepeatDialog remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: RepeatDialog() - uid: botbuilder-dialogs-adaptive.RepeatDialog.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new RepeatDialog() properties: - name: $kind uid: botbuilder-dialogs-adaptive.RepeatDialog.$kind @@ -27,7 +16,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -42,7 +30,6 @@ properties: dialog. fullName: allowLoop remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowLoop?: BoolExpression' @@ -55,13 +42,38 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.RepeatDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.RepeatDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.RepeatDialog.activityProcessed @@ -71,7 +83,6 @@ inheritedProperties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' @@ -87,7 +98,6 @@ inheritedProperties: summary: The dialog to call. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog: DialogExpression' @@ -108,35 +118,21 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.RepeatDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.EndOfTurn) - name: options uid: botbuilder-dialogs-adaptive.RepeatDialog.options package: botbuilder-dialogs-adaptive summary: Configurable options for the dialog. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: ObjectExpression' @@ -146,44 +142,31 @@ inheritedProperties: inheritanceDescription: >- Inherited From [BaseInvokeDialog.options](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.options) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.RepeatDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.RepeatDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): RepeatDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.configure](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.RepeatDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -207,20 +190,22 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.continueDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.continueDialog) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.RepeatDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -249,27 +234,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.endDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.endDialog) - name: getDependencies() uid: botbuilder-dialogs-adaptive.RepeatDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -278,13 +263,12 @@ inheritedMethods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog<__type>[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog<__type>[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [BaseInvokeDialog.getDependencies](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getDependencies) @@ -310,7 +294,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -319,15 +302,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.getVersion](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.RepeatDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -345,11 +329,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.RepeatDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -370,25 +356,25 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.RepeatDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -428,12 +414,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -445,26 +430,26 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.resumeDialog + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.resumeDialog) methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.RepeatDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -476,21 +461,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof RepeatDialogConfiguration) uid: botbuilder-dialogs-adaptive.RepeatDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof RepeatDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof RepeatDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialogConfiguration.yml index da51633e..20484507 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/RepeatDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: RepeatDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: allowLoop remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowLoop?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -42,7 +39,6 @@ inheritedProperties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed?: BoolProperty' @@ -58,7 +54,6 @@ inheritedProperties: summary: '' fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog?: DialogProperty' @@ -74,21 +69,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [BaseInvokeDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration.id) - name: options uid: botbuilder-dialogs-adaptive.RepeatDialogConfiguration.options package: botbuilder-dialogs-adaptive summary: '' fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options?: ObjectProperty' @@ -106,12 +101,13 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [BaseInvokeDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialog.yml index 9fb77322..f41e653f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialog.yml @@ -7,18 +7,16 @@ summary: >- is done it will go to the caller's parent dialog. fullName: ReplaceDialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ReplaceDialog(string, O)' + - name: ReplaceDialog(string, O) uid: botbuilder-dialogs-adaptive.ReplaceDialog.constructor package: botbuilder-dialogs-adaptive summary: >- Creates a new [ReplaceDialog](xref:botbuilder-dialogs-adaptive.ReplaceDialog) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ReplaceDialog(dialogIdToCall: string, options?: O)' @@ -28,7 +26,7 @@ constructors: description: '' - id: options type: O - description: > + description: >- Optional, static options to pass the [Dialog](xref:botbuilder-dialogs.Dialog). properties: @@ -38,7 +36,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -51,13 +48,38 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.ReplaceDialog.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.ReplaceDialog.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: activityProcessed uid: botbuilder-dialogs-adaptive.ReplaceDialog.activityProcessed @@ -67,7 +89,6 @@ inheritedProperties: activity. fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed: BoolExpression' @@ -83,7 +104,6 @@ inheritedProperties: summary: The dialog to call. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog: DialogExpression' @@ -104,35 +124,21 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.ReplaceDialog.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.EndOfTurn) - name: options uid: botbuilder-dialogs-adaptive.ReplaceDialog.options package: botbuilder-dialogs-adaptive summary: Configurable options for the dialog. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: ObjectExpression' @@ -142,44 +148,31 @@ inheritedProperties: inheritanceDescription: >- Inherited From [BaseInvokeDialog.options](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.options) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ReplaceDialog.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ReplaceDialog.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ReplaceDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.configure](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ReplaceDialog.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -203,20 +196,22 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.continueDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.continueDialog) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ReplaceDialog.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -245,27 +240,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.endDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.endDialog) - name: getDependencies() uid: botbuilder-dialogs-adaptive.ReplaceDialog.getDependencies package: botbuilder-dialogs-adaptive @@ -274,13 +269,12 @@ inheritedMethods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog<__type>[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog<__type>[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] inheritanceDescription: >- Inherited From [BaseInvokeDialog.getDependencies](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getDependencies) @@ -306,7 +300,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -315,15 +308,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.getVersion](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ReplaceDialog.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -341,11 +335,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ReplaceDialog.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -366,25 +362,25 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ReplaceDialog.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -424,12 +420,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -441,26 +436,26 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> - inheritanceDescription: Inherited From Dialog.resumeDialog + type: Promise<DialogTurnResult<any>> + inheritanceDescription: >- + Inherited From + [BaseInvokeDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.BaseInvokeDialog.resumeDialog) methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.ReplaceDialog.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -472,21 +467,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ReplaceDialogConfiguration) uid: botbuilder-dialogs-adaptive.ReplaceDialog.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ReplaceDialogConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ReplaceDialogConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialogConfiguration.yml index e3fcb5d1..f7f5dc06 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ReplaceDialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ReplaceDialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -29,7 +27,6 @@ inheritedProperties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityProcessed?: BoolProperty' @@ -45,7 +42,6 @@ inheritedProperties: summary: '' fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialog?: DialogProperty' @@ -61,21 +57,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [BaseInvokeDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration.id) - name: options uid: botbuilder-dialogs-adaptive.ReplaceDialogConfiguration.options package: botbuilder-dialogs-adaptive summary: '' fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options?: ObjectProperty' @@ -93,12 +89,13 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [BaseInvokeDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration.telemetryClient) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceExtensions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceExtensions.yml index dea645c7..78f80055 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceExtensions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceExtensions.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs-adaptive summary: Extension methods for resource explorer. fullName: ResourceExtensions remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'useResourceExplorer(DialogManager, ResourceExplorer)' + - name: useResourceExplorer(DialogManager, ResourceExplorer) uid: botbuilder-dialogs-adaptive.ResourceExtensions.useResourceExplorer package: botbuilder-dialogs-adaptive summary: Register ResourceExplorer into DialogManager. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGenerator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGenerator.yml index 86306145..b3beebee 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGenerator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGenerator.yml @@ -5,28 +5,25 @@ package: botbuilder-dialogs-adaptive summary: >- Uses resourceExplorer to mount root lg and all language variants as a multi language generator. -fullName: 'ResourceMultiLanguageGenerator' +fullName: ResourceMultiLanguageGenerator remarks: >- Given file name like "foo.lg" this will generate a map of foo.{LOCALE}.lg files. -isPreview: false isDeprecated: false type: class constructors: - - name: ResourceMultiLanguageGenerator(string) + - name: ResourceMultiLanguageGenerator(string) uid: botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator.constructor package: botbuilder-dialogs-adaptive summary: Initializes a new instance of the ResourceMultiLanguageGenerator class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ResourceMultiLanguageGenerator(resourceId?: string)' parameters: - id: resourceId type: string - description: | - Resource id of LG file. + description: Resource id of LG file. properties: - name: $kind uid: botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator.$kind @@ -34,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -47,7 +43,6 @@ properties: summary: Resource id of LG file. fullName: resourceId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceId: string' @@ -61,7 +56,6 @@ inheritedProperties: summary: Language policy required by language generator. fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy: LanguagePolicy' @@ -72,31 +66,35 @@ inheritedProperties: Inherited From [MultiLanguageGeneratorBase.languagePolicy](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.languagePolicy) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + ResourceMultiLanguageGenerator parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: 'generate(DialogContext, string, D)' + type: >- + <T, D> + inheritanceDescription: >- + Inherited From + [MultiLanguageGeneratorBase.configure](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.configure) + - name: generate(DialogContext, string, D) uid: botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator.generate package: botbuilder-dialogs-adaptive summary: Find a language generator that matches the current context locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,32 +116,34 @@ inheritedMethods: inheritanceDescription: >- Inherited From [MultiLanguageGeneratorBase.generate](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.generate) - - name: getConverter(Object) + - name: getConverter("languagePolicy") uid: botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: "languagePolicy"): Converter | ConverterFactory parameters: - id: property - type: Object + type: '"languagePolicy"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: >- Inherited From [MultiLanguageGeneratorBase.getConverter](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase.getConverter) methods: - - name: 'tryGetGenerator(DialogContext, string)' + - name: tryGetGenerator(DialogContext, string) uid: botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator.tryGetGenerator package: botbuilder-dialogs-adaptive summary: Implementation of lookup by locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGeneratorConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGeneratorConfiguration.yml index 51213e2f..71e3f220 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGeneratorConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResourceMultiLanguageGeneratorConfiguration.yml @@ -8,7 +8,6 @@ summary: >- class. fullName: ResourceMultiLanguageGeneratorConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: summary: '' fullName: resourceId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceId?: string' @@ -34,15 +32,14 @@ inheritedProperties: summary: '' fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'languagePolicy?: Record | LanguagePolicy' + content: 'languagePolicy?: LanguagePolicy | Record' return: description: '' type: >- - Record<string, string[]> | + | + Record<string, string[]> inheritanceDescription: >- Inherited From [MultiLanguageGeneratorBaseConfiguration.languagePolicy](xref:botbuilder-dialogs-adaptive.MultiLanguageGeneratorBaseConfiguration.languagePolicy) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResponsesTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResponsesTypes.yml index e94282e9..8730c5be 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResponsesTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ResponsesTypes.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ResponsesTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: None diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Result.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Result.yml index 05f664d2..abba8484 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Result.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/Result.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Result data of HTTP operation. fullName: Result remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botbuilder-dialogs-adaptive summary: Initialize a new instance of Result class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Result(headers?: Headers)' parameters: - id: headers type: Headers - description: | - Response headers. + description: Response headers. properties: - name: content uid: botbuilder-dialogs-adaptive.Result.content @@ -30,7 +27,6 @@ properties: summary: The content body from the response to HTTP operation. fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content?: any' @@ -43,20 +39,18 @@ properties: summary: The headers from the response to HTTP operation. fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'headers?: [key: string]: string' + content: 'headers?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: reasonPhrase uid: botbuilder-dialogs-adaptive.Result.reasonPhrase package: botbuilder-dialogs-adaptive summary: The reason phrase from the response to HTTP operation. fullName: reasonPhrase remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reasonPhrase?: string' @@ -69,7 +63,6 @@ properties: summary: The status code from the response to HTTP operation. fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SchemaHelper.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SchemaHelper.yml index 2bb0310d..18d33dde 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SchemaHelper.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SchemaHelper.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Helper class for dialog schema. fullName: SchemaHelper remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botbuilder-dialogs-adaptive summary: Creates a new `SchemaHelper` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SchemaHelper(schema: object)' parameters: - id: schema type: object - description: | - JSON schema to parse. + description: JSON schema to parse. properties: - name: property uid: botbuilder-dialogs-adaptive.SchemaHelper.property @@ -30,7 +27,6 @@ properties: summary: Root object property for the schema. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: PropertySchema' @@ -43,20 +39,18 @@ properties: summary: List of required property names. fullName: required remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] required' + content: string[] required return: description: The list of required property names. - type: 'string[]' + type: string[] - name: schema uid: botbuilder-dialogs-adaptive.SchemaHelper.schema package: botbuilder-dialogs-adaptive summary: JSON schema object. fullName: schema remarks: '' - isPreview: false isDeprecated: false syntax: content: 'schema: object' @@ -69,14 +63,13 @@ methods: package: botbuilder-dialogs-adaptive summary: Returns the schema object for a given property path. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function pathToSchema(path: string): PropertySchema | undefined' + content: 'function pathToSchema(path: string): undefined | PropertySchema' parameters: - id: path type: string description: Path of the properties schema to return. return: description: the schema object for a given property path. - type: | undefined + type: undefined | diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivity.yml index fa191b2e..9af75c8c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivity.yml @@ -5,27 +5,25 @@ package: botbuilder-dialogs-adaptive summary: Send an activity back to the user. fullName: SendActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: SendActivity(Partial | string) + - name: SendActivity(string | Partial) uid: botbuilder-dialogs-adaptive.SendActivity.constructor package: botbuilder-dialogs-adaptive summary: >- Creates a new [SendActivity](xref:botbuilder-dialogs-adaptive.SendActivity) instance. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new SendActivity(activity?: Partial | string)' + content: 'new SendActivity(activity?: string | Partial)' parameters: - id: activity - type: Partial<Activity> | string - description: > - (xref:botframework-schema.Activity) or message text to send the - user. + type: string | Partial<Activity> + description: >- + [Activity](xref:botframework-schema.Activity) or message text to + send the user. properties: - name: $kind uid: botbuilder-dialogs-adaptive.SendActivity.$kind @@ -33,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -46,100 +43,96 @@ properties: summary: Gets or sets template for the activity. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'activity: TemplateInterface, D & O>' + content: >- + activity: TemplateInterface, DialogStateManager & { + utterance: string } & O> return: description: '' type: >- - TemplateInterface<Partial<Activity>, & O> + TemplateInterface<Partial<Activity>, DialogStateManager & { + utterance: string } & O> - name: disabled uid: botbuilder-dialogs-adaptive.SendActivity.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.SendActivity.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.SendActivity.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.SendActivity.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.SendActivity.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.SendActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SendActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.SendActivity.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -163,20 +156,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.SendActivity.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -205,23 +198,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -248,7 +239,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -258,14 +248,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.SendActivity.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -284,10 +273,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.SendActivity.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -308,25 +297,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.SendActivity.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -366,12 +353,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -383,26 +369,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.SendActivity.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -412,21 +396,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SendActivityConfiguration) uid: botbuilder-dialogs-adaptive.SendActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof SendActivityConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof SendActivityConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivityConfiguration.yml index b19bbc73..fa9673bb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: SendActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity?: TemplateInterfaceProperty, D>' @@ -23,15 +21,13 @@ properties: description: '' type: >- <Partial<Activity>, > + /><Partial<Activity>, D> - name: disabled uid: botbuilder-dialogs-adaptive.SendActivityConfiguration.disabled package: botbuilder-dialogs-adaptive summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -45,7 +41,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -59,7 +54,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivity.yml index 0bbd3b4f..38f02495 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivity.yml @@ -7,9 +7,8 @@ summary: >- calls this.endDialog). -fullName: SendHandoffActivity +fullName: SendHandoffActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -20,15 +19,13 @@ constructors: Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SendHandoffActivity(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: $kind uid: botbuilder-dialogs-adaptive.SendHandoffActivity.$kind @@ -36,7 +33,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -49,20 +45,44 @@ properties: summary: Context to send with handoff activity fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: ObjectExpression>' return: description: '' - type: 'ObjectExpression<Record<string, unknown>>' + type: ObjectExpression<Record<string, unknown>> + - name: id + uid: botbuilder-dialogs-adaptive.SendHandoffActivity.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.SendHandoffActivity.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: transcript uid: botbuilder-dialogs-adaptive.SendHandoffActivity.transcript package: botbuilder-dialogs-adaptive summary: Transcript to send with handoff activity fullName: transcript remarks: '' - isPreview: false isDeprecated: false syntax: content: 'transcript: ObjectExpression' @@ -81,66 +101,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.SendHandoffActivity.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.SendHandoffActivity.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SendHandoffActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -164,20 +154,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -206,23 +196,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -249,7 +237,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -259,14 +246,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -285,10 +271,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -309,25 +295,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -367,12 +351,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -384,11 +367,10 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - name: beginDialog(DialogContext) @@ -398,7 +380,6 @@ methods: Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -411,20 +392,23 @@ methods: return: description: result of sending handoff activity type: Promise<DialogTurnResult<ResourceResponse>> - - name: getConverter(Object) + - name: getConverter(keyof SendHandoffActivityConfiguration) uid: botbuilder-dialogs-adaptive.SendHandoffActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof SendHandoffActivityConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof SendHandoffActivityConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivityConfiguration.yml index 526e1387..56ed28a5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SendHandoffActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: SendHandoffActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: ObjectProperty>' @@ -30,7 +28,6 @@ properties: summary: '' fullName: transcript remarks: '' - isPreview: false isDeprecated: false syntax: content: 'transcript?: ObjectProperty' @@ -46,7 +43,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -61,7 +57,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperties.yml index 8fce126e..25688668 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperties.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperties.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Sets properties with the result of evaluating a value expression. fullName: SetProperties remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: SetProperties() - uid: botbuilder-dialogs-adaptive.SetProperties.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SetProperties() properties: - name: $kind uid: botbuilder-dialogs-adaptive.SetProperties.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,98 +26,92 @@ properties: summary: Additional property settings as property/value pairs. fullName: assignments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assignments: PropertyAssignment[]' return: description: '' - type: '[]' + type: [] - name: disabled uid: botbuilder-dialogs-adaptive.SetProperties.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.SetProperties.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.SetProperties.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.SetProperties.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.SetProperties.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.SetProperties.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SetProperties' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.SetProperties.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -153,20 +135,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.SetProperties.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -195,23 +177,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -238,7 +218,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -248,14 +227,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.SetProperties.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -274,10 +252,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.SetProperties.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -298,25 +276,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.SetProperties.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -356,12 +332,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -373,26 +348,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.SetProperties.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -404,21 +377,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SetPropertiesConfiguration) uid: botbuilder-dialogs-adaptive.SetProperties.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof SetPropertiesConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof SetPropertiesConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertiesConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertiesConfiguration.yml index 3fe69382..b0781311 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertiesConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertiesConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: SetPropertiesConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,15 +14,13 @@ properties: summary: '' fullName: assignments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'assignments?: AssignmentInput[] | PropertyAssignment[]' return: description: '' type: >- - <unknown>[] | [] - name: disabled uid: botbuilder-dialogs-adaptive.SetPropertiesConfiguration.disabled @@ -31,7 +28,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -45,7 +41,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -59,7 +54,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperty.yml index ccd812ba..0d068c53 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetProperty.yml @@ -5,29 +5,16 @@ package: botbuilder-dialogs-adaptive summary: Sets a property with the result of evaluating a value expression. fullName: SetProperty remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: SetProperty() - uid: botbuilder-dialogs-adaptive.SetProperty.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [SetProperty](xref:botbuilder-dialogs-adaptive.SetProperty) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SetProperty() - - name: 'SetProperty(string, any)' + - name: SetProperty(string, any) uid: botbuilder-dialogs-adaptive.SetProperty.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [SetProperty](xref:botbuilder-dialogs-adaptive.SetProperty) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SetProperty(property: string, value: any)' @@ -37,8 +24,7 @@ constructors: description: Property path to put the value in. - id: value type: any - description: | - The expression to get the value to put into property path. + description: The expression to get the value to put into property path. properties: - name: $kind uid: botbuilder-dialogs-adaptive.SetProperty.$kind @@ -46,7 +32,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -59,33 +44,56 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.SetProperty.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: property uid: botbuilder-dialogs-adaptive.SetProperty.property package: botbuilder-dialogs-adaptive summary: Property path to put the value in. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.SetProperty.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.SetProperty.value package: botbuilder-dialogs-adaptive summary: The expression to get the value to put into property path. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -104,66 +112,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.SetProperty.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.SetProperty.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.SetProperty.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SetProperty' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.SetProperty.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -187,20 +165,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.SetProperty.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -229,23 +207,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -272,7 +248,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -282,14 +257,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.SetProperty.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -308,10 +282,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.SetProperty.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -332,25 +306,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.SetProperty.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -390,12 +362,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -407,26 +378,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.SetProperty.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -438,21 +407,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SetPropertyConfiguration) uid: botbuilder-dialogs-adaptive.SetProperty.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof SetPropertyConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof SetPropertyConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertyConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertyConfiguration.yml index 8dc664e1..31921ded 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertyConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SetPropertyConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: SetPropertyConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -41,13 +38,12 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.SetPropertyConfiguration.id @@ -55,7 +51,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -69,7 +64,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUser.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUser.yml index 065e6592..ff99d605 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUser.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUser.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Singns out the user and finishes the dialog. fullName: SignOutUser remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: SignOutUser() - uid: botbuilder-dialogs-adaptive.SignOutUser.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SignOutUser() properties: - name: $kind uid: botbuilder-dialogs-adaptive.SignOutUser.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,7 +26,6 @@ properties: summary: The name of the OAuth connection. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: StringExpression' @@ -51,20 +38,44 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.SignOutUser.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.SignOutUser.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: userId uid: botbuilder-dialogs-adaptive.SignOutUser.userId package: botbuilder-dialogs-adaptive summary: The expression which resolves to the userId to sign out. fullName: userId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userId: StringExpression' @@ -83,66 +94,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.SignOutUser.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.SignOutUser.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.SignOutUser.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SignOutUser' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.SignOutUser.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -166,20 +147,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.SignOutUser.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -208,23 +189,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -251,7 +230,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -261,14 +239,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.SignOutUser.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -287,10 +264,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.SignOutUser.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -311,25 +288,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.SignOutUser.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -369,12 +344,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -386,26 +360,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.SignOutUser.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -417,21 +389,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SignOutUserConfiguration) uid: botbuilder-dialogs-adaptive.SignOutUser.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof SignOutUserConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof SignOutUserConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUserConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUserConfiguration.yml index fa81de45..84a7e0c7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUserConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SignOutUserConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: SignOutUserConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName?: StringProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: userId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userId?: StringProperty' @@ -55,7 +51,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -69,7 +64,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SkillExtensions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SkillExtensions.yml index cb96ecf9..1b8d7d64 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SkillExtensions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SkillExtensions.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs-adaptive summary: Extension methods for skills. fullName: SkillExtensions remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'useSkillClient(DialogManager, BotFrameworkClient)' + - name: useSkillClient(DialogManager, BotFrameworkClient) uid: botbuilder-dialogs-adaptive.SkillExtensions.useSkillClient package: botbuilder-dialogs-adaptive summary: Configures the skill client to use. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,6 @@ methods: package: botbuilder-dialogs-adaptive summary: Configures the skill conversation id factory to use. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplate.yml index 303ed9b7..2444d12a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplate.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplate.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Defines a static activity as a template. fullName: StaticActivityTemplate remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botbuilder-dialogs-adaptive summary: Intialize a new instance of StaticActivityTemplate class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StaticActivityTemplate(activity?: Partial)' parameters: - id: activity type: Partial<Activity> - description: | - Activity as a template. + description: Activity as a template. properties: - name: $kind uid: botbuilder-dialogs-adaptive.StaticActivityTemplate.$kind @@ -30,7 +27,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -43,7 +39,6 @@ properties: summary: Gets or sets the activity as template. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity: Partial' @@ -56,7 +51,6 @@ properties: summary: '' fullName: toString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'toString: () => string' @@ -64,12 +58,11 @@ properties: description: '' type: () => string methods: - - name: 'bind(DialogContext, unknown)' + - name: bind(DialogContext, unknown) uid: botbuilder-dialogs-adaptive.StaticActivityTemplate.bind package: botbuilder-dialogs-adaptive summary: Get predefined activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -81,8 +74,7 @@ methods: description: DialogContext. - id: data type: unknown - description: | - Data to bind to (not working with static activity template). + description: Data to bind to (not working with static activity template). return: description: '' type: Promise<Partial<Activity>> @@ -91,10 +83,11 @@ methods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: StaticActivityTemplateConfiguration): this' + content: >- + function configure(config: StaticActivityTemplateConfiguration): + StaticActivityTemplate parameters: - id: config type: >- @@ -104,20 +97,23 @@ methods: description: The configuration. return: description: A object with the given configuration. - type: this - - name: getConverter(Object) + type: + - name: getConverter("activity") uid: botbuilder-dialogs-adaptive.StaticActivityTemplate.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: Object): Converter | ConverterFactory' + content: >- + function getConverter(_property: "activity"): Converter | ConverterFactory parameters: - id: _property - type: Object + type: '"activity"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplateConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplateConfiguration.yml index c657c1bd..45281912 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplateConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StaticActivityTemplateConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: StaticActivityTemplateConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity?: Partial' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StringProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StringProperty.yml index d97b4af6..714bb4e6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StringProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/StringProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: StringProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type StringProperty = StringExpression | Property diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchCondition.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchCondition.yml index 471359c3..44789b59 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchCondition.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchCondition.yml @@ -5,45 +5,31 @@ package: botbuilder-dialogs-adaptive summary: Conditional branch with multiple cases. fullName: SwitchCondition remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: SwitchCondition() - uid: botbuilder-dialogs-adaptive.SwitchCondition.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [SwitchCondition](xref:botbuilder-dialogs-adaptive.SwitchCondition) class - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new SwitchCondition() - - name: 'SwitchCondition(string, Dialog[], Case[])' + - name: SwitchCondition(string, Dialog<{}>[], Case[]) uid: botbuilder-dialogs-adaptive.SwitchCondition.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [SwitchCondition](xref:botbuilder-dialogs-adaptive.SwitchCondition) class remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new SwitchCondition(condition: string, defaultDialogs: Dialog[], cases: - Case[]) + new SwitchCondition(condition: string, defaultDialogs: Dialog<{}>[], + cases: Case[]) parameters: - id: condition type: string description: Condition expression against memory. - id: defaultDialogs - type: 'Dialog[]' - description: 'Default [Dialog](xref:botbuilder-dialogs.Dialog) array.' + type: Dialog<{}>[] + description: Default [Dialog](xref:botbuilder-dialogs.Dialog) array. - id: cases - type: '[]' - description: | - Cases. + type: [] + description: Cases. properties: - name: $kind uid: botbuilder-dialogs-adaptive.SwitchCondition.$kind @@ -51,7 +37,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -64,20 +49,18 @@ properties: summary: Cases. fullName: cases remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cases: Case[]' return: description: '' - type: '[]' + type: [] - name: condition uid: botbuilder-dialogs-adaptive.SwitchCondition.condition package: botbuilder-dialogs-adaptive summary: Condition expression against memory. fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition: Expression' @@ -90,98 +73,92 @@ properties: summary: Default case. fullName: default remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'default: Dialog[]' + content: 'default: Dialog<{}>[]' return: description: '' - type: 'Dialog[]' + type: Dialog<{}>[] - name: disabled uid: botbuilder-dialogs-adaptive.SwitchCondition.disabled package: botbuilder-dialogs-adaptive summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.SwitchCondition.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.SwitchCondition.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.SwitchCondition.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.SwitchCondition.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.SwitchCondition.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SwitchCondition' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.SwitchCondition.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -205,20 +182,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.SwitchCondition.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -247,23 +224,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -290,7 +265,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -300,14 +274,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.SwitchCondition.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -326,10 +299,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.SwitchCondition.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -350,25 +323,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.SwitchCondition.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -408,12 +379,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -425,26 +395,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.SwitchCondition.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -456,23 +424,26 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof SwitchConditionConfiguration) uid: botbuilder-dialogs-adaptive.SwitchCondition.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof SwitchConditionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof SwitchConditionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> - name: getDependencies() uid: botbuilder-dialogs-adaptive.SwitchCondition.getDependencies package: botbuilder-dialogs-adaptive @@ -481,11 +452,10 @@ methods: they can be added to the containers [Dialog](xref:botbuilder-dialogs.Dialog) set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies.' - type: 'Dialog[]' + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) dependencies. + type: Dialog<{}>[] extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchConditionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchConditionConfiguration.yml index 67be0951..0a1e591c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchConditionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/SwitchConditionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Conditional branch with multiple cases. fullName: SwitchConditionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,22 +14,18 @@ properties: summary: '' fullName: cases remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cases?: CaseInput[] | Case[]' return: description: '' - type: >- - [] | [] + type: CaseInput[] | [] - name: condition uid: botbuilder-dialogs-adaptive.SwitchConditionConfiguration.condition package: botbuilder-dialogs-adaptive summary: '' fullName: condition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'condition?: Property' @@ -43,20 +38,18 @@ properties: summary: '' fullName: default remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'default?: string[] | Dialog[]' + content: 'default?: string[] | Dialog<{}>[]' return: description: '' - type: 'string[] | Dialog[]' + type: string[] | Dialog<{}>[] - name: disabled uid: botbuilder-dialogs-adaptive.SwitchConditionConfiguration.disabled package: botbuilder-dialogs-adaptive summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -70,7 +63,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -84,7 +76,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryLoggerConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryLoggerConstants.yml index 09b5c235..dedbd827 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryLoggerConstants.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryLoggerConstants.yml @@ -7,7 +7,6 @@ summary: >- [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) object. fullName: TelemetryLoggerConstants remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: The name of the event when an adaptive dialog complete occurs. fullName: CompleteEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static CompleteEvent: string' @@ -31,7 +29,6 @@ properties: summary: The name of the event when a cross trained recognizer set result occurs. fullName: CrossTrainedRecognizerSetResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static CrossTrainedRecognizerSetResultEvent: string' @@ -44,7 +41,6 @@ properties: summary: The name of the event when an adaptive dialog action occurs. fullName: DialogActionEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DialogActionEvent: string' @@ -57,7 +53,6 @@ properties: summary: The name of the event when an adaptive dialog cancel occurs. fullName: DialogCancelEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DialogCancelEvent: string' @@ -70,7 +65,6 @@ properties: summary: The name of the event when an adaptive dialog start occurs. fullName: DialogStartEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DialogStartEvent: string' @@ -85,7 +79,6 @@ properties: logged, the context property will contain a more descriptive constant. fullName: GeneratorResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static GeneratorResultEvent: string' @@ -99,7 +92,6 @@ properties: summary: The name of the event when an Input result occurs. fullName: InputDialogResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static InputDialogResultEvent: string' @@ -112,7 +104,6 @@ properties: summary: The name of the event when a Log Action result occurs. fullName: LogActionResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static LogActionResultEvent: string' @@ -126,7 +117,6 @@ properties: summary: The name of the event when a multi language recognizer result occurs. fullName: MultiLanguageRecognizerResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MultiLanguageRecognizerResultEvent: string' @@ -139,7 +129,6 @@ properties: summary: The name of the event when an OAuth Input result occurs. fullName: OAuthInputResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OAuthInputResultEvent: string' @@ -153,7 +142,6 @@ properties: summary: The name of the event when a recognizer set result occurs. fullName: RecognizerSetResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static RecognizerSetResultEvent: string' @@ -167,7 +155,6 @@ properties: summary: The name of the event when a regex recognizer result occurs. fullName: RegexRecognizerResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static RegexRecognizerResultEvent: string' @@ -181,7 +168,6 @@ properties: summary: The name of the event when a Sent Activity result occurs. fullName: SendActivityResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static SendActivityResultEvent: string' @@ -194,7 +180,6 @@ properties: summary: The name of the event when an adaptive dialog trigger occurs. fullName: TriggerEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TriggerEvent: string' @@ -208,7 +193,6 @@ properties: summary: The name of the event when an Update Activity result occurs. fullName: UpdateActivityResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static UpdateActivityResultEvent: string' @@ -222,7 +206,6 @@ properties: summary: The name of the event when a value recognizer result occurs. fullName: ValueRecognizerResultEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static ValueRecognizerResultEvent: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventAction.yml index a10a4d93..88567419 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventAction.yml @@ -3,13 +3,12 @@ name: TelemetryTrackEventAction uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction package: botbuilder-dialogs-adaptive summary: Track a custom event. -fullName: 'TelemetryTrackEventAction' +fullName: TelemetryTrackEventAction remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TelemetryTrackEventAction(string, [key: string]: string)' + - name: 'TelemetryTrackEventAction(string, {[name: string]: string})' uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.constructor package: botbuilder-dialogs-adaptive summary: >- @@ -17,20 +16,18 @@ constructors: [TelemetryTrackEventAction](xref:botbuilder-dialogs-adaptive.TelemetryTrackEventAction) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TelemetryTrackEventAction(eventName: string, properties: [key: - string]: string) + new TelemetryTrackEventAction(eventName: string, properties: {[name: + string]: string}) parameters: - id: eventName type: string description: Name to use for the event. - id: properties - type: '[key: string]\: string' - description: | - Properties to attach to the tracked event. + type: '{[name: string]: string}' + description: Properties to attach to the tracked event. properties: - name: $kind uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.$kind @@ -38,7 +35,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -53,7 +49,6 @@ properties: action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled: BoolExpression' @@ -66,26 +61,50 @@ properties: summary: Gets or sets a name to use for the event. fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: StringExpression' return: description: '' type: StringExpression + - name: id + uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: properties uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.properties package: botbuilder-dialogs-adaptive summary: Gets or sets the properties to attach to the tracked event. fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties: [key: string]: StringExpression' + content: 'properties: {[name: string]: StringExpression}' return: description: '' - type: '[key: string]\: StringExpression' + type: '{[name: string]: StringExpression}' + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: EndOfTurn uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.EndOfTurn @@ -98,66 +117,40 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + TelemetryTrackEventAction parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: >- + <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -181,20 +174,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -223,23 +216,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -266,7 +257,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -276,14 +266,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -302,10 +291,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -326,25 +315,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -384,12 +371,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -401,26 +387,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -432,21 +416,25 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof TelemetryTrackEventActionConfiguration) uid: botbuilder-dialogs-adaptive.TelemetryTrackEventAction.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof + TelemetryTrackEventActionConfiguration): Converter | + ConverterFactory parameters: - id: property - type: Object + type: keyof TelemetryTrackEventActionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventActionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventActionConfiguration.yml index b56086a4..6ddbc299 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventActionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TelemetryTrackEventActionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: TelemetryTrackEventActionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -30,7 +28,6 @@ properties: summary: '' fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName?: StringProperty' @@ -44,15 +41,12 @@ properties: summary: '' fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'properties?: PropertiesInput | PropertiesOutput' return: description: '' - type: >- - | + type: PropertiesInput | PropertiesOutput inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.TelemetryTrackEventActionConfiguration.id @@ -60,7 +54,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -75,7 +68,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemperatureEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemperatureEntityRecognizer.yml index 331a1c90..b086ddd2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemperatureEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemperatureEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes temperature input. fullName: TemperatureEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: >- botbuilder-dialogs-adaptive.TemperatureEntityRecognizer.logPersonalInformation @@ -46,16 +43,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.TemperatureEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -64,51 +58,54 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TemperatureEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + TemperatureEntityRecognizer parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.TemperatureEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -116,7 +113,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,25 +127,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.TemperatureEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -168,14 +161,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGenerator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGenerator.yml index 411874bc..fa326680 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGenerator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGenerator.yml @@ -5,14 +5,13 @@ package: botbuilder-dialogs-adaptive summary: >- [LanguageGenerator](xref:botbuilder-dialogs-adaptive.LanguageGenerator) implementation which uses LGFile. -fullName: 'TemplateEngineLanguageGenerator' +fullName: TemplateEngineLanguageGenerator remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- - TemplateEngineLanguageGenerator(Templates | Resource, Map(Resource | Templates, Map) uid: botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator.constructor package: botbuilder-dialogs-adaptive @@ -21,22 +20,20 @@ constructors: [TemplateEngineLanguageGenerator](xref:botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateEngineLanguageGenerator(arg1?: Templates | Resource, arg2?: + new TemplateEngineLanguageGenerator(arg1?: Resource | Templates, arg2?: Map) parameters: - id: arg1 - type: Templates | Resource + type: Resource | Templates description: >- Optional. An LG [Templates](xref:botbuilder-lg.Templates) or a [Resource](xref:botbuilder-dialogs-declarative.Resource). - id: arg2 - type: 'Map<string, Resource[]>' - description: | - Optional. A `Map` object with a `Resource` array for each key. + type: Map<string, Resource[]> + description: Optional. A `Map` object with a `Resource` array for each key. properties: - name: $kind uid: botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator.$kind @@ -44,7 +41,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -57,7 +53,6 @@ properties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -65,49 +60,55 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: >- + function configure(config: Record): + TemplateEngineLanguageGenerator parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: >- + <T, D> inheritanceDescription: Inherited From Configurable.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: Inherited From Configurable.getConverter methods: - - name: 'generate(DialogContext, string, D)' + - name: generate(DialogContext, string, D) uid: botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator.generate package: botbuilder-dialogs-adaptive summary: Method to generate text from given template and data. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGeneratorConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGeneratorConfiguration.yml index c79ef251..164a6d49 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGeneratorConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateEngineLanguageGeneratorConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: TemplateEngineLanguageGeneratorConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateInterfaceProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateInterfaceProperty.yml index d20a40c9..ee87a1d3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateInterfaceProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TemplateInterfaceProperty.yml @@ -3,9 +3,8 @@ name: TemplateInterfaceProperty uid: botbuilder-dialogs-adaptive.TemplateInterfaceProperty package: botbuilder-dialogs-adaptive summary: '' -fullName: 'TemplateInterfaceProperty' +fullName: TemplateInterfaceProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type TemplateInterfaceProperty = T | TemplateInterface | string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntity.yml index 7f932a47..a19d3d93 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntity.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Text entity base class. fullName: TextEntity remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,15 +15,13 @@ constructors: Initializes a new instance of the [TextEntity](xref:botbuilder-dialogs-adaptive.TextEntity) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TextEntity(text?: string)' parameters: - id: text type: string - description: | - The text value. + description: The text value. properties: - name: text uid: botbuilder-dialogs-adaptive.TextEntity.text @@ -32,7 +29,6 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -45,7 +41,6 @@ properties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntityRecognizer.yml deleted file mode 100644 index a6c2a411..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextEntityRecognizer.yml +++ /dev/null @@ -1,166 +0,0 @@ -### YamlMime:TSType -name: TextEntityRecognizer -uid: botbuilder-dialogs-adaptive.TextEntityRecognizer -package: botbuilder-dialogs-adaptive -summary: >- - TextEntityRecognizer - base class for Text.Recogizers from the text recognizer - library. -fullName: TextEntityRecognizer -remarks: '' -isPreview: false -isDeprecated: false -type: class -inheritedProperties: - - name: id - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.id - package: botbuilder-dialogs-adaptive - summary: Recognizers unique ID. - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Recognizer.id - - name: logPersonalInformation - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.logPersonalInformation - package: botbuilder-dialogs-adaptive - summary: >- - (Optional) Flag that designates whether personally identifiable - information (PII) should log to telemetry. - fullName: logPersonalInformation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logPersonalInformation: BoolExpression' - return: - description: '' - type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.telemetryClient - package: botbuilder-dialogs-adaptive - summary: |- - The telemetry client for logging events. - Default this to the NullTelemetryClient, which does nothing. - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.configure - package: botbuilder-dialogs-adaptive - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.getConverter - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter - - name: >- - recognize(DialogContext, Partial, Record, - Record) - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.recognize - package: botbuilder-dialogs-adaptive - summary: To recognize intents and entities in a users utterance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function recognize(dialogContext: DialogContext, activity: - Partial, _telemetryProperties?: Record, - _telemetryMetrics?: Record): Promise - parameters: - - id: dialogContext - type: DialogContext - description: Dialog Context. - - id: activity - type: Partial<Activity> - description: Activity. - - id: _telemetryProperties - type: 'Record<string, string>' - description: Additional properties to be logged to telemetry with event. - - id: _telemetryMetrics - type: 'Record<string, number>' - description: Additional metrics to be logged to telemetry with event. - return: - description: Analysis of utterance. - type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) -methods: - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities - package: botbuilder-dialogs-adaptive - summary: >- - Recognizes entities from an [Entity](xref:botframework-schema.Entity) - list. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function recognizeEntities(dialogContext: DialogContext, text: string, - locale: string, entities: Entity[]): Promise - parameters: - - id: dialogContext - type: DialogContext - description: >- - The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the - current turn of conversation. - - id: text - type: string - description: Text to recognize. - - id: locale - type: string - description: Locale to use. - - id: entities - type: 'Entity[]' - description: >- - The [Entity](xref:botframework-schema.Entity) array to be - recognized. - return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInput.yml index 02d3eb75..c6900742 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInput.yml @@ -3,30 +3,28 @@ name: TextInput uid: botbuilder-dialogs-adaptive.TextInput package: botbuilder-dialogs-adaptive summary: Declarative text input to gather text data from users. -fullName: TextInput +fullName: TextInput remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TextInput(string, Partial | string)' + - name: TextInput(string, string | Partial) uid: botbuilder-dialogs-adaptive.TextInput.constructor package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [InputDialog](xref:botbuilder-dialogs-adaptive.InputDialog) class remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new TextInput(property?: string, prompt?: Partial | string)' + content: 'new TextInput(property?: string, prompt?: string | Partial)' parameters: - id: property type: string description: Optional. The value expression which the input will be bound to. - id: prompt - type: Partial<Activity> | string - description: > + type: string | Partial<Activity> + description: >- Optional. The [Activity](xref:botframework-schema.Activity) to send to the user, @@ -39,26 +37,50 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' return: description: '' type: string + - name: id + uid: botbuilder-dialogs-adaptive.TextInput.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: outputFormat uid: botbuilder-dialogs-adaptive.TextInput.outputFormat package: botbuilder-dialogs-adaptive summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.TextInput.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient inheritedProperties: - name: allowInterruptions uid: botbuilder-dialogs-adaptive.TextInput.allowInterruptions @@ -66,7 +88,6 @@ inheritedProperties: summary: Interruption policy. fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions: BoolExpression' @@ -84,7 +105,6 @@ inheritedProperties: regardless of there being a value or not. fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt: BoolExpression' @@ -100,7 +120,6 @@ inheritedProperties: summary: The default value for the input dialog when maxTurnCount is exceeded. fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultValue?: ValueExpression' @@ -118,7 +137,6 @@ inheritedProperties: default value is used. fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -126,7 +144,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.defaultValueResponse](xref:botbuilder-dialogs-adaptive.InputDialog.defaultValueResponse) @@ -136,7 +154,6 @@ inheritedProperties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -157,28 +174,15 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.TextInput.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id + type: DialogTurnResult<any> + inheritanceDescription: >- + Inherited From + [InputDialog.EndOfTurn](xref:botbuilder-dialogs-adaptive.InputDialog.EndOfTurn) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.TextInput.invalidPrompt package: botbuilder-dialogs-adaptive @@ -187,13 +191,12 @@ inheritedProperties: invalid or not. fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invalidPrompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.invalidPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.invalidPrompt) @@ -205,7 +208,6 @@ inheritedProperties: gives up. fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntExpression' @@ -221,7 +223,6 @@ inheritedProperties: summary: '' fullName: OPTIONS_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static OPTIONS_PROPERTY: string' @@ -237,13 +238,12 @@ inheritedProperties: summary: The activity to send to the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt: TemplateInterface, DialogStateManager>' return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.prompt](xref:botbuilder-dialogs-adaptive.InputDialog.prompt) @@ -253,7 +253,6 @@ inheritedProperties: summary: The value expression which the input will be bound to. fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property: StringExpression' @@ -263,27 +262,12 @@ inheritedProperties: inheritanceDescription: >- Inherited From [InputDialog.property](xref:botbuilder-dialogs-adaptive.InputDialog.property) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.TextInput.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient - name: TURN_COUNT_PROPERTY uid: botbuilder-dialogs-adaptive.TextInput.TURN_COUNT_PROPERTY package: botbuilder-dialogs-adaptive summary: '' fullName: TURN_COUNT_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static TURN_COUNT_PROPERTY: string' @@ -299,7 +283,6 @@ inheritedProperties: summary: The activity template for retrying prompt. fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -307,7 +290,7 @@ inheritedProperties: DialogStateManager> return: description: '' - type: 'TemplateInterface<Partial<Activity>, DialogStateManager>' + type: TemplateInterface<Partial<Activity>, DialogStateManager> inheritanceDescription: >- Inherited From [InputDialog.unrecognizedPrompt](xref:botbuilder-dialogs-adaptive.InputDialog.unrecognizedPrompt) @@ -317,13 +300,12 @@ inheritedProperties: summary: The expressions to run to validate the input. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialog.validations](xref:botbuilder-dialogs-adaptive.InputDialog.validations) @@ -333,7 +315,6 @@ inheritedProperties: summary: A value expression which can be used to initialize the input prompt. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: ValueExpression' @@ -349,7 +330,6 @@ inheritedProperties: summary: '' fullName: VALUE_PROPERTY remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static VALUE_PROPERTY: string' @@ -360,19 +340,18 @@ inheritedProperties: Inherited From [InputDialog.VALUE_PROPERTY](xref:botbuilder-dialogs-adaptive.InputDialog.VALUE_PROPERTY) inheritedMethods: - - name: 'beginDialog(DialogContext, any)' + - name: beginDialog(DialogContext, any) uid: botbuilder-dialogs-adaptive.TextInput.beginDialog package: botbuilder-dialogs-adaptive summary: >- Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: any): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -388,29 +367,30 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.beginDialog](xref:botbuilder-dialogs-adaptive.InputDialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TextInput.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TextInput' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [InputDialog.configure](xref:botbuilder-dialogs-adaptive.InputDialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.TextInput.continueDialog package: botbuilder-dialogs-adaptive @@ -418,10 +398,11 @@ inheritedMethods: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is _continued_, where it is the active dialog and the user replies with a new activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext @@ -432,11 +413,11 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.continueDialog](xref:botbuilder-dialogs-adaptive.InputDialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.TextInput.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -465,27 +446,27 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog + inheritanceDescription: >- + Inherited From + [InputDialog.endDialog](xref:botbuilder-dialogs-adaptive.InputDialog.endDialog) - name: getVersion() uid: botbuilder-dialogs-adaptive.TextInput.getVersion package: botbuilder-dialogs-adaptive @@ -508,7 +489,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -517,15 +497,16 @@ inheritedMethods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + inheritanceDescription: >- + Inherited From + [InputDialog.getVersion](xref:botbuilder-dialogs-adaptive.InputDialog.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.TextInput.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -543,11 +524,13 @@ inheritedMethods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + inheritanceDescription: >- + Inherited From + [InputDialog.onDialogEvent](xref:botbuilder-dialogs-adaptive.InputDialog.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.TextInput.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -568,37 +551,36 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + inheritanceDescription: >- + Inherited From + [InputDialog.repromptDialog](xref:botbuilder-dialogs-adaptive.InputDialog.repromptDialog) + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.TextInput.resumeDialog package: botbuilder-dialogs-adaptive summary: >- Called when a child [Dialog](xref:botbuilder-dialogs.Dialog) completes its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: DialogContext @@ -608,8 +590,8 @@ inheritedMethods: - id: _reason type: DialogReason description: >- - (xref:botbuilder-dialogs.DialogReason), reason why the dialog - resumed. + [DialogReason](xref:botbuilder-dialogs.DialogReason), reason why the + dialog resumed. - id: _result type: any description: >- @@ -621,25 +603,28 @@ inheritedMethods: description: >- A [DialogTurnResult](xref:botbuilder-dialogs.DialogTurnResult) `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: >- Inherited From [InputDialog.resumeDialog](xref:botbuilder-dialogs-adaptive.InputDialog.resumeDialog) methods: - - name: getConverter(Object) + - name: getConverter(keyof TextInputConfiguration) uid: botbuilder-dialogs-adaptive.TextInput.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof TextInputConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof TextInputConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInputConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInputConfiguration.yml index d667d57e..dcd4eee6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInputConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextInputConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: TextInputConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: outputFormat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'outputFormat?: StringProperty' @@ -29,7 +27,6 @@ inheritedProperties: summary: '' fullName: allowInterruptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowInterruptions?: BoolProperty' @@ -45,7 +42,6 @@ inheritedProperties: summary: '' fullName: alwaysPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alwaysPrompt?: BoolProperty' @@ -61,13 +57,12 @@ inheritedProperties: summary: '' fullName: defaultValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultValue?: UnknownProperty' + content: 'defaultValue?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.defaultValue](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.defaultValue) @@ -77,7 +72,6 @@ inheritedProperties: summary: '' fullName: defaultValueResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -97,7 +91,6 @@ inheritedProperties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -113,21 +106,21 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: Inherited From DialogConfiguration.id + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.id](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.id) - name: invalidPrompt uid: botbuilder-dialogs-adaptive.TextInputConfiguration.invalidPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: invalidPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -147,7 +140,6 @@ inheritedProperties: summary: '' fullName: maxTurnCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTurnCount?: IntProperty' @@ -163,7 +155,6 @@ inheritedProperties: summary: '' fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -183,7 +174,6 @@ inheritedProperties: summary: '' fullName: property remarks: '' - isPreview: false isDeprecated: false syntax: content: 'property?: StringProperty' @@ -199,21 +189,21 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From DialogConfiguration.telemetryClient + inheritanceDescription: >- + Inherited From + [InputDialogConfiguration.telemetryClient](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.telemetryClient) - name: unrecognizedPrompt uid: botbuilder-dialogs-adaptive.TextInputConfiguration.unrecognizedPrompt package: botbuilder-dialogs-adaptive summary: '' fullName: unrecognizedPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -233,13 +223,12 @@ inheritedProperties: summary: '' fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [InputDialogConfiguration.validations](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.validations) @@ -249,13 +238,12 @@ inheritedProperties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown inheritanceDescription: >- Inherited From [InputDialogConfiguration.value](xref:botbuilder-dialogs-adaptive.InputDialogConfiguration.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplate.yml index 753b6d5c..69388521 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplate.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplate.yml @@ -7,24 +7,21 @@ summary: |- and processed through registered language generator. fullName: TextTemplate remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: TextTemplate(string) + - name: TextTemplate(string) uid: botbuilder-dialogs-adaptive.TextTemplate.constructor package: botbuilder-dialogs-adaptive summary: Initialize a new instance of TextTemplate class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TextTemplate(template?: string)' parameters: - id: template type: string - description: | - The template to evaluate to create text. + description: The template to evaluate to create text. properties: - name: $kind uid: botbuilder-dialogs-adaptive.TextTemplate.$kind @@ -32,7 +29,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -45,7 +41,6 @@ properties: summary: Gets or sets the template to evaluate to create the text. fullName: template remarks: '' - isPreview: false isDeprecated: false syntax: content: 'template: string' @@ -58,7 +53,6 @@ properties: summary: '' fullName: toString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'toString: () => string' @@ -66,12 +60,11 @@ properties: description: '' type: () => string methods: - - name: 'bind(DialogContext, D)' + - name: bind(DialogContext, D) uid: botbuilder-dialogs-adaptive.TextTemplate.bind package: botbuilder-dialogs-adaptive summary: Bind data to template. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function bind(dialogContext: DialogContext, data: D): Promise' @@ -90,30 +83,32 @@ methods: package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: TextTemplateConfiguration): this' + content: 'function configure(config: TextTemplateConfiguration): TextTemplate' parameters: - id: config type: description: The configuration. return: description: A object with the given configuration. - type: this - - name: getConverter(Object) + type: <D> + - name: getConverter("template") uid: botbuilder-dialogs-adaptive.TextTemplate.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: Object): Converter | ConverterFactory' + content: >- + function getConverter(_property: "template"): Converter | ConverterFactory parameters: - id: _property - type: Object + type: '"template"' description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConfiguration.yml index bb6b162f..771081ed 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: TextTemplateConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: template remarks: '' - isPreview: false isDeprecated: false syntax: content: 'template?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConverter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConverter.yml deleted file mode 100644 index cb5d3b2c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TextTemplateConverter.yml +++ /dev/null @@ -1,33 +0,0 @@ -### YamlMime:TSType -name: TextTemplateConverter -uid: botbuilder-dialogs-adaptive.TextTemplateConverter -package: botbuilder-dialogs-adaptive -summary: >- - Text template converter that implements - [Converter](xref:botbuilder-dialogs-declarative.Converter). -fullName: TextTemplateConverter -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: convert(string | TextTemplate) - uid: botbuilder-dialogs-adaptive.TextTemplateConverter.convert - package: botbuilder-dialogs-adaptive - summary: >- - Converts a string to a - [TextTemplate](xref:botbuilder-dialogs-adaptive.TextTemplate) instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function convert(value: string | TextTemplate): TextTemplate' - parameters: - - id: value - type: string | - description: The template to evaluate to create text. - return: - description: >- - A new [TextTemplate](xref:botbuilder-dialogs-adaptive.TextTemplate) - instance. - type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowException.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowException.yml index 57a3672e..665a9f20 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowException.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowException.yml @@ -3,9 +3,8 @@ name: ThrowException uid: botbuilder-dialogs-adaptive.ThrowException package: botbuilder-dialogs-adaptive summary: Action which throws an exception declaratively. -fullName: ThrowException +fullName: ThrowException remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,14 +15,13 @@ constructors: Initializes a new instance of the [ThrowException](xref:botbuilder-dialogs-adaptive.ThrowException) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ThrowException(errorValue: unknown)' parameters: - id: errorValue type: unknown - description: > + description: >- Optional. Memory property path to use to get the error value to throw. properties: @@ -33,7 +31,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -48,7 +45,6 @@ properties: action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' @@ -63,85 +59,80 @@ properties: throw. fullName: errorValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorValue?: ValueExpression' return: description: '' type: ValueExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.ThrowException.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.ThrowException.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.ThrowException.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.ThrowException.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.ThrowException.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ThrowException' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.ThrowException.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -165,20 +156,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.ThrowException.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -207,23 +198,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -250,7 +239,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -260,14 +248,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.ThrowException.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -286,10 +273,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.ThrowException.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -310,25 +297,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.ThrowException.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -368,12 +353,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -385,26 +369,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, Record)' + - name: beginDialog(DialogContext, Record) uid: botbuilder-dialogs-adaptive.ThrowException.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: Record): Promise + unknown>): Promise> parameters: - id: dc type: DialogContext @@ -412,25 +394,28 @@ methods: The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation. - id: _options - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof ThrowExceptionConfiguration) uid: botbuilder-dialogs-adaptive.ThrowException.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof ThrowExceptionConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof ThrowExceptionConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowExceptionConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowExceptionConfiguration.yml index 2f6b5c44..20373819 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowExceptionConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ThrowExceptionConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: ThrowExceptionConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,13 +26,12 @@ properties: summary: '' fullName: errorValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'errorValue?: UnknownProperty' + content: 'errorValue?: unknown' return: description: '' - type: + type: unknown inheritedProperties: - name: id uid: botbuilder-dialogs-adaptive.ThrowExceptionConfiguration.id @@ -42,7 +39,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivity.yml index 31fe9e74..85d67407 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivity.yml @@ -5,29 +5,16 @@ package: botbuilder-dialogs-adaptive summary: Send an trace activity back to the transcript. fullName: TraceActivity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: TraceActivity() - uid: botbuilder-dialogs-adaptive.TraceActivity.constructor - package: botbuilder-dialogs-adaptive - summary: >- - Initializes a new instance of the - [TraceActivity](xref:botbuilder-dialogs-adaptive.TraceActivity) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new TraceActivity() - - name: 'TraceActivity(string, string, any, string)' + - name: TraceActivity(string, string, any, string) uid: botbuilder-dialogs-adaptive.TraceActivity.constructor_1 package: botbuilder-dialogs-adaptive summary: >- Initializes a new instance of the [TraceActivity](xref:botbuilder-dialogs-adaptive.TraceActivity) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,8 +32,7 @@ constructors: description: Value expression to send as the value. - id: label type: string - description: | - Label to use when describing a trace activity. + description: Label to use when describing a trace activity. properties: - name: $kind uid: botbuilder-dialogs-adaptive.TraceActivity.$kind @@ -54,7 +40,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -67,20 +52,30 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression + - name: id + uid: botbuilder-dialogs-adaptive.TraceActivity.id + package: botbuilder-dialogs-adaptive + summary: Unique ID of the dialog. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: string id + return: + description: The Id for the dialog. + type: string - name: label uid: botbuilder-dialogs-adaptive.TraceActivity.label package: botbuilder-dialogs-adaptive summary: Gets or sets a label to use when describing a trace activity. fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label?: StringExpression' @@ -93,20 +88,32 @@ properties: summary: Gets or sets name of the trace activity. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: StringExpression' return: description: '' type: StringExpression + - name: telemetryClient + uid: botbuilder-dialogs-adaptive.TraceActivity.telemetryClient + package: botbuilder-dialogs-adaptive + summary: Gets the telemetry client for this dialog. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. + type: BotTelemetryClient - name: value uid: botbuilder-dialogs-adaptive.TraceActivity.value package: botbuilder-dialogs-adaptive summary: Gets or sets value expression to send as the value. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: ValueExpression' @@ -119,7 +126,6 @@ properties: summary: Gets or sets value type of the trace activity. fullName: valueType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'valueType?: StringExpression' @@ -138,66 +144,36 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> inheritanceDescription: Inherited From Dialog.EndOfTurn - - name: id - uid: botbuilder-dialogs-adaptive.TraceActivity.id - package: botbuilder-dialogs-adaptive - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Dialog.id - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.TraceActivity.telemetryClient - package: botbuilder-dialogs-adaptive - summary: '' - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TraceActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TraceActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.TraceActivity.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -221,20 +197,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.TraceActivity.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -263,23 +239,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -306,7 +280,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -316,14 +289,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.TraceActivity.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -342,10 +314,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.TraceActivity.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -366,25 +338,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.TraceActivity.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -424,12 +394,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -441,26 +410,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.TraceActivity.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, _options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -472,21 +439,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof TraceActivityConfiguration) uid: botbuilder-dialogs-adaptive.TraceActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof TraceActivityConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof TraceActivityConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivityConfiguration.yml index 74dbe37b..f394dbae 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TraceActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: TraceActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -28,7 +26,6 @@ properties: summary: '' fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label?: StringProperty' @@ -41,7 +38,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: StringProperty' @@ -54,20 +50,18 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'value?: UnknownProperty' + content: 'value?: unknown' return: description: '' - type: + type: unknown - name: valueType uid: botbuilder-dialogs-adaptive.TraceActivityConfiguration.valueType package: botbuilder-dialogs-adaptive summary: '' fullName: valueType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'valueType?: StringProperty' @@ -81,7 +75,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -95,7 +88,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TriggerSelector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TriggerSelector.yml index 145ac8cb..f8e25d59 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TriggerSelector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TriggerSelector.yml @@ -5,78 +5,75 @@ package: botbuilder-dialogs-adaptive summary: Select the trigger to execute in a given state. fullName: TriggerSelector remarks: '' -isPreview: false isDeprecated: false type: class inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TriggerSelector.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TriggerSelector' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: Inherited From Configurable.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.TriggerSelector.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> inheritanceDescription: Inherited From Configurable.getConverter methods: - - name: 'initialize(OnCondition[], boolean)' + - name: initialize(OnCondition[], boolean) uid: botbuilder-dialogs-adaptive.TriggerSelector.initialize package: botbuilder-dialogs-adaptive summary: Initialize the selector with the set of rules. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(conditionHandlers: OnCondition[], evaluate: boolean)' parameters: - id: conditionHandlers - type: '[]' + type: [] description: Possible rules to match. - id: evaluate type: boolean - description: | - True if rules should be evaluated on select. + description: True if rules should be evaluated on select. - name: select(ActionContext) uid: botbuilder-dialogs-adaptive.TriggerSelector.select package: botbuilder-dialogs-adaptive summary: Select the best rule to execute. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function select(actionContext: ActionContext): Promise' parameters: - id: actionContext type: - description: | - Dialog context for evaluation. + description: Dialog context for evaluation. return: description: '' type: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TrueSelector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TrueSelector.yml index 3dc913d0..9122919b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TrueSelector.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/TrueSelector.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Select all rules which evaluate to true. fullName: TrueSelector remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -23,66 +21,69 @@ properties: description: '' type: string inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.TrueSelector.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TrueSelector' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: >- + Inherited From + [TriggerSelector.configure](xref:botbuilder-dialogs-adaptive.TriggerSelector.configure) - name: getConverter(string) uid: botbuilder-dialogs-adaptive.TrueSelector.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: >- + Inherited From + [TriggerSelector.getConverter](xref:botbuilder-dialogs-adaptive.TriggerSelector.getConverter) methods: - - name: 'initialize(OnCondition[], boolean)' + - name: initialize(OnCondition[], boolean) uid: botbuilder-dialogs-adaptive.TrueSelector.initialize package: botbuilder-dialogs-adaptive summary: Initialize the selector with the set of rules. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(conditionals: OnCondition[], evaluate: boolean)' parameters: - id: conditionals - type: '[]' + type: [] description: Possible rules to match. - id: evaluate type: boolean - description: | - True if rules should be evaluated on select. + description: True if rules should be evaluated on select. - name: select(ActionContext) uid: botbuilder-dialogs-adaptive.TrueSelector.select package: botbuilder-dialogs-adaptive summary: Select the best rule to execute. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function select(actionContext: ActionContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UnknownProperty.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UnknownProperty.yml index bcdec8e2..5b348961 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UnknownProperty.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UnknownProperty.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: UnknownProperty remarks: '' -isPreview: false isDeprecated: false syntax: | type UnknownProperty = unknown | ValueExpression diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivity.yml index a4fa40bd..072aa7a0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivity.yml @@ -5,19 +5,8 @@ package: botbuilder-dialogs-adaptive summary: Update an activity with replacement. fullName: UpdateActivity remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: UpdateActivity() - uid: botbuilder-dialogs-adaptive.UpdateActivity.constructor - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new UpdateActivity() properties: - name: $kind uid: botbuilder-dialogs-adaptive.UpdateActivity.$kind @@ -25,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -38,22 +26,22 @@ properties: summary: Gets or sets template for the activity. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'activity: TemplateInterface, D & O>' + content: >- + activity: TemplateInterface, DialogStateManager & { + utterance: string } & O> return: description: '' type: >- - TemplateInterface<Partial<Activity>, & O> + TemplateInterface<Partial<Activity>, DialogStateManager & { + utterance: string } & O> - name: activityId uid: botbuilder-dialogs-adaptive.UpdateActivity.activityId package: botbuilder-dialogs-adaptive summary: The expression which resolves to the activityId to update. fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId: StringExpression' @@ -66,85 +54,80 @@ properties: summary: An optional expression which if is true will disable this action. fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolExpression' return: description: '' type: BoolExpression -inheritedProperties: - - name: EndOfTurn - uid: botbuilder-dialogs-adaptive.UpdateActivity.EndOfTurn - package: botbuilder-dialogs-adaptive - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: DialogTurnResult - inheritanceDescription: Inherited From Dialog.EndOfTurn - name: id uid: botbuilder-dialogs-adaptive.UpdateActivity.id package: botbuilder-dialogs-adaptive - summary: '' + summary: Unique ID of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'id: string' + content: string id return: - description: '' + description: The Id for the dialog. type: string - inheritanceDescription: Inherited From Dialog.id - name: telemetryClient uid: botbuilder-dialogs-adaptive.UpdateActivity.telemetryClient package: botbuilder-dialogs-adaptive - summary: '' + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'telemetryClient: BotTelemetryClient' + content: BotTelemetryClient telemetryClient return: - description: '' + description: >- + The [BotTelemetryClient](xref:botbuilder.BotTelemetryClient) to use + for logging. type: BotTelemetryClient - inheritanceDescription: Inherited From Dialog.telemetryClient +inheritedProperties: + - name: EndOfTurn + uid: botbuilder-dialogs-adaptive.UpdateActivity.EndOfTurn + package: botbuilder-dialogs-adaptive + summary: Gets a default end-of-turn result. + fullName: EndOfTurn + remarks: >- + This result indicates that a dialog (or a logical step within a dialog) + has completed + + processing for the current turn, is still active, and is waiting for more + input. + isDeprecated: false + syntax: + content: 'static EndOfTurn: DialogTurnResult' + return: + description: '' + type: DialogTurnResult<any> + inheritanceDescription: Inherited From Dialog.EndOfTurn inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.UpdateActivity.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): UpdateActivity' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: <O> + inheritanceDescription: Inherited From Dialog.configure - name: continueDialog(DialogContext) uid: botbuilder-dialogs-adaptive.UpdateActivity.continueDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -168,20 +151,20 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: DialogContext - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.continueDialog - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs-adaptive.UpdateActivity.endDialog package: botbuilder-dialogs-adaptive summary: >- @@ -210,23 +193,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance + type: DialogInstance<any> description: Current state information for this dialog. - id: _reason type: DialogReason - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -253,7 +234,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -263,14 +243,13 @@ inheritedMethods: way that should restart the dialog. type: string inheritanceDescription: Inherited From Dialog.getVersion - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs-adaptive.UpdateActivity.onDialogEvent package: botbuilder-dialogs-adaptive summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -289,10 +268,10 @@ inheritedMethods: stop. type: Promise<boolean> inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs-adaptive.UpdateActivity.repromptDialog package: botbuilder-dialogs-adaptive - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -313,25 +292,23 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: DialogInstance - description: | - Current state information for this dialog. + type: DialogInstance<any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: Inherited From Dialog.repromptDialog - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs-adaptive.UpdateActivity.resumeDialog package: botbuilder-dialogs-adaptive summary: >- @@ -371,12 +348,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: DialogContext @@ -388,26 +364,24 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<DialogTurnResult> + type: Promise<DialogTurnResult<any>> inheritanceDescription: Inherited From Dialog.resumeDialog methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs-adaptive.UpdateActivity.beginDialog package: botbuilder-dialogs-adaptive summary: >- Starts a new [Dialog](xref:botbuilder-dialogs.Dialog) and pushes it onto the dialog stack. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: DialogContext @@ -419,21 +393,24 @@ methods: description: Optional. Initial information to pass to the dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<DialogTurnResult> - - name: getConverter(Object) + type: Promise<DialogTurnResult<any>> + - name: getConverter(keyof UpdateActivityConfiguration) uid: botbuilder-dialogs-adaptive.UpdateActivity.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(property: Object): Converter | ConverterFactory' + content: >- + function getConverter(property: keyof UpdateActivityConfiguration): + Converter | ConverterFactory parameters: - id: property - type: Object + type: keyof UpdateActivityConfiguration description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> extends: Dialog<O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivityConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivityConfiguration.yml index c648321a..508fbd0d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivityConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UpdateActivityConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: '' fullName: UpdateActivityConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity?: TemplateInterfaceProperty, D>' @@ -23,15 +21,13 @@ properties: description: '' type: >- <Partial<Activity>, > + /><Partial<Activity>, D> - name: activityId uid: botbuilder-dialogs-adaptive.UpdateActivityConfiguration.activityId package: botbuilder-dialogs-adaptive summary: '' fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId?: StringProperty' @@ -44,7 +40,6 @@ properties: summary: '' fullName: disabled remarks: '' - isPreview: false isDeprecated: false syntax: content: 'disabled?: BoolProperty' @@ -58,7 +53,6 @@ inheritedProperties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -72,7 +66,6 @@ inheritedProperties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UrlEntityRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UrlEntityRecognizer.yml index 9b25abb1..5c181bef 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UrlEntityRecognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/UrlEntityRecognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-adaptive summary: Recognizes URL input. fullName: UrlEntityRecognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: $kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static $kind: string' @@ -29,14 +27,13 @@ inheritedProperties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.id + inheritanceDescription: Inherited From TextEntityRecognizer.id - name: logPersonalInformation uid: botbuilder-dialogs-adaptive.UrlEntityRecognizer.logPersonalInformation package: botbuilder-dialogs-adaptive @@ -45,16 +42,13 @@ inheritedProperties: information (PII) should log to telemetry. fullName: logPersonalInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logPersonalInformation: BoolExpression' return: description: '' type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) + inheritanceDescription: Inherited From TextEntityRecognizer.logPersonalInformation - name: telemetryClient uid: botbuilder-dialogs-adaptive.UrlEntityRecognizer.telemetryClient package: botbuilder-dialogs-adaptive @@ -63,51 +57,52 @@ inheritedProperties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' return: description: '' type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient + inheritanceDescription: Inherited From TextEntityRecognizer.telemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs-adaptive.UrlEntityRecognizer.configure package: botbuilder-dialogs-adaptive summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): UrlEntityRecognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure + type: + inheritanceDescription: Inherited From TextEntityRecognizer.configure - name: getConverter(string) uid: botbuilder-dialogs-adaptive.UrlEntityRecognizer.getConverter package: botbuilder-dialogs-adaptive summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string description: The key of the conditional selector configuration. return: description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter + type: >- + Converter<unknown, unknown> | ConverterFactory<unknown, + unknown> + inheritanceDescription: Inherited From TextEntityRecognizer.getConverter - name: >- recognize(DialogContext, Partial, Record, Record) @@ -115,7 +110,6 @@ inheritedMethods: package: botbuilder-dialogs-adaptive summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,25 +124,22 @@ inheritedMethods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' + type: Record<string, number> description: Additional metrics to be logged to telemetry with event. return: description: Analysis of utterance. type: Promise<RecognizerResult> - inheritanceDescription: >- - Inherited From - [EntityRecognizer.recognize](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognize) - - name: 'recognizeEntities(DialogContext, string, string, Entity[])' + inheritanceDescription: Inherited From TextEntityRecognizer.recognize + - name: recognizeEntities(DialogContext, string, string, Entity[]) uid: botbuilder-dialogs-adaptive.UrlEntityRecognizer.recognizeEntities package: botbuilder-dialogs-adaptive summary: >- Recognizes entities from an [Entity](xref:botframework-schema.Entity) list. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -167,14 +158,12 @@ inheritedMethods: type: string description: Locale to use. - id: entities - type: 'Entity[]' + type: Entity[] description: >- The [Entity](xref:botframework-schema.Entity) array to be recognized. return: - description: 'Recognized [Entity](xref:botframework-schema.Entity) list Promise.' - type: 'Promise<Entity[]>' - inheritanceDescription: >- - Inherited From - [TextEntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.TextEntityRecognizer.recognizeEntities) -extends: + description: Recognized [Entity](xref:botframework-schema.Entity) list Promise. + type: Promise<Entity[]> + inheritanceDescription: Inherited From TextEntityRecognizer.recognizeEntities +extends: TextEntityRecognizer diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ValueRecognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ValueRecognizer.yml deleted file mode 100644 index d476c72b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/ValueRecognizer.yml +++ /dev/null @@ -1,142 +0,0 @@ -### YamlMime:TSType -name: ValueRecognizer -uid: botbuilder-dialogs-adaptive.ValueRecognizer -package: botbuilder-dialogs-adaptive -summary: >- - ValueRecognizer - Recognizer for mapping message activity. Value payload into - intent/entities. -fullName: ValueRecognizer -remarks: >- - This recognizer will map MessageActivity Value payloads into intents and - entities. - activity.Value.intent => RecognizerResult.Intents. - activity.Value.properties => RecognizerResult.Entities. -isPreview: false -isDeprecated: false -type: class -inheritedProperties: - - name: id - uid: botbuilder-dialogs-adaptive.ValueRecognizer.id - package: botbuilder-dialogs-adaptive - summary: Recognizers unique ID. - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Recognizer.id - - name: logPersonalInformation - uid: botbuilder-dialogs-adaptive.ValueRecognizer.logPersonalInformation - package: botbuilder-dialogs-adaptive - summary: >- - (Optional) Flag that designates whether personally identifiable - information (PII) should log to telemetry. - fullName: logPersonalInformation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logPersonalInformation: BoolExpression' - return: - description: '' - type: BoolExpression - inheritanceDescription: >- - Inherited From - [AdaptiveRecognizer.logPersonalInformation](xref:botbuilder-dialogs-adaptive.AdaptiveRecognizer.logPersonalInformation) - - name: telemetryClient - uid: botbuilder-dialogs-adaptive.ValueRecognizer.telemetryClient - package: botbuilder-dialogs-adaptive - summary: |- - The telemetry client for logging events. - Default this to the NullTelemetryClient, which does nothing. - fullName: telemetryClient - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryClient: BotTelemetryClient' - return: - description: '' - type: BotTelemetryClient - inheritanceDescription: Inherited From Recognizer.telemetryClient -inheritedMethods: - - name: 'configure(Record)' - uid: botbuilder-dialogs-adaptive.ValueRecognizer.configure - package: botbuilder-dialogs-adaptive - summary: Fluent method for configuring the object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function configure(config: Record): this' - parameters: - - id: config - type: 'Record<string, unknown>' - description: Configuration settings to apply. - return: - description: >- - The [Configurable](xref:botbuilder-dialogs.Configurable) after the - operation is complete. - type: this - inheritanceDescription: Inherited From Configurable.configure - - name: getConverter(string) - uid: botbuilder-dialogs-adaptive.ValueRecognizer.getConverter - package: botbuilder-dialogs-adaptive - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' - parameters: - - id: _property - type: string - description: The key of the conditional selector configuration. - return: - description: The converter for the selector configuration. - type: Converter | ConverterFactory - inheritanceDescription: Inherited From Configurable.getConverter -methods: - - name: >- - recognize(DialogContext, Activity, [key: string]: string, [key: string]: - number) - uid: botbuilder-dialogs-adaptive.ValueRecognizer.recognize - package: botbuilder-dialogs-adaptive - summary: >- - Runs current DialogContext.TurnContext.Activity through a recognizer and - returns a [RecognizerResult](xref:botbuilder-core.RecognizerResult). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function recognize(dialogContext: DialogContext, activity: Activity, - telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: - string]: number): Promise - parameters: - - id: dialogContext - type: DialogContext - description: >- - The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the - current turn of conversation. - - id: activity - type: Activity - description: '(xref:botframework-schema.Activity) to recognize.' - - id: telemetryProperties - type: '[key: string]\: string' - description: >- - Optional, additional properties to be logged to telemetry with the - LuisResult event. - - id: telemetryMetrics - type: '[key: string]\: number' - description: >- - Optional, additional metrics to be logged to telemetry with the - LuisResult event. - return: - description: Analysis of utterance. - type: Promise<RecognizerResult> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/index.yml index f9490da2..35f53bb1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive/index.yml @@ -3,144 +3,93 @@ uid: botbuilder-dialogs-adaptive name: botbuilder-dialogs-adaptive summary: '' type: package -interfaces: - - botbuilder-dialogs-adaptive.ActionChangeList - - botbuilder-dialogs-adaptive.ActionState - - botbuilder-dialogs-adaptive.ActionScopeConfiguration - - botbuilder-dialogs-adaptive.ActionScopeResult - - botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration - - botbuilder-dialogs-adaptive.BeginDialogConfiguration - - botbuilder-dialogs-adaptive.BeginSkillConfiguration - - botbuilder-dialogs-adaptive.BreakLoopConfiguration - - botbuilder-dialogs-adaptive.CancelAllDialogsBaseConfiguration - - botbuilder-dialogs-adaptive.CodeActionConfiguration - - botbuilder-dialogs-adaptive.ContinueConversationConfiguration - - botbuilder-dialogs-adaptive.ContinueConversationLaterConfiguration - - botbuilder-dialogs-adaptive.ContinueLoopConfiguration - - botbuilder-dialogs-adaptive.DeleteActivityConfiguration - - botbuilder-dialogs-adaptive.DeletePropertiesConfiguration - - botbuilder-dialogs-adaptive.DeletePropertyConfiguration - - botbuilder-dialogs-adaptive.EditActionsConfiguration - - botbuilder-dialogs-adaptive.EditArrayConfiguration - - botbuilder-dialogs-adaptive.EmitEventConfiguration - - botbuilder-dialogs-adaptive.EndDialogConfiguration - - botbuilder-dialogs-adaptive.EndTurnConfiguration - - botbuilder-dialogs-adaptive.ForEachConfiguration - - botbuilder-dialogs-adaptive.ForEachPageConfiguration - - botbuilder-dialogs-adaptive.GetActivityMembersConfiguration - - botbuilder-dialogs-adaptive.GetConversationMembersConfiguration - - botbuilder-dialogs-adaptive.GetConversationReferenceConfiguration - - botbuilder-dialogs-adaptive.GotoActionConfiguration - - botbuilder-dialogs-adaptive.HttpRequestConfiguration - - botbuilder-dialogs-adaptive.IfConditionConfiguration - - botbuilder-dialogs-adaptive.LogActionConfiguration - - botbuilder-dialogs-adaptive.RepeatDialogConfiguration - - botbuilder-dialogs-adaptive.ReplaceDialogConfiguration - - botbuilder-dialogs-adaptive.SendActivityConfiguration - - botbuilder-dialogs-adaptive.SendHandoffActivityConfiguration - - botbuilder-dialogs-adaptive.PropertyAssignment - - botbuilder-dialogs-adaptive.SetPropertiesConfiguration - - botbuilder-dialogs-adaptive.SetPropertyConfiguration - - botbuilder-dialogs-adaptive.SignOutUserConfiguration - - botbuilder-dialogs-adaptive.SwitchConditionConfiguration - - botbuilder-dialogs-adaptive.TelemetryTrackEventActionConfiguration - - botbuilder-dialogs-adaptive.ThrowExceptionConfiguration - - botbuilder-dialogs-adaptive.TraceActivityConfiguration - - botbuilder-dialogs-adaptive.UpdateActivityConfiguration - - botbuilder-dialogs-adaptive.AdaptiveDialogConfiguration - - botbuilder-dialogs-adaptive.AdaptiveDialogState - - botbuilder-dialogs-adaptive.OnActivityConfiguration - - botbuilder-dialogs-adaptive.OnAssignEntityConfiguration - - botbuilder-dialogs-adaptive.OnChooseEntityConfiguration - - botbuilder-dialogs-adaptive.OnChooseIntentConfiguration - - botbuilder-dialogs-adaptive.OnConditionConfiguration - - botbuilder-dialogs-adaptive.OnDialogEventConfiguration - - botbuilder-dialogs-adaptive.OnIntentConfiguration - - botbuilder-dialogs-adaptive.EntityAssignmentConfiguration - - botbuilder-dialogs-adaptive.EntityAssignmentsConfiguration - - botbuilder-dialogs-adaptive.MultiLanguageGeneratorBaseConfiguration - - botbuilder-dialogs-adaptive.ResourceMultiLanguageGeneratorConfiguration - - botbuilder-dialogs-adaptive.TemplateEngineLanguageGeneratorConfiguration - - botbuilder-dialogs-adaptive.AskConfiguration - - botbuilder-dialogs-adaptive.AttachmentInputConfiguration - - botbuilder-dialogs-adaptive.ChoiceInputConfiguration - - botbuilder-dialogs-adaptive.ChoiceInputOptions - - botbuilder-dialogs-adaptive.ConfirmInputConfiguration - - botbuilder-dialogs-adaptive.DateTimeInputConfiguration - - botbuilder-dialogs-adaptive.InputDialogConfiguration - - botbuilder-dialogs-adaptive.NumberInputConfiguration - - botbuilder-dialogs-adaptive.OAuthInputConfiguration - - botbuilder-dialogs-adaptive.TextInputConfiguration - - botbuilder-dialogs-adaptive.LanguageGenerator - - botbuilder-dialogs-adaptive.AdaptiveRecognizerConfiguration - - botbuilder-dialogs-adaptive.CrossTrainedRecognizerSetConfiguration - - botbuilder-dialogs-adaptive.RegexEntityRecognizerConfiguration - - botbuilder-dialogs-adaptive.MultiLanguageRecognizerConfiguration - - botbuilder-dialogs-adaptive.RecognizerSetConfiguration - - botbuilder-dialogs-adaptive.RegexRecognizerConfiguration - - botbuilder-dialogs-adaptive.ConditionalSelectorConfiguration - - botbuilder-dialogs-adaptive.MostSpecificSelectorConfiguration - - botbuilder-dialogs-adaptive.ActivityTemplateConguration - - botbuilder-dialogs-adaptive.StaticActivityTemplateConfiguration - - botbuilder-dialogs-adaptive.TextTemplateConfiguration enums: - - botbuilder-dialogs-adaptive.ActionChangeType - botbuilder-dialogs-adaptive.ActionScopeCommands - botbuilder-dialogs-adaptive.ArrayChangeType - - botbuilder-dialogs-adaptive.HttpMethod - - botbuilder-dialogs-adaptive.ResponsesTypes - botbuilder-dialogs-adaptive.AttachmentOutputFormat - botbuilder-dialogs-adaptive.ChoiceOutputFormat + - botbuilder-dialogs-adaptive.HttpMethod - botbuilder-dialogs-adaptive.InputState + - botbuilder-dialogs-adaptive.ResponsesTypes classes: - botbuilder-dialogs-adaptive.ActionContext - botbuilder-dialogs-adaptive.ActionScope + - botbuilder-dialogs-adaptive.ActivityTemplate + - botbuilder-dialogs-adaptive.AdaptiveBotComponent + - botbuilder-dialogs-adaptive.AdaptiveDialog + - botbuilder-dialogs-adaptive.AdaptiveEvents + - botbuilder-dialogs-adaptive.AdaptiveRecognizer + - botbuilder-dialogs-adaptive.AgeEntityRecognizer + - botbuilder-dialogs-adaptive.Ask + - botbuilder-dialogs-adaptive.AttachmentInput - botbuilder-dialogs-adaptive.BaseInvokeDialog - botbuilder-dialogs-adaptive.BeginDialog - botbuilder-dialogs-adaptive.BeginSkill - botbuilder-dialogs-adaptive.BreakLoop - botbuilder-dialogs-adaptive.CancelAllDialogs - - botbuilder-dialogs-adaptive.CancelAllDialogsBase - botbuilder-dialogs-adaptive.CancelDialog - botbuilder-dialogs-adaptive.Case + - botbuilder-dialogs-adaptive.ChannelMentionEntityRecognizer + - botbuilder-dialogs-adaptive.ChoiceInput + - botbuilder-dialogs-adaptive.ChoiceOptionsSet + - botbuilder-dialogs-adaptive.ChoiceSet - botbuilder-dialogs-adaptive.CodeAction + - botbuilder-dialogs-adaptive.ConditionalSelector + - botbuilder-dialogs-adaptive.ConfirmInput + - botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer - botbuilder-dialogs-adaptive.ContinueConversation - botbuilder-dialogs-adaptive.ContinueConversationLater - botbuilder-dialogs-adaptive.ContinueLoop + - botbuilder-dialogs-adaptive.CrossTrainedRecognizerSet + - botbuilder-dialogs-adaptive.CurrencyEntityRecognizer + - botbuilder-dialogs-adaptive.DateTimeEntityRecognizer + - botbuilder-dialogs-adaptive.DateTimeInput - botbuilder-dialogs-adaptive.DeleteActivity - botbuilder-dialogs-adaptive.DeleteProperties - botbuilder-dialogs-adaptive.DeleteProperty + - botbuilder-dialogs-adaptive.DialogExpression + - botbuilder-dialogs-adaptive.DialogExpressionConverter + - botbuilder-dialogs-adaptive.DimensionEntityRecognizer - botbuilder-dialogs-adaptive.DynamicBeginDialog - botbuilder-dialogs-adaptive.EditActions - botbuilder-dialogs-adaptive.EditArray + - botbuilder-dialogs-adaptive.EmailEntityRecognizer - botbuilder-dialogs-adaptive.EmitEvent - botbuilder-dialogs-adaptive.EndDialog - botbuilder-dialogs-adaptive.EndTurn + - botbuilder-dialogs-adaptive.EntityRecognizer + - botbuilder-dialogs-adaptive.EntityRecognizerSet + - botbuilder-dialogs-adaptive.FirstSelector - botbuilder-dialogs-adaptive.ForEach - botbuilder-dialogs-adaptive.ForEachPage - botbuilder-dialogs-adaptive.GetActivityMembers - botbuilder-dialogs-adaptive.GetConversationMembers - botbuilder-dialogs-adaptive.GetConversationReference - botbuilder-dialogs-adaptive.GotoAction + - botbuilder-dialogs-adaptive.GuidEntityRecognizer + - botbuilder-dialogs-adaptive.HasPendingActionsFunction + - botbuilder-dialogs-adaptive.HashtagEntityRecognizer - botbuilder-dialogs-adaptive.HttpRequest - - botbuilder-dialogs-adaptive.Result - botbuilder-dialogs-adaptive.IfCondition + - botbuilder-dialogs-adaptive.InputDialog + - botbuilder-dialogs-adaptive.IntentPattern + - botbuilder-dialogs-adaptive.IpEntityRecognizer + - botbuilder-dialogs-adaptive.IsDialogActiveFunction + - botbuilder-dialogs-adaptive.LanguageGenerationBotComponent + - botbuilder-dialogs-adaptive.LanguageGeneratorExtensions + - botbuilder-dialogs-adaptive.LanguageGeneratorManager + - botbuilder-dialogs-adaptive.LanguagePolicy + - botbuilder-dialogs-adaptive.LanguagePolicyConverter + - botbuilder-dialogs-adaptive.LanguageResourceLoader - botbuilder-dialogs-adaptive.LogAction - - botbuilder-dialogs-adaptive.RepeatDialog - - botbuilder-dialogs-adaptive.ReplaceDialog - - botbuilder-dialogs-adaptive.SendActivity - - botbuilder-dialogs-adaptive.SendHandoffActivity - - botbuilder-dialogs-adaptive.SetProperties - - botbuilder-dialogs-adaptive.SetProperty - - botbuilder-dialogs-adaptive.SignOutUser - - botbuilder-dialogs-adaptive.SwitchCondition - - botbuilder-dialogs-adaptive.TelemetryTrackEventAction - - botbuilder-dialogs-adaptive.ThrowException - - botbuilder-dialogs-adaptive.TraceActivity - - botbuilder-dialogs-adaptive.UpdateActivity - - botbuilder-dialogs-adaptive.AdaptiveBotComponent - - botbuilder-dialogs-adaptive.AdaptiveDialog - - botbuilder-dialogs-adaptive.AdaptiveEvents + - botbuilder-dialogs-adaptive.MentionEntityRecognizer + - botbuilder-dialogs-adaptive.MostSpecificSelector + - botbuilder-dialogs-adaptive.MultiLanguageGenerator + - botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase + - botbuilder-dialogs-adaptive.MultiLanguageRecognizer + - botbuilder-dialogs-adaptive.NumberEntityRecognizer + - botbuilder-dialogs-adaptive.NumberInput + - botbuilder-dialogs-adaptive.OAuthInput - botbuilder-dialogs-adaptive.OnActivity - botbuilder-dialogs-adaptive.OnAssignEntity - botbuilder-dialogs-adaptive.OnBeginDialog @@ -170,100 +119,120 @@ classes: - botbuilder-dialogs-adaptive.OnRepromptDialog - botbuilder-dialogs-adaptive.OnTypingActivity - botbuilder-dialogs-adaptive.OnUnknownIntent - - botbuilder-dialogs-adaptive.ActivityTemplateConverter - - botbuilder-dialogs-adaptive.DialogExpressionConverter - - botbuilder-dialogs-adaptive.DialogListConverter - - botbuilder-dialogs-adaptive.DialogSetConverter - - botbuilder-dialogs-adaptive.LanguageGeneratorConverter - - botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter - - botbuilder-dialogs-adaptive.RecognizerConverter - - botbuilder-dialogs-adaptive.RecognizerListConverter - - botbuilder-dialogs-adaptive.TextTemplateConverter - - botbuilder-dialogs-adaptive.DynamicBeginDialogDeserializer - - botbuilder-dialogs-adaptive.EntityAssignment - - botbuilder-dialogs-adaptive.EntityAssignmentComparer - - botbuilder-dialogs-adaptive.EntityAssignments - - botbuilder-dialogs-adaptive.EntityInfo - - botbuilder-dialogs-adaptive.DialogExpression - - botbuilder-dialogs-adaptive.HasPendingActionsFunction - - botbuilder-dialogs-adaptive.IsDialogActiveFunction - - botbuilder-dialogs-adaptive.LanguageGeneratorManager - - botbuilder-dialogs-adaptive.MultiLanguageGenerator - - botbuilder-dialogs-adaptive.MultiLanguageGeneratorBase - - botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator - - botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator - - botbuilder-dialogs-adaptive.Ask - - botbuilder-dialogs-adaptive.AttachmentInput - - botbuilder-dialogs-adaptive.ChoiceInput - - botbuilder-dialogs-adaptive.ChoiceOptionsSet - - botbuilder-dialogs-adaptive.ChoiceSet - - botbuilder-dialogs-adaptive.ConfirmInput - - botbuilder-dialogs-adaptive.DateTimeInput - - botbuilder-dialogs-adaptive.InputDialog - - botbuilder-dialogs-adaptive.NumberInput - - botbuilder-dialogs-adaptive.OAuthInput - - botbuilder-dialogs-adaptive.TextInput - - botbuilder-dialogs-adaptive.LanguageGenerationBotComponent - - botbuilder-dialogs-adaptive.LanguageGeneratorExtensions - - botbuilder-dialogs-adaptive.LanguagePolicy - - botbuilder-dialogs-adaptive.LanguagePolicyConverter - - botbuilder-dialogs-adaptive.LanguageResourceLoader - - botbuilder-dialogs-adaptive.PropertySchema - - botbuilder-dialogs-adaptive.AdaptiveRecognizer - - botbuilder-dialogs-adaptive.CrossTrainedRecognizerSet - - botbuilder-dialogs-adaptive.AgeEntityRecognizer - - botbuilder-dialogs-adaptive.ChannelMentionEntityRecognizer - - botbuilder-dialogs-adaptive.ConfirmationEntityRecognizer - - botbuilder-dialogs-adaptive.CurrencyEntityRecognizer - - botbuilder-dialogs-adaptive.DateTimeEntityRecognizer - - botbuilder-dialogs-adaptive.DimensionEntityRecognizer - - botbuilder-dialogs-adaptive.EmailEntityRecognizer - - botbuilder-dialogs-adaptive.EntityRecognizer - - botbuilder-dialogs-adaptive.EntityRecognizerSet - - botbuilder-dialogs-adaptive.GuidEntityRecognizer - - botbuilder-dialogs-adaptive.HashtagEntityRecognizer - - botbuilder-dialogs-adaptive.IpEntityRecognizer - - botbuilder-dialogs-adaptive.MentionEntityRecognizer - - botbuilder-dialogs-adaptive.NumberEntityRecognizer - botbuilder-dialogs-adaptive.OrdinalEntityRecognizer - botbuilder-dialogs-adaptive.PercentageEntityRecognizer - botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer - - botbuilder-dialogs-adaptive.RegexEntityRecognizer - - botbuilder-dialogs-adaptive.TemperatureEntityRecognizer - - botbuilder-dialogs-adaptive.TextEntity - - botbuilder-dialogs-adaptive.TextEntityRecognizer - - botbuilder-dialogs-adaptive.UrlEntityRecognizer - - botbuilder-dialogs-adaptive.IntentPattern - - botbuilder-dialogs-adaptive.MultiLanguageRecognizer + - botbuilder-dialogs-adaptive.PropertySchema + - botbuilder-dialogs-adaptive.RandomSelector - botbuilder-dialogs-adaptive.RecognizerSet + - botbuilder-dialogs-adaptive.RegexEntityRecognizer - botbuilder-dialogs-adaptive.RegexRecognizer - - botbuilder-dialogs-adaptive.ValueRecognizer + - botbuilder-dialogs-adaptive.RepeatDialog + - botbuilder-dialogs-adaptive.ReplaceDialog - botbuilder-dialogs-adaptive.ResourceExtensions + - botbuilder-dialogs-adaptive.ResourceMultiLanguageGenerator + - botbuilder-dialogs-adaptive.Result - botbuilder-dialogs-adaptive.SchemaHelper - - botbuilder-dialogs-adaptive.ConditionalSelector - - botbuilder-dialogs-adaptive.FirstSelector - - botbuilder-dialogs-adaptive.MostSpecificSelector - - botbuilder-dialogs-adaptive.RandomSelector - - botbuilder-dialogs-adaptive.TrueSelector + - botbuilder-dialogs-adaptive.SendActivity + - botbuilder-dialogs-adaptive.SendHandoffActivity + - botbuilder-dialogs-adaptive.SetProperties + - botbuilder-dialogs-adaptive.SetProperty + - botbuilder-dialogs-adaptive.SignOutUser - botbuilder-dialogs-adaptive.SkillExtensions - - botbuilder-dialogs-adaptive.TelemetryLoggerConstants - - botbuilder-dialogs-adaptive.ActivityTemplate - botbuilder-dialogs-adaptive.StaticActivityTemplate + - botbuilder-dialogs-adaptive.SwitchCondition + - botbuilder-dialogs-adaptive.TelemetryLoggerConstants + - botbuilder-dialogs-adaptive.TelemetryTrackEventAction + - botbuilder-dialogs-adaptive.TemperatureEntityRecognizer + - botbuilder-dialogs-adaptive.TemplateEngineLanguageGenerator + - botbuilder-dialogs-adaptive.TextEntity + - botbuilder-dialogs-adaptive.TextInput - botbuilder-dialogs-adaptive.TextTemplate + - botbuilder-dialogs-adaptive.ThrowException + - botbuilder-dialogs-adaptive.TraceActivity - botbuilder-dialogs-adaptive.TriggerSelector + - botbuilder-dialogs-adaptive.TrueSelector + - botbuilder-dialogs-adaptive.UpdateActivity + - botbuilder-dialogs-adaptive.UrlEntityRecognizer +interfaces: + - botbuilder-dialogs-adaptive.ActionScopeConfiguration + - botbuilder-dialogs-adaptive.ActionScopeResult + - botbuilder-dialogs-adaptive.ActivityTemplateConguration + - botbuilder-dialogs-adaptive.AdaptiveDialogConfiguration + - botbuilder-dialogs-adaptive.AdaptiveRecognizerConfiguration + - botbuilder-dialogs-adaptive.AskConfiguration + - botbuilder-dialogs-adaptive.AttachmentInputConfiguration + - botbuilder-dialogs-adaptive.BaseInvokeDialogConfiguration + - botbuilder-dialogs-adaptive.BeginDialogConfiguration + - botbuilder-dialogs-adaptive.BeginSkillConfiguration + - botbuilder-dialogs-adaptive.BreakLoopConfiguration + - botbuilder-dialogs-adaptive.CancelAllDialogsBaseConfiguration + - botbuilder-dialogs-adaptive.ChoiceInputConfiguration + - botbuilder-dialogs-adaptive.ChoiceInputOptions + - botbuilder-dialogs-adaptive.CodeActionConfiguration + - botbuilder-dialogs-adaptive.ConditionalSelectorConfiguration + - botbuilder-dialogs-adaptive.ConfirmInputConfiguration + - botbuilder-dialogs-adaptive.ContinueConversationConfiguration + - botbuilder-dialogs-adaptive.ContinueConversationLaterConfiguration + - botbuilder-dialogs-adaptive.ContinueLoopConfiguration + - botbuilder-dialogs-adaptive.CrossTrainedRecognizerSetConfiguration + - botbuilder-dialogs-adaptive.DateTimeInputConfiguration + - botbuilder-dialogs-adaptive.DeleteActivityConfiguration + - botbuilder-dialogs-adaptive.DeletePropertiesConfiguration + - botbuilder-dialogs-adaptive.DeletePropertyConfiguration + - botbuilder-dialogs-adaptive.EditActionsConfiguration + - botbuilder-dialogs-adaptive.EditArrayConfiguration + - botbuilder-dialogs-adaptive.EmitEventConfiguration + - botbuilder-dialogs-adaptive.EndDialogConfiguration + - botbuilder-dialogs-adaptive.EndTurnConfiguration + - botbuilder-dialogs-adaptive.ForEachConfiguration + - botbuilder-dialogs-adaptive.ForEachPageConfiguration + - botbuilder-dialogs-adaptive.GetActivityMembersConfiguration + - botbuilder-dialogs-adaptive.GetConversationMembersConfiguration + - botbuilder-dialogs-adaptive.GetConversationReferenceConfiguration + - botbuilder-dialogs-adaptive.GotoActionConfiguration + - botbuilder-dialogs-adaptive.HttpRequestConfiguration + - botbuilder-dialogs-adaptive.IfConditionConfiguration + - botbuilder-dialogs-adaptive.InputDialogConfiguration + - botbuilder-dialogs-adaptive.LanguageGenerator + - botbuilder-dialogs-adaptive.LogActionConfiguration + - botbuilder-dialogs-adaptive.MostSpecificSelectorConfiguration + - botbuilder-dialogs-adaptive.MultiLanguageGeneratorBaseConfiguration + - botbuilder-dialogs-adaptive.MultiLanguageRecognizerConfiguration + - botbuilder-dialogs-adaptive.NumberInputConfiguration + - botbuilder-dialogs-adaptive.OAuthInputConfiguration + - botbuilder-dialogs-adaptive.OnActivityConfiguration + - botbuilder-dialogs-adaptive.OnAssignEntityConfiguration + - botbuilder-dialogs-adaptive.OnChooseEntityConfiguration + - botbuilder-dialogs-adaptive.OnChooseIntentConfiguration + - botbuilder-dialogs-adaptive.OnConditionConfiguration + - botbuilder-dialogs-adaptive.OnDialogEventConfiguration + - botbuilder-dialogs-adaptive.OnIntentConfiguration + - botbuilder-dialogs-adaptive.PropertyAssignment + - botbuilder-dialogs-adaptive.RecognizerSetConfiguration + - botbuilder-dialogs-adaptive.RegexEntityRecognizerConfiguration + - botbuilder-dialogs-adaptive.RegexRecognizerConfiguration + - botbuilder-dialogs-adaptive.RepeatDialogConfiguration + - botbuilder-dialogs-adaptive.ReplaceDialogConfiguration + - botbuilder-dialogs-adaptive.ResourceMultiLanguageGeneratorConfiguration + - botbuilder-dialogs-adaptive.SendActivityConfiguration + - botbuilder-dialogs-adaptive.SendHandoffActivityConfiguration + - botbuilder-dialogs-adaptive.SetPropertiesConfiguration + - botbuilder-dialogs-adaptive.SetPropertyConfiguration + - botbuilder-dialogs-adaptive.SignOutUserConfiguration + - botbuilder-dialogs-adaptive.StaticActivityTemplateConfiguration + - botbuilder-dialogs-adaptive.SwitchConditionConfiguration + - botbuilder-dialogs-adaptive.TelemetryTrackEventActionConfiguration + - botbuilder-dialogs-adaptive.TemplateEngineLanguageGeneratorConfiguration + - botbuilder-dialogs-adaptive.TextInputConfiguration + - botbuilder-dialogs-adaptive.TextTemplateConfiguration + - botbuilder-dialogs-adaptive.ThrowExceptionConfiguration + - botbuilder-dialogs-adaptive.TraceActivityConfiguration + - botbuilder-dialogs-adaptive.UpdateActivityConfiguration typeAliases: - - botbuilder-dialogs-adaptive.CodeActionHandler - - botbuilder-dialogs-adaptive.HeadersInput - - botbuilder-dialogs-adaptive.HeadersOutput - - botbuilder-dialogs-adaptive.D - - botbuilder-dialogs-adaptive.AssignmentInput - - botbuilder-dialogs-adaptive.CaseInput - - botbuilder-dialogs-adaptive.PropertiesInput - - botbuilder-dialogs-adaptive.PropertiesOutput - - botbuilder-dialogs-adaptive.Input - - botbuilder-dialogs-adaptive.Output - botbuilder-dialogs-adaptive.ArrayProperty - botbuilder-dialogs-adaptive.BoolProperty + - botbuilder-dialogs-adaptive.CodeActionHandler - botbuilder-dialogs-adaptive.DialogProperty - botbuilder-dialogs-adaptive.EnumProperty - botbuilder-dialogs-adaptive.IntProperty @@ -273,60 +242,14 @@ typeAliases: - botbuilder-dialogs-adaptive.StringProperty - botbuilder-dialogs-adaptive.TemplateInterfaceProperty - botbuilder-dialogs-adaptive.UnknownProperty - - botbuilder-dialogs-adaptive.IntentPatternInput functions: - - name: 'evaluateExpression(DialogStateManager, ValueExpression)' - uid: botbuilder-dialogs-adaptive.evaluateExpression - package: botbuilder-dialogs-adaptive - summary: Evaluate ValueExpression according the value type. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function evaluateExpression(state: DialogStateManager, valExpr: - ValueExpression): any - parameters: - - id: state - type: DialogStateManager - description: Input ValueExpression - - id: valExpr - type: ValueExpression - description: A scope for looking up variables. - return: - description: Deep data binding result. - type: any - - name: 'replaceJsonRecursively(DialogStateManager, object)' - uid: botbuilder-dialogs-adaptive.replaceJsonRecursively - package: botbuilder-dialogs-adaptive - summary: >- - Replaces the binding paths in a JSON value with the evaluated results - recursively. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function replaceJsonRecursively(state: DialogStateManager, unit: - object): any - parameters: - - id: state - type: DialogStateManager - description: A scope for looking up variables. - - id: unit - type: object - description: An object. - return: - description: Deep data binding result. - type: any - - name: 'useTelemetry(DialogManager, BotTelemetryClient)' + - name: useTelemetry(DialogManager, BotTelemetryClient) uid: botbuilder-dialogs-adaptive.useTelemetry package: botbuilder-dialogs-adaptive summary: |- Extension methods for telemetry. Configures the telemetry client to use. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ComponentDeclarativeTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ComponentDeclarativeTypes.yml index 05c99929..18fe7402 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ComponentDeclarativeTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ComponentDeclarativeTypes.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-declarative summary: Interface for registering declarative types. fullName: ComponentDeclarativeTypes remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -15,16 +14,17 @@ methods: package: botbuilder-dialogs-declarative summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getDeclarativeTypes(resourceExplorer: ResourceExplorer): - DeclarativeType[] + DeclarativeType>[] parameters: - id: resourceExplorer type: description: '' return: description: '' - type: '[]' + type: >- + <unknown, Record<string, unknown>>[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/CustomDeserializer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/CustomDeserializer.yml index 67822556..23932bf7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/CustomDeserializer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/CustomDeserializer.yml @@ -5,18 +5,16 @@ package: botbuilder-dialogs-declarative summary: >- Defines the contract for a deserializer from a configuration object to a typed object. -fullName: 'CustomDeserializer' +fullName: CustomDeserializer remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'load(C, Newable)' + - name: load(C, Newable) uid: botbuilder-dialogs-declarative.CustomDeserializer.load package: botbuilder-dialogs-declarative summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(config: C, type: Newable): T' @@ -25,7 +23,7 @@ methods: type: C description: '' - id: type - type: 'Newable<T, any[]>' + type: Newable<T, any[]> description: '' return: description: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DeclarativeType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DeclarativeType.yml index b643b76f..5f604512 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DeclarativeType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DeclarativeType.yml @@ -3,9 +3,8 @@ name: DeclarativeType uid: botbuilder-dialogs-declarative.DeclarativeType package: botbuilder-dialogs-declarative summary: DeclarativeType interface maps $kind to type. -fullName: 'DeclarativeType' +fullName: DeclarativeType remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'kind: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: loader remarks: '' - isPreview: false isDeprecated: false syntax: content: 'loader?: CustomDeserializer' @@ -43,10 +40,9 @@ properties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: Newable' return: description: '' - type: 'Newable<T, any[]>' + type: Newable<T, any[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DefaultLoader.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DefaultLoader.yml index 11ba1b3c..42a400c8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DefaultLoader.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/DefaultLoader.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-declarative summary: A default loader for deserializing configuration objects. fullName: DefaultLoader remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,33 +13,30 @@ constructors: package: botbuilder-dialogs-declarative summary: Intializes an instance of `DefaultLoader`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DefaultLoader(_resourceExplorer: ResourceExplorer)' parameters: - id: _resourceExplorer type: - description: | - The `ResourceExplorer` used by the loader. + description: The `ResourceExplorer` used by the loader. methods: - - name: 'load(Record, Newable)' + - name: load(Record, Newable) uid: botbuilder-dialogs-declarative.DefaultLoader.load package: botbuilder-dialogs-declarative summary: The method that loads the configuration object to a requested type. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function load(config: Record, type: - Newable): Configurable + Newable): Configurable parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: The configuration object to deserialize. - id: type - type: Newable<Configurable> + type: Newable<Configurable, unknown[]> description: The object type that the configuration will be deserialized to. return: description: A `Configurable` object created from the configuration. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FileResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FileResource.yml index 69c1ed8b..d5b5f7b4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FileResource.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FileResource.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-declarative summary: Class which represents a file as a resource. fullName: FileResource remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botbuilder-dialogs-declarative summary: Initialize a new instance of the `FileResouce` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new FileResource(path: string)' parameters: - id: path type: string - description: | - Path to file. + description: Path to file. properties: - name: fullName uid: botbuilder-dialogs-declarative.FileResource.fullName @@ -30,7 +27,6 @@ properties: summary: The full path to the resource on disk fullName: fullName remarks: '' - isPreview: false isDeprecated: false syntax: content: string fullName @@ -43,7 +39,6 @@ properties: summary: Resource id. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: string id @@ -56,7 +51,6 @@ methods: package: botbuilder-dialogs-declarative summary: Read text content of a file resource. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readText(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FolderResourceProvider.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FolderResourceProvider.yml index fea94566..987a2f96 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FolderResourceProvider.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/FolderResourceProvider.yml @@ -7,16 +7,14 @@ summary: >- file system. fullName: FolderResourceProvider remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'FolderResourceProvider(ResourceExplorer, string, boolean, boolean)' + - name: FolderResourceProvider(ResourceExplorer, string, boolean, boolean) uid: botbuilder-dialogs-declarative.FolderResourceProvider.constructor package: botbuilder-dialogs-declarative summary: Initializes a new instance of the `FolderResourceProvider` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,8 +32,7 @@ constructors: description: Whether include its sub folders. - id: monitorChanges type: boolean - description: | - Whether monitor changes. + description: Whether monitor changes. properties: - name: changed uid: botbuilder-dialogs-declarative.FolderResourceProvider.changed @@ -45,20 +42,18 @@ properties: detects changes to the underlining resource. fullName: changed remarks: '' - isPreview: false isDeprecated: false syntax: - content: any changed + content: void changed return: description: '' - type: any + type: void - name: directory uid: botbuilder-dialogs-declarative.FolderResourceProvider.directory package: botbuilder-dialogs-declarative summary: Folder to enumerate. fullName: directory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'directory: string' @@ -71,7 +66,6 @@ properties: summary: Gets the ID for this resource provider. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: string id @@ -84,7 +78,6 @@ properties: summary: A value indicating whether to include subfolders. fullName: includeSubFolders remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeSubFolders: boolean' @@ -97,7 +90,6 @@ properties: summary: Gets the resource explorer. fullName: resourceExplorer remarks: '' - isPreview: false isDeprecated: false syntax: content: ResourceExplorer resourceExplorer @@ -110,7 +102,6 @@ properties: summary: Gets attached file watcher. fullName: watcher remarks: '' - isPreview: false isDeprecated: false syntax: content: FSWatcher watcher @@ -123,7 +114,6 @@ methods: package: botbuilder-dialogs-declarative summary: Gets resource by its id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getResource(id: string): Resource' @@ -139,7 +129,6 @@ methods: package: botbuilder-dialogs-declarative summary: Gets resources by extension. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getResources(extension: string): Resource[]' @@ -149,13 +138,12 @@ methods: description: Resource extension. return: description: Collection of resources. - type: '[]' + type: [] - name: refresh() uid: botbuilder-dialogs-declarative.FolderResourceProvider.refresh package: botbuilder-dialogs-declarative summary: Refresh any cached content and look for new content. remarks: '' - isPreview: false isDeprecated: false syntax: content: function refresh() diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/PathUtil.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/PathUtil.yml deleted file mode 100644 index 19f3665a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/PathUtil.yml +++ /dev/null @@ -1,64 +0,0 @@ -### YamlMime:TSType -name: PathUtil -uid: botbuilder-dialogs-declarative.PathUtil -package: botbuilder-dialogs-declarative -summary: An utility class for file path operations. -fullName: PathUtil -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: getDirectories(string) - uid: botbuilder-dialogs-declarative.PathUtil.getDirectories - package: botbuilder-dialogs-declarative - summary: Get sub folders in a directory - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getDirectories(path: string): string[]' - parameters: - - id: path - type: string - description: Path of root directory. - return: - description: Sub folders in the directory. - type: 'string[]' - - name: 'getFiles(string, boolean)' - uid: botbuilder-dialogs-declarative.PathUtil.getFiles - package: botbuilder-dialogs-declarative - summary: Get files in a directory - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getFiles(path: string, includeSubFolders?: boolean): - string[] - parameters: - - id: path - type: string - description: Path of root directory. - - id: includeSubFolders - type: boolean - description: Whether include its sub folders. - return: - description: The files in the directory. - type: 'string[]' - - name: isDirectory(string) - uid: botbuilder-dialogs-declarative.PathUtil.isDirectory - package: botbuilder-dialogs-declarative - summary: Check if a path is a directory - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function isDirectory(path: string): boolean' - parameters: - - id: path - type: string - description: Path of the directory. - return: - description: True if the path is a directory; false otherwise. - type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/Resource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/Resource.yml index 64e5a041..982b9e33 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/Resource.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/Resource.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-declarative summary: Abstract class for access the content of a resource. fullName: Resource remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: The full path to the resource on disk fullName: fullName remarks: '' - isPreview: false isDeprecated: false syntax: content: string fullName @@ -28,7 +26,6 @@ properties: summary: Resource id. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: string id @@ -41,7 +38,6 @@ methods: package: botbuilder-dialogs-declarative summary: Get resource as text. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readText(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceChangeEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceChangeEvent.yml index 55ee16bd..9b99ab46 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceChangeEvent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceChangeEvent.yml @@ -9,7 +9,6 @@ summary: |- removed - an existing resource has been removed. fullName: ResourceChangeEvent remarks: '' -isPreview: false isDeprecated: false fields: - name: added diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorer.yml index 79653aeb..2d9f76bb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-declarative summary: Class which gives standard access to content resources. fullName: ResourceExplorer remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [ResourceExplorer](botbuilder-dialogs.declarative.ResourceExplorer) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ResourceExplorer(options?: ResourceExplorerOptions)' @@ -25,23 +23,21 @@ constructors: type: >- - description: | - The configuration options. - - name: 'ResourceExplorer(ResourceProvider[])' + description: The configuration options. + - name: ResourceExplorer(ResourceProvider[]) uid: botbuilder-dialogs-declarative.ResourceExplorer.constructor package: botbuilder-dialogs-declarative summary: >- Initializes a new instance of the [ResourceExplorer](botbuilder-dialogs.declarative.ResourceExplorer) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ResourceExplorer(providers: ResourceProvider[])' parameters: - id: providers - type: '[]' - description: > + type: [] + description: >- The list of [ResourceProvider](botbuilder-dialogs-declarative.ResourceProvider) to initialize the current instance. @@ -52,33 +48,30 @@ properties: summary: Event which fires when a resource is changed. fullName: changed remarks: '' - isPreview: false isDeprecated: false syntax: - content: any changed + content: void changed return: description: '' - type: any + type: void - name: resourceProviders uid: botbuilder-dialogs-declarative.ResourceExplorer.resourceProviders package: botbuilder-dialogs-declarative summary: Gets resource providers. fullName: resourceProviders remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceProviders: ResourceProvider[]' return: description: '' - type: '[]' + type: [] - name: resourceTypes uid: botbuilder-dialogs-declarative.ResourceExplorer.resourceTypes package: botbuilder-dialogs-declarative summary: Gets resource type id extensions managed by resource explorer. fullName: resourceTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceTypes: Set' @@ -86,12 +79,11 @@ properties: description: '' type: Set<string> methods: - - name: 'addFolder(string, boolean, boolean)' + - name: addFolder(string, boolean, boolean) uid: botbuilder-dialogs-declarative.ResourceExplorer.addFolder package: botbuilder-dialogs-declarative summary: Add a folder resource. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -112,12 +104,11 @@ methods: Resource explorer so that you can fluently call multiple methods on the resource explorer. type: - - name: 'addFolders(string, string[], boolean)' + - name: addFolders(string, string[], boolean) uid: botbuilder-dialogs-declarative.ResourceExplorer.addFolders package: botbuilder-dialogs-declarative summary: Add folder resources. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -128,7 +119,7 @@ methods: type: string description: Collection of folders to be included as resources. - id: ignoreFolders - type: 'string[]' + type: string[] description: Imediate subfolders to ignore. - id: monitorChanges type: boolean @@ -143,7 +134,6 @@ methods: package: botbuilder-dialogs-declarative summary: Add a resource provider to the resources managed by resource explorer. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,21 +153,18 @@ methods: package: botbuilder-dialogs-declarative summary: Add a resource type to resource type set. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addResourceType(type: string)' parameters: - id: type type: string - description: | - Resource type. - - name: 'buildType(string, C)' + description: Resource type. + - name: buildType(string, C) uid: botbuilder-dialogs-declarative.ResourceExplorer.buildType package: botbuilder-dialogs-declarative summary: Build type for given $kind from configuration. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function buildType(kind: string, config: C): T' @@ -196,7 +183,6 @@ methods: package: botbuilder-dialogs-declarative summary: Gets resource by id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getResource(id: string): Resource' @@ -205,14 +191,13 @@ methods: type: string description: Resource id. return: - description: 'The resource, or undefined if not found.' + description: The resource, or undefined if not found. type: - name: getResources(string) uid: botbuilder-dialogs-declarative.ResourceExplorer.getResources package: botbuilder-dialogs-declarative summary: Get resources of a given type extension. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getResources(fileExtension: string): Resource[]' @@ -222,13 +207,12 @@ methods: description: File extension filter. return: description: The resources. - type: '[]' + type: [] - name: loadType(Resource) uid: botbuilder-dialogs-declarative.ResourceExplorer.loadType_1 package: botbuilder-dialogs-declarative summary: Load type from resource remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loadType(resource: Resource): T' @@ -244,7 +228,6 @@ methods: package: botbuilder-dialogs-declarative summary: Load type from resource remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loadType(resourceId: string): T' @@ -260,29 +243,28 @@ methods: package: botbuilder-dialogs-declarative summary: Reload any cached data. remarks: '' - isPreview: false isDeprecated: false syntax: content: function refresh() - name: >- - registerType(string, Newable, CustomDeserializer>) + registerType(string, Newable, CustomDeserializer>) uid: botbuilder-dialogs-declarative.ResourceExplorer.registerType package: botbuilder-dialogs-declarative summary: Register a declarative type with the resource loader system. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function registerType(kind: string, type: Newable, loader?: - CustomDeserializer>): ResourceExplorer + function registerType(kind: string, type: Newable, + loader?: CustomDeserializer>): + ResourceExplorer parameters: - id: kind type: string description: The $kind name to map to this type. - id: type - type: Newable<T> + type: Newable<T, unknown[]> description: Type of object to create. - id: loader type: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorerOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorerOptions.yml index e34d46bc..68a1aa98 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorerOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceExplorerOptions.yml @@ -7,7 +7,6 @@ summary: >- [ResourceExplorer](xref:botbuilder-dialogs-declarative.ResourceExplorer). fullName: ResourceExplorerOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: [ResourceExplorer](xref:botbuilder-dialogs-declarative.ResourceExplorer). fullName: allowCycles remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowCycles?: boolean' @@ -32,7 +30,6 @@ properties: summary: The list of declarative types to use. fullName: declarativeTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'declarativeTypes?: ComponentDeclarativeTypes[]' @@ -49,10 +46,9 @@ properties: [ResourceExplorer](xref:botbuilder-dialogs-declarative.ResourceExplorer). fullName: providers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'providers?: ResourceProvider[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceProvider.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceProvider.yml index 498ad234..8c9359e6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceProvider.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/ResourceProvider.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs-declarative summary: Abstract class for looking up a resource by id. fullName: ResourceProvider remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botbuilder-dialogs-declarative summary: Initialize an instance of `ResourceProvider` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ResourceProvider(resourceExplorer: ResourceExplorer)' parameters: - id: resourceExplorer type: - description: | - Resource explorer. + description: Resource explorer. properties: - name: changed uid: botbuilder-dialogs-declarative.ResourceProvider.changed @@ -32,20 +29,18 @@ properties: detects changes to the underlining resource. fullName: changed remarks: '' - isPreview: false isDeprecated: false syntax: - content: any changed + content: void changed return: description: '' - type: any + type: void - name: id uid: botbuilder-dialogs-declarative.ResourceProvider.id package: botbuilder-dialogs-declarative summary: Gets the ID for this resource provider. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: string id @@ -58,7 +53,6 @@ properties: summary: Gets the resource explorer. fullName: resourceExplorer remarks: '' - isPreview: false isDeprecated: false syntax: content: ResourceExplorer resourceExplorer @@ -71,15 +65,13 @@ methods: package: botbuilder-dialogs-declarative summary: Gets resource by id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getResource(id: string): Resource' parameters: - id: id type: string - description: | - Resource id. + description: Resource id. return: description: '' type: @@ -88,24 +80,21 @@ methods: package: botbuilder-dialogs-declarative summary: Enumerate resources. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getResources(extension: string): Resource[]' parameters: - id: extension type: string - description: | - Extension filter. + description: Extension filter. return: description: '' - type: '[]' + type: [] - name: refresh() uid: botbuilder-dialogs-declarative.ResourceProvider.refresh package: botbuilder-dialogs-declarative summary: Refresh any cached resources. remarks: '' - isPreview: false isDeprecated: false syntax: content: function refresh() diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/index.yml index 8189492b..a4f1db9d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-declarative/index.yml @@ -3,6 +3,15 @@ uid: botbuilder-dialogs-declarative name: botbuilder-dialogs-declarative summary: '' type: package +enums: + - botbuilder-dialogs-declarative.ResourceChangeEvent +classes: + - botbuilder-dialogs-declarative.DefaultLoader + - botbuilder-dialogs-declarative.FileResource + - botbuilder-dialogs-declarative.FolderResourceProvider + - botbuilder-dialogs-declarative.Resource + - botbuilder-dialogs-declarative.ResourceExplorer + - botbuilder-dialogs-declarative.ResourceProvider interfaces: - botbuilder-dialogs-declarative.ComponentDeclarativeTypes - botbuilder-dialogs-declarative.CustomDeserializer @@ -19,24 +28,13 @@ functions: [ComponentDeclarativeTypes](xref:botbuilder-dialogs-declarative.ComponentDeclarativeTypes) or not. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function isComponentDeclarativeTypes(component: unknown): boolean' + content: 'function isComponentDeclarativeTypes(component: unknown): component' parameters: - id: component type: unknown description: The component registration. return: description: Type check result. - type: boolean -classes: - - botbuilder-dialogs-declarative.DefaultLoader - - botbuilder-dialogs-declarative.PathUtil - - botbuilder-dialogs-declarative.FileResource - - botbuilder-dialogs-declarative.FolderResourceProvider - - botbuilder-dialogs-declarative.Resource - - botbuilder-dialogs-declarative.ResourceExplorer - - botbuilder-dialogs-declarative.ResourceProvider -enums: - - botbuilder-dialogs-declarative.ResourceChangeEvent + type: component diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ActivityPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ActivityPrompt.yml index 75a4373a..830a3711 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ActivityPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ActivityPrompt.yml @@ -3,7 +3,7 @@ name: ActivityPrompt uid: botbuilder-dialogs.ActivityPrompt package: botbuilder-dialogs summary: Waits for an activity to be received. -fullName: ActivityPrompt +fullName: ActivityPrompt remarks: >- This prompt requires a validator be passed in and is useful when waiting for non-message @@ -12,16 +12,14 @@ remarks: >- events until the expected activity is received. -isPreview: false isDeprecated: false type: class constructors: - - name: 'ActivityPrompt(string, PromptValidator)' + - name: ActivityPrompt(string, PromptValidator) uid: botbuilder-dialogs.ActivityPrompt.constructor package: botbuilder-dialogs summary: Creates a new ActivityPrompt instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -35,18 +33,14 @@ constructors: `ComponentDialog`. - id: validator type: <Activity> - description: | - Validator that will be called each time a new activity is received. + description: Validator that will be called each time a new activity is received. properties: - name: id uid: botbuilder-dialogs.ActivityPrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -56,12 +50,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.ActivityPrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -82,39 +73,37 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.ActivityPrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ActivityPrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + [Dialog.configure](xref:botbuilder-dialogs.Dialog.configure) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.ActivityPrompt.endDialog package: botbuilder-dialogs summary: >- @@ -143,23 +132,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -171,10 +158,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -182,11 +170,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Dialog.getConverter](xref:botbuilder-dialogs.Dialog.getConverter) - name: getVersion() uid: botbuilder-dialogs.ActivityPrompt.getVersion package: botbuilder-dialogs @@ -209,7 +198,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -221,14 +209,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.ActivityPrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -250,7 +237,7 @@ inheritedMethods: Inherited From [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) methods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.ActivityPrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -261,12 +248,11 @@ methods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -278,11 +264,13 @@ methods: - id: options type: description: |- - (xref:botbuilder-dialogs.PromptOptions), additional + [PromptOptions](xref:botbuilder-dialogs.PromptOptions), additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.ActivityPrompt.continueDialog package: botbuilder-dialogs @@ -299,10 +287,11 @@ methods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -313,35 +302,40 @@ methods: turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> - - name: 'repromptDialog(TurnContext, DialogInstance)' + type: >- + Promise<<any>> + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.ActivityPrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.ActivityPrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -350,12 +344,11 @@ methods: when the previous active dialog on the stack completes. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -366,8 +359,10 @@ methods: of the conversation. - id: _reason type: - description: |- - (xref:botbuilder-dialogs.DialogReason), an enum indicating why + description: >- + [DialogReason](xref:botbuilder-dialogs.DialogReason), an enum + indicating why + the dialog resumed. - id: _result type: any @@ -376,5 +371,7 @@ methods: The type of the value returned is dependent on the previous dialog. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AliasPathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AliasPathResolver.yml index d3abd4e5..f9e9f577 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AliasPathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AliasPathResolver.yml @@ -5,18 +5,16 @@ package: botbuilder-dialogs summary: Maps aliasXXX -> path.xxx ($foo => dialog.foo). fullName: AliasPathResolver remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AliasPathResolver(string, string, string)' + - name: AliasPathResolver(string, string, string) uid: botbuilder-dialogs.AliasPathResolver.constructor package: botbuilder-dialogs summary: >- Initializes a new instance of the [AliasPathResolver](xref:botbuilder-dialogs.AliasPathResolver) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AliasPathResolver(alias: string, prefix: string, postfix?: string)' @@ -29,15 +27,13 @@ constructors: description: Prefix name. - id: postfix type: string - description: | - Postfix name. + description: Postfix name. methods: - name: transformPath(string) uid: botbuilder-dialogs.AliasPathResolver.transformPath package: botbuilder-dialogs summary: Transforms the path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtAtPathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtAtPathResolver.yml index 4536d19b..ce8d5173 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtAtPathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtAtPathResolver.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Maps @@ => turn.recognized.entitites.xxx array. fullName: AtAtPathResolver remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [AtAtPathResolver](xref:botbuilder-dialogs.AtAtPathResolver) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new AtAtPathResolver() @@ -26,7 +24,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Transforms the path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtPathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtPathResolver.yml index 6210aa09..5c9a1d51 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtPathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AtPathResolver.yml @@ -2,10 +2,9 @@ name: AtPathResolver uid: botbuilder-dialogs.AtPathResolver package: botbuilder-dialogs -summary: 'Maps @@ => turn.recognized.entitites.xxx[0]' +summary: Maps @@ => turn.recognized.entitites.xxx[0] fullName: AtPathResolver remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [AtPathResolver](xref:botbuilder-dialogs.AtPathResolver) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new AtPathResolver() @@ -26,7 +24,6 @@ methods: package: botbuilder-dialogs summary: Transforms the path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AttachmentPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AttachmentPrompt.yml index f3fb758a..eec935f7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AttachmentPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/AttachmentPrompt.yml @@ -3,18 +3,16 @@ name: AttachmentPrompt uid: botbuilder-dialogs.AttachmentPrompt package: botbuilder-dialogs summary: Prompts a user to upload attachments like images. -fullName: AttachmentPrompt -remarks: 'By default the prompt will return to the calling dialog an `Attachment[]`.' -isPreview: false +fullName: AttachmentPrompt +remarks: By default the prompt will return to the calling dialog an `Attachment[]`. isDeprecated: false type: class constructors: - - name: 'AttachmentPrompt(string, PromptValidator)' + - name: AttachmentPrompt(string, PromptValidator) uid: botbuilder-dialogs.AttachmentPrompt.constructor package: botbuilder-dialogs summary: Creates a new `AttachmentPrompt` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,19 +28,16 @@ constructors: type: >- <Attachment[]> - description: > + description: >- (Optional) validator that will be called each time the user responds to the prompt. properties: - name: id uid: botbuilder-dialogs.AttachmentPrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -52,12 +47,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.AttachmentPrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -78,18 +70,17 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [Prompt.EndOfTurn](xref:botbuilder-dialogs.Prompt.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.AttachmentPrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -100,12 +91,11 @@ inheritedMethods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -121,31 +111,32 @@ inheritedMethods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.beginDialog](xref:botbuilder-dialogs.Prompt.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.AttachmentPrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): AttachmentPrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Prompt.configure](xref:botbuilder-dialogs.Prompt.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.AttachmentPrompt.continueDialog package: botbuilder-dialogs @@ -162,10 +153,11 @@ inheritedMethods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -174,11 +166,13 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.continueDialog](xref:botbuilder-dialogs.Prompt.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.AttachmentPrompt.endDialog package: botbuilder-dialogs summary: >- @@ -207,38 +201,37 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) + [Prompt.endDialog](xref:botbuilder-dialogs.Prompt.endDialog) - name: getConverter(string) uid: botbuilder-dialogs.AttachmentPrompt.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -246,11 +239,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Prompt.getConverter](xref:botbuilder-dialogs.Prompt.getConverter) - name: getVersion() uid: botbuilder-dialogs.AttachmentPrompt.getVersion package: botbuilder-dialogs @@ -273,7 +267,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -284,15 +277,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Prompt.getVersion](xref:botbuilder-dialogs.Prompt.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.AttachmentPrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -312,30 +304,33 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: >- Inherited From - [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + [Prompt.onDialogEvent](xref:botbuilder-dialogs.Prompt.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.AttachmentPrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. @@ -343,7 +338,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Prompt.repromptDialog](xref:botbuilder-dialogs.Prompt.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.AttachmentPrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -356,12 +351,11 @@ inheritedMethods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -376,8 +370,10 @@ inheritedMethods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.resumeDialog](xref:botbuilder-dialogs.Prompt.resumeDialog) -extends: '<Attachment[]>' +extends: <Attachment[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BeginSkillDialogOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BeginSkillDialogOptions.yml index 7274a39f..5f50781f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BeginSkillDialogOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BeginSkillDialogOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: A class with dialog arguments for a SkillDialog. fullName: BeginSkillDialogOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The Activity to send to the skill. fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity: Partial' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BotStateMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BotStateMemoryScope.yml index 7ca73483..f1e745fe 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BotStateMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/BotStateMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Base class for memory scopes based on BotState. fullName: BotStateMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,15 +16,13 @@ constructors: [BotStateMemoryScope](xref:adaptive-expressions.BotStateMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BotStateMemoryScope(name: string)' parameters: - id: name type: string - description: | - name of the property. + description: name of the property. inheritedProperties: - name: includeInSnapshot uid: botbuilder-dialogs.BotStateMemoryScope.includeInSnapshot @@ -35,7 +32,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -51,7 +47,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -69,7 +64,6 @@ methods: Deletes any state in storage and the cache for this [BotState](xref:botbuilder-core.BotState). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' @@ -87,7 +81,6 @@ methods: package: botbuilder-dialogs summary: Get the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -98,14 +91,13 @@ methods: return: description: Memory for the scope. type: object - - name: 'load(DialogContext, boolean)' + - name: load(DialogContext, boolean) uid: botbuilder-dialogs.BotStateMemoryScope.load package: botbuilder-dialogs summary: >- Populates the state cache for this [BotState](xref:botbuilder-core.BotState) from the storage layer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(dc: DialogContext, force?: boolean): Promise' @@ -125,14 +117,13 @@ methods: return: description: A Promise that represents the work queued to execute. type: Promise<void> - - name: 'saveChanges(DialogContext, boolean)' + - name: saveChanges(DialogContext, boolean) uid: botbuilder-dialogs.BotStateMemoryScope.saveChanges package: botbuilder-dialogs summary: >- Writes the state cache for this [BotState](xref:botbuilder-core.BotState) to the storage layer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(dc: DialogContext, force?: boolean): Promise' @@ -152,12 +143,11 @@ methods: return: description: A Promise that represents the work queued to execute. type: Promise<void> - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.BotStateMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(dc: DialogContext, _memory: object)' @@ -167,6 +157,5 @@ methods: description: current dialog context - id: _memory type: object - description: | - memory + description: memory extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Choice.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Choice.yml index 1d39af7a..d90496d1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Choice.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Choice.yml @@ -40,7 +40,6 @@ remarks: >- }; ``` -isPreview: false isDeprecated: false type: interface properties: @@ -58,7 +57,6 @@ properties: field. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action?: CardAction' @@ -75,13 +73,12 @@ properties: [action](#action) fields. fullName: synonyms remarks: '' - isPreview: false isDeprecated: false syntax: content: 'synonyms?: string[]' return: description: '' - type: 'string[]' + type: string[] - name: value uid: botbuilder-dialogs.Choice.value package: botbuilder-dialogs @@ -92,7 +89,6 @@ properties: to the user if no [action](#action) is provided. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsChoicePrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsChoicePrompt.yml deleted file mode 100644 index b4acce10..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsChoicePrompt.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSType -name: ChoiceDefaultsChoicePrompt -uid: botbuilder-dialogs.ChoiceDefaultsChoicePrompt -package: botbuilder-dialogs -summary: '' -fullName: ChoiceDefaultsChoicePrompt -remarks: '' -isPreview: false -isDeprecated: false -type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsConfirmPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsConfirmPrompt.yml deleted file mode 100644 index e4398ce3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceDefaultsConfirmPrompt.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSType -name: ChoiceDefaultsConfirmPrompt -uid: botbuilder-dialogs.ChoiceDefaultsConfirmPrompt -package: botbuilder-dialogs -summary: '' -fullName: ChoiceDefaultsConfirmPrompt -remarks: '' -isPreview: false -isDeprecated: false -type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactory.yml index c0d632a0..c2633402 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactory.yml @@ -26,12 +26,11 @@ remarks: >- await context.sendActivity(message); ``` -isPreview: false isDeprecated: false type: class methods: - name: >- - forChannel(string | TurnContext, string | Choice[], string, string, + forChannel(string | TurnContext, (string | Choice)[], string, string, ChoiceFactoryOptions) uid: botbuilder-dialogs.ChoiceFactory.forChannel package: botbuilder-dialogs @@ -69,19 +68,18 @@ methods: await context.sendActivity(message); ``` - isPreview: false isDeprecated: false syntax: content: >- static function forChannel(channelOrContext: string | TurnContext, - choices: string | Choice[], text?: string, speak?: string, options?: + choices: (string | Choice)[], text?: string, speak?: string, options?: ChoiceFactoryOptions): Partial parameters: - id: channelOrContext type: string | TurnContext description: Channel ID or context object for the current turn of conversation. - id: choices - type: 'string | []' + type: (string | )[] description: List of choices to render. - id: text type: string @@ -95,7 +93,7 @@ methods: return: description: The created message activity. type: Partial<Activity> - - name: 'heroCard(string | Choice[], string, string)' + - name: heroCard((string | Choice)[], string, string) uid: botbuilder-dialogs.ChoiceFactory.heroCard package: botbuilder-dialogs summary: >- @@ -103,16 +101,15 @@ methods: includes a [Choice](xref:botbuilder-dialogs.Choice) list that have been added as `HeroCard`'s. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function heroCard(choices?: string | Choice[], text?: string, + static function heroCard(choices?: (string | Choice)[], text?: string, speak?: string): Activity parameters: - id: choices - type: 'string | []' - description: 'Optional. The [Choice](xref:botbuilder-dialogs.Choice) list to add.' + type: (string | )[] + description: Optional. The [Choice](xref:botbuilder-dialogs.Choice) list to add. - id: text type: string description: Optional. Text of the message. @@ -126,7 +123,7 @@ methods: An [Activity](xref:botframework-schema.Activity) with choices as `HeroCard` with buttons. type: Activity - - name: 'inline(string | Choice[], string, string, ChoiceFactoryOptions)' + - name: inline((string | Choice)[], string, string, ChoiceFactoryOptions) uid: botbuilder-dialogs.ChoiceFactory.inline package: botbuilder-dialogs summary: >- @@ -147,15 +144,14 @@ methods: await context.sendActivity(message); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function inline(choices: string | Choice[], text?: string, + static function inline(choices: (string | Choice)[], text?: string, speak?: string, options?: ChoiceFactoryOptions): Partial parameters: - id: choices - type: 'string | []' + type: (string | )[] description: List of choices to render. - id: text type: string @@ -169,7 +165,7 @@ methods: return: description: The created message activity. type: Partial<Activity> - - name: 'list(string | Choice[], string, string, ChoiceFactoryOptions)' + - name: list((string | Choice)[], string, string, ChoiceFactoryOptions) uid: botbuilder-dialogs.ChoiceFactory.list package: botbuilder-dialogs summary: >- @@ -190,15 +186,14 @@ methods: await context.sendActivity(message); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function list(choices: string | Choice[], text?: string, speak?: - string, options?: ChoiceFactoryOptions): Partial + static function list(choices: (string | Choice)[], text?: string, + speak?: string, options?: ChoiceFactoryOptions): Partial parameters: - id: choices - type: 'string | []' + type: (string | )[] description: List of choices to render. - id: text type: string @@ -212,7 +207,7 @@ methods: return: description: The created message activity. type: Partial<Activity> - - name: 'suggestedAction(string | Choice[], string, string)' + - name: suggestedAction((string | Choice)[], string, string) uid: botbuilder-dialogs.ChoiceFactory.suggestedAction package: botbuilder-dialogs summary: >- @@ -233,15 +228,14 @@ methods: await context.sendActivity(message); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function suggestedAction(choices: string | Choice[], text?: + static function suggestedAction(choices: (string | Choice)[], text?: string, speak?: string): Partial parameters: - id: choices - type: 'string | []' + type: (string | )[] description: List of choices to add. - id: text type: string @@ -252,7 +246,7 @@ methods: return: description: An activity with choices as suggested actions. type: Partial<Activity> - - name: 'toChoices(string | Choice[] | undefined)' + - name: toChoices(undefined | (string | Choice)[]) uid: botbuilder-dialogs.ChoiceFactory.toChoices package: botbuilder-dialogs summary: >- @@ -274,16 +268,15 @@ methods: const choices = ChoiceFactory.toChoices(['red', 'green', 'blue']); ``` - isPreview: false isDeprecated: false syntax: content: >- - static function toChoices(choices: string | Choice[] | undefined): + static function toChoices(choices: undefined | (string | Choice)[]): Choice[] parameters: - id: choices - type: 'string | [] | undefined' + type: undefined | (string | )[] description: List of choices to add. return: description: A list of choices. - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactoryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactoryOptions.yml index 853516ea..6c5a8243 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactoryOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoiceFactoryOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Additional options used to tweak the formatting of choice lists. fullName: ChoiceFactoryOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -22,7 +21,6 @@ properties: default value is `true`. fullName: includeNumbers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeNumbers?: boolean' @@ -39,7 +37,6 @@ properties: value is `" or "`. fullName: inlineOr remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineOr?: string' @@ -56,7 +53,6 @@ properties: The default value is `", or "`. fullName: inlineOrMore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineOrMore?: string' @@ -73,7 +69,6 @@ properties: The default value is `", "`. fullName: inlineSeparator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineSeparator?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoicePrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoicePrompt.yml index 7e60ccbf..5fdd4f30 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoicePrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ChoicePrompt.yml @@ -3,13 +3,12 @@ name: ChoicePrompt uid: botbuilder-dialogs.ChoicePrompt package: botbuilder-dialogs summary: Prompts a user to select from a list of choices. -fullName: ChoicePrompt +fullName: ChoicePrompt remarks: >- By default the prompt will return to the calling dialog a `FoundChoice` object containing the choice that was selected. -isPreview: false isDeprecated: false type: class constructors: @@ -20,7 +19,6 @@ constructors: package: botbuilder-dialogs summary: Creates a new `ChoicePrompt` instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,8 +43,8 @@ constructors: (Optional) locale to use if `dc.context.activity.locale` not specified. Defaults to a value of `en-us`. - id: choiceDefaults - type: - description: > + type: ChoiceDefaultsChoicePrompt + description: >- (Optional) Overrides the dictionary of Bot Framework SDK-supported _choiceDefaults (for prompt localization). Must be passed in to each ConfirmPrompt that needs the custom choice defaults. @@ -61,35 +59,30 @@ properties: rendered to the user. fullName: choiceOptions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'choiceOptions: ChoiceFactoryOptions | undefined' + content: 'choiceOptions: undefined | ChoiceFactoryOptions' return: description: '' - type: | undefined + type: undefined | - name: defaultLocale uid: botbuilder-dialogs.ChoicePrompt.defaultLocale package: botbuilder-dialogs summary: The prompts default locale that should be recognized. fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultLocale: string | undefined' + content: 'defaultLocale: undefined | string' return: description: '' - type: string | undefined + type: undefined | string - name: id uid: botbuilder-dialogs.ChoicePrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -102,20 +95,18 @@ properties: summary: Additional options passed to the underlying `recognizeChoices()` function. fullName: recognizerOptions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'recognizerOptions: FindChoicesOptions | undefined' + content: 'recognizerOptions: undefined | FindChoicesOptions' return: description: '' - type: | undefined + type: undefined | - name: style uid: botbuilder-dialogs.ChoicePrompt.style package: botbuilder-dialogs summary: Style of the "yes" and "no" choices rendered to the user when prompting. fullName: style remarks: Defaults to `ListStyle.auto`. - isPreview: false isDeprecated: false syntax: content: 'style: ListStyle' @@ -125,12 +116,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.ChoicePrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -151,18 +139,17 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [Prompt.EndOfTurn](xref:botbuilder-dialogs.Prompt.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.ChoicePrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -173,12 +160,11 @@ inheritedMethods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -194,31 +180,32 @@ inheritedMethods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.beginDialog](xref:botbuilder-dialogs.Prompt.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.ChoicePrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ChoicePrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Prompt.configure](xref:botbuilder-dialogs.Prompt.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.ChoicePrompt.continueDialog package: botbuilder-dialogs @@ -235,10 +222,11 @@ inheritedMethods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -247,11 +235,13 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.continueDialog](xref:botbuilder-dialogs.Prompt.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.ChoicePrompt.endDialog package: botbuilder-dialogs summary: >- @@ -280,38 +270,37 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) + [Prompt.endDialog](xref:botbuilder-dialogs.Prompt.endDialog) - name: getConverter(string) uid: botbuilder-dialogs.ChoicePrompt.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -319,11 +308,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Prompt.getConverter](xref:botbuilder-dialogs.Prompt.getConverter) - name: getVersion() uid: botbuilder-dialogs.ChoicePrompt.getVersion package: botbuilder-dialogs @@ -346,7 +336,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -357,15 +346,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Prompt.getVersion](xref:botbuilder-dialogs.Prompt.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.ChoicePrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -385,30 +373,33 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: >- Inherited From - [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + [Prompt.onDialogEvent](xref:botbuilder-dialogs.Prompt.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.ChoicePrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. @@ -416,7 +407,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Prompt.repromptDialog](xref:botbuilder-dialogs.Prompt.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.ChoicePrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -429,12 +420,11 @@ inheritedMethods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -449,7 +439,9 @@ inheritedMethods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.resumeDialog](xref:botbuilder-dialogs.Prompt.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ClassMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ClassMemoryScope.yml index 147e0145..6f75d43b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ClassMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ClassMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: ClassMemoryScope maps "class" -> dc.activeDialog.properties fullName: ClassMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,15 +15,13 @@ constructors: Initializes a new instance of the [ClassMemoryScope](xref:botbuilder-dialogs.ClassMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ClassMemoryScope(name?: string)' parameters: - id: name type: string - description: | - Name of the scope class. + description: Name of the scope class. inheritedProperties: - name: includeInSnapshot uid: botbuilder-dialogs.ClassMemoryScope.includeInSnapshot @@ -34,7 +31,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -50,7 +46,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -66,15 +61,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -86,15 +79,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -106,27 +97,24 @@ inheritedMethods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [MemoryScope.saveChanges](xref:botbuilder-dialogs.MemoryScope.saveChanges) - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.ClassMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(_dc: DialogContext, _memory: object)' @@ -136,8 +124,7 @@ inheritedMethods: description: Current dialog context - id: _memory type: object - description: | - memory to assign + description: memory to assign inheritanceDescription: >- Inherited From [MemoryScope.setMemory](xref:botbuilder-dialogs.MemoryScope.setMemory) @@ -147,7 +134,6 @@ methods: package: botbuilder-dialogs summary: Gets the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentDialog.yml index 1c04cae5..b79e3ba1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentDialog.yml @@ -74,36 +74,30 @@ remarks: >- dialogs.add(new FillProfileDialog('fillProfile')); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: ComponentDialog(string) + - name: ComponentDialog(string) uid: botbuilder-dialogs.ComponentDialog.constructor package: botbuilder-dialogs summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ComponentDialog(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: id uid: botbuilder-dialogs.ComponentDialog.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -113,13 +107,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.ComponentDialog.telemetryClient package: botbuilder-dialogs - summary: |- - Set the telemetry client, and also apply it to all child dialogs. - Future dialogs added to the component will also inherit this client. - Get the current telemetry client. + summary: Get the current telemetry client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -135,7 +125,6 @@ inheritedProperties: summary: The containers dialog set. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -156,54 +145,51 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [DialogContainer.EndOfTurn](xref:botbuilder-dialogs.DialogContainer.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.ComponentDialog.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ComponentDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: <O> inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [DialogContainer.configure](xref:botbuilder-dialogs.DialogContainer.configure) - name: findDialog(string) uid: botbuilder-dialogs.ComponentDialog.findDialog package: botbuilder-dialogs summary: Finds a child dialog that was previously added to the container. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function findDialog(dialogId: string): Dialog | undefined' + content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog to lookup. return: description: The Dialog if found; otherwise null. - type: | undefined + type: undefined | <{}> inheritanceDescription: >- Inherited From [DialogContainer.findDialog](xref:botbuilder-dialogs.DialogContainer.findDialog) @@ -212,10 +198,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -223,11 +210,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [DialogContainer.getConverter](xref:botbuilder-dialogs.DialogContainer.getConverter) - name: getVersion() uid: botbuilder-dialogs.ComponentDialog.getVersion package: botbuilder-dialogs @@ -250,7 +238,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -261,15 +248,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [DialogContainer.getVersion](xref:botbuilder-dialogs.DialogContainer.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.ComponentDialog.onDialogEvent package: botbuilder-dialogs summary: |- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -291,7 +277,7 @@ inheritedMethods: Inherited From [DialogContainer.onDialogEvent](xref:botbuilder-dialogs.DialogContainer.onDialogEvent) methods: - - name: addDialog(Dialog) + - name: addDialog(Dialog<{}>) uid: botbuilder-dialogs.ComponentDialog.addDialog package: botbuilder-dialogs summary: >- @@ -300,20 +286,19 @@ methods: remarks: >- The [Dialog.id](xref:botbuilder-dialogs.Dialog.id) of the first child added to the component will be assigned to the initialDialogId property. - isPreview: false isDeprecated: false syntax: - content: 'function addDialog(dialog: Dialog): this' + content: 'function addDialog(dialog: Dialog<{}>): ComponentDialog' parameters: - id: dialog - type: - description: 'The child [Dialog](xref:botbuilder-dialogs.Dialog) or prompt to add.' + type: <{}> + description: The child [Dialog](xref:botbuilder-dialogs.Dialog) or prompt to add. return: description: >- The [ComponentDialog](xref:botbuilder-dialogs.ComponentDialog) after the operation is complete. - type: this - - name: 'beginDialog(DialogContext, O)' + type: <O> + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs.ComponentDialog.beginDialog package: botbuilder-dialogs summary: >- @@ -332,12 +317,11 @@ methods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(outerDC: DialogContext, options?: O): - Promise + Promise> parameters: - id: outerDC type: @@ -346,10 +330,12 @@ methods: for the current turn of conversation. - id: options type: O - description: 'Optional, initial information to pass to the dialog.' + description: Optional, initial information to pass to the dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.ComponentDialog.continueDialog package: botbuilder-dialogs @@ -369,12 +355,11 @@ methods: also contain a return value. - isPreview: false isDeprecated: false syntax: content: >- function continueDialog(outerDC: DialogContext): - Promise + Promise> parameters: - id: outerDC type: @@ -383,13 +368,14 @@ methods: for the current turn of conversation. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: createChildContext(DialogContext) uid: botbuilder-dialogs.ComponentDialog.createChildContext package: botbuilder-dialogs summary: Creates the inner dialog context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createChildContext(outerDC: DialogContext): DialogContext' @@ -400,20 +386,19 @@ methods: return: description: The created Dialog Context. type: - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.ComponentDialog.endDialog package: botbuilder-dialogs - summary: 'Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is ending.' + summary: Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is ending. remarks: >- When this method is called from the parent dialog's context, the component [Dialog](xref:botbuilder-dialogs.Dialog) cancels all of the dialogs on its inner dialog stack before ending. - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(context: TurnContext, instance: DialogInstance, + function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise parameters: - id: context @@ -422,7 +407,7 @@ methods: The [TurnContext](xref:botbuilder-core.TurnContext) object for this turn. - id: instance - type: + type: <any> description: >- State information associated with the instance of this component @@ -430,21 +415,20 @@ methods: stack. - id: reason type: - description: 'Reason why the [Dialog](xref:botbuilder-dialogs.Dialog) ended.' + description: Reason why the [Dialog](xref:botbuilder-dialogs.Dialog) ended. return: description: A Promise representing the asynchronous operation. type: Promise<void> - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.ComponentDialog.repromptDialog package: botbuilder-dialogs summary: Called when the dialog should re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext @@ -452,12 +436,12 @@ methods: The [TurnContext](xref:botbuilder-core.TurnContext) object for this turn. - id: instance - type: + type: <any> description: State information for this dialog. return: description: A Promise representing the asynchronous operation. type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.ComponentDialog.resumeDialog package: botbuilder-dialogs summary: >- @@ -483,12 +467,11 @@ methods: If this method is *not* overridden, the dialog automatically calls its RepromptDialog(ITurnContext, DialogInstance) when the user replies. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(outerDC: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: outerDC type: @@ -505,5 +488,7 @@ methods: of the value returned is dependent on the child dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentMemoryScopes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentMemoryScopes.yml index 4741be36..870445d0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentMemoryScopes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentMemoryScopes.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Interface for enumerating memory scopes. fullName: ComponentMemoryScopes remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,10 +13,9 @@ methods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemoryScopes(): MemoryScope[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentPathResolvers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentPathResolvers.yml index aa221d3b..3973a34f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentPathResolvers.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ComponentPathResolvers.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Interface for declaring path resolvers. fullName: ComponentPathResolvers remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,10 +13,9 @@ methods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getPathResolvers(): PathResolver[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Configurable.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Configurable.yml index d29e79ca..6740b56b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Configurable.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Configurable.yml @@ -5,37 +5,36 @@ package: botbuilder-dialogs summary: Base class for all configurable classes. fullName: Configurable remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.Configurable.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): Configurable' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: - name: getConverter(string) uid: botbuilder-dialogs.Configurable.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -43,5 +42,6 @@ methods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConfirmPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConfirmPrompt.yml index 609b2385..e0f73219 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConfirmPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConfirmPrompt.yml @@ -3,13 +3,12 @@ name: ConfirmPrompt uid: botbuilder-dialogs.ConfirmPrompt package: botbuilder-dialogs summary: Prompts a user to confirm something with a "yes" or "no" response. -fullName: ConfirmPrompt +fullName: ConfirmPrompt remarks: >- By default the prompt will return to the calling dialog a `boolean` representing the users selection. -isPreview: false isDeprecated: false type: class constructors: @@ -20,7 +19,6 @@ constructors: package: botbuilder-dialogs summary: Creates a new ConfirmPrompt instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -44,10 +42,10 @@ constructors: (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`. - id: choiceDefaults - type: - description: > + type: ChoiceDefaultsConfirmPrompt + description: >- (Optional) Overrides the dictionary of Default Choices on - [[PromptCultureModels.getSupportedCultures()]]. + . properties: - name: choiceOptions uid: botbuilder-dialogs.ConfirmPrompt.choiceOptions @@ -59,48 +57,42 @@ properties: rendered to the user. fullName: choiceOptions remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'choiceOptions: ChoiceFactoryOptions | undefined' + content: 'choiceOptions: undefined | ChoiceFactoryOptions' return: description: '' - type: | undefined + type: undefined | - name: confirmChoices uid: botbuilder-dialogs.ConfirmPrompt.confirmChoices package: botbuilder-dialogs summary: Custom list of choices to send for the prompt. fullName: confirmChoices remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'confirmChoices: string | Choice[] | undefined' + content: 'confirmChoices: undefined | (string | Choice)[]' return: description: '' - type: 'string | [] | undefined' + type: undefined | (string | )[] - name: defaultLocale uid: botbuilder-dialogs.ConfirmPrompt.defaultLocale package: botbuilder-dialogs summary: The prompts default locale that should be recognized. fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultLocale: string | undefined' + content: 'defaultLocale: undefined | string' return: description: '' - type: string | undefined + type: undefined | string - name: id uid: botbuilder-dialogs.ConfirmPrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -113,7 +105,6 @@ properties: summary: Style of the "yes" and "no" choices rendered to the user when prompting. fullName: style remarks: Defaults to `ListStyle.auto`. - isPreview: false isDeprecated: false syntax: content: 'style: ListStyle' @@ -123,12 +114,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.ConfirmPrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -149,18 +137,17 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [Prompt.EndOfTurn](xref:botbuilder-dialogs.Prompt.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.ConfirmPrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -171,12 +158,11 @@ inheritedMethods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -192,31 +178,32 @@ inheritedMethods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.beginDialog](xref:botbuilder-dialogs.Prompt.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.ConfirmPrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): ConfirmPrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Prompt.configure](xref:botbuilder-dialogs.Prompt.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.ConfirmPrompt.continueDialog package: botbuilder-dialogs @@ -233,10 +220,11 @@ inheritedMethods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -245,11 +233,13 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.continueDialog](xref:botbuilder-dialogs.Prompt.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.ConfirmPrompt.endDialog package: botbuilder-dialogs summary: >- @@ -278,38 +268,37 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) + [Prompt.endDialog](xref:botbuilder-dialogs.Prompt.endDialog) - name: getConverter(string) uid: botbuilder-dialogs.ConfirmPrompt.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -317,11 +306,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Prompt.getConverter](xref:botbuilder-dialogs.Prompt.getConverter) - name: getVersion() uid: botbuilder-dialogs.ConfirmPrompt.getVersion package: botbuilder-dialogs @@ -344,7 +334,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -355,15 +344,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Prompt.getVersion](xref:botbuilder-dialogs.Prompt.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.ConfirmPrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -383,30 +371,33 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: >- Inherited From - [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + [Prompt.onDialogEvent](xref:botbuilder-dialogs.Prompt.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.ConfirmPrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. @@ -414,7 +405,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Prompt.repromptDialog](xref:botbuilder-dialogs.Prompt.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.ConfirmPrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -427,12 +418,11 @@ inheritedMethods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -447,7 +437,9 @@ inheritedMethods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.resumeDialog](xref:botbuilder-dialogs.Prompt.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConversationMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConversationMemoryScope.yml index e2dcebcf..e19f0c65 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConversationMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConversationMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Memory that's scoped to the current conversation. fullName: ConversationMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: [ConversationMemoryScope](xref:botbuilder-dialogs.ConversationMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new ConversationMemoryScope() @@ -30,7 +28,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -39,14 +36,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [MemoryScope.includeInSnapshot](xref:botbuilder-dialogs.MemoryScope.includeInSnapshot) + [BotStateMemoryScope.includeInSnapshot](xref:botbuilder-dialogs.BotStateMemoryScope.includeInSnapshot) - name: name uid: botbuilder-dialogs.ConversationMemoryScope.name package: botbuilder-dialogs summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -55,7 +51,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MemoryScope.name](xref:botbuilder-dialogs.MemoryScope.name) + [BotStateMemoryScope.name](xref:botbuilder-dialogs.BotStateMemoryScope.name) inheritedMethods: - name: delete(DialogContext) uid: botbuilder-dialogs.ConversationMemoryScope.delete @@ -64,7 +60,6 @@ inheritedMethods: Deletes any state in storage and the cache for this [BotState](xref:botbuilder-core.BotState). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' @@ -85,7 +80,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Get the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -99,14 +93,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotStateMemoryScope.getMemory](xref:botbuilder-dialogs.BotStateMemoryScope.getMemory) - - name: 'load(DialogContext, boolean)' + - name: load(DialogContext, boolean) uid: botbuilder-dialogs.ConversationMemoryScope.load package: botbuilder-dialogs summary: >- Populates the state cache for this [BotState](xref:botbuilder-core.BotState) from the storage layer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(dc: DialogContext, force?: boolean): Promise' @@ -129,14 +122,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotStateMemoryScope.load](xref:botbuilder-dialogs.BotStateMemoryScope.load) - - name: 'saveChanges(DialogContext, boolean)' + - name: saveChanges(DialogContext, boolean) uid: botbuilder-dialogs.ConversationMemoryScope.saveChanges package: botbuilder-dialogs summary: >- Writes the state cache for this [BotState](xref:botbuilder-core.BotState) to the storage layer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(dc: DialogContext, force?: boolean): Promise' @@ -159,12 +151,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotStateMemoryScope.saveChanges](xref:botbuilder-dialogs.BotStateMemoryScope.saveChanges) - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.ConversationMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(dc: DialogContext, _memory: object)' @@ -174,8 +165,7 @@ inheritedMethods: description: current dialog context - id: _memory type: object - description: | - memory + description: memory inheritanceDescription: >- Inherited From [BotStateMemoryScope.setMemory](xref:botbuilder-dialogs.BotStateMemoryScope.setMemory) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Converter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Converter.yml index 46e33af8..5d361dc9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Converter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Converter.yml @@ -3,9 +3,8 @@ name: Converter uid: botbuilder-dialogs.Converter package: botbuilder-dialogs summary: The converter converts object from one type to another. -fullName: 'Converter' +fullName: Converter remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function convert(value: From | To): To' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConverterFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConverterFactory.yml index 66cb3601..82ba5b55 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConverterFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ConverterFactory.yml @@ -3,9 +3,8 @@ name: ConverterFactory uid: botbuilder-dialogs.ConverterFactory package: botbuilder-dialogs summary: '' -fullName: 'ConverterFactory' +fullName: ConverterFactory remarks: '' -isPreview: false isDeprecated: false syntax: | - type ConverterFactory = {} + type ConverterFactory = (args: unknown[]) => Converter diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimePrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimePrompt.yml index 0c87bd2f..a75e8567 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimePrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimePrompt.yml @@ -3,20 +3,18 @@ name: DateTimePrompt uid: botbuilder-dialogs.DateTimePrompt package: botbuilder-dialogs summary: Prompts a user to enter a datetime expression. -fullName: DateTimePrompt +fullName: DateTimePrompt remarks: >- By default the prompt will return to the calling dialog a `DateTimeResolution[]`. -isPreview: false isDeprecated: false type: class constructors: - - name: 'DateTimePrompt(string, PromptValidator, string)' + - name: DateTimePrompt(string, PromptValidator, string) uid: botbuilder-dialogs.DateTimePrompt.constructor package: botbuilder-dialogs summary: Creates a new DateTimePrompt instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,7 @@ constructors: to the prompt. - id: defaultLocale type: string - description: > + description: >- (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`. properties: @@ -47,22 +45,18 @@ properties: summary: The prompts default locale that should be recognized. fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'defaultLocale: string | undefined' + content: 'defaultLocale: undefined | string' return: description: '' - type: string | undefined + type: undefined | string - name: id uid: botbuilder-dialogs.DateTimePrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -72,12 +66,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.DateTimePrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -98,18 +89,17 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [Prompt.EndOfTurn](xref:botbuilder-dialogs.Prompt.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.DateTimePrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -120,12 +110,11 @@ inheritedMethods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -141,31 +130,32 @@ inheritedMethods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.beginDialog](xref:botbuilder-dialogs.Prompt.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.DateTimePrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DateTimePrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Prompt.configure](xref:botbuilder-dialogs.Prompt.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.DateTimePrompt.continueDialog package: botbuilder-dialogs @@ -182,10 +172,11 @@ inheritedMethods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -194,11 +185,13 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.continueDialog](xref:botbuilder-dialogs.Prompt.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.DateTimePrompt.endDialog package: botbuilder-dialogs summary: >- @@ -227,38 +220,37 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) + [Prompt.endDialog](xref:botbuilder-dialogs.Prompt.endDialog) - name: getConverter(string) uid: botbuilder-dialogs.DateTimePrompt.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -266,11 +258,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Prompt.getConverter](xref:botbuilder-dialogs.Prompt.getConverter) - name: getVersion() uid: botbuilder-dialogs.DateTimePrompt.getVersion package: botbuilder-dialogs @@ -293,7 +286,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -304,15 +296,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Prompt.getVersion](xref:botbuilder-dialogs.Prompt.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.DateTimePrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -332,30 +323,33 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: >- Inherited From - [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + [Prompt.onDialogEvent](xref:botbuilder-dialogs.Prompt.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.DateTimePrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. @@ -363,7 +357,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Prompt.repromptDialog](xref:botbuilder-dialogs.Prompt.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.DateTimePrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -376,12 +370,11 @@ inheritedMethods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -396,7 +389,9 @@ inheritedMethods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.resumeDialog](xref:botbuilder-dialogs.Prompt.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimeResolution.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimeResolution.yml index 7a972e94..8545e026 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimeResolution.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DateTimeResolution.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Result returned by the `DateTimePrompt`. fullName: DateTimeResolution remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: TIMEX expression representing ambiguity of the recognized time. fullName: timex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timex: string' @@ -32,7 +30,6 @@ properties: 'timerange', 'datetimerange', 'duration', or 'set'. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -49,7 +46,6 @@ properties: of the [timex](#timex). fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Dialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Dialog.yml index 2986547a..15f39bb6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Dialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Dialog.yml @@ -5,26 +5,23 @@ package: botbuilder-dialogs summary: Defines the core behavior for all dialogs. fullName: Dialog remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: Dialog(string) + - name: Dialog(string) uid: botbuilder-dialogs.Dialog.constructor package: botbuilder-dialogs summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Dialog(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: EndOfTurn uid: botbuilder-dialogs.Dialog.EndOfTurn @@ -37,22 +34,18 @@ properties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> - name: id uid: botbuilder-dialogs.Dialog.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -62,12 +55,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.Dialog.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -77,24 +67,23 @@ properties: for logging. type: BotTelemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.Dialog.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): Dialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: <O> inheritanceDescription: >- Inherited From [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) @@ -103,10 +92,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -114,16 +104,17 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) methods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs.Dialog.beginDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, starts the dialog.' + summary: When overridden in a derived class, starts the dialog. remarks: >- Derived dialogs must override this method. @@ -150,27 +141,27 @@ methods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: description: The context for the current dialog turn. - id: options type: O - description: | - Optional. Arguments to use when the dialog starts. + description: Optional. Arguments to use when the dialog starts. return: description: '' - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.Dialog.continueDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -194,19 +185,21 @@ methods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<> - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: >- + Promise<<any>> + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.Dialog.endDialog package: botbuilder-dialogs summary: >- @@ -235,23 +228,21 @@ methods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -277,7 +268,6 @@ methods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -286,14 +276,13 @@ methods: Unique string which should only change when dialog has changed in a way that should restart the dialog. type: string - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.Dialog.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -311,10 +300,10 @@ methods: True if the event is handled by the current dialog and bubbling should stop. type: Promise<boolean> - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.Dialog.repromptDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -335,24 +324,22 @@ methods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: - description: | - Current state information for this dialog. + type: <any> + description: Current state information for this dialog. return: description: '' type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.Dialog.resumeDialog package: botbuilder-dialogs summary: >- @@ -392,12 +379,11 @@ methods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: @@ -409,9 +395,10 @@ methods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogClassMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogClassMemoryScope.yml index 6d986336..d67414bb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogClassMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogClassMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: DialogClassMemoryScope maps "dialogClass" -> dc.parent.activeDialog.properties fullName: DialogClassMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: [DialogClassMemoryScope](xref:botbuilder-dialogs.DialogClassMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new DialogClassMemoryScope() @@ -30,7 +28,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -39,14 +36,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [MemoryScope.includeInSnapshot](xref:botbuilder-dialogs.MemoryScope.includeInSnapshot) + [ClassMemoryScope.includeInSnapshot](xref:botbuilder-dialogs.ClassMemoryScope.includeInSnapshot) - name: name uid: botbuilder-dialogs.DialogClassMemoryScope.name package: botbuilder-dialogs summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -55,34 +51,31 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MemoryScope.name](xref:botbuilder-dialogs.MemoryScope.name) + [ClassMemoryScope.name](xref:botbuilder-dialogs.ClassMemoryScope.name) inheritedMethods: - name: delete(DialogContext) uid: botbuilder-dialogs.DialogClassMemoryScope.delete package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [MemoryScope.delete](xref:botbuilder-dialogs.MemoryScope.delete) + [ClassMemoryScope.delete](xref:botbuilder-dialogs.ClassMemoryScope.delete) - name: getMemory(DialogContext) uid: botbuilder-dialogs.DialogClassMemoryScope.getMemory package: botbuilder-dialogs summary: Gets the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -103,47 +96,42 @@ inheritedMethods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [MemoryScope.load](xref:botbuilder-dialogs.MemoryScope.load) + [ClassMemoryScope.load](xref:botbuilder-dialogs.ClassMemoryScope.load) - name: saveChanges(DialogContext) uid: botbuilder-dialogs.DialogClassMemoryScope.saveChanges package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [MemoryScope.saveChanges](xref:botbuilder-dialogs.MemoryScope.saveChanges) - - name: 'setMemory(DialogContext, object)' + [ClassMemoryScope.saveChanges](xref:botbuilder-dialogs.ClassMemoryScope.saveChanges) + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.DialogClassMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(_dc: DialogContext, _memory: object)' @@ -153,9 +141,8 @@ inheritedMethods: description: Current dialog context - id: _memory type: object - description: | - memory to assign + description: memory to assign inheritanceDescription: >- Inherited From - [MemoryScope.setMemory](xref:botbuilder-dialogs.MemoryScope.setMemory) + [ClassMemoryScope.setMemory](xref:botbuilder-dialogs.ClassMemoryScope.setMemory) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogConfiguration.yml index 7fdfd385..fd6e94e5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: DialogConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Static id of the dialog. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -28,7 +26,6 @@ properties: summary: Telemetry client the dialog should use. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContainer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContainer.yml index 598c4025..e4f425c4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContainer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContainer.yml @@ -5,26 +5,23 @@ package: botbuilder-dialogs summary: A container for a set of Dialogs. fullName: DialogContainer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: DialogContainer(string) + - name: DialogContainer(string) uid: botbuilder-dialogs.DialogContainer.constructor package: botbuilder-dialogs summary: >- Creates a new instance of the [Dialog](xref:botbuilder-dialogs.Dialog) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DialogContainer(dialogId?: string)' parameters: - id: dialogId type: string - description: | - Optional. unique ID of the dialog. + description: Optional. unique ID of the dialog. properties: - name: dialogs uid: botbuilder-dialogs.DialogContainer.dialogs @@ -32,7 +29,6 @@ properties: summary: The containers dialog set. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -42,12 +38,9 @@ properties: - name: id uid: botbuilder-dialogs.DialogContainer.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -57,13 +50,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.DialogContainer.telemetryClient package: botbuilder-dialogs - summary: |- - Set the telemetry client, and also apply it to all child dialogs. - Future dialogs added to the component will also inherit this client. - Get the current telemetry client. + summary: Get the current telemetry client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -84,21 +73,20 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, O)' + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs.DialogContainer.beginDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, starts the dialog.' + summary: When overridden in a derived class, starts the dialog. remarks: >- Derived dialogs must override this method. @@ -125,51 +113,50 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: description: The context for the current dialog turn. - id: options type: O - description: | - Optional. Arguments to use when the dialog starts. + description: Optional. Arguments to use when the dialog starts. return: description: '' - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Dialog.beginDialog](xref:botbuilder-dialogs.Dialog.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.DialogContainer.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): DialogContainer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: <O> inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Dialog.configure](xref:botbuilder-dialogs.Dialog.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.DialogContainer.continueDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, continues the dialog.' + summary: When overridden in a derived class, continues the dialog. remarks: >- Derived dialogs that support multiple-turn conversations should override this method. @@ -193,22 +180,24 @@ inheritedMethods: - [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: - description: | - The context for the current dialog turn. + description: The context for the current dialog turn. return: description: A promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Dialog.continueDialog](xref:botbuilder-dialogs.Dialog.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.DialogContainer.endDialog package: botbuilder-dialogs summary: >- @@ -237,23 +226,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -265,10 +252,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -276,11 +264,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Dialog.getConverter](xref:botbuilder-dialogs.Dialog.getConverter) - name: getVersion() uid: botbuilder-dialogs.DialogContainer.getVersion package: botbuilder-dialogs @@ -303,7 +292,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -315,10 +303,10 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.DialogContainer.repromptDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -339,27 +327,25 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: - description: | - Current state information for this dialog. + type: <any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [Dialog.repromptDialog](xref:botbuilder-dialogs.Dialog.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.DialogContainer.resumeDialog package: botbuilder-dialogs summary: >- @@ -399,12 +385,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: @@ -416,11 +401,12 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Dialog.resumeDialog](xref:botbuilder-dialogs.Dialog.resumeDialog) @@ -430,12 +416,11 @@ methods: package: botbuilder-dialogs summary: Creates an inner dialog context for the containers active child. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function createChildContext(dc: DialogContext): DialogContext | - undefined + function createChildContext(dc: DialogContext): undefined | + DialogContext parameters: - id: dc type: @@ -444,31 +429,29 @@ methods: description: >- A new dialog context for the active child or `undefined` if there is no active child. - type: | undefined + type: undefined | - name: findDialog(string) uid: botbuilder-dialogs.DialogContainer.findDialog package: botbuilder-dialogs summary: Finds a child dialog that was previously added to the container. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function findDialog(dialogId: string): Dialog | undefined' + content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog to lookup. return: description: The Dialog if found; otherwise null. - type: | undefined - - name: 'onDialogEvent(DialogContext, DialogEvent)' + type: undefined | <{}> + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.DialogContainer.onDialogEvent package: botbuilder-dialogs summary: |- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContext.yml index 34a4e9c2..355de0f4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContext.yml @@ -31,11 +31,10 @@ remarks: >- const result = await dc.continueDialog(); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'DialogContext(DialogSet, DialogContext, DialogState)' + - name: DialogContext(DialogSet, DialogContext, DialogState) uid: botbuilder-dialogs.DialogContext.constructor_1 package: botbuilder-dialogs summary: >- @@ -44,7 +43,6 @@ constructors: remarks: >- Passing in a [DialogContext](xref:botbuilder-dialogs.DialogContext) instance will clone the dialog context. - isPreview: false isDeprecated: false syntax: content: >- @@ -59,14 +57,14 @@ constructors: - id: contextOrDC type: description: >- - The [TurnContext](xref:botbuilder-core.TurnContext) object for the - current turn of the bot. + The [DialogContext](xref:botbuilder-dialogs.DialogContext) object + for the current turn of the bot. - id: state type: description: >- The state object to use to read and write [DialogState](xref:botbuilder-dialogs.DialogState) to storage. - - name: 'DialogContext(DialogSet, TurnContext, DialogState)' + - name: DialogContext(DialogSet, TurnContext, DialogState) uid: botbuilder-dialogs.DialogContext.constructor package: botbuilder-dialogs summary: >- @@ -75,7 +73,6 @@ constructors: remarks: >- Passing in a [DialogContext](xref:botbuilder-dialogs.DialogContext) instance will clone the dialog context. - isPreview: false isDeprecated: false syntax: content: >- @@ -104,37 +101,36 @@ properties: summary: '' fullName: activeDialog remarks: '' - isPreview: false isDeprecated: false syntax: - content: DialogInstance | undefined activeDialog + content: undefined | DialogInstance activeDialog return: description: >- The state information for the dialog on the top of the dialog stack, or `undefined` if the stack is empty. - type: | undefined + type: >- + undefined | <any> - name: child uid: botbuilder-dialogs.DialogContext.child package: botbuilder-dialogs summary: '' fullName: child remarks: '' - isPreview: false isDeprecated: false syntax: - content: DialogContext | undefined child + content: undefined | DialogContext child return: description: Dialog context for child if the active dialog is a container. - type: | undefined + type: undefined | - name: context uid: botbuilder-dialogs.DialogContext.context package: botbuilder-dialogs summary: Gets the context object for the turn. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: TurnContext' @@ -147,9 +143,7 @@ properties: summary: '' fullName: dialogManager remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: This property serves no function. + isDeprecated: false syntax: content: DialogManager dialogManager return: @@ -161,7 +155,6 @@ properties: summary: Gets the dialogs that can be called directly from this context. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -184,20 +177,18 @@ properties: in this dialog context, it searches in its parent dialog context, and so on. - isPreview: false isDeprecated: false syntax: - content: 'parent: DialogContext | undefined' + content: 'parent: undefined | DialogContext' return: description: '' - type: | undefined + type: undefined | - name: services uid: botbuilder-dialogs.DialogContext.services package: botbuilder-dialogs summary: Gets the services collection which is contextual to this dialog context. fullName: services remarks: '' - isPreview: false isDeprecated: false syntax: content: 'services: TurnContextStateCollection' @@ -210,20 +201,18 @@ properties: summary: Gets the current dialog stack. fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stack: DialogInstance[]' + content: 'stack: DialogInstance[]' return: description: '' - type: '[]' + type: <any>[] - name: state uid: botbuilder-dialogs.DialogContext.state package: botbuilder-dialogs summary: Gets the DialogStateManager which manages view of all memory scopes. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: DialogStateManager' @@ -231,7 +220,7 @@ properties: description: '' type: methods: - - name: 'beginDialog(string, object)' + - name: beginDialog(string, object) uid: botbuilder-dialogs.DialogContext.beginDialog package: botbuilder-dialogs summary: |- @@ -274,12 +263,11 @@ methods: - [replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - [Dialog.beginDialog](xref:botbuilder-dialogs.Dialog.beginDialog) - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dialogId: string, options?: object): - Promise + Promise> parameters: - id: dialogId type: string @@ -289,11 +277,13 @@ methods: description: Optional. Arguments to pass into the dialog when it starts. return: description: a promise resolving to the dialog turn result. - type: Promise<> - - name: 'cancelAllDialogs(boolean, string, any)' + type: >- + Promise<<any>> + - name: cancelAllDialogs(boolean, string, any) uid: botbuilder-dialogs.DialogContext.cancelAllDialogs package: botbuilder-dialogs - summary: 'Cancels all dialogs on the dialog stack, and clears stack.' + summary: Cancels all dialogs on the dialog stack, and clears stack. remarks: >- This calls each dialog's [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) method before @@ -326,12 +316,11 @@ methods: **See also** - [endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function cancelAllDialogs(cancelParents?: boolean, eventName?: string, - eventValue?: any): Promise + eventValue?: any): Promise> parameters: - id: cancelParents type: boolean @@ -347,7 +336,9 @@ methods: description: Optional. Value to pass along with custom cancellation event. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog() uid: botbuilder-dialogs.DialogContext.continueDialog package: botbuilder-dialogs @@ -386,21 +377,21 @@ methods: } ``` - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(): Promise' + content: 'function continueDialog(): Promise>' return: description: a promise resolving to the dialog turn result. - type: Promise<> - - name: 'emitEvent(string, any, boolean, boolean)' + type: >- + Promise<<any>> + - name: emitEvent(string, any, boolean, boolean) uid: botbuilder-dialogs.DialogContext.emitEvent package: botbuilder-dialogs summary: Searches for a dialog with a given ID. remarks: >- Emits a named event for the current dialog, or someone who started it, to handle. - isPreview: false isDeprecated: false syntax: content: >- @@ -476,10 +467,9 @@ methods: - [replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) - isPreview: false isDeprecated: false syntax: - content: 'function endDialog(result?: any): Promise' + content: 'function endDialog(result?: any): Promise>' parameters: - id: result type: any @@ -490,7 +480,9 @@ methods: the bot's turn handler. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> - name: findDialog(string) uid: botbuilder-dialogs.DialogContext.findDialog package: botbuilder-dialogs @@ -508,30 +500,28 @@ methods: - [dialogs](xref:botbuilder-dialogs.DialogContext.dialogs) - [parent](xref:botbuilder-dialogs.DialogContext.parent) - isPreview: false isDeprecated: false syntax: - content: 'function findDialog(dialogId: string): Dialog | undefined' + content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog to search for. return: description: The dialog for the provided ID. - type: | undefined + type: undefined | <{}> - name: getLocale() uid: botbuilder-dialogs.DialogContext.getLocale package: botbuilder-dialogs summary: Obtain the CultureInfo in DialogContext. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLocale(): string' return: description: a locale string. type: string - - name: 'prompt(string, string | Partial | PromptOptions)' + - name: prompt(string, string | Partial | PromptOptions) uid: botbuilder-dialogs.DialogContext.prompt package: botbuilder-dialogs summary: >- @@ -551,12 +541,11 @@ methods: quit?`); ``` - isPreview: false isDeprecated: false syntax: content: >- function prompt(dialogId: string, promptOrOptions: string | - Partial | PromptOptions): Promise + Partial | PromptOptions): Promise> parameters: - id: dialogId type: string @@ -571,10 +560,12 @@ methods: the object with which to format the prompt dialog. return: description: '' - type: Promise<> + type: >- + Promise<<any>> - name: >- - prompt(string, string | Partial | PromptOptions, string | - Choice[]) + prompt(string, string | Partial | PromptOptions, (string | + Choice)[]) uid: botbuilder-dialogs.DialogContext.prompt_1 package: botbuilder-dialogs summary: >- @@ -594,13 +585,12 @@ methods: quit?`); ``` - isPreview: false isDeprecated: false syntax: content: >- function prompt(dialogId: string, promptOrOptions: string | - Partial | PromptOptions, choices: string | Choice[]): - Promise + Partial | PromptOptions, choices: (string | Choice)[]): + Promise> parameters: - id: dialogId type: string @@ -617,14 +607,16 @@ methods: the object with which to format the prompt dialog. - id: choices - type: 'string | []' + type: (string | )[] description: |- Optional. Array of choices for the user to choose from, for use with a [ChoicePrompt](xref:botbuilder-dialogs.ChoicePrompt). return: description: '' - type: Promise<> - - name: 'replaceDialog(string, object)' + type: >- + Promise<<any>> + - name: replaceDialog(string, object) uid: botbuilder-dialogs.DialogContext.replaceDialog package: botbuilder-dialogs summary: Ends the active dialog and starts a new dialog in its place. @@ -650,12 +642,11 @@ methods: - [beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) - [endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function replaceDialog(dialogId: string, options?: object): - Promise + Promise> parameters: - id: dialogId type: string @@ -665,7 +656,9 @@ methods: description: Optional. Arguments to pass into the new dialog when it starts. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> - name: repromptDialog() uid: botbuilder-dialogs.DialogContext.repromptDialog package: botbuilder-dialogs @@ -682,7 +675,6 @@ methods: await dc.repromptDialog(); ``` - isPreview: false isDeprecated: false syntax: content: 'function repromptDialog(): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextError.yml index 3f39a4fb..10fd34f8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextError.yml @@ -2,32 +2,29 @@ name: DialogContextError uid: botbuilder-dialogs.DialogContextError package: botbuilder-dialogs -summary: 'An Error that includes extra dialog context, including the dialog stack.' +summary: An Error that includes extra dialog context, including the dialog stack. fullName: DialogContextError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DialogContextError(Error | string, DialogContext)' + - name: DialogContextError(string | Error, DialogContext) uid: botbuilder-dialogs.DialogContextError.constructor package: botbuilder-dialogs summary: Construct a DialogError. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new DialogContextError(error: Error | string, dialogContext: + new DialogContextError(error: string | Error, dialogContext: DialogContext) parameters: - id: error - type: Error | string + type: string | Error description: Source error or error message. - id: dialogContext type: - description: | - Dialog context that is the source of the error. + description: Dialog context that is the source of the error. properties: - name: dialogContext uid: botbuilder-dialogs.DialogContextError.dialogContext @@ -35,41 +32,28 @@ properties: summary: Represents the state of a dialog when an error occurred. fullName: dialogContext remarks: '' - isPreview: false isDeprecated: false syntax: content: >- dialogContext: { activeDialog?: string, parent?: string, stack: - DialogInstance[] } + DialogInstance[] } return: description: '' - type: '{ activeDialog?: string, parent?: string, stack: DialogInstance[] }' + type: >- + { activeDialog?: string, parent?: string, stack: + DialogInstance<any>[] } - name: error uid: botbuilder-dialogs.DialogContextError.error package: botbuilder-dialogs summary: '' fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'error: Error | string' + content: 'error: string | Error' return: description: '' - type: Error | string - - name: Error - uid: botbuilder-dialogs.DialogContextError.Error - package: botbuilder-dialogs - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor + type: string | Error inheritedProperties: - name: message uid: botbuilder-dialogs.DialogContextError.message @@ -77,7 +61,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -91,7 +74,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -99,13 +81,28 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: botbuilder-dialogs.DialogContextError.prepareStackTrace + package: botbuilder-dialogs + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: botbuilder-dialogs.DialogContextError.stack package: botbuilder-dialogs summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -113,4 +110,36 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: botbuilder-dialogs.DialogContextError.stackTraceLimit + package: botbuilder-dialogs + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: botbuilder-dialogs.DialogContextError.captureStackTrace + package: botbuilder-dialogs + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace extends: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextMemoryScope.yml index 6bafd8f3..a2c83653 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogContextMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '`DialogContextMemoryScope` maps ''dialogcontext'' -> properties.' fullName: DialogContextMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-dialogs summary: Initializes a new instance of the `DialogContextMemoryScope` class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new DialogContextMemoryScope() @@ -27,7 +25,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -43,7 +40,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -59,15 +55,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -79,15 +73,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -99,27 +91,24 @@ inheritedMethods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [MemoryScope.saveChanges](xref:botbuilder-dialogs.MemoryScope.saveChanges) - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.DialogContextMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(_dc: DialogContext, _memory: object)' @@ -129,8 +118,7 @@ inheritedMethods: description: Current dialog context - id: _memory type: object - description: | - memory to assign + description: memory to assign inheritanceDescription: >- Inherited From [MemoryScope.setMemory](xref:botbuilder-dialogs.MemoryScope.setMemory) @@ -140,7 +128,6 @@ methods: package: botbuilder-dialogs summary: Gets the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -152,5 +139,5 @@ methods: description: The `DialogContext` object for this turn. return: description: Memory for the scope. - type: 'Record<"stack" | "activeDialog" | "parent", unknown>' + type: Record<"stack" | "activeDialog" | "parent", unknown> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogDependencies.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogDependencies.yml index 7f8bd0d9..11d49995 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogDependencies.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogDependencies.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: DialogDependencies remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -16,10 +15,9 @@ methods: Returns a dialogs child dialog dependencies so they can be added to a containers dialog set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDependencies(): Dialog[]' + content: 'function getDependencies(): Dialog<{}>[]' return: description: '' - type: '[]' + type: <{}>[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvent.yml index 7afa7a31..65fdbaa7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvent.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: DialogEvent remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: `DialogContext`. fullName: bubble remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bubble: boolean' @@ -30,7 +28,6 @@ properties: summary: Name of the event being raised. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -43,7 +40,6 @@ properties: summary: Optional. Value associated with the event. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvents.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvents.yml index e06b7722..f9827370 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvents.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogEvents.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Represents the events related to the "lifecycle" of the dialog. fullName: DialogEvents remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: reprocess an activity.) fullName: activityReceived remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static activityReceived: "activityReceived" = "activityReceived"' @@ -32,7 +30,6 @@ properties: been called. fullName: beginDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static beginDialog: "beginDialog" = "beginDialog"' @@ -45,7 +42,6 @@ properties: summary: Event fired when a dialog is being canceled. fullName: cancelDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static cancelDialog: "cancelDialog" = "cancelDialog"' @@ -58,7 +54,6 @@ properties: summary: Event fired when there was an exception thrown in the system. fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static error: "error" = "error"' @@ -71,7 +66,6 @@ properties: summary: Event fired when `DialogContext.repromptDialog()` is called. fullName: repromptDialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static repromptDialog: "repromptDialog" = "repromptDialog"' @@ -86,7 +80,6 @@ properties: the execution of dialogs between turns. fullName: versionChanged remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static versionChanged: "versionChanged" = "versionChanged"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogInstance.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogInstance.yml index cea71683..0c150f5c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogInstance.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogInstance.yml @@ -23,7 +23,6 @@ remarks: >- - [DialogSet](xref:botbuilder-dialogs.DialogSet) - [Dialog](xref:botbuilder-dialogs.Dialog) -isPreview: false isDeprecated: false type: interface properties: @@ -44,7 +43,6 @@ properties: - [DialogState](xref:botbuilder-dialogs.DialogState) - [DialogSet](xref:botbuilder-dialogs.DialogSet) - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -57,7 +55,6 @@ properties: summary: The state information for this instance of this dialog. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: T' @@ -72,7 +69,6 @@ properties: instance was started. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManager.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManager.yml index 5f2e3f79..063bea41 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManager.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManager.yml @@ -5,29 +5,27 @@ package: botbuilder-dialogs summary: Class which runs the dialog system. fullName: DialogManager remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: This class will be deprecated. type: class constructors: - - name: 'DialogManager(Dialog, string)' + - name: DialogManager(Dialog<{}>, string) uid: botbuilder-dialogs.DialogManager.constructor package: botbuilder-dialogs summary: >- Creates an instance of the [DialogSet](xref:botbuilder-dialogs.DialogManager) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new DialogManager(rootDialog?: Dialog, dialogStateProperty?: string)' + content: 'new DialogManager(rootDialog?: Dialog<{}>, dialogStateProperty?: string)' parameters: - id: rootDialog - type: - description: 'Optional, root [Dialog](xref:botbuilder-dialogs.Dialog) to use.' + type: <{}> + description: Optional, root [Dialog](xref:botbuilder-dialogs.Dialog) to use. - id: dialogStateProperty type: string - description: > + description: >- Optional, alternate name for the dialogState property. (Default is "DialogStateProperty") properties: @@ -37,7 +35,6 @@ properties: summary: Bots persisted conversation state. fullName: conversationState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationState: ConversationState' @@ -50,7 +47,6 @@ properties: summary: Global dialogs that you want to have be callable. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -65,7 +61,6 @@ properties: after. fullName: expireAfter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expireAfter?: number' @@ -80,7 +75,6 @@ properties: of each turn. fullName: initialTurnState remarks: '' - isPreview: false isDeprecated: false syntax: content: TurnContextStateCollection initialTurnState @@ -90,18 +84,15 @@ properties: - name: rootDialog uid: botbuilder-dialogs.DialogManager.rootDialog package: botbuilder-dialogs - summary: |- - Root dialog to start from [onTurn()](#onturn) method. - Gets the root [Dialog](xref:botbuilder-dialogs.Dialog) ID. + summary: Gets the root [Dialog](xref:botbuilder-dialogs.Dialog) ID. fullName: rootDialog remarks: '' - isPreview: false isDeprecated: false syntax: - content: Dialog rootDialog + content: Dialog<{}> rootDialog return: - description: 'The root [Dialog](xref:botbuilder-dialogs.Dialog) ID.' - type: + description: The root [Dialog](xref:botbuilder-dialogs.Dialog) ID. + type: <{}> - name: stateConfiguration uid: botbuilder-dialogs.DialogManager.stateConfiguration package: botbuilder-dialogs @@ -110,7 +101,6 @@ properties: bot. fullName: stateConfiguration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stateConfiguration?: DialogStateManagerConfiguration' @@ -123,7 +113,6 @@ properties: summary: Optional. Bots persisted user state. fullName: userState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userState?: UserState' @@ -136,10 +125,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -147,8 +137,9 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) @@ -158,10 +149,11 @@ methods: package: botbuilder-dialogs summary: Set configuration settings. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Partial): this' + content: >- + function configure(config: Partial): + DialogManager parameters: - id: config type: >- @@ -172,7 +164,7 @@ methods: description: >- The cofigured [DialogManager](xref:botbuilder-dialogs.DialogManager) context. - type: this + type: - name: onTurn(TurnContext) uid: botbuilder-dialogs.DialogManager.onTurn package: botbuilder-dialogs @@ -180,7 +172,6 @@ methods: Runs dialog system in the context of a [TurnContext](xref:botbuilder-core.TurnContext). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function onTurn(context: TurnContext): Promise' @@ -188,8 +179,8 @@ methods: - id: context type: TurnContext description: >- - (xref:botbuilder-core.TurnContext) for the current turn of - conversation with the user. + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation with the user. return: description: Result of running the logic against the activity. type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerConfiguration.yml index 75c7c262..3202df27 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: DialogManagerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: State property used to persist the bots dialog stack. fullName: conversationState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationState: BotState' @@ -30,7 +28,6 @@ properties: after. fullName: expireAfter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expireAfter?: number' @@ -40,16 +37,15 @@ properties: - name: rootDialog uid: botbuilder-dialogs.DialogManagerConfiguration.rootDialog package: botbuilder-dialogs - summary: 'Root dialog to start from [onTurn()](#onturn) method.' + summary: Root dialog to start from [onTurn()](#onturn) method. fullName: rootDialog remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'rootDialog: Dialog' + content: 'rootDialog: Dialog<{}>' return: description: '' - type: + type: <{}> - name: stateConfiguration uid: botbuilder-dialogs.DialogManagerConfiguration.stateConfiguration package: botbuilder-dialogs @@ -58,7 +54,6 @@ properties: bot. fullName: stateConfiguration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stateConfiguration?: DialogStateManagerConfiguration' @@ -71,7 +66,6 @@ properties: summary: Optional. Bots persisted user state. fullName: userState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userState?: UserState' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerResult.yml index aa9cba88..14a29b17 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogManagerResult.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: DialogManagerResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: turnResult remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'turnResult: DialogTurnResult' + content: 'turnResult: DialogTurnResult' return: description: '' - type: + type: <any> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogMemoryScope.yml index c6bb92ca..68eb5505 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogMemoryScope.yml @@ -7,7 +7,6 @@ summary: >- dc.activeDialog.state fullName: DialogMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: Initializes a new instance of the [DialogMemoryScope](xref:botbuilder-dialogs.DialogMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new DialogMemoryScope() @@ -31,7 +29,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -47,7 +44,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -63,15 +59,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -83,15 +77,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -103,15 +95,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -124,7 +114,6 @@ methods: package: botbuilder-dialogs summary: Gets the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -137,12 +126,11 @@ methods: return: description: The memory for the scope. type: object - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.DialogMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(dc: DialogContext, memory: object)' @@ -154,6 +142,5 @@ methods: for this turn. - id: memory type: object - description: | - Memory object to set for the scope. + description: Memory object to set for the scope. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogPath.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogPath.yml index 278b4b41..6d3dc5e9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogPath.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogPath.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Defines path for available dialogs. fullName: DialogPath remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: defaultOperation remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +28,6 @@ properties: summary: '' fullName: eventCounter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static eventCounter: "dialog.eventCounter" = "dialog.eventCounter"' @@ -43,7 +40,6 @@ properties: summary: '' fullName: expectedProperties remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -58,7 +54,6 @@ properties: summary: '' fullName: lastEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static lastEvent: "dialog.lastEvent" = "dialog.lastEvent"' @@ -71,7 +66,6 @@ properties: summary: '' fullName: lastIntent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static lastIntent: "dialog.lastIntent" = "dialog.lastIntent"' @@ -84,7 +78,6 @@ properties: summary: '' fullName: lastTriggerEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -99,7 +92,6 @@ properties: summary: '' fullName: requiredProperties remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,7 +106,6 @@ properties: summary: '' fullName: retries remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static retries: "dialog.retries" = "dialog.retries"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogReason.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogReason.yml index b7529ce8..12ee0a7b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogReason.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogReason.yml @@ -19,7 +19,6 @@ remarks: >- - [DialogSet](xref:botbuilder-dialogs.DialogSet) - [Dialog](xref:botbuilder-dialogs.Dialog) -isPreview: false isDeprecated: false fields: - name: beginCalled diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogSet.yml index 8d06ce50..5946903f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogSet.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogSet.yml @@ -75,7 +75,6 @@ remarks: >- } ``` -isPreview: false isDeprecated: false type: class constructors: @@ -98,7 +97,6 @@ constructors: const dc = new DialogContext(dialogs, turnContext, state); ``` - isPreview: false isDeprecated: false syntax: content: 'new DialogSet(dialogState?: StatePropertyAccessor)' @@ -107,8 +105,7 @@ constructors: type: >- StatePropertyAccessor<> - description: | - (Optional) state property used to persist the sets dialog stack. + description: (Optional) state property used to persist the sets dialog stack. properties: - name: telemetryClient uid: botbuilder-dialogs.DialogSet.telemetryClient @@ -116,14 +113,8 @@ properties: summary: >- Set the telemetry client for this dialog set and apply it to all current dialogs. - - Set the telemetry client for this dialog set and apply it to all current - dialogs. - - Future dialogs added to the set will also inherit this client. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -148,10 +139,9 @@ methods: one having an id of "duplicate2". - isPreview: false isDeprecated: false syntax: - content: 'function add(dialog: T): this' + content: 'function add(dialog: T): DialogSet' parameters: - id: dialog type: T @@ -162,7 +152,7 @@ methods: to each dialog. return: description: The dialog set after the operation is complete. - type: this + type: - name: createContext(TurnContext) uid: botbuilder-dialogs.DialogSet.createContext package: botbuilder-dialogs @@ -170,7 +160,6 @@ methods: Creates a dialog context which can be used to work with the dialogs in the set. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createContext(context: TurnContext): Promise' @@ -184,36 +173,34 @@ methods: - name: find(string) uid: botbuilder-dialogs.DialogSet.find package: botbuilder-dialogs - summary: 'Finds a dialog that was previously added to the set using [add()](#add).' + summary: Finds a dialog that was previously added to the set using [add()](#add). remarks: |- This example finds a dialog named "greeting": ```JavaScript const dialog = dialogs.find('greeting'); ``` - isPreview: false isDeprecated: false syntax: - content: 'function find(dialogId: string): Dialog | undefined' + content: 'function find(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog or prompt to lookup. return: description: The dialog if found; otherwise undefined. - type: | undefined + type: undefined | <{}> - name: getDialogs() uid: botbuilder-dialogs.DialogSet.getDialogs package: botbuilder-dialogs summary: Gets the Dialogs of the set. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getDialogs(): Dialog[]' + content: 'function getDialogs(): Dialog<{}>[]' return: - description: 'An array of [Dialog](xref:botbuilder-dialogs.Dialog).' - type: '[]' + description: An array of [Dialog](xref:botbuilder-dialogs.Dialog). + type: <{}>[] - name: getVersion() uid: botbuilder-dialogs.DialogSet.getVersion package: botbuilder-dialogs @@ -221,7 +208,6 @@ methods: remarks: >- This hash is persisted to state storage and used to detect changes to a dialog set. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogState.yml index 546ed5e5..74e0133e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogState.yml @@ -21,7 +21,6 @@ remarks: >- [Dialogs library](https://docs.microsoft.com/azure/bot-service/bot-builder-concept-dialog). -isPreview: false isDeprecated: false type: interface properties: @@ -33,10 +32,9 @@ properties: [Dialog](xref:botbuilder-dialogs.Dialog) on the stack. fullName: dialogStack remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'dialogStack: DialogInstance[]' + content: 'dialogStack: DialogInstance[]' return: description: '' - type: '[]' + type: <any>[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManager.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManager.yml index 7b469cd4..f633fb60 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManager.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManager.yml @@ -12,18 +12,16 @@ remarks: >- like $foo -> dialog.foo -isPreview: false isDeprecated: false type: class constructors: - - name: 'DialogStateManager(DialogContext, DialogStateManagerConfiguration)' + - name: DialogStateManager(DialogContext, DialogStateManagerConfiguration) uid: botbuilder-dialogs.DialogStateManager.constructor package: botbuilder-dialogs summary: >- Initializes a new instance of the [DialogStateManager](xref:botbuilder-dialogs.DialogStateManager) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -35,8 +33,7 @@ constructors: description: The dialog context for the current turn of the conversation. - id: configuration type: - description: | - Configuration for the dialog state manager. + description: Configuration for the dialog state manager. properties: - name: configuration uid: botbuilder-dialogs.DialogStateManager.configuration @@ -53,7 +50,6 @@ properties: will update the configuration for the entire chain. - isPreview: false isDeprecated: false syntax: content: 'configuration: DialogStateManagerConfiguration' @@ -61,12 +57,11 @@ properties: description: '' type: methods: - - name: 'anyPathChanged(number, string[])' + - name: anyPathChanged(number, string[]) uid: botbuilder-dialogs.DialogStateManager.anyPathChanged package: botbuilder-dialogs summary: Check to see if any path has changed since watermark. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function anyPathChanged(counter: number, paths: string[]): boolean' @@ -75,8 +70,8 @@ methods: type: number description: Time counter to compare to. - id: paths - type: 'string[]' - description: 'Paths from [trackPaths()](#trackpaths) to check.' + type: string[] + description: Paths from [trackPaths()](#trackpaths) to check. return: description: True if any path has changed since counter. type: boolean @@ -85,15 +80,13 @@ methods: package: botbuilder-dialogs summary: Deletes all of the backing memory for a given scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deleteScopesMemory(name: string): Promise' parameters: - id: name type: string - description: | - Name of the scope. + description: Name of the scope. return: description: '' type: Promise<void> @@ -102,35 +95,31 @@ methods: package: botbuilder-dialogs summary: Delete property from memory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deleteValue(pathExpression: string)' parameters: - id: pathExpression type: string - description: | - The leaf property to remove. + description: The leaf property to remove. - name: getMemorySnapshot() uid: botbuilder-dialogs.DialogStateManager.getMemorySnapshot package: botbuilder-dialogs summary: Gets all memory scopes suitable for logging. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemorySnapshot(): object' return: description: Object which represents all memory scopes. type: object - - name: 'getValue(string, T | () => T)' + - name: getValue(string, T | () => T) uid: botbuilder-dialogs.DialogStateManager.getValue package: botbuilder-dialogs summary: Get the value from memory using path expression. remarks: >- This always returns a CLONE of the memory, any modifications to the result will not affect memory. - isPreview: false isDeprecated: false syntax: content: >- @@ -155,24 +144,22 @@ methods: package: botbuilder-dialogs summary: Ensures that all memory scopes have been loaded for the current turn. remarks: This should be called at the beginning of the turn. - isPreview: false isDeprecated: false syntax: content: 'function loadAllScopes(): Promise' return: description: '' type: Promise<void> - - name: 'parsePath(string, boolean)' + - name: parsePath(string, boolean) uid: botbuilder-dialogs.DialogStateManager.parsePath package: botbuilder-dialogs summary: Normalizes the path segments of a passed in path. - remarks: 'A path of `profile.address[0]` will be normalized to `profile.address.0`.' - isPreview: false + remarks: A path of `profile.address[0]` will be normalized to `profile.address.0`. isDeprecated: false syntax: content: >- function parsePath(pathExpression: string, allowNestedPaths?: boolean): - string | number[] + (string | number)[] parameters: - id: pathExpression type: string @@ -184,25 +171,23 @@ methods: empty path to be returned. Defaults to 'true'. return: description: The normalized path. - type: 'string | number[]' + type: (string | number)[] - name: saveAllChanges() uid: botbuilder-dialogs.DialogStateManager.saveAllChanges package: botbuilder-dialogs summary: Saves any changes made to memory scopes. remarks: This should be called at the end of the turn. - isPreview: false isDeprecated: false syntax: content: 'function saveAllChanges(): Promise' return: description: '' type: Promise<void> - - name: 'setValue(string, any)' + - name: setValue(string, any) uid: botbuilder-dialogs.DialogStateManager.setValue package: botbuilder-dialogs summary: Set memory to value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setValue(pathExpression: string, value: any)' @@ -212,30 +197,27 @@ methods: description: Path to memory. - id: value type: any - description: | - Value to set. - - name: 'trackPaths(string[])' + description: Value to set. + - name: trackPaths(string[]) uid: botbuilder-dialogs.DialogStateManager.trackPaths package: botbuilder-dialogs summary: Track when specific paths are changed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trackPaths(paths: string[]): string[]' parameters: - id: paths - type: 'string[]' + type: string[] description: Paths to track. return: - description: 'Normalized paths to pass to [anyPathChanged()](#anypathchanged).' - type: 'string[]' + description: Normalized paths to pass to [anyPathChanged()](#anypathchanged). + type: string[] - name: transformPath(string) uid: botbuilder-dialogs.DialogStateManager.transformPath package: botbuilder-dialogs summary: Transform the path using the registered path transformers. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(pathExpression: string): string' @@ -251,7 +233,6 @@ methods: package: botbuilder-dialogs summary: Gets the version number. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function version(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManagerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManagerConfiguration.yml index 261edef4..e464564b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManagerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogStateManagerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: DialogStateManagerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,23 +14,21 @@ properties: summary: List of the supported memory scopes. fullName: memoryScopes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'memoryScopes: MemoryScope[]' return: description: '' - type: '[]' + type: [] - name: pathResolvers uid: botbuilder-dialogs.DialogStateManagerConfiguration.pathResolvers package: botbuilder-dialogs summary: List of path resolvers used to evaluate memory paths. fullName: pathResolvers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pathResolvers: PathResolver[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnResult.yml index 9807f41c..bb14a17c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnResult.yml @@ -37,7 +37,6 @@ remarks: >- - [DialogSet](xref:botbuilder-dialogs.DialogSet) - [Dialog](xref:botbuilder-dialogs.Dialog) -isPreview: false isDeprecated: false type: interface properties: @@ -51,7 +50,6 @@ properties: any further processing. fullName: parentEnded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'parentEnded?: boolean' @@ -61,14 +59,13 @@ properties: - name: result uid: botbuilder-dialogs.DialogTurnResult.result package: botbuilder-dialogs - summary: 'The result, if any, returned by the last dialog on the stack.' + summary: The result, if any, returned by the last dialog on the stack. fullName: result remarks: |- A result value is available only if the stack is now empty, the last dialog on the stack completed normally, and the last dialog returned a result to the dialog context. - isPreview: false isDeprecated: false syntax: content: 'result?: T' @@ -81,7 +78,6 @@ properties: summary: The state of the dialog stack after a dialog context's attempt. fullName: status remarks: '' - isPreview: false isDeprecated: false syntax: content: 'status: DialogTurnStatus' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStateConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStateConstants.yml index 804a7666..cb78b3a0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStateConstants.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStateConstants.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Defines dialog turn state constants. fullName: DialogTurnStateConstants remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: configuration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static configuration: symbol' @@ -28,7 +26,6 @@ properties: summary: '' fullName: dialogManager remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static dialogManager: symbol' @@ -41,7 +38,6 @@ properties: summary: '' fullName: queueStorage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static queueStorage: symbol' @@ -54,7 +50,6 @@ properties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static telemetryClient: symbol' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStatus.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStatus.yml index 38def896..370abc53 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStatus.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogTurnStatus.yml @@ -2,12 +2,13 @@ name: DialogTurnStatus uid: botbuilder-dialogs.DialogTurnStatus package: botbuilder-dialogs -summary: > +summary: >- Represents the state of the dialog stack after a dialog context attempts to begin, continue, or otherwise manipulate one or more dialogs. + **See also** - [DialogContext](xref:botbuilder-dialogs.DialogContext) @@ -15,7 +16,6 @@ summary: > - [Dialog](xref:botbuilder-dialogs.Dialog) fullName: DialogTurnStatus remarks: '' -isPreview: false isDeprecated: false fields: - name: cancelled @@ -29,7 +29,7 @@ fields: - name: completeAndWait uid: botbuilder-dialogs.DialogTurnStatus.completeAndWait package: botbuilder-dialogs - summary: 'Current dialog completed successfully, but turn should end.' + summary: Current dialog completed successfully, but turn should end. - name: empty uid: botbuilder-dialogs.DialogTurnStatus.empty package: botbuilder-dialogs diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsBotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsBotComponent.yml index 080394b7..d0b0ab2f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsBotComponent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsBotComponent.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Bot component for bot Dialogs. fullName: DialogsBotComponent remarks: '' -isPreview: false isDeprecated: false type: class inheritedProperties: @@ -15,21 +14,19 @@ inheritedProperties: summary: '' fullName: z remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static z: ZodType' + content: 'static z: ZodType' return: description: '' - type: 'ZodType<BotComponent, ZodTypeDef>' + type: ZodType<BotComponent, ZodTypeDef, BotComponent> inheritanceDescription: Inherited From BotComponent.z methods: - - name: 'configureServices(ServiceCollection, Configuration)' + - name: configureServices(ServiceCollection, Configuration) uid: botbuilder-dialogs.DialogsBotComponent.configureServices package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,6 +38,5 @@ methods: description: Services Collection to register. - id: configuration type: Configuration - description: | - Configuration for the bot component. + description: Configuration for the bot component. extends: BotComponent diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsComponentRegistration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsComponentRegistration.yml deleted file mode 100644 index db30748b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DialogsComponentRegistration.yml +++ /dev/null @@ -1,80 +0,0 @@ -### YamlMime:TSType -name: DialogsComponentRegistration -uid: botbuilder-dialogs.DialogsComponentRegistration -package: botbuilder-dialogs -summary: Makes dialogs component available to the system registering functionality. -fullName: DialogsComponentRegistration -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DialogsComponentRegistration() - uid: botbuilder-dialogs.DialogsComponentRegistration.constructor - package: botbuilder-dialogs - summary: >- - Creates an instance of the - [DialogsComponentRegistration](xref:botbuilder-dialogs.DialogsComponentRegistration) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DialogsComponentRegistration() -inheritedProperties: - - name: components - uid: botbuilder-dialogs.DialogsComponentRegistration.components - package: botbuilder-dialogs - summary: '' - fullName: components - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static components: ComponentRegistration[]' - return: - description: '' - type: 'ComponentRegistration[]' - inheritanceDescription: Inherited From ComponentRegistration.components -inheritedMethods: - - name: add(ComponentRegistration) - uid: botbuilder-dialogs.DialogsComponentRegistration.add - package: botbuilder-dialogs - summary: 'Add a component, only one instance per type is allowed for components.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function add(componentRegistration: ComponentRegistration)' - parameters: - - id: componentRegistration - type: ComponentRegistration - description: | - The component to be registered. - inheritanceDescription: Inherited From ComponentRegistration.add -methods: - - name: getMemoryScopes() - uid: botbuilder-dialogs.DialogsComponentRegistration.getMemoryScopes - package: botbuilder-dialogs - summary: Gets the dialogs memory scopes. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMemoryScopes(): MemoryScope[]' - return: - description: 'A list of [MemoryScope](xref:botbuilder-dialogs.MemoryScope).' - type: '[]' - - name: getPathResolvers() - uid: botbuilder-dialogs.DialogsComponentRegistration.getPathResolvers - package: botbuilder-dialogs - summary: Gets the dialogs path resolvers. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPathResolvers(): PathResolver[]' - return: - description: 'A list of [PathResolver](xref:botbuilder-dialogs.PathResolver).' - type: '[]' -extends: ComponentRegistration diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DollarPathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DollarPathResolver.yml index 60c4c947..9d694718 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DollarPathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/DollarPathResolver.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Maps $xxx => dialog.xxx fullName: DollarPathResolver remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [DollarPathResolver](xref:botbuilder-dialogs.DollarPathResolver) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new DollarPathResolver() @@ -26,7 +24,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Transforms the path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindChoicesOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindChoicesOptions.yml index 99c422c9..c2136861 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindChoicesOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindChoicesOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Options to control the recognition performed by `findChoices()`. fullName: FindChoicesOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: Defaults to `false`. fullName: noAction remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noAction?: boolean' @@ -34,7 +32,6 @@ properties: Defaults to `false`. fullName: noValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noValue?: boolean' @@ -49,7 +46,6 @@ properties: used to check the utterance for numbers. fullName: recognizeNumbers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizeNumbers?: boolean' @@ -64,7 +60,6 @@ properties: used to check the utterance for ordinal numbers. fullName: recognizeOrdinals remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recognizeOrdinals?: boolean' @@ -82,7 +77,6 @@ inheritedProperties: a match. The default value is "false". fullName: allowPartialMatches remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowPartialMatches?: boolean' @@ -98,7 +92,6 @@ inheritedProperties: summary: (Optional) locale/culture code of the utterance. The default is `en-US`. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -123,7 +116,6 @@ inheritedProperties: The default value is "2". fullName: maxTokenDistance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTokenDistance?: number' @@ -141,7 +133,6 @@ inheritedProperties: recognized. fullName: tokenizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenizer?: TokenizerFunction' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindValuesOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindValuesOptions.yml index 5b71f737..b4d18dc3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindValuesOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FindValuesOptions.yml @@ -7,7 +7,6 @@ summary: >- utterance. fullName: FindValuesOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -21,7 +20,6 @@ properties: a match. The default value is "false". fullName: allowPartialMatches remarks: '' - isPreview: false isDeprecated: false syntax: content: 'allowPartialMatches?: boolean' @@ -34,7 +32,6 @@ properties: summary: (Optional) locale/culture code of the utterance. The default is `en-US`. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -56,7 +53,6 @@ properties: The default value is "2". fullName: maxTokenDistance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxTokenDistance?: number' @@ -71,7 +67,6 @@ properties: recognized. fullName: tokenizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenizer?: TokenizerFunction' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundChoice.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundChoice.yml index aa3a6af3..af2288b5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundChoice.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundChoice.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Result returned by `findChoices()`. fullName: FoundChoice remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: 'index: number' @@ -32,7 +30,6 @@ properties: value of 1.0 would indicate a perfect match. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score: number' @@ -45,7 +42,6 @@ properties: summary: '' fullName: synonym remarks: '' - isPreview: false isDeprecated: false syntax: content: 'synonym?: string' @@ -58,7 +54,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundValue.yml index 7f6c6ba5..9f028a04 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/FoundValue.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: 'INTERNAL: Raw search result returned by `findValues()`.' fullName: FoundValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The index of the value that was matched. fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: 'index: number' @@ -32,7 +30,6 @@ properties: value of 1.0 would indicate a perfect match. fullName: score remarks: '' - isPreview: false isDeprecated: false syntax: content: 'score: number' @@ -45,7 +42,6 @@ properties: summary: The value that was matched. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/HashPathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/HashPathResolver.yml index 7e0c2987..b037e52b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/HashPathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/HashPathResolver.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: 'Maps #xxx => turn.recognized.intents.xxx' fullName: HashPathResolver remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [HashPathResolver](botbuilder-dialogs.HashPathResolver) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new HashPathResolver() @@ -26,7 +24,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Transforms the path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ListStyle.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ListStyle.yml index e275282c..c4c1b426 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ListStyle.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ListStyle.yml @@ -9,7 +9,6 @@ summary: >- presented to a user. fullName: ListStyle remarks: '' -isPreview: false isDeprecated: false fields: - name: none diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/MemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/MemoryScope.yml index 0daf2602..43f5e739 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/MemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/MemoryScope.yml @@ -5,18 +5,16 @@ package: botbuilder-dialogs summary: Abstract base class for all memory scopes. fullName: MemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MemoryScope(string, boolean)' + - name: MemoryScope(string, boolean) uid: botbuilder-dialogs.MemoryScope.constructor package: botbuilder-dialogs summary: >- Initializes a new instance of the [MemoryScope](xref:botbuilder-dialogs.MemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MemoryScope(name: string, includeInSnapshot?: boolean)' @@ -26,7 +24,7 @@ constructors: description: Name of the scope. - id: includeInSnapshot type: boolean - description: | + description: |- Boolean value indicating whether this memory should be included in snapshot. Default value is true. properties: @@ -38,7 +36,6 @@ properties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -51,7 +48,6 @@ properties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -64,15 +60,13 @@ methods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -81,7 +75,6 @@ methods: package: botbuilder-dialogs summary: Get the backing memory for this scope remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -97,15 +90,13 @@ methods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -114,24 +105,21 @@ methods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.MemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(_dc: DialogContext, _memory: object)' @@ -141,5 +129,4 @@ methods: description: Current dialog context - id: _memory type: object - description: | - memory to assign + description: memory to assign diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ModelResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ModelResult.yml index 6e072a1d..82ed3ec8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ModelResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ModelResult.yml @@ -13,7 +13,6 @@ remarks: >- recognized. The actual result can be accessed through the [resolution](#resolution) property. -isPreview: false isDeprecated: false type: interface properties: @@ -23,7 +22,6 @@ properties: summary: End character position of the recognized substring. fullName: end remarks: '' - isPreview: false isDeprecated: false syntax: content: 'end: number' @@ -36,7 +34,6 @@ properties: summary: The recognized entity. fullName: resolution remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resolution: T' @@ -49,7 +46,6 @@ properties: summary: Start character position of the recognized substring. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: number' @@ -62,7 +58,6 @@ properties: summary: Substring of the utterance that was recognized. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -75,7 +70,6 @@ properties: summary: Type of entity that was recognized. fullName: typeName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'typeName: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/NumberPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/NumberPrompt.yml index 432e2c03..a72dea44 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/NumberPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/NumberPrompt.yml @@ -3,20 +3,18 @@ name: NumberPrompt uid: botbuilder-dialogs.NumberPrompt package: botbuilder-dialogs summary: Prompts a user to enter a number. -fullName: NumberPrompt +fullName: NumberPrompt remarks: >- By default the prompt will return to the calling dialog a `number` representing the users input. -isPreview: false isDeprecated: false type: class constructors: - - name: 'NumberPrompt(string, PromptValidator, string)' + - name: NumberPrompt(string, PromptValidator, string) uid: botbuilder-dialogs.NumberPrompt.constructor package: botbuilder-dialogs summary: Creates a new NumberPrompt instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -35,7 +33,7 @@ constructors: to the prompt. - id: defaultLocale type: string - description: > + description: >- (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`. properties: @@ -45,7 +43,6 @@ properties: summary: The prompts default locale that should be recognized. fullName: defaultLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'defaultLocale?: string' @@ -55,12 +52,9 @@ properties: - name: id uid: botbuilder-dialogs.NumberPrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -70,12 +64,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.NumberPrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -96,18 +87,17 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [Prompt.EndOfTurn](xref:botbuilder-dialogs.Prompt.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.NumberPrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -118,12 +108,11 @@ inheritedMethods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -139,31 +128,32 @@ inheritedMethods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.beginDialog](xref:botbuilder-dialogs.Prompt.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.NumberPrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): NumberPrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Prompt.configure](xref:botbuilder-dialogs.Prompt.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.NumberPrompt.continueDialog package: botbuilder-dialogs @@ -180,10 +170,11 @@ inheritedMethods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -192,11 +183,13 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.continueDialog](xref:botbuilder-dialogs.Prompt.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.NumberPrompt.endDialog package: botbuilder-dialogs summary: >- @@ -225,38 +218,37 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) + [Prompt.endDialog](xref:botbuilder-dialogs.Prompt.endDialog) - name: getConverter(string) uid: botbuilder-dialogs.NumberPrompt.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -264,11 +256,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Prompt.getConverter](xref:botbuilder-dialogs.Prompt.getConverter) - name: getVersion() uid: botbuilder-dialogs.NumberPrompt.getVersion package: botbuilder-dialogs @@ -291,7 +284,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -302,15 +294,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Prompt.getVersion](xref:botbuilder-dialogs.Prompt.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.NumberPrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -330,30 +321,33 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: >- Inherited From - [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + [Prompt.onDialogEvent](xref:botbuilder-dialogs.Prompt.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.NumberPrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. @@ -361,7 +355,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Prompt.repromptDialog](xref:botbuilder-dialogs.Prompt.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.NumberPrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -374,12 +368,11 @@ inheritedMethods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -394,7 +387,9 @@ inheritedMethods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.resumeDialog](xref:botbuilder-dialogs.Prompt.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPrompt.yml index 024069ff..60e63ea2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPrompt.yml @@ -7,7 +7,7 @@ summary: >- Single Sign On (SSO) service. -fullName: OAuthPrompt +fullName: OAuthPrompt remarks: >- The prompt will attempt to retrieve the users current token and if the user isn't signed in, it @@ -117,16 +117,14 @@ remarks: >- ])); ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'OAuthPrompt(string, OAuthPromptSettings, PromptValidator)' + - name: OAuthPrompt(string, OAuthPromptSettings, PromptValidator) uid: botbuilder-dialogs.OAuthPrompt.constructor package: botbuilder-dialogs summary: Creates a new OAuthPrompt instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -145,19 +143,16 @@ constructors: type: >- <TokenResponse> - description: > + description: >- (Optional) validator that will be called each time the user responds to the prompt. properties: - name: id uid: botbuilder-dialogs.OAuthPrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -167,12 +162,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.OAuthPrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -193,39 +185,37 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.OAuthPrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): OAuthPrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + [Dialog.configure](xref:botbuilder-dialogs.Dialog.configure) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.OAuthPrompt.endDialog package: botbuilder-dialogs summary: >- @@ -254,23 +244,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -282,10 +270,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -293,11 +282,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Dialog.getConverter](xref:botbuilder-dialogs.Dialog.getConverter) - name: getVersion() uid: botbuilder-dialogs.OAuthPrompt.getVersion package: botbuilder-dialogs @@ -320,7 +310,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -332,14 +321,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.OAuthPrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -360,10 +348,10 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.OAuthPrompt.repromptDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -384,27 +372,25 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: - description: | - Current state information for this dialog. + type: <any> + description: Current state information for this dialog. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [Dialog.repromptDialog](xref:botbuilder-dialogs.Dialog.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.OAuthPrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -444,12 +430,11 @@ inheritedMethods: - [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: @@ -461,16 +446,17 @@ inheritedMethods: [DialogReason.endCalled](xref:botbuilder-dialogs.DialogReason.endCalled) - id: result type: any - description: | - Optional. The return value, if any, from the dialog that ended. + description: Optional. The return value, if any, from the dialog that ended. return: description: A promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Dialog.resumeDialog](xref:botbuilder-dialogs.Dialog.resumeDialog) methods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.OAuthPrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -481,12 +467,11 @@ methods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -502,7 +487,9 @@ methods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.OAuthPrompt.continueDialog package: botbuilder-dialogs @@ -519,10 +506,11 @@ methods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -533,18 +521,19 @@ methods: of the conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> - - name: 'getUserToken(TurnContext, string)' + type: >- + Promise<<any>> + - name: getUserToken(TurnContext, string) uid: botbuilder-dialogs.OAuthPrompt.getUserToken package: botbuilder-dialogs summary: Attempts to retrieve the stored token for the current user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getUserToken(context: TurnContext, code?: string): - Promise + Promise parameters: - id: context type: TurnContext @@ -554,7 +543,7 @@ methods: description: (Optional) login code received from the user. return: description: The token response. - type: Promise<TokenResponse | undefined> + type: Promise<undefined | TokenResponse> - name: recognizeToken(DialogContext) uid: botbuilder-dialogs.OAuthPrompt.recognizeToken package: botbuilder-dialogs @@ -565,7 +554,6 @@ methods: the implementation of the OAuthPrompt and OAuthInput. Application logic should use those dialog classes. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -589,7 +577,6 @@ methods: package: botbuilder-dialogs summary: Sends an OAuth card. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -605,8 +592,7 @@ methods: description: Turn context. - id: prompt type: string | Partial<Activity> - description: | - Message activity. + description: Message activity. return: description: '' type: Promise<void> @@ -629,7 +615,6 @@ methods: await prompt.signOutUser(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function signOutUser(context: TurnContext): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPromptSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPromptSettings.yml index 9b8cb20c..842f779e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPromptSettings.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/OAuthPromptSettings.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Settings used to configure an `OAuthPrompt` instance. fullName: OAuthPromptSettings remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Name of the OAuth connection being used. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: string' @@ -41,7 +39,6 @@ properties: by default for backwards compatibility. fullName: endOnInvalidMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endOnInvalidMessage?: boolean' @@ -54,7 +51,6 @@ properties: summary: AppCredentials for OAuth. fullName: oAuthAppCredentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'oAuthAppCredentials?: CoreAppCredentials' @@ -71,7 +67,6 @@ properties: True to display the SignInLink. fullName: showSignInLink remarks: '' - isPreview: false isDeprecated: false syntax: content: 'showSignInLink?: boolean' @@ -84,7 +79,6 @@ properties: summary: (Optional) additional text to include on the signin card. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -101,7 +95,6 @@ properties: Defaults to a value `900,000` (15 minutes.) fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -114,7 +107,6 @@ properties: summary: Title of the cards signin button. fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PathResolver.yml index 3f7671a2..8302b5cb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PathResolver.yml @@ -7,7 +7,6 @@ summary: |- Licensed under the MIT License. fullName: PathResolver remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -16,7 +15,6 @@ methods: package: botbuilder-dialogs summary: Transform the path remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PercentPathResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PercentPathResolver.yml index 0cd33a18..d0a394ba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PercentPathResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PercentPathResolver.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Maps %xxx => class.xxx (aka activeDialog.properties.xxx) fullName: PercentPathResolver remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [PercentPathResolver](xref:botbuilder-dialogs.PercentPathResolver) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new PercentPathResolver() @@ -26,7 +24,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Transforms the path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transformPath(path: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Prompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Prompt.yml index 602914f7..2041232b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Prompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Prompt.yml @@ -3,21 +3,17 @@ name: Prompt uid: botbuilder-dialogs.Prompt package: botbuilder-dialogs summary: Base class for all prompts. -fullName: 'Prompt' +fullName: Prompt remarks: '' -isPreview: false isDeprecated: false type: class properties: - name: id uid: botbuilder-dialogs.Prompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -27,12 +23,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.Prompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -53,39 +46,37 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.Prompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): Prompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: <T> inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + [Dialog.configure](xref:botbuilder-dialogs.Dialog.configure) + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.Prompt.endDialog package: botbuilder-dialogs summary: >- @@ -114,23 +105,21 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> @@ -142,10 +131,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -153,11 +143,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Dialog.getConverter](xref:botbuilder-dialogs.Dialog.getConverter) - name: getVersion() uid: botbuilder-dialogs.Prompt.getVersion package: botbuilder-dialogs @@ -180,7 +171,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -192,14 +182,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.Prompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -221,7 +210,7 @@ inheritedMethods: Inherited From [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) methods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.Prompt.beginDialog package: botbuilder-dialogs summary: >- @@ -232,12 +221,11 @@ methods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -253,7 +241,9 @@ methods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.Prompt.continueDialog package: botbuilder-dialogs @@ -270,10 +260,11 @@ methods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -282,35 +273,40 @@ methods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> - - name: 'repromptDialog(TurnContext, DialogInstance)' + type: >- + Promise<<any>> + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.Prompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.Prompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -323,12 +319,11 @@ methods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -343,5 +338,7 @@ methods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModel.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModel.yml index 9425d724..aa4b22a6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModel.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModel.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: PromptCultureModel remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,11 +16,12 @@ properties: **Example** + ```ts " or " + ``` fullName: inlineOr remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineOr: string' @@ -36,11 +36,12 @@ properties: **Example** + ```ts ", or " + ``` fullName: inlineOrMore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inlineOrMore: string' @@ -55,11 +56,12 @@ properties: **Example** + ```ts "en-US" + ``` fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale: string' @@ -74,11 +76,12 @@ properties: **Example** + ```ts "No" + ``` fullName: noInLanguage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noInLanguage: string' @@ -93,11 +96,12 @@ properties: **Example** + ```ts ", " + ``` fullName: separator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'separator: string' @@ -112,11 +116,12 @@ properties: **Example** + ```ts "Yes" + ``` fullName: yesInLanguage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'yesInLanguage: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModels.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModels.yml index eefa02b7..4cb2b39d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModels.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptCultureModels.yml @@ -7,7 +7,6 @@ summary: >- Prompt. fullName: PromptCultureModels remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: Chinese remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Chinese: PromptCultureModel' @@ -30,7 +28,6 @@ properties: summary: '' fullName: Dutch remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Dutch: PromptCultureModel' @@ -43,7 +40,6 @@ properties: summary: '' fullName: English remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static English: PromptCultureModel' @@ -56,7 +52,6 @@ properties: summary: '' fullName: French remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static French: PromptCultureModel' @@ -69,7 +64,6 @@ properties: summary: '' fullName: German remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static German: PromptCultureModel' @@ -82,20 +76,18 @@ properties: summary: '' fullName: getSupportedCultures remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static getSupportedCultures: () => PromptCultureModel[]' return: description: '' - type: '() => PromptCultureModel[]' + type: () => PromptCultureModel[] - name: Italian uid: botbuilder-dialogs.PromptCultureModels.Italian package: botbuilder-dialogs summary: '' fullName: Italian remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Italian: PromptCultureModel' @@ -108,7 +100,6 @@ properties: summary: '' fullName: Japanese remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Japanese: PromptCultureModel' @@ -121,7 +112,6 @@ properties: summary: '' fullName: Portuguese remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Portuguese: PromptCultureModel' @@ -134,7 +124,6 @@ properties: summary: '' fullName: Spanish remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Spanish: PromptCultureModel' @@ -152,7 +141,6 @@ methods: This is mostly a copy/paste from https://github.com/microsoft/Recognizers-Text/blob/master/JavaScript/packages/recognizers-text/src/culture.ts#L39 This doesn't directly use Recognizers-Text's MapToNearestLanguage because if they add language support before we do, it will break our prompts. - isPreview: false isDeprecated: false syntax: content: 'static function mapToNearestLanguage(cultureCode: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptOptions.yml index a8464aa6..4d8b2653 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Basic configuration options supported by all prompts. fullName: PromptOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,33 +14,42 @@ properties: summary: (Optional) List of choices associated with the prompt. fullName: choices remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'choices?: string | Choice[]' + content: 'choices?: (string | Choice)[]' return: description: '' - type: 'string | []' + type: (string | )[] - name: prompt uid: botbuilder-dialogs.PromptOptions.prompt package: botbuilder-dialogs summary: (Optional) Initial prompt to send the user. fullName: prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'prompt?: string | Partial' return: description: '' type: string | Partial<Activity> + - name: recognizeLanguage + uid: botbuilder-dialogs.PromptOptions.recognizeLanguage + package: botbuilder-dialogs + summary: The locale to be use for recognizing the utterance. + fullName: recognizeLanguage + remarks: '' + isDeprecated: false + syntax: + content: 'recognizeLanguage?: string' + return: + description: '' + type: string - name: retryPrompt uid: botbuilder-dialogs.PromptOptions.retryPrompt package: botbuilder-dialogs summary: (Optional) Retry prompt to send the user. fullName: retryPrompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'retryPrompt?: string | Partial' @@ -58,7 +66,6 @@ properties: when the prompt is executed using DialogContext.prompt. fullName: style remarks: '' - isPreview: false isDeprecated: false syntax: content: 'style?: ListStyle' @@ -73,7 +80,6 @@ properties: routine. fullName: validations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validations?: object' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptRecognizerResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptRecognizerResult.yml index 315b53c0..45956b3f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptRecognizerResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptRecognizerResult.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Result returned by a prompts recognizer function. fullName: PromptRecognizerResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: recognized result. fullName: succeeded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'succeeded: boolean' @@ -29,10 +27,9 @@ properties: - name: value uid: botbuilder-dialogs.PromptRecognizerResult.value package: botbuilder-dialogs - summary: 'Value that was recognized if [succeeded](#succeeded) is `true`.' + summary: Value that was recognized if [succeeded](#succeeded) is `true`. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: T' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidator.yml index e8fc8d0a..845022f7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidator.yml @@ -2,9 +2,10 @@ name: PromptValidator uid: botbuilder-dialogs.PromptValidator package: botbuilder-dialogs -summary: > +summary: >- Function signature for providing a custom prompt validator. + ```TypeScript type PromptValidator = (prompt: PromptValidatorContext) => @@ -27,7 +28,6 @@ remarks: >- `prompt.context.sendActivity()`. In that > case the prompts default re-rpompt logic will not be run. -isPreview: false isDeprecated: false syntax: | type PromptValidator = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidatorContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidatorContext.yml index e6c22d18..8d103cdb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidatorContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/PromptValidatorContext.yml @@ -5,21 +5,20 @@ package: botbuilder-dialogs summary: Contextual information passed to a custom `PromptValidator`. fullName: PromptValidatorContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: attemptCount uid: botbuilder-dialogs.PromptValidatorContext.attemptCount package: botbuilder-dialogs - summary: > + summary: >- A count of the number of times the prompt has been executed. + A number indicating how many times the prompt was invoked (starting at 1 for the first time it was invoked). fullName: attemptCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attemptCount: number' @@ -32,7 +31,6 @@ properties: summary: The context for the current turn of conversation with the user. fullName: context remarks: The validator can use this to re-prompt the user. - isPreview: false isDeprecated: false syntax: content: 'context: TurnContext' @@ -47,7 +45,6 @@ properties: remarks: >- The validator can extend this interface to support additional prompt options. - isPreview: false isDeprecated: false syntax: content: 'options: PromptOptions' @@ -65,7 +62,6 @@ properties: anything and then the value can be retrieved from `prompt.recognized.value`. - isPreview: false isDeprecated: false syntax: content: 'recognized: PromptRecognizerResult' @@ -82,7 +78,6 @@ properties: remarks: >- The validator can use this to persist things like turn counts or other state information. - isPreview: false isDeprecated: false syntax: content: 'state: object' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Recognizer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Recognizer.yml index acaed653..308d58ad 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Recognizer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Recognizer.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Recognizer base class. fullName: Recognizer remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: Recognizers unique ID. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -30,7 +28,6 @@ properties: Default this to the NullTelemetryClient, which does nothing. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient: BotTelemetryClient' @@ -38,24 +35,23 @@ properties: description: '' type: BotTelemetryClient inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.Recognizer.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): Recognizer' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) @@ -64,10 +60,11 @@ inheritedMethods: package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -75,8 +72,9 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) @@ -88,7 +86,6 @@ methods: package: botbuilder-dialogs summary: To recognize intents and entities in a users utterance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -103,12 +100,11 @@ methods: type: Partial<Activity> description: Activity. - id: _telemetryProperties - type: 'Record<string, string>' + type: Record<string, string> description: Additional properties to be logged to telemetry with event. - id: _telemetryMetrics - type: 'Record<string, number>' - description: | - Additional metrics to be logged to telemetry with event. + type: Record<string, number> + description: Additional metrics to be logged to telemetry with event. return: description: '' type: Promise<RecognizerResult> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/RecognizerConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/RecognizerConfiguration.yml index 49e6fd2b..e022646d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/RecognizerConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/RecognizerConfiguration.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: RecognizerConfiguration remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryClient?: BotTelemetryClient' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ScopePath.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ScopePath.yml index 0e8f6401..eaf8e3c8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ScopePath.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ScopePath.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Defines paths for the available scopes. fullName: ScopePath remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: Class memory scope root path. fullName: class remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static class: "class" = "class"' @@ -28,7 +26,6 @@ properties: summary: Conversation memory scope root path. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static conversation: "conversation" = "conversation"' @@ -41,7 +38,6 @@ properties: summary: Dialog memory scope root path. fullName: dialog remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static dialog: "dialog" = "dialog"' @@ -54,7 +50,6 @@ properties: summary: DialogClass memory scope root path. fullName: dialogClass remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static dialogClass: "dialogClass" = "dialogClass"' @@ -67,7 +62,6 @@ properties: summary: DialogContext memory scope root path. fullName: dialogContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static dialogContext: "dialogContext" = "dialogContext"' @@ -80,7 +74,6 @@ properties: summary: Settings memory scope root path. fullName: settings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static settings: "settings" = "settings"' @@ -93,7 +86,6 @@ properties: summary: This memory scope root path. fullName: this remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static this: "this" = "this"' @@ -106,7 +98,6 @@ properties: summary: Turn memory scope root path. fullName: turn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static turn: "turn" = "turn"' @@ -119,7 +110,6 @@ properties: summary: User memory scope root path. fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static user: "user" = "user"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SettingsMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SettingsMemoryScope.yml index 01f44ae4..b804d951 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SettingsMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SettingsMemoryScope.yml @@ -2,29 +2,26 @@ name: SettingsMemoryScope uid: botbuilder-dialogs.SettingsMemoryScope package: botbuilder-dialogs -summary: 'SettingsMemoryScope maps "settings" -> dc.context.turnState[''settings'']' +summary: SettingsMemoryScope maps "settings" -> dc.context.turnState['settings'] fullName: SettingsMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'SettingsMemoryScope(Record)' + - name: SettingsMemoryScope(Record) uid: botbuilder-dialogs.SettingsMemoryScope.constructor package: botbuilder-dialogs summary: >- Initializes a new instance of the [SettingsMemoryScope](xref:botbuilder-dialogs.SettingsMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SettingsMemoryScope(initialSettings?: Record)' parameters: - id: initialSettings - type: 'Record<string, unknown>' - description: | - initial set of settings to supply + type: Record<string, unknown> + description: initial set of settings to supply inheritedProperties: - name: includeInSnapshot uid: botbuilder-dialogs.SettingsMemoryScope.includeInSnapshot @@ -34,7 +31,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -50,7 +46,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -66,15 +61,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -86,27 +79,24 @@ inheritedMethods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [MemoryScope.saveChanges](xref:botbuilder-dialogs.MemoryScope.saveChanges) - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.SettingsMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(_dc: DialogContext, _memory: object)' @@ -116,8 +106,7 @@ inheritedMethods: description: Current dialog context - id: _memory type: object - description: | - memory to assign + description: memory to assign inheritanceDescription: >- Inherited From [MemoryScope.setMemory](xref:botbuilder-dialogs.MemoryScope.setMemory) @@ -127,7 +116,6 @@ methods: package: botbuilder-dialogs summary: Gets the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): Record' @@ -139,21 +127,19 @@ methods: for this turn. return: description: The memory for the scope. - type: 'Record<string, unknown>' + type: Record<string, unknown> - name: load(DialogContext) uid: botbuilder-dialogs.SettingsMemoryScope.load package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(dc: DialogContext): Promise' parameters: - id: dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialog.yml index 9098bf28..40ad8d6e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialog.yml @@ -9,11 +9,10 @@ remarks: >- instance with the initial parameters for the dialog. -isPreview: false isDeprecated: false type: class constructors: - - name: 'SkillDialog(SkillDialogOptions, string)' + - name: SkillDialog(SkillDialogOptions, string) uid: botbuilder-dialogs.SkillDialog.constructor package: botbuilder-dialogs summary: A sample dialog that can wrap remote calls to a skill. @@ -22,7 +21,6 @@ constructors: object with the initial parameters for the dialog. - isPreview: false isDeprecated: false syntax: content: 'new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)' @@ -32,18 +30,14 @@ constructors: description: The options to execute the skill dialog. - id: dialogId type: string - description: | - The id of the dialog. + description: The id of the dialog. properties: - name: id uid: botbuilder-dialogs.SkillDialog.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -53,12 +47,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.SkillDialog.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -79,47 +70,46 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.SkillDialog.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): SkillDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Dialog.configure](xref:botbuilder-dialogs.Dialog.configure) - name: getConverter(string) uid: botbuilder-dialogs.SkillDialog.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -127,11 +117,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Dialog.getConverter](xref:botbuilder-dialogs.Dialog.getConverter) - name: getVersion() uid: botbuilder-dialogs.SkillDialog.getVersion package: botbuilder-dialogs @@ -154,7 +145,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -166,14 +156,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.SkillDialog.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -195,19 +184,18 @@ inheritedMethods: Inherited From [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) methods: - - name: 'beginDialog(DialogContext, BeginSkillDialogOptions)' + - name: beginDialog(DialogContext, BeginSkillDialogOptions) uid: botbuilder-dialogs.SkillDialog.beginDialog package: botbuilder-dialogs summary: Called when the skill dialog is started and pushed onto the dialog stack. remarks: >- If the task is successful, the result indicates whether the dialog is still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: - BeginSkillDialogOptions): Promise + BeginSkillDialogOptions): Promise> parameters: - id: dc type: @@ -219,7 +207,9 @@ methods: description: Initial information to pass to the dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.SkillDialog.continueDialog package: botbuilder-dialogs @@ -236,10 +226,11 @@ methods: also contain a return value. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -248,17 +239,18 @@ methods: current turn of conversation. return: description: A Promise representing the asynchronous operation. - type: Promise<> - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: >- + Promise<<any>> + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.SkillDialog.endDialog package: botbuilder-dialogs summary: Called when the skill dialog is ending. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(context: TurnContext, instance: DialogInstance, + function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise parameters: - id: context @@ -267,27 +259,26 @@ methods: The [TurnContext](xref:botbuilder-core.TurnContext) object for this turn. - id: instance - type: + type: <any> description: >- State information associated with the instance of this dialog on the dialog stack. - id: reason type: - description: '(xref:botbuilder-dialogs.DialogReason) why the dialog ended.' + description: '[Reason](xref:botbuilder-dialogs.DialogReason) why the dialog ended.' return: description: A Promise representing the asynchronous operation. type: Promise<void> - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.SkillDialog.repromptDialog package: botbuilder-dialogs summary: Called when the skill dialog should re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext @@ -295,24 +286,23 @@ methods: The [TurnContext](xref:botbuilder-core.TurnContext) object for this turn. - id: instance - type: + type: <any> description: State information for this dialog. return: description: A Promise representing the asynchronous operation. type: Promise<void> - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.SkillDialog.resumeDialog package: botbuilder-dialogs summary: >- Called when a child skill dialog completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -321,7 +311,9 @@ methods: current turn of the conversation. - id: _reason type: - description: '(xref:botbuilder-dialogs.DialogReason) why the dialog resumed.' + description: >- + [Reason](xref:botbuilder-dialogs.DialogReason) why the dialog + resumed. - id: _result type: any description: |- @@ -329,7 +321,9 @@ methods: of the value returned is dependent on the child dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> extends: >- <Partial<>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialogOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialogOptions.yml index 7af97956..3daf2198 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialogOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SkillDialogOptions.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: '' fullName: SkillDialogOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The Microsoft app ID of the bot calling the skill. fullName: botId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botId: string' @@ -28,7 +26,6 @@ properties: summary: Optional. The OAuth Connection Name for the Parent Bot. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName?: string' @@ -41,7 +38,6 @@ properties: summary: The BotFrameworkSkill that the dialog will call. fullName: conversationIdFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationIdFactory: SkillConversationIdFactoryBase' @@ -54,7 +50,6 @@ properties: summary: The ConversationState to be used by the Dialog. fullName: conversationState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationState: ConversationState' @@ -67,7 +62,6 @@ properties: summary: The BotFrameworkSkill the dialog will call. fullName: skill remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skill: BotFrameworkSkill' @@ -80,7 +74,6 @@ properties: summary: The BotFrameworkClient used to call the remote skill. fullName: skillClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillClient: BotFrameworkClient' @@ -93,7 +86,6 @@ properties: summary: The callback Url for the skill host. fullName: skillHostEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skillHostEndpoint: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SortedValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SortedValue.yml index ac71aff5..ff59cbe8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SortedValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/SortedValue.yml @@ -18,7 +18,6 @@ summary: >- to search while maintaining the index of the choice that value came from. fullName: SortedValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -28,7 +27,6 @@ properties: summary: '' fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: 'index: number' @@ -41,7 +39,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TemplateInterface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TemplateInterface.yml index d718e232..ee41fcf3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TemplateInterface.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TemplateInterface.yml @@ -3,18 +3,16 @@ name: TemplateInterface uid: botbuilder-dialogs.TemplateInterface package: botbuilder-dialogs summary: Defines Template interface for binding data to T. -fullName: 'TemplateInterface' +fullName: TemplateInterface remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'bind(DialogContext, D)' + - name: bind(DialogContext, D) uid: botbuilder-dialogs.TemplateInterface.bind package: botbuilder-dialogs summary: Given the turn context bind to the data to create the object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function bind(dialogContext: DialogContext, data?: D): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TextPrompt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TextPrompt.yml index a80fdf13..d40f51cd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TextPrompt.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TextPrompt.yml @@ -3,20 +3,18 @@ name: TextPrompt uid: botbuilder-dialogs.TextPrompt package: botbuilder-dialogs summary: Prompts a user to enter some text. -fullName: TextPrompt +fullName: TextPrompt remarks: >- By default the prompt will return to the calling dialog a `string` representing the users reply. -isPreview: false isDeprecated: false type: class constructors: - - name: 'TextPrompt(string, PromptValidator)' + - name: TextPrompt(string, PromptValidator) uid: botbuilder-dialogs.TextPrompt.constructor package: botbuilder-dialogs summary: Creates a new TextPrompt instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TextPrompt(dialogId?: string, validator?: PromptValidator)' @@ -28,19 +26,16 @@ constructors: `ComponentDialog`. - id: validator type: <string> - description: > + description: >- (Optional) validator that will be called each time the user responds to the prompt. properties: - name: id uid: botbuilder-dialogs.TextPrompt.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -50,12 +45,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.TextPrompt.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -76,18 +68,17 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From - [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) + [Prompt.EndOfTurn](xref:botbuilder-dialogs.Prompt.EndOfTurn) inheritedMethods: - - name: 'beginDialog(DialogContext, PromptOptions)' + - name: beginDialog(DialogContext, PromptOptions) uid: botbuilder-dialogs.TextPrompt.beginDialog package: botbuilder-dialogs summary: >- @@ -98,12 +89,11 @@ inheritedMethods: still active after the turn has been processed by the prompt. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options: PromptOptions): - Promise + Promise> parameters: - id: dc type: @@ -119,31 +109,32 @@ inheritedMethods: additional information to pass to the prompt being started. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.beginDialog](xref:botbuilder-dialogs.Prompt.beginDialog) - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.TextPrompt.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): TextPrompt' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Prompt.configure](xref:botbuilder-dialogs.Prompt.configure) - name: continueDialog(DialogContext) uid: botbuilder-dialogs.TextPrompt.continueDialog package: botbuilder-dialogs @@ -160,10 +151,11 @@ inheritedMethods: accepts the user's reply as valid input for the prompt. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -172,11 +164,13 @@ inheritedMethods: current turn of conversation. return: description: A `Promise` representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.continueDialog](xref:botbuilder-dialogs.Prompt.continueDialog) - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.TextPrompt.endDialog package: botbuilder-dialogs summary: >- @@ -205,38 +199,37 @@ inheritedMethods: - [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(_context: TurnContext, _instance: DialogInstance, - _reason: DialogReason): Promise + function endDialog(_context: TurnContext, _instance: + DialogInstance, _reason: DialogReason): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: + type: <any> description: Current state information for this dialog. - id: _reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) + [Prompt.endDialog](xref:botbuilder-dialogs.Prompt.endDialog) - name: getConverter(string) uid: botbuilder-dialogs.TextPrompt.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -244,11 +237,12 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) + [Prompt.getConverter](xref:botbuilder-dialogs.Prompt.getConverter) - name: getVersion() uid: botbuilder-dialogs.TextPrompt.getVersion package: botbuilder-dialogs @@ -271,7 +265,6 @@ inheritedMethods: Returning an empty string will disable version tracking for the component all together. - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' @@ -282,15 +275,14 @@ inheritedMethods: type: string inheritanceDescription: >- Inherited From - [Dialog.getVersion](xref:botbuilder-dialogs.Dialog.getVersion) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Prompt.getVersion](xref:botbuilder-dialogs.Prompt.getVersion) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.TextPrompt.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -310,30 +302,33 @@ inheritedMethods: type: Promise<boolean> inheritanceDescription: >- Inherited From - [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + [Prompt.onDialogEvent](xref:botbuilder-dialogs.Prompt.onDialogEvent) + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.TextPrompt.repromptDialog package: botbuilder-dialogs summary: >- Called when a prompt dialog has been requested to re-prompt the user for input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function repromptDialog(context: TurnContext, instance: DialogInstance): - Promise + function repromptDialog(context: TurnContext, instance: + DialogInstance): Promise parameters: - id: context type: TurnContext - description: |- - (xref:botbuilder-core.TurnContext), context for the current + description: >- + [TurnContext](xref:botbuilder-core.TurnContext), context for the + current + turn of conversation with the user. - id: instance - type: - description: |- - (xref:botbuilder-dialogs.DialogInstance), the instance + type: <any> + description: >- + [DialogInstance](xref:botbuilder-dialogs.DialogInstance), the + instance + of the dialog on the stack. return: description: A `Promise` representing the asynchronous operation. @@ -341,7 +336,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Prompt.repromptDialog](xref:botbuilder-dialogs.Prompt.repromptDialog) - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.TextPrompt.resumeDialog package: botbuilder-dialogs summary: >- @@ -354,12 +349,11 @@ inheritedMethods: still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, _reason: DialogReason, - _result?: any): Promise + _result?: any): Promise> parameters: - id: dc type: @@ -374,7 +368,9 @@ inheritedMethods: The type of the value returned is dependent on the previous dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [Prompt.resumeDialog](xref:botbuilder-dialogs.Prompt.resumeDialog) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisMemoryScope.yml index 9462061e..4fca4faf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: ThisMemoryScope maps "this" -> dc.activeDialog.state fullName: ThisMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [ThisMemoryScope](xref:botbuilder-dialogs.ThisMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new ThisMemoryScope() @@ -29,7 +27,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -45,7 +42,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -61,15 +57,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -81,15 +75,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -101,15 +93,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -122,7 +112,6 @@ methods: package: botbuilder-dialogs summary: Gets the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -135,12 +124,11 @@ methods: return: description: The memory for the scope. type: object - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.ThisMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(dc: DialogContext, memory: object)' @@ -152,6 +140,5 @@ methods: for this turn. - id: memory type: object - description: | - Memory object to set for the scope. + description: Memory object to set for the scope. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisPath.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisPath.yml index 0983991a..c3618257 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisPath.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/ThisPath.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Defines path passed to the active dialog. fullName: ThisPath remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: BeginDialog. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static options: "this.options" = "this.options"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Token.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Token.yml index 3db82bb8..1836793a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Token.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/Token.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Individual token returned by a `TokenizerFunction`. fullName: Token remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: End character position of the token within the outer string. fullName: end remarks: '' - isPreview: false isDeprecated: false syntax: content: 'end: number' @@ -30,7 +28,6 @@ properties: stemming. fullName: normalized remarks: '' - isPreview: false isDeprecated: false syntax: content: 'normalized: string' @@ -43,7 +40,6 @@ properties: summary: Start character position of the token within the outer string. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: number' @@ -56,7 +52,6 @@ properties: summary: Original text of the token. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TokenizerFunction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TokenizerFunction.yml index 924c132e..881f8c67 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TokenizerFunction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TokenizerFunction.yml @@ -2,12 +2,13 @@ name: TokenizerFunction uid: botbuilder-dialogs.TokenizerFunction package: botbuilder-dialogs -summary: > +summary: >- Signature for an alternate word breaker that can be passed to `recognizeChoices()`, `findChoices()`, or `findValues()`. + ```TypeScript type TokenizerFunction = (text: string, locale?: string) => Token[]; @@ -17,7 +18,6 @@ fullName: TokenizerFunction remarks: >- The `defaultTokenizer()` is fairly simple and only breaks on spaces and punctuation. -isPreview: false isDeprecated: false syntax: | type TokenizerFunction = (text: string, locale?: string) => Token[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnMemoryScope.yml index a3facc22..edbe22d8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: TurnMemoryScope represents memory scoped to the current turn. fullName: TurnMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [TurnMemoryScope](xref:botbuilder-dialogs.TurnMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new TurnMemoryScope() @@ -29,7 +27,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -45,7 +42,6 @@ inheritedProperties: summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -61,15 +57,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Deletes the backing memory for a scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -81,15 +75,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Loads a scopes backing memory at the start of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -101,15 +93,13 @@ inheritedMethods: package: botbuilder-dialogs summary: Saves a scopes backing memory at the end of a turn. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(_dc: DialogContext): Promise' parameters: - id: _dc type: - description: | - Current dialog context. + description: Current dialog context. return: description: '' type: Promise<void> @@ -122,7 +112,6 @@ methods: package: botbuilder-dialogs summary: Get the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -135,12 +124,11 @@ methods: return: description: The memory for the scope. type: object - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.TurnMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(dc: DialogContext, memory: object)' @@ -152,6 +140,5 @@ methods: turn. - id: memory type: object - description: | - Memory object to set for the scope. + description: Memory object to set for the scope. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnPath.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnPath.yml index b4692c68..b32ba7b0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnPath.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/TurnPath.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Defines path for avaiable turns. fullName: TurnPath remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static activity: "turn.activity" = "turn.activity"' @@ -28,7 +26,6 @@ properties: summary: '' fullName: activityProcessed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -43,7 +40,6 @@ properties: summary: '' fullName: dialogEvent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static dialogEvent: "turn.dialogEvent" = "turn.dialogEvent"' @@ -56,7 +52,6 @@ properties: summary: '' fullName: interrupted remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static interrupted: "turn.interrupted" = "turn.interrupted"' @@ -69,7 +64,6 @@ properties: summary: '' fullName: lastResult remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static lastResult: "turn.lastresult" = "turn.lastresult"' @@ -82,7 +76,6 @@ properties: summary: '' fullName: recognized remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static recognized: "turn.recognized" = "turn.recognized"' @@ -95,7 +88,6 @@ properties: summary: '' fullName: recognizedEntities remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -110,7 +102,6 @@ properties: summary: '' fullName: repeatedIds remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static repeatedIds: "turn.repeatedIds" = "turn.repeatedIds"' @@ -123,7 +114,6 @@ properties: summary: '' fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static text: "turn.recognized.text" = "turn.recognized.text"' @@ -136,7 +126,6 @@ properties: summary: '' fullName: topIntent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static topIntent: "turn.recognized.intent" = "turn.recognized.intent"' @@ -149,7 +138,6 @@ properties: summary: '' fullName: topScore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static topScore: "turn.recognized.score" = "turn.recognized.score"' @@ -162,7 +150,6 @@ properties: summary: '' fullName: unrecognizedText remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/UserMemoryScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/UserMemoryScope.yml index fd8e75d7..b1fa164b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/UserMemoryScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/UserMemoryScope.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Memory that's scoped to the current user. fullName: UserMemoryScope remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: Initializes a new instance of the [UserMemoryScope](xref:botbuilder-dialogs.UserMemoryScope) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new UserMemoryScope() @@ -29,7 +27,6 @@ inheritedProperties: snapshot. fullName: includeInSnapshot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeInSnapshot: boolean' @@ -38,14 +35,13 @@ inheritedProperties: type: boolean inheritanceDescription: >- Inherited From - [MemoryScope.includeInSnapshot](xref:botbuilder-dialogs.MemoryScope.includeInSnapshot) + [BotStateMemoryScope.includeInSnapshot](xref:botbuilder-dialogs.BotStateMemoryScope.includeInSnapshot) - name: name uid: botbuilder-dialogs.UserMemoryScope.name package: botbuilder-dialogs summary: Gets or sets name of the scope fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -54,7 +50,7 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MemoryScope.name](xref:botbuilder-dialogs.MemoryScope.name) + [BotStateMemoryScope.name](xref:botbuilder-dialogs.BotStateMemoryScope.name) inheritedMethods: - name: delete(DialogContext) uid: botbuilder-dialogs.UserMemoryScope.delete @@ -63,7 +59,6 @@ inheritedMethods: Deletes any state in storage and the cache for this [BotState](xref:botbuilder-core.BotState). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function delete(_dc: DialogContext): Promise' @@ -84,7 +79,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Get the backing memory for this scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMemory(dc: DialogContext): object' @@ -98,14 +92,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotStateMemoryScope.getMemory](xref:botbuilder-dialogs.BotStateMemoryScope.getMemory) - - name: 'load(DialogContext, boolean)' + - name: load(DialogContext, boolean) uid: botbuilder-dialogs.UserMemoryScope.load package: botbuilder-dialogs summary: >- Populates the state cache for this [BotState](xref:botbuilder-core.BotState) from the storage layer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function load(dc: DialogContext, force?: boolean): Promise' @@ -128,14 +121,13 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotStateMemoryScope.load](xref:botbuilder-dialogs.BotStateMemoryScope.load) - - name: 'saveChanges(DialogContext, boolean)' + - name: saveChanges(DialogContext, boolean) uid: botbuilder-dialogs.UserMemoryScope.saveChanges package: botbuilder-dialogs summary: >- Writes the state cache for this [BotState](xref:botbuilder-core.BotState) to the storage layer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveChanges(dc: DialogContext, force?: boolean): Promise' @@ -158,12 +150,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BotStateMemoryScope.saveChanges](xref:botbuilder-dialogs.BotStateMemoryScope.saveChanges) - - name: 'setMemory(DialogContext, object)' + - name: setMemory(DialogContext, object) uid: botbuilder-dialogs.UserMemoryScope.setMemory package: botbuilder-dialogs summary: Changes the backing object for the memory scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setMemory(dc: DialogContext, _memory: object)' @@ -173,8 +164,7 @@ inheritedMethods: description: current dialog context - id: _memory type: object - description: | - memory + description: memory inheritanceDescription: >- Inherited From [BotStateMemoryScope.setMemory](xref:botbuilder-dialogs.BotStateMemoryScope.setMemory) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallDialog.yml index 10d428e5..f363e29e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallDialog.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallDialog.yml @@ -60,18 +60,16 @@ remarks: >- module.exports.FillProfileDialog = FillProfileDialog; ``` -isPreview: false isDeprecated: false type: class constructors: - - name: 'WaterfallDialog(string, WaterfallStep[])' + - name: WaterfallDialog(string, WaterfallStep[]) uid: botbuilder-dialogs.WaterfallDialog.constructor package: botbuilder-dialogs summary: Creates a new waterfall dialog containing the given array of steps. remarks: >- See the [addStep()](#addstep) function for details on creating a valid step function. - isPreview: false isDeprecated: false syntax: content: 'new WaterfallDialog(dialogId: string, steps?: WaterfallStep[])' @@ -82,19 +80,15 @@ constructors: Unique ID of the dialog within the component or set its being added to. - id: steps - type: '<O>[]' - description: | - (Optional) array of asynchronous waterfall step functions. + type: <O>[] + description: (Optional) array of asynchronous waterfall step functions. properties: - name: id uid: botbuilder-dialogs.WaterfallDialog.id package: botbuilder-dialogs - summary: |- - Unique ID of the dialog. - Sets the unique ID of the dialog. + summary: Unique ID of the dialog. fullName: id - remarks: This will be automatically generated if not specified. - isPreview: false + remarks: '' isDeprecated: false syntax: content: string id @@ -104,12 +98,9 @@ properties: - name: telemetryClient uid: botbuilder-dialogs.WaterfallDialog.telemetryClient package: botbuilder-dialogs - summary: |- - Gets the telemetry client for this dialog. - Sets the telemetry client for this dialog. + summary: Gets the telemetry client for this dialog. fullName: telemetryClient remarks: '' - isPreview: false isDeprecated: false syntax: content: BotTelemetryClient telemetryClient @@ -130,47 +121,46 @@ inheritedProperties: processing for the current turn, is still active, and is waiting for more input. - isPreview: false isDeprecated: false syntax: - content: 'static EndOfTurn: DialogTurnResult' + content: 'static EndOfTurn: DialogTurnResult' return: description: '' - type: + type: <any> inheritanceDescription: >- Inherited From [Dialog.EndOfTurn](xref:botbuilder-dialogs.Dialog.EndOfTurn) inheritedMethods: - - name: 'configure(Record)' + - name: configure(Record) uid: botbuilder-dialogs.WaterfallDialog.configure package: botbuilder-dialogs summary: Fluent method for configuring the object. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function configure(config: Record): this' + content: 'function configure(config: Record): WaterfallDialog' parameters: - id: config - type: 'Record<string, unknown>' + type: Record<string, unknown> description: Configuration settings to apply. return: description: >- The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete. - type: this + type: <O> inheritanceDescription: >- Inherited From - [Configurable.configure](xref:botbuilder-dialogs.Configurable.configure) + [Dialog.configure](xref:botbuilder-dialogs.Dialog.configure) - name: getConverter(string) uid: botbuilder-dialogs.WaterfallDialog.getConverter package: botbuilder-dialogs summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConverter(_property: string): Converter | ConverterFactory' + content: >- + function getConverter(_property: string): Converter | + ConverterFactory parameters: - id: _property type: string @@ -178,19 +168,19 @@ inheritedMethods: return: description: The converter for the selector configuration. type: >- - | + <unknown, unknown> | + <unknown, + unknown> inheritanceDescription: >- Inherited From - [Configurable.getConverter](xref:botbuilder-dialogs.Configurable.getConverter) - - name: 'onDialogEvent(DialogContext, DialogEvent)' + [Dialog.getConverter](xref:botbuilder-dialogs.Dialog.getConverter) + - name: onDialogEvent(DialogContext, DialogEvent) uid: botbuilder-dialogs.WaterfallDialog.onDialogEvent package: botbuilder-dialogs summary: >- Called when an event has been raised, using `DialogContext.emitEvent()`, by either the current dialog or a dialog that the current dialog started. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -211,10 +201,10 @@ inheritedMethods: inheritanceDescription: >- Inherited From [Dialog.onDialogEvent](xref:botbuilder-dialogs.Dialog.onDialogEvent) - - name: 'repromptDialog(TurnContext, DialogInstance)' + - name: repromptDialog(TurnContext, DialogInstance) uid: botbuilder-dialogs.WaterfallDialog.repromptDialog package: botbuilder-dialogs - summary: 'When overridden in a derived class, reprompts the user for input.' + summary: When overridden in a derived class, reprompts the user for input. remarks: >- Derived dialogs that support validation and re-prompt logic should override this method. @@ -235,20 +225,18 @@ inheritedMethods: [DialogContext.repromptDialog](xref:botbuilder-dialogs.DialogContext.repromptDialog) - [Prompt](xref:botbuilder-dialogs.Prompt) - isPreview: false isDeprecated: false syntax: content: >- function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise + DialogInstance): Promise parameters: - id: _context type: TurnContext description: The context object for the turn. - id: _instance - type: - description: | - Current state information for this dialog. + type: <any> + description: Current state information for this dialog. return: description: '' type: Promise<void> @@ -313,18 +301,17 @@ methods: helloDialog.addStep(this.helloWorldStep.bind(this)); ``` - isPreview: false isDeprecated: false syntax: - content: 'function addStep(step: WaterfallStep): this' + content: 'function addStep(step: WaterfallStep): WaterfallDialog' parameters: - id: step type: <O> description: Asynchronous step function to call. return: description: Waterfall dialog for fluent calls to `addStep()`. - type: this - - name: 'beginDialog(DialogContext, O)' + type: <O> + - name: beginDialog(DialogContext, O) uid: botbuilder-dialogs.WaterfallDialog.beginDialog package: botbuilder-dialogs summary: >- @@ -335,12 +322,11 @@ methods: [Dialog](xref:botbuilder-dialogs.Dialog) is still active after the turn has been processed by the dialog. - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dc: DialogContext, options?: O): - Promise + Promise> parameters: - id: dc type: @@ -354,7 +340,9 @@ methods: [Dialog](xref:botbuilder-dialogs.Dialog). return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> - name: continueDialog(DialogContext) uid: botbuilder-dialogs.WaterfallDialog.continueDialog package: botbuilder-dialogs @@ -371,10 +359,11 @@ methods: also contain a return value. - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(dc: DialogContext): Promise' + content: >- + function continueDialog(dc: DialogContext): + Promise> parameters: - id: dc type: @@ -383,45 +372,44 @@ methods: current turn of conversation. return: description: A Promise representing the asynchronous operation. - type: Promise<> - - name: 'endDialog(TurnContext, DialogInstance, DialogReason)' + type: >- + Promise<<any>> + - name: endDialog(TurnContext, DialogInstance, DialogReason) uid: botbuilder-dialogs.WaterfallDialog.endDialog package: botbuilder-dialogs summary: Called when the dialog is ending. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endDialog(context: TurnContext, instance: DialogInstance, + function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise parameters: - id: context type: TurnContext description: Context for the current turn of conversation. - id: instance - type: + type: <any> description: The instance of the current dialog. - id: reason type: - description: | - The reason the dialog is ending. + description: The reason the dialog is ending. return: description: '' type: Promise<void> - name: getVersion() uid: botbuilder-dialogs.WaterfallDialog.getVersion package: botbuilder-dialogs - summary: 'Gets the dialog version, composed of the ID and number of steps.' + summary: Gets the dialog version, composed of the ID and number of steps. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getVersion(): string' return: - description: 'Dialog version, composed of the ID and number of steps.' + description: Dialog version, composed of the ID and number of steps. type: string - - name: 'resumeDialog(DialogContext, DialogReason, any)' + - name: resumeDialog(DialogContext, DialogReason, any) uid: botbuilder-dialogs.WaterfallDialog.resumeDialog package: botbuilder-dialogs summary: >- @@ -429,12 +417,11 @@ methods: [WaterfallDialog](xref:botbuilder-dialogs.WaterfallDialog) completed its turn, returning control to this dialog. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise + any): Promise> parameters: - id: dc type: @@ -443,7 +430,9 @@ methods: current turn of the conversation. - id: reason type: - description: '(xref:botbuilder-dialogs.DialogReason) why the dialog resumed.' + description: >- + [Reason](xref:botbuilder-dialogs.DialogReason) why the dialog + resumed. - id: result type: any description: |- @@ -451,5 +440,7 @@ methods: of the value returned is dependent on the child dialog. return: description: A Promise representing the asynchronous operation. - type: Promise<> + type: >- + Promise<<any>> extends: <O> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStep.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStep.yml index 70cdbcfc..430faaec 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStep.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStep.yml @@ -2,9 +2,10 @@ name: WaterfallStep uid: botbuilder-dialogs.WaterfallStep package: botbuilder-dialogs -summary: > +summary: >- Function signature of an individual waterfall step. + ```TypeScript type WaterfallStep = (step: WaterfallStepContext) => @@ -13,7 +14,6 @@ summary: > ``` fullName: WaterfallStep remarks: '' -isPreview: false isDeprecated: false syntax: | type WaterfallStep = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepContext.yml index f03381a3..caef8212 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepContext.yml @@ -5,16 +5,14 @@ package: botbuilder-dialogs summary: Context object passed in to a `WaterfallStep`. fullName: WaterfallStepContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'WaterfallStepContext(DialogContext, WaterfallStepInfo)' + - name: WaterfallStepContext(DialogContext, WaterfallStepInfo) uid: botbuilder-dialogs.WaterfallStepContext.constructor package: botbuilder-dialogs summary: Creates a new WaterfallStepContext instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new WaterfallStepContext(dc: DialogContext, info: WaterfallStepInfo)' @@ -24,8 +22,7 @@ constructors: description: The dialog context for the current turn of conversation. - id: info type: <O> - description: | - Values to initialize the step context with. + description: Values to initialize the step context with. properties: - name: activeDialog uid: botbuilder-dialogs.WaterfallStepContext.activeDialog @@ -33,39 +30,37 @@ properties: summary: '' fullName: activeDialog remarks: '' - isPreview: false isDeprecated: false syntax: - content: DialogInstance | undefined activeDialog + content: undefined | DialogInstance activeDialog return: description: >- The state information for the dialog on the top of the dialog stack, or `undefined` if the stack is empty. - type: | undefined + type: >- + undefined | <any> - name: child uid: botbuilder-dialogs.WaterfallStepContext.child package: botbuilder-dialogs summary: '' fullName: child remarks: '' - isPreview: false isDeprecated: false syntax: - content: DialogContext | undefined child + content: undefined | DialogContext child return: description: Dialog context for child if the active dialog is a container. - type: | undefined + type: undefined | - name: dialogManager uid: botbuilder-dialogs.WaterfallStepContext.dialogManager package: botbuilder-dialogs summary: '' fullName: dialogManager remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: This property serves no function. + isDeprecated: false syntax: content: DialogManager dialogManager return: @@ -77,7 +72,6 @@ properties: summary: The index of the current waterfall step being executed. fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: number index @@ -92,7 +86,6 @@ properties: `DialogContext.beginDialog()`. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: O options @@ -105,7 +98,6 @@ properties: summary: The reason the waterfall step is being executed. fullName: reason remarks: '' - isPreview: false isDeprecated: false syntax: content: DialogReason reason @@ -120,7 +112,6 @@ properties: waterfall step. fullName: result remarks: '' - isPreview: false isDeprecated: false syntax: content: any result @@ -133,7 +124,6 @@ properties: summary: A dictionary of values which will be persisted across all waterfall steps. fullName: values remarks: '' - isPreview: false isDeprecated: false syntax: content: object values @@ -149,7 +139,6 @@ inheritedProperties: summary: Gets the context object for the turn. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: TurnContext' @@ -165,7 +154,6 @@ inheritedProperties: summary: Gets the dialogs that can be called directly from this context. fullName: dialogs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dialogs: DialogSet' @@ -191,13 +179,12 @@ inheritedProperties: in this dialog context, it searches in its parent dialog context, and so on. - isPreview: false isDeprecated: false syntax: - content: 'parent: DialogContext | undefined' + content: 'parent: undefined | DialogContext' return: description: '' - type: | undefined + type: undefined | inheritanceDescription: >- Inherited From [DialogContext.parent](xref:botbuilder-dialogs.DialogContext.parent) @@ -207,7 +194,6 @@ inheritedProperties: summary: Gets the services collection which is contextual to this dialog context. fullName: services remarks: '' - isPreview: false isDeprecated: false syntax: content: 'services: TurnContextStateCollection' @@ -223,13 +209,12 @@ inheritedProperties: summary: Gets the current dialog stack. fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stack: DialogInstance[]' + content: 'stack: DialogInstance[]' return: description: '' - type: '[]' + type: <any>[] inheritanceDescription: >- Inherited From [DialogContext.stack](xref:botbuilder-dialogs.DialogContext.stack) @@ -239,7 +224,6 @@ inheritedProperties: summary: Gets the DialogStateManager which manages view of all memory scopes. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: DialogStateManager' @@ -250,7 +234,7 @@ inheritedProperties: Inherited From [DialogContext.state](xref:botbuilder-dialogs.DialogContext.state) inheritedMethods: - - name: 'beginDialog(string, object)' + - name: beginDialog(string, object) uid: botbuilder-dialogs.WaterfallStepContext.beginDialog package: botbuilder-dialogs summary: |- @@ -293,12 +277,11 @@ inheritedMethods: - [replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - [Dialog.beginDialog](xref:botbuilder-dialogs.Dialog.beginDialog) - isPreview: false isDeprecated: false syntax: content: >- function beginDialog(dialogId: string, options?: object): - Promise + Promise> parameters: - id: dialogId type: string @@ -308,14 +291,16 @@ inheritedMethods: description: Optional. Arguments to pass into the dialog when it starts. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) - - name: 'cancelAllDialogs(boolean, string, any)' + - name: cancelAllDialogs(boolean, string, any) uid: botbuilder-dialogs.WaterfallStepContext.cancelAllDialogs package: botbuilder-dialogs - summary: 'Cancels all dialogs on the dialog stack, and clears stack.' + summary: Cancels all dialogs on the dialog stack, and clears stack. remarks: >- This calls each dialog's [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) method before @@ -348,12 +333,11 @@ inheritedMethods: **See also** - [endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function cancelAllDialogs(cancelParents?: boolean, eventName?: string, - eventValue?: any): Promise + eventValue?: any): Promise> parameters: - id: cancelParents type: boolean @@ -369,7 +353,9 @@ inheritedMethods: description: Optional. Value to pass along with custom cancellation event. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs) @@ -411,24 +397,24 @@ inheritedMethods: } ``` - isPreview: false isDeprecated: false syntax: - content: 'function continueDialog(): Promise' + content: 'function continueDialog(): Promise>' return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog) - - name: 'emitEvent(string, any, boolean, boolean)' + - name: emitEvent(string, any, boolean, boolean) uid: botbuilder-dialogs.WaterfallStepContext.emitEvent package: botbuilder-dialogs summary: Searches for a dialog with a given ID. remarks: >- Emits a named event for the current dialog, or someone who started it, to handle. - isPreview: false isDeprecated: false syntax: content: >- @@ -507,10 +493,9 @@ inheritedMethods: - [replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) - [Dialog.endDialog](xref:botbuilder-dialogs.Dialog.endDialog) - isPreview: false isDeprecated: false syntax: - content: 'function endDialog(result?: any): Promise' + content: 'function endDialog(result?: any): Promise>' parameters: - id: result type: any @@ -521,7 +506,9 @@ inheritedMethods: the bot's turn handler. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) @@ -542,17 +529,16 @@ inheritedMethods: - [dialogs](xref:botbuilder-dialogs.DialogContext.dialogs) - [parent](xref:botbuilder-dialogs.DialogContext.parent) - isPreview: false isDeprecated: false syntax: - content: 'function findDialog(dialogId: string): Dialog | undefined' + content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' parameters: - id: dialogId type: string description: ID of the dialog to search for. return: description: The dialog for the provided ID. - type: | undefined + type: undefined | <{}> inheritanceDescription: >- Inherited From [DialogContext.findDialog](xref:botbuilder-dialogs.DialogContext.findDialog) @@ -561,7 +547,6 @@ inheritedMethods: package: botbuilder-dialogs summary: Obtain the CultureInfo in DialogContext. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLocale(): string' @@ -571,7 +556,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [DialogContext.getLocale](xref:botbuilder-dialogs.DialogContext.getLocale) - - name: 'prompt(string, string | Partial | PromptOptions)' + - name: prompt(string, string | Partial | PromptOptions) uid: botbuilder-dialogs.WaterfallStepContext.prompt package: botbuilder-dialogs summary: >- @@ -591,12 +576,11 @@ inheritedMethods: quit?`); ``` - isPreview: false isDeprecated: false syntax: content: >- function prompt(dialogId: string, promptOrOptions: string | - Partial | PromptOptions): Promise + Partial | PromptOptions): Promise> parameters: - id: dialogId type: string @@ -611,13 +595,15 @@ inheritedMethods: the object with which to format the prompt dialog. return: description: '' - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt) - name: >- - prompt(string, string | Partial | PromptOptions, string | - Choice[]) + prompt(string, string | Partial | PromptOptions, (string | + Choice)[]) uid: botbuilder-dialogs.WaterfallStepContext.prompt_1 package: botbuilder-dialogs summary: >- @@ -637,13 +623,12 @@ inheritedMethods: quit?`); ``` - isPreview: false isDeprecated: false syntax: content: >- function prompt(dialogId: string, promptOrOptions: string | - Partial | PromptOptions, choices: string | Choice[]): - Promise + Partial | PromptOptions, choices: (string | Choice)[]): + Promise> parameters: - id: dialogId type: string @@ -660,17 +645,19 @@ inheritedMethods: the object with which to format the prompt dialog. - id: choices - type: 'string | []' + type: (string | )[] description: |- Optional. Array of choices for the user to choose from, for use with a [ChoicePrompt](xref:botbuilder-dialogs.ChoicePrompt). return: description: '' - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.prompt](xref:botbuilder-dialogs.DialogContext.prompt) - - name: 'replaceDialog(string, object)' + - name: replaceDialog(string, object) uid: botbuilder-dialogs.WaterfallStepContext.replaceDialog package: botbuilder-dialogs summary: Ends the active dialog and starts a new dialog in its place. @@ -696,12 +683,11 @@ inheritedMethods: - [beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog) - [endDialog](xref:botbuilder-dialogs.DialogContext.endDialog) - isPreview: false isDeprecated: false syntax: content: >- function replaceDialog(dialogId: string, options?: object): - Promise + Promise> parameters: - id: dialogId type: string @@ -711,7 +697,9 @@ inheritedMethods: description: Optional. Arguments to pass into the new dialog when it starts. return: description: a promise resolving to the dialog turn result. - type: Promise<> + type: >- + Promise<<any>> inheritanceDescription: >- Inherited From [DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog) @@ -731,7 +719,6 @@ inheritedMethods: await dc.repromptDialog(); ``` - isPreview: false isDeprecated: false syntax: content: 'function repromptDialog(): Promise' @@ -750,15 +737,16 @@ methods: ```JavaScript return await step.skip(); ``` - isPreview: false isDeprecated: false syntax: - content: 'function next(result?: any): Promise' + content: 'function next(result?: any): Promise>' parameters: - id: result type: any description: (Optional) result to pass to the next step. return: description: A promise with the DialogTurnResult. - type: Promise<> + type: >- + Promise<<any>> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepInfo.yml index 88b56ff3..3055e701 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/WaterfallStepInfo.yml @@ -5,7 +5,6 @@ package: botbuilder-dialogs summary: Values passed to the `WaterfallStepContext` constructor. fullName: WaterfallStepInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The index of the current waterfall step being executed. fullName: index remarks: '' - isPreview: false isDeprecated: false syntax: content: 'index: number' @@ -30,7 +28,6 @@ properties: `DialogContext.beginDialog()`. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: O' @@ -43,7 +40,6 @@ properties: summary: The reason the waterfall step is being executed. fullName: reason remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reason: DialogReason' @@ -58,7 +54,6 @@ properties: waterfall step. fullName: result remarks: '' - isPreview: false isDeprecated: false syntax: content: 'result: any' @@ -71,7 +66,6 @@ properties: summary: A dictionary of values which will be persisted across all waterfall steps. fullName: values remarks: '' - isPreview: false isDeprecated: false syntax: content: 'values: object' @@ -84,15 +78,15 @@ methods: package: botbuilder-dialogs summary: Called to skip to the next waterfall step. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onNext(result?: any): Promise' + content: 'function onNext(result?: any): Promise>' parameters: - id: result type: any - description: | - (Optional) result to pass to the next step. + description: (Optional) result to pass to the next step. return: description: '' - type: Promise<> + type: >- + Promise<<any>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/index.yml index a5d97e40..060f717f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs/index.yml @@ -3,94 +3,150 @@ uid: botbuilder-dialogs name: botbuilder-dialogs summary: '' type: package -interfaces: - - botbuilder-dialogs.BeginSkillDialogOptions - - botbuilder-dialogs.ChoiceFactoryOptions - - botbuilder-dialogs.Choice - - botbuilder-dialogs.FindChoicesOptions - - botbuilder-dialogs.FoundChoice - - botbuilder-dialogs.FindValuesOptions - - botbuilder-dialogs.FoundValue - - botbuilder-dialogs.SortedValue - - botbuilder-dialogs.ModelResult - - botbuilder-dialogs.Token - - botbuilder-dialogs.Converter - - botbuilder-dialogs.DialogConfiguration - - botbuilder-dialogs.DialogEvent - - botbuilder-dialogs.DialogInstance - - botbuilder-dialogs.DialogTurnResult - - botbuilder-dialogs.DialogState - - botbuilder-dialogs.DialogManagerConfiguration - - botbuilder-dialogs.DialogManagerResult - - botbuilder-dialogs.DialogDependencies - - botbuilder-dialogs.ComponentMemoryScopes - - botbuilder-dialogs.ComponentPathResolvers - - botbuilder-dialogs.DialogStateManagerConfiguration - - botbuilder-dialogs.PathResolver - - botbuilder-dialogs.ChoiceDefaultsChoicePrompt - - botbuilder-dialogs.ChoiceDefaultsConfirmPrompt - - botbuilder-dialogs.DateTimeResolution - - botbuilder-dialogs.OAuthPromptSettings - - botbuilder-dialogs.PromptOptions - - botbuilder-dialogs.PromptRecognizerResult - - botbuilder-dialogs.PromptValidatorContext - - botbuilder-dialogs.PromptCultureModel - - botbuilder-dialogs.RecognizerConfiguration - - botbuilder-dialogs.SkillDialogOptions - - botbuilder-dialogs.TemplateInterface - - botbuilder-dialogs.WaterfallStepInfo +enums: + - botbuilder-dialogs.DialogReason + - botbuilder-dialogs.DialogTurnStatus + - botbuilder-dialogs.ListStyle classes: + - botbuilder-dialogs.ActivityPrompt + - botbuilder-dialogs.AliasPathResolver + - botbuilder-dialogs.AtAtPathResolver + - botbuilder-dialogs.AtPathResolver + - botbuilder-dialogs.AttachmentPrompt + - botbuilder-dialogs.BotStateMemoryScope - botbuilder-dialogs.ChoiceFactory + - botbuilder-dialogs.ChoicePrompt + - botbuilder-dialogs.ClassMemoryScope - botbuilder-dialogs.ComponentDialog - botbuilder-dialogs.Configurable + - botbuilder-dialogs.ConfirmPrompt + - botbuilder-dialogs.ConversationMemoryScope + - botbuilder-dialogs.DateTimePrompt - botbuilder-dialogs.Dialog + - botbuilder-dialogs.DialogClassMemoryScope - botbuilder-dialogs.DialogContainer - botbuilder-dialogs.DialogContext - botbuilder-dialogs.DialogContextError + - botbuilder-dialogs.DialogContextMemoryScope - botbuilder-dialogs.DialogEvents - botbuilder-dialogs.DialogManager + - botbuilder-dialogs.DialogMemoryScope + - botbuilder-dialogs.DialogPath - botbuilder-dialogs.DialogSet + - botbuilder-dialogs.DialogStateManager - botbuilder-dialogs.DialogTurnStateConstants - botbuilder-dialogs.DialogsBotComponent - - botbuilder-dialogs.DialogsComponentRegistration - - botbuilder-dialogs.DialogPath - - botbuilder-dialogs.DialogStateManager - - botbuilder-dialogs.AliasPathResolver - - botbuilder-dialogs.AtAtPathResolver - - botbuilder-dialogs.AtPathResolver - botbuilder-dialogs.DollarPathResolver - botbuilder-dialogs.HashPathResolver - - botbuilder-dialogs.PercentPathResolver - - botbuilder-dialogs.ScopePath - - botbuilder-dialogs.BotStateMemoryScope - - botbuilder-dialogs.ClassMemoryScope - - botbuilder-dialogs.ConversationMemoryScope - - botbuilder-dialogs.DialogClassMemoryScope - - botbuilder-dialogs.DialogContextMemoryScope - - botbuilder-dialogs.DialogMemoryScope - botbuilder-dialogs.MemoryScope - - botbuilder-dialogs.SettingsMemoryScope - - botbuilder-dialogs.ThisMemoryScope - - botbuilder-dialogs.TurnMemoryScope - - botbuilder-dialogs.UserMemoryScope - - botbuilder-dialogs.ThisPath - - botbuilder-dialogs.TurnPath - - botbuilder-dialogs.ActivityPrompt - - botbuilder-dialogs.AttachmentPrompt - - botbuilder-dialogs.ChoicePrompt - - botbuilder-dialogs.ConfirmPrompt - - botbuilder-dialogs.DateTimePrompt - botbuilder-dialogs.NumberPrompt - botbuilder-dialogs.OAuthPrompt + - botbuilder-dialogs.PercentPathResolver - botbuilder-dialogs.Prompt - botbuilder-dialogs.PromptCultureModels - - botbuilder-dialogs.TextPrompt - botbuilder-dialogs.Recognizer + - botbuilder-dialogs.ScopePath + - botbuilder-dialogs.SettingsMemoryScope - botbuilder-dialogs.SkillDialog + - botbuilder-dialogs.TextPrompt + - botbuilder-dialogs.ThisMemoryScope + - botbuilder-dialogs.ThisPath + - botbuilder-dialogs.TurnMemoryScope + - botbuilder-dialogs.TurnPath + - botbuilder-dialogs.UserMemoryScope - botbuilder-dialogs.WaterfallDialog - botbuilder-dialogs.WaterfallStepContext +interfaces: + - botbuilder-dialogs.BeginSkillDialogOptions + - botbuilder-dialogs.Choice + - botbuilder-dialogs.ChoiceFactoryOptions + - botbuilder-dialogs.ComponentMemoryScopes + - botbuilder-dialogs.ComponentPathResolvers + - botbuilder-dialogs.Converter + - botbuilder-dialogs.DateTimeResolution + - botbuilder-dialogs.DialogConfiguration + - botbuilder-dialogs.DialogDependencies + - botbuilder-dialogs.DialogEvent + - botbuilder-dialogs.DialogInstance + - botbuilder-dialogs.DialogManagerConfiguration + - botbuilder-dialogs.DialogManagerResult + - botbuilder-dialogs.DialogState + - botbuilder-dialogs.DialogStateManagerConfiguration + - botbuilder-dialogs.DialogTurnResult + - botbuilder-dialogs.FindChoicesOptions + - botbuilder-dialogs.FindValuesOptions + - botbuilder-dialogs.FoundChoice + - botbuilder-dialogs.FoundValue + - botbuilder-dialogs.ModelResult + - botbuilder-dialogs.OAuthPromptSettings + - botbuilder-dialogs.PathResolver + - botbuilder-dialogs.PromptCultureModel + - botbuilder-dialogs.PromptOptions + - botbuilder-dialogs.PromptRecognizerResult + - botbuilder-dialogs.PromptValidatorContext + - botbuilder-dialogs.RecognizerConfiguration + - botbuilder-dialogs.SkillDialogOptions + - botbuilder-dialogs.SortedValue + - botbuilder-dialogs.TemplateInterface + - botbuilder-dialogs.Token + - botbuilder-dialogs.WaterfallStepInfo +typeAliases: + - botbuilder-dialogs.ConverterFactory + - botbuilder-dialogs.PromptValidator + - botbuilder-dialogs.TokenizerFunction + - botbuilder-dialogs.WaterfallStep functions: - - name: 'findChoices(string, string | Choice[], FindChoicesOptions)' + - name: defaultTokenizer(string, string) + uid: botbuilder-dialogs.defaultTokenizer + package: botbuilder-dialogs + summary: Simple tokenizer that breaks on spaces and punctuation. + remarks: >- + The only normalization done is to lowercase the tokens. Developers can + wrap this tokenizer with + + their own function to perform additional normalization like + [stemming](https://github.com/words/stemmer). + + + ```JavaScript + + const { recognizeChoices, defaultTokenizer } = + require('botbuilder-choices'); + + const stemmer = require('stemmer'); + + + function customTokenizer(text, locale) { + const tokens = defaultTokenizer(text, locale); + tokens.forEach((t) => { + t.normalized = stemmer(t.normalized); + }); + return tokens; + } + + + const choices = ['red', 'green', 'blue']; + + const utterance = context.activity.text; + + const results = recognizeChoices(utterance, choices, { tokenizer: + customTokenizer }); + + ``` + isDeprecated: false + syntax: + content: 'function defaultTokenizer(text: string, _locale?: string): Token[]' + parameters: + - id: text + type: string + description: The input text. + - id: _locale + type: string + description: Optional, identifies the locale of the input text. + return: + description: A list of tokens. + type: [] + - name: findChoices(string, (string | Choice)[], FindChoicesOptions) uid: botbuilder-dialogs.findChoices package: botbuilder-dialogs summary: Mid-level search function for recognizing a choice in an utterance. @@ -132,11 +188,10 @@ functions: } ``` - isPreview: false isDeprecated: false syntax: content: >- - function findChoices(utterance: string, choices: string | Choice[], + function findChoices(utterance: string, choices: (string | Choice)[], options?: FindChoicesOptions): ModelResult[] parameters: - id: utterance @@ -145,17 +200,17 @@ functions: The text or user utterance to search over. For an incoming 'message' activity you can simply use `context.activity.text`. - id: choices - type: 'string | []' + type: (string | )[] description: List of choices to search over. - id: options type: description: (Optional) options used to tweak the search that's performed. return: - description: 'A list of found choices, sorted by most relevant first.' + description: A list of found choices, sorted by most relevant first. type: >- <>[] - - name: 'findValues(string, SortedValue[], FindValuesOptions)' + - name: findValues(string, SortedValue[], FindValuesOptions) uid: botbuilder-dialogs.findValues package: botbuilder-dialogs summary: >- @@ -170,7 +225,6 @@ functions: the fuzzy search algorithm that drives choice recognition. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -181,7 +235,7 @@ functions: type: string description: The text or user utterance to search over. - id: values - type: '[]' + type: [] description: List of values to search over. - id: options type: @@ -191,7 +245,47 @@ functions: type: >- <>[] - - name: 'recognizeChoices(string, string | Choice[], FindChoicesOptions)' + - name: isComponentMemoryScopes(unknown) + uid: botbuilder-dialogs.isComponentMemoryScopes + package: botbuilder-dialogs + summary: >- + Check if a + [ComponentRegistration](xref:botbuilder-core.ComponentRegistration) is + + [ComponentMemoryScopes](xref:botbuilder-dialogs.ComponentMemoryScopes) or + not. + remarks: '' + isDeprecated: false + syntax: + content: 'function isComponentMemoryScopes(component: unknown): component' + parameters: + - id: component + type: unknown + description: The component registration. + return: + description: Type check result. + type: component + - name: isComponentPathResolvers(unknown) + uid: botbuilder-dialogs.isComponentPathResolvers + package: botbuilder-dialogs + summary: >- + Check if a + [ComponentRegistration](xref:botbuilder-core.ComponentRegistration) is + + [ComponentPathResolvers](xref:botbuilder-dialogs.ComponentPathResolvers) + or not. + remarks: '' + isDeprecated: false + syntax: + content: 'function isComponentPathResolvers(component: unknown): component' + parameters: + - id: component + type: unknown + description: The component registration. + return: + description: Type check result. + type: component + - name: recognizeChoices(string, (string | Choice)[], FindChoicesOptions) uid: botbuilder-dialogs.recognizeChoices package: botbuilder-dialogs summary: High level function for recognizing a choice in a users utterance. @@ -234,12 +328,11 @@ functions: } ``` - isPreview: false isDeprecated: false syntax: content: >- - function recognizeChoices(utterance: string, choices: string | Choice[], - options?: FindChoicesOptions): ModelResult[] + function recognizeChoices(utterance: string, choices: (string | + Choice)[], options?: FindChoicesOptions): ModelResult[] parameters: - id: utterance type: string @@ -247,355 +340,42 @@ functions: The text or user utterance to search over. For an incoming 'message' activity you can simply use `context.activity.text`. - id: choices - type: 'string | []' + type: (string | )[] description: List of choices to search over. - id: options type: description: (Optional) options used to tweak the search that's performed. return: - description: 'A list of found choices, sorted by most relevant first.' + description: A list of found choices, sorted by most relevant first. type: >- <>[] - - name: 'defaultTokenizer(string, string)' - uid: botbuilder-dialogs.defaultTokenizer - package: botbuilder-dialogs - summary: Simple tokenizer that breaks on spaces and punctuation. - remarks: >- - The only normalization done is to lowercase the tokens. Developers can - wrap this tokenizer with - - their own function to perform additional normalization like - [stemming](https://github.com/words/stemmer). - - - ```JavaScript - - const { recognizeChoices, defaultTokenizer } = - require('botbuilder-choices'); - - const stemmer = require('stemmer'); - - - function customTokenizer(text, locale) { - const tokens = defaultTokenizer(text, locale); - tokens.forEach((t) => { - t.normalized = stemmer(t.normalized); - }); - return tokens; - } - - - const choices = ['red', 'green', 'blue']; - - const utterance = context.activity.text; - - const results = recognizeChoices(utterance, choices, { tokenizer: - customTokenizer }); - - ``` - isPreview: false - isDeprecated: false - syntax: - content: 'function defaultTokenizer(text: string, _locale?: string): Token[]' - parameters: - - id: text - type: string - description: The input text. - - id: _locale - type: string - description: 'Optional, identifies the locale of the input text.' - return: - description: A list of tokens. - type: '[]' - - name: getActiveDialogContext(DialogContext) - uid: botbuilder-dialogs.getActiveDialogContext - package: botbuilder-dialogs - summary: Recursively walk up the DC stack to find the active DC. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getActiveDialogContext(dialogContext: DialogContext): - DialogContext - parameters: - - id: dialogContext - type: - description: >- - (xref:botbuilder-dialogs.DialogContext) for the current turn of - conversation with the user. - return: - description: 'Active [DialogContext](xref:botbuilder-dialogs.DialogContext).' - type: - - name: >- - internalRun(TurnContext, string, DialogContext, - DialogStateManagerConfiguration) - uid: botbuilder-dialogs.internalRun - package: botbuilder-dialogs - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function internalRun(context: TurnContext, dialogId: string, - dialogContext: DialogContext, dialogStateManagerConfiguration?: - DialogStateManagerConfiguration): Promise - parameters: - - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for the turn.' - - id: dialogId - type: string - description: The dialog ID. - - id: dialogContext - type: - description: >- - The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the - current turn of conversation. - - id: dialogStateManagerConfiguration - type: - description: Configuration for the dialog state manager. - return: - description: a promise resolving to the dialog turn result. - type: Promise<> - - name: isFromParentToSkill(TurnContext) - uid: botbuilder-dialogs.isFromParentToSkill - package: botbuilder-dialogs - summary: Determines if the skill is acting as a skill parent. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isFromParentToSkill(context: TurnContext): boolean' - parameters: - - id: context - type: TurnContext - description: >- - (xref:botbuilder-core.TurnContext) object for the current turn of - conversation with the user. - return: - description: A boolean representing if the skill is acting as a skill parent. - type: boolean - - name: 'runDialog(Dialog, TurnContext, StatePropertyAccessor)' + - name: runDialog(Dialog<{}>, TurnContext, StatePropertyAccessor) uid: botbuilder-dialogs.runDialog package: botbuilder-dialogs summary: Runs a dialog from a given context and accessor. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function runDialog(dialog: Dialog, context: TurnContext, accessor: + function runDialog(dialog: Dialog<{}>, context: TurnContext, accessor: StatePropertyAccessor): Promise parameters: - id: dialog - type: - description: 'The [Dialog](xref:botbuilder-dialogs.Dialog) to run.' + type: <{}> + description: The [Dialog](xref:botbuilder-dialogs.Dialog) to run. - id: context type: TurnContext description: >- - (xref:botbuilder-core.TurnContext) object for the current turn of - conversation with the user. + [TurnContext](xref:botbuilder-core.TurnContext) object for the + current turn of conversation with the user. - id: accessor type: >- StatePropertyAccessor<> - description: > + description: >- Defined methods for accessing the state property created in a BotState object. return: description: '' type: Promise<void> - - name: 'shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)' - uid: botbuilder-dialogs.shouldSendEndOfConversationToParent - package: botbuilder-dialogs - summary: Helper to determine if we should send an EoC to the parent or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function shouldSendEndOfConversationToParent(context: TurnContext, - turnResult: DialogTurnResult): boolean - parameters: - - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for the turn.' - - id: turnResult - type: - description: The dialog turn result. - return: - description: 'True if should send EoC, otherwise false.' - type: boolean - - name: isComponentMemoryScopes(unknown) - uid: botbuilder-dialogs.isComponentMemoryScopes - package: botbuilder-dialogs - summary: >- - Check if a - [ComponentRegistration](xref:botbuilder-core.ComponentRegistration) is - - [ComponentMemoryScopes](xref:botbuilder-dialogs.ComponentMemoryScopes) or - not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isComponentMemoryScopes(component: unknown): boolean' - parameters: - - id: component - type: unknown - description: The component registration. - return: - description: Type check result. - type: boolean - - name: isComponentPathResolvers(unknown) - uid: botbuilder-dialogs.isComponentPathResolvers - package: botbuilder-dialogs - summary: >- - Check if a - [ComponentRegistration](xref:botbuilder-core.ComponentRegistration) is - - [ComponentPathResolvers](xref:botbuilder-dialogs.ComponentPathResolvers) - or not. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isComponentPathResolvers(component: unknown): boolean' - parameters: - - id: component - type: unknown - description: The component registration. - return: - description: Type check result. - type: boolean - - name: 'createConnectorClient(TurnContext, string, ClaimsIdentity, string)' - uid: botbuilder-dialogs.createConnectorClient - package: botbuilder-dialogs - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createConnectorClient(context: TurnContext, serviceUrl: string, - claimsIdentity: ClaimsIdentity, audience: string): - Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: serviceUrl - type: string - description: '' - - id: claimsIdentity - type: ClaimsIdentity - description: '' - - id: audience - type: string - description: '' - return: - description: '' - type: Promise<ConnectorClient> - - name: 'exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)' - uid: botbuilder-dialogs.exchangeToken - package: botbuilder-dialogs - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function exchangeToken(context: TurnContext, settings: - OAuthPromptSettings, tokenExchangeRequest: TokenExchangeRequest): - Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: settings - type: - description: '' - - id: tokenExchangeRequest - type: TokenExchangeRequest - description: '' - return: - description: '' - type: Promise<TokenResponse> - - name: 'getSignInResource(TurnContext, OAuthPromptSettings)' - uid: botbuilder-dialogs.getSignInResource - package: botbuilder-dialogs - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInResource(context: TurnContext, settings: - OAuthPromptSettings): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: settings - type: - description: '' - return: - description: '' - type: Promise<SignInUrlResponse> - - name: 'getUserToken(TurnContext, OAuthPromptSettings, string)' - uid: botbuilder-dialogs.getUserToken - package: botbuilder-dialogs - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getUserToken(context: TurnContext, settings: - OAuthPromptSettings, magicCode: string): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: settings - type: - description: '' - - id: magicCode - type: string - description: '' - return: - description: '' - type: Promise<TokenResponse> - - name: 'signOutUser(TurnContext, OAuthPromptSettings)' - uid: botbuilder-dialogs.signOutUser - package: botbuilder-dialogs - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signOutUser(context: TurnContext, settings: - OAuthPromptSettings): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: settings - type: - description: '' - return: - description: '' - type: Promise<void> -typeAliases: - - botbuilder-dialogs.TokenizerFunction - - botbuilder-dialogs.ConverterFactory - - botbuilder-dialogs.PromptValidator - - botbuilder-dialogs.WaterfallStep -enums: - - botbuilder-dialogs.DialogReason - - botbuilder-dialogs.DialogTurnStatus - - botbuilder-dialogs.ListStyle diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Analyzer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Analyzer.yml index 9ca435dd..fc137176 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Analyzer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Analyzer.yml @@ -5,18 +5,16 @@ package: botbuilder-lg summary: Analyzer engine. To get the static analyzer results. fullName: Analyzer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Analyzer(Templates, EvaluationOptions, AnalyzerOptions)' + - name: Analyzer(Templates, EvaluationOptions, AnalyzerOptions) uid: botbuilder-lg.Analyzer.constructor package: botbuilder-lg summary: >- Creates a new instance of the [Analyzer](xref:botbuilder-lg.Analyzer) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,8 +29,7 @@ constructors: description: Options for LG. - id: analyzerOptions type: - description: | - Options for the analyzer. + description: Options for the analyzer. properties: - name: templates uid: botbuilder-lg.Analyzer.templates @@ -40,7 +37,6 @@ properties: summary: Templates. fullName: templates remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templates: Templates' @@ -51,12 +47,12 @@ inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.Analyzer.visit package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation calls on the specified tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): AnalyzerResult' @@ -71,8 +67,9 @@ inheritedMethods: - name: visitChildren(RuleNode) uid: botbuilder-lg.Analyzer.visitChildren package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation initializes the aggregate result to [defaultResult()](xref:%23defaultResult). Before visiting each child, it calls [shouldVisitNextChild](xref:%23shouldVisitNextChild); if the result @@ -85,7 +82,6 @@ inheritedMethods: the tree structure. Visitors that modify the tree should override this method to behave properly in respect to the specific algorithm in use. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): AnalyzerResult' @@ -100,12 +96,12 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.Analyzer.visitErrorNode package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): AnalyzerResult' @@ -120,12 +116,12 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: botbuilder-lg.Analyzer.visitTerminal package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): AnalyzerResult' @@ -143,7 +139,6 @@ methods: package: botbuilder-lg summary: Analyze a template to get the static analyzer results. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function analyzeTemplate(templateName: string): AnalyzerResult' @@ -161,7 +156,6 @@ methods: Visit a parse tree produced by the ifElseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitIfElseBody(ctx: IfElseBodyContext): AnalyzerResult' @@ -170,7 +164,7 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: - name: visitNormalBody(NormalBodyContext) uid: botbuilder-lg.Analyzer.visitNormalBody @@ -179,7 +173,6 @@ methods: Visit a parse tree produced by the normalBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitNormalBody(ctx: NormalBodyContext): AnalyzerResult' @@ -188,14 +181,13 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: - name: visitNormalTemplateBody(NormalTemplateBodyContext) uid: botbuilder-lg.Analyzer.visitNormalTemplateBody package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -206,14 +198,13 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: - name: visitNormalTemplateString(NormalTemplateStringContext) uid: botbuilder-lg.Analyzer.visitNormalTemplateString package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateString. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,14 +215,13 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: - name: visitStructuredTemplateBody(StructuredTemplateBodyContext) uid: botbuilder-lg.Analyzer.visitStructuredTemplateBody package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.structuredTemplateBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,14 +232,13 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: - name: visitStructureValue(KeyValueStructureLineContext) uid: botbuilder-lg.Analyzer.visitStructureValue package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.structuredValue. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -260,7 +249,7 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: - name: visitSwitchCaseBody(SwitchCaseBodyContext) uid: botbuilder-lg.Analyzer.visitSwitchCaseBody @@ -269,7 +258,6 @@ methods: Visit a parse tree produced by the switchCaseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitSwitchCaseBody(ctx: SwitchCaseBodyContext): AnalyzerResult' @@ -278,6 +266,6 @@ methods: type: description: The parse tree. return: - description: 'The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance.' + description: The [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) instance. type: extends: AbstractParseTreeVisitor<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerOptions.yml index 14b5582c..7c058548 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerOptions.yml @@ -5,25 +5,23 @@ package: botbuilder-lg summary: Options for analyzing LG templates. fullName: AnalyzerOptions remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AnalyzerOptions(AnalyzerOptions | string[])' + - name: AnalyzerOptions(string[] | AnalyzerOptions) uid: botbuilder-lg.AnalyzerOptions.constructor package: botbuilder-lg summary: >- Initializes a new instance of the [AnalyzerOptions](xref:botbuilder-lg.AnalyzerOptions) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new AnalyzerOptions(options?: AnalyzerOptions | string[])' + content: 'new AnalyzerOptions(options?: string[] | AnalyzerOptions)' parameters: - id: options - type: ' | string[]' - description: > + type: string[] | + description: >- Optional. Instance to copy analyzer settings from or list of strings containing the options from an LG file. properties: @@ -33,12 +31,11 @@ properties: summary: Gets or sets a value determining if recursive calls throw an exception. fullName: ThrowOnRecursive remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ThrowOnRecursive?: boolean = null' + content: 'ThrowOnRecursive?: boolean' return: - description: '' + description: When true, throw an exception if a recursive call is detected. type: boolean methods: - name: Merge(AnalyzerOptions) @@ -50,7 +47,6 @@ methods: option, then the value of this property will be overwritten. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function Merge(opt: AnalyzerOptions): AnalyzerOptions' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerResult.yml index 9e7be79f..72fc743a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/AnalyzerResult.yml @@ -5,29 +5,26 @@ package: botbuilder-lg summary: Analyzer result. Contains variables and template references. fullName: AnalyzerResult remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AnalyzerResult(string[], string[])' + - name: AnalyzerResult(string[], string[]) uid: botbuilder-lg.AnalyzerResult.constructor package: botbuilder-lg summary: >- Creates a new instance of the [AnalyzerResult](xref:botbuilder-lg.AnalyzerResult) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new AnalyzerResult(variables: string[], templateRefNames: string[])' + content: 'new AnalyzerResult(variables?: string[], templateRefNames?: string[])' parameters: - id: variables - type: 'string[]' + type: string[] description: Init varibales. - id: templateRefNames - type: 'string[]' - description: | - Init template references. + type: string[] + description: Init template references. properties: - name: TemplateReferences uid: botbuilder-lg.AnalyzerResult.TemplateReferences @@ -35,40 +32,37 @@ properties: summary: template references that this template contains. fullName: TemplateReferences remarks: '' - isPreview: false isDeprecated: false syntax: content: 'TemplateReferences: string[]' return: description: '' - type: 'string[]' + type: string[] - name: Variables uid: botbuilder-lg.AnalyzerResult.Variables package: botbuilder-lg summary: Variables that this template contains. fullName: Variables remarks: '' - isPreview: false isDeprecated: false syntax: content: 'Variables: string[]' return: description: '' - type: 'string[]' + type: string[] methods: - name: union(AnalyzerResult) uid: botbuilder-lg.AnalyzerResult.union package: botbuilder-lg summary: Combine two analyzer results. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function union(outputItem: AnalyzerResult): this' + content: 'function union(outputItem: AnalyzerResult): AnalyzerResult' parameters: - id: outputItem type: description: Another analyzer result. return: description: Combined analyzer result. - type: this + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/BodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/BodyContext.yml index c7f375e0..e2642f77 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/BodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/BodyContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: BodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BodyContext(ParserRuleContext | undefined, number)' + - name: BodyContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.BodyContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new BodyContext(parent: ParserRuleContext | undefined, invokingState: + new BodyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.BodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.BodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.BodyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.BodyContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.BodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.BodyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.BodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: BodyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.BodyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,40 +216,38 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.BodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: accept(ParseTreeVisitor) uid: botbuilder-lg.BodyContext.accept package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: ParseTreeVisitor): T' @@ -275,22 +258,20 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From RuleContext.accept + inheritanceDescription: Inherited From ParserRuleContext.accept - name: addAnyChild(T) uid: botbuilder-lg.BodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -307,7 +288,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -321,7 +301,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -343,7 +322,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -361,7 +339,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -386,7 +363,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -404,20 +380,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.BodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -430,7 +404,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: ParseTreeListener)' @@ -444,7 +417,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: ParseTreeListener)' @@ -458,7 +430,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -470,32 +441,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.BodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.BodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -511,50 +480,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.BodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.BodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.BodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -574,7 +540,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -584,7 +549,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.BodyContext.removeLastChild @@ -594,7 +559,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -604,7 +568,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -612,7 +575,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.BodyContext.toInfoString package: botbuilder-lg @@ -620,7 +583,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -637,105 +599,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.BodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.BodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.BodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.BodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.BodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.BodyContext.toStringTree package: botbuilder-lg @@ -744,7 +700,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -755,75 +710,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.BodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.BodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.BodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.BodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -833,7 +788,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: copyFrom(BodyContext) @@ -841,7 +796,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: BodyContext)' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CommentDefinitionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CommentDefinitionContext.yml index 63048324..ab26dca6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CommentDefinitionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CommentDefinitionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: CommentDefinitionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'CommentDefinitionContext(ParserRuleContext | undefined, number)' + - name: CommentDefinitionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.CommentDefinitionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new CommentDefinitionContext(parent: ParserRuleContext | undefined, + new CommentDefinitionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.CommentDefinitionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.CommentDefinitionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.CommentDefinitionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.CommentDefinitionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.CommentDefinitionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.CommentDefinitionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.CommentDefinitionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: CommentDefinitionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.CommentDefinitionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.CommentDefinitionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.CommentDefinitionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.CommentDefinitionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.CommentDefinitionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.CommentDefinitionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.CommentDefinitionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.CommentDefinitionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.CommentDefinitionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.CommentDefinitionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.CommentDefinitionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.CommentDefinitionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.CommentDefinitionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.CommentDefinitionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.CommentDefinitionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.CommentDefinitionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.CommentDefinitionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.CommentDefinitionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.CommentDefinitionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.CommentDefinitionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.CommentDefinitionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.CommentDefinitionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function COMMENT(): TerminalNode' @@ -848,7 +804,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -861,7 +816,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -874,11 +828,10 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CustomizedMemory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CustomizedMemory.yml index d3370e97..fb00fbfe 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CustomizedMemory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/CustomizedMemory.yml @@ -8,18 +8,16 @@ summary: |- accessible at any sub evaluation process. fullName: CustomizedMemory remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'CustomizedMemory(unknown, MemoryInterface)' + - name: CustomizedMemory(unknown, MemoryInterface) uid: botbuilder-lg.CustomizedMemory.constructor package: botbuilder-lg summary: >- Creates a new instance of the [CustomizedMemory](xref:botbuilder-lg.CustomizedMemory) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CustomizedMemory(scope?: unknown, localMemory?: MemoryInterface)' @@ -29,8 +27,7 @@ constructors: description: Optional. Scope. - id: localMemory type: MemoryInterface - description: | - Optional. Local memory. + description: Optional. Local memory. properties: - name: globalMemory uid: botbuilder-lg.CustomizedMemory.globalMemory @@ -38,7 +35,6 @@ properties: summary: Global memory. fullName: globalMemory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'globalMemory: MemoryInterface' @@ -51,7 +47,6 @@ properties: summary: Local memory. fullName: localMemory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localMemory: MemoryInterface' @@ -67,7 +62,6 @@ methods: memory, if global memory does not contain, get from local memory. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getValue(path: string): any' @@ -78,12 +72,11 @@ methods: return: description: Resolved value. type: any - - name: 'setValue(string, any)' + - name: setValue(string, any) uid: botbuilder-lg.CustomizedMemory.setValue package: botbuilder-lg summary: Set value to a given path. This method is not implemented. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setValue(_path: string, _value: any)' @@ -93,8 +86,7 @@ methods: description: Memory path. - id: _value type: any - description: | - Value to set. + description: Value to set. - name: version() uid: botbuilder-lg.CustomizedMemory.version package: botbuilder-lg @@ -105,7 +97,6 @@ methods: If version is not changed, the caller may choose to use the cached result instead of recomputing everything. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function version(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Diagnostic.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Diagnostic.yml index 4e0bccc8..2ad9e00d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Diagnostic.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Diagnostic.yml @@ -5,22 +5,20 @@ package: botbuilder-lg summary: Diagnostic class fullName: Diagnostic remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Diagnostic(Range, string, DiagnosticSeverity, string, string)' + - name: Diagnostic(Range, string, DiagnosticSeverity, string, string) uid: botbuilder-lg.Diagnostic.constructor package: botbuilder-lg summary: >- Creates a new instance of the [Diagnostic](xref:botbuilder-lg.Diagnostic) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new Diagnostic(range: Range, message: string, severity: + new Diagnostic(range: Range, message: string, severity?: DiagnosticSeverity, source?: string, code?: string) parameters: - id: range @@ -37,8 +35,7 @@ constructors: description: Source of the error or warning occurred. - id: code type: string - description: | - Code or identifier of the error or warning. + description: Code or identifier of the error or warning. properties: - name: code uid: botbuilder-lg.Diagnostic.code @@ -46,7 +43,6 @@ properties: summary: '' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: content: 'code: string' @@ -59,7 +55,6 @@ properties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -72,7 +67,6 @@ properties: summary: '' fullName: range remarks: '' - isPreview: false isDeprecated: false syntax: content: 'range: Range' @@ -85,7 +79,6 @@ properties: summary: '' fullName: severity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'severity: DiagnosticSeverity' @@ -98,7 +91,6 @@ properties: summary: '' fullName: source remarks: '' - isPreview: false isDeprecated: false syntax: content: 'source: string' @@ -113,7 +105,6 @@ methods: Returns a string that represents the current [Diagnostic](xref:botbuilder-lg.Diagnostic) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/DiagnosticSeverity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/DiagnosticSeverity.yml index e7737f23..d26fc9e7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/DiagnosticSeverity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/DiagnosticSeverity.yml @@ -5,22 +5,25 @@ package: botbuilder-lg summary: DiagnosticSeverity enum fullName: DiagnosticSeverity remarks: '' -isPreview: false isDeprecated: false fields: - name: Error uid: botbuilder-lg.DiagnosticSeverity.Error package: botbuilder-lg summary: '' - - name: Hint - uid: botbuilder-lg.DiagnosticSeverity.Hint + numericValue: 0 + - name: Warning + uid: botbuilder-lg.DiagnosticSeverity.Warning package: botbuilder-lg summary: '' + numericValue: 1 - name: Information uid: botbuilder-lg.DiagnosticSeverity.Information package: botbuilder-lg summary: '' - - name: Warning - uid: botbuilder-lg.DiagnosticSeverity.Warning + numericValue: 2 + - name: Hint + uid: botbuilder-lg.DiagnosticSeverity.Hint package: botbuilder-lg summary: '' + numericValue: 3 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorDefinitionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorDefinitionContext.yml index 9b9f489f..60b62376 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorDefinitionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorDefinitionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ErrorDefinitionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ErrorDefinitionContext(ParserRuleContext | undefined, number)' + - name: ErrorDefinitionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ErrorDefinitionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ErrorDefinitionContext(parent: ParserRuleContext | undefined, + new ErrorDefinitionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ErrorDefinitionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ErrorDefinitionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ErrorDefinitionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ErrorDefinitionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ErrorDefinitionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ErrorDefinitionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ErrorDefinitionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ErrorDefinitionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ErrorDefinitionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ErrorDefinitionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ErrorDefinitionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ErrorDefinitionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ErrorDefinitionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorDefinitionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ErrorDefinitionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorDefinitionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ErrorDefinitionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ErrorDefinitionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ErrorDefinitionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ErrorDefinitionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ErrorDefinitionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ErrorDefinitionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ErrorDefinitionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ErrorDefinitionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ErrorDefinitionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ErrorDefinitionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ErrorDefinitionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorDefinitionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorDefinitionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ErrorDefinitionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -862,7 +817,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function INVALID_LINE(): TerminalNode' @@ -874,11 +828,10 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorListener.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorListener.yml index 76825d9f..5eadff7d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorListener.yml @@ -5,18 +5,16 @@ package: botbuilder-lg summary: LG parser error listener. fullName: ErrorListener remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ErrorListener(string, number)' + - name: ErrorListener(string, number) uid: botbuilder-lg.ErrorListener.constructor package: botbuilder-lg summary: >- Creates a new instance of the [ErrorListener](xref:botbuilder-lg.ErrorListener) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ErrorListener(errorSource: string, lineOffset?: number)' @@ -26,26 +24,24 @@ constructors: description: String value that represents the source of the error. - id: lineOffset type: number - description: | - Offset of the line where the error occurred. + description: Offset of the line where the error occurred. methods: - name: >- - syntaxError(Recognizer, any, number, number, string, - RecognitionException | undefined) + syntaxError(Recognizer, any, number, number, string, undefined + | RecognitionException) uid: botbuilder-lg.ErrorListener.syntaxError package: botbuilder-lg summary: Notifies any interested parties upon a syntax error. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function syntaxError(recognizer: Recognizer, offendingSymbol: - any, line: number, charPositionInLine: number, msg: string, e: - RecognitionException | undefined) + any, line: number, charPositionInLine: number, msg: string, e: undefined + | RecognitionException) parameters: - id: recognizer - type: 'Recognizer<T, any>' + type: Recognizer<T, any> description: >- What parser got the error. From this object, you can access the context as well as the input stream. @@ -64,6 +60,5 @@ methods: type: string description: Message to emit. - id: e - type: RecognitionException | undefined - description: | - Exception. + type: undefined | RecognitionException + description: Exception. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructureLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructureLineContext.yml index 6b837edb..3fb605f9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructureLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructureLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ErrorStructureLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ErrorStructureLineContext(ParserRuleContext | undefined, number)' + - name: ErrorStructureLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ErrorStructureLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ErrorStructureLineContext(parent: ParserRuleContext | undefined, + new ErrorStructureLineContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ErrorStructureLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ErrorStructureLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ErrorStructureLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ErrorStructureLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ErrorStructureLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ErrorStructureLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ErrorStructureLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ErrorStructureLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ErrorStructureLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ErrorStructureLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ErrorStructureLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ErrorStructureLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ErrorStructureLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructureLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ErrorStructureLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructureLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ErrorStructureLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ErrorStructureLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ErrorStructureLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ErrorStructureLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ErrorStructureLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ErrorStructureLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ErrorStructureLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ErrorStructureLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ErrorStructureLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ErrorStructureLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ErrorStructureLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructureLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructureLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ErrorStructureLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,20 +807,18 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER_IN_STRUCTURE_BODY(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: ESCAPE_CHARACTER_IN_STRUCTURE_BODY(number) uid: >- botbuilder-lg.ErrorStructureLineContext.ESCAPE_CHARACTER_IN_STRUCTURE_BODY_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER_IN_STRUCTURE_BODY(i: number): TerminalNode' @@ -880,7 +834,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -893,19 +846,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expressionInStructure(): ExpressionInStructureContext[]' return: description: '' - type: '[]' + type: [] - name: expressionInStructure(number) uid: botbuilder-lg.ErrorStructureLineContext.expressionInStructure_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expressionInStructure(i: number): ExpressionInStructureContext' @@ -921,19 +872,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_EQUALS(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRUCTURE_EQUALS(number) uid: botbuilder-lg.ErrorStructureLineContext.STRUCTURE_EQUALS_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_EQUALS(i: number): TerminalNode' @@ -949,19 +898,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_IDENTIFIER(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRUCTURE_IDENTIFIER(number) uid: botbuilder-lg.ErrorStructureLineContext.STRUCTURE_IDENTIFIER_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_IDENTIFIER(i: number): TerminalNode' @@ -977,19 +924,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_OR_MARK(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRUCTURE_OR_MARK(number) uid: botbuilder-lg.ErrorStructureLineContext.STRUCTURE_OR_MARK_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_OR_MARK(i: number): TerminalNode' @@ -1005,19 +950,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_IN_STRUCTURE_BODY(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT_IN_STRUCTURE_BODY(number) uid: botbuilder-lg.ErrorStructureLineContext.TEXT_IN_STRUCTURE_BODY_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_IN_STRUCTURE_BODY(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructuredNameContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructuredNameContext.yml index 84cfbb5a..9cf2339a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructuredNameContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorStructuredNameContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ErrorStructuredNameContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ErrorStructuredNameContext(ParserRuleContext | undefined, number)' + - name: ErrorStructuredNameContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ErrorStructuredNameContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ErrorStructuredNameContext(parent: ParserRuleContext | undefined, + new ErrorStructuredNameContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ErrorStructuredNameContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ErrorStructuredNameContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ErrorStructuredNameContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ErrorStructuredNameContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ErrorStructuredNameContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ErrorStructuredNameContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ErrorStructuredNameContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ErrorStructuredNameContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ErrorStructuredNameContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ErrorStructuredNameContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ErrorStructuredNameContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ErrorStructuredNameContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ErrorStructuredNameContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructuredNameContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ErrorStructuredNameContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructuredNameContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ErrorStructuredNameContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ErrorStructuredNameContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ErrorStructuredNameContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ErrorStructuredNameContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ErrorStructuredNameContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ErrorStructuredNameContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ErrorStructuredNameContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ErrorStructuredNameContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ErrorStructuredNameContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ErrorStructuredNameContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ErrorStructuredNameContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructuredNameContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorStructuredNameContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ErrorStructuredNameContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_NAME(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRUCTURE_NAME(number) uid: botbuilder-lg.ErrorStructuredNameContext.STRUCTURE_NAME_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_NAME(i: number): TerminalNode' @@ -892,19 +845,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_IN_STRUCTURE_NAME(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT_IN_STRUCTURE_NAME(number) uid: botbuilder-lg.ErrorStructuredNameContext.TEXT_IN_STRUCTURE_NAME_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_IN_STRUCTURE_NAME(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorTemplateStringContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorTemplateStringContext.yml index a7aa5fe4..321d3f9c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorTemplateStringContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ErrorTemplateStringContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ErrorTemplateStringContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ErrorTemplateStringContext(ParserRuleContext | undefined, number)' + - name: ErrorTemplateStringContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ErrorTemplateStringContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ErrorTemplateStringContext(parent: ParserRuleContext | undefined, + new ErrorTemplateStringContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ErrorTemplateStringContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ErrorTemplateStringContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ErrorTemplateStringContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ErrorTemplateStringContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ErrorTemplateStringContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ErrorTemplateStringContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ErrorTemplateStringContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ErrorTemplateStringContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ErrorTemplateStringContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ErrorTemplateStringContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ErrorTemplateStringContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ErrorTemplateStringContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ErrorTemplateStringContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorTemplateStringContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ErrorTemplateStringContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorTemplateStringContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ErrorTemplateStringContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ErrorTemplateStringContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ErrorTemplateStringContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ErrorTemplateStringContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ErrorTemplateStringContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ErrorTemplateStringContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ErrorTemplateStringContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ErrorTemplateStringContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ErrorTemplateStringContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ErrorTemplateStringContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ErrorTemplateStringContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorTemplateStringContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ErrorTemplateStringContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ErrorTemplateStringContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function INVALID_TOKEN(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: INVALID_TOKEN(number) uid: botbuilder-lg.ErrorTemplateStringContext.INVALID_TOKEN_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function INVALID_TOKEN(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationOptions.yml index fd40a427..2e589055 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationOptions.yml @@ -5,26 +5,23 @@ package: botbuilder-lg summary: Options for evaluating LG templates. fullName: EvaluationOptions remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'EvaluationOptions(EvaluationOptions | string[])' + - name: EvaluationOptions(string[] | EvaluationOptions) uid: botbuilder-lg.EvaluationOptions.constructor package: botbuilder-lg summary: >- Creates a new instance of the [EvaluationOptions](xref:botbuilder-lg.EvaluationOptions) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new EvaluationOptions(opt?: EvaluationOptions | string[])' + content: 'new EvaluationOptions(opt?: string[] | EvaluationOptions)' parameters: - id: opt - type: ' | string[]' - description: | - Instance to copy initial settings from. + type: string[] | + description: Instance to copy initial settings from. properties: - name: cacheScope uid: botbuilder-lg.EvaluationOptions.cacheScope @@ -32,33 +29,30 @@ properties: summary: Cache scope of the evaluation result. fullName: cacheScope remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'cacheScope: LGCacheScope | undefined' + content: 'cacheScope: undefined | LGCacheScope' return: description: '' - type: | undefined + type: undefined | - name: LineBreakStyle uid: botbuilder-lg.EvaluationOptions.LineBreakStyle package: botbuilder-lg summary: '' fullName: LineBreakStyle remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'LineBreakStyle: LGLineBreakStyle | undefined' + content: 'LineBreakStyle: undefined | LGLineBreakStyle' return: description: '' - type: | undefined + type: undefined | - name: locale uid: botbuilder-lg.EvaluationOptions.locale package: botbuilder-lg summary: The locale info for evaluating LG. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale: string' @@ -71,7 +65,6 @@ properties: summary: '' fullName: nullSubstitution remarks: '' - isPreview: false isDeprecated: false syntax: content: 'nullSubstitution: (path: string) => unknown' @@ -84,13 +77,12 @@ properties: summary: '' fullName: strictMode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'strictMode: boolean | undefined' + content: 'strictMode: undefined | boolean' return: description: '' - type: boolean | undefined + type: undefined | boolean methods: - name: merge(EvaluationOptions) uid: botbuilder-lg.EvaluationOptions.merge @@ -101,7 +93,6 @@ methods: option, then the value of this property will be overwritten. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function merge(opt: EvaluationOptions): EvaluationOptions' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationTarget.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationTarget.yml index 8619fb38..ce2cbac0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationTarget.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/EvaluationTarget.yml @@ -5,18 +5,16 @@ package: botbuilder-lg summary: Runtime template state. fullName: EvaluationTarget remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'EvaluationTarget(string, MemoryInterface)' + - name: EvaluationTarget(string, MemoryInterface) uid: botbuilder-lg.EvaluationTarget.constructor package: botbuilder-lg summary: >- Creates a new instance of the [EvaluationTarget](xref:botbuilder-lg.EvaluationTarget) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new EvaluationTarget(templateName: string, scope: MemoryInterface)' @@ -26,8 +24,7 @@ constructors: description: Template name. - id: scope type: MemoryInterface - description: | - Template scope. + description: Template scope. properties: - name: cachedEvaluatedChildren uid: botbuilder-lg.EvaluationTarget.cachedEvaluatedChildren @@ -35,20 +32,18 @@ properties: summary: The children templates that this template has evaluated currently. fullName: cachedEvaluatedChildren remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cachedEvaluatedChildren: Map' return: description: '' - type: 'Map<string, unknown>' + type: Map<string, unknown> - name: scope uid: botbuilder-lg.EvaluationTarget.scope package: botbuilder-lg summary: Scope. fullName: scope remarks: '' - isPreview: false isDeprecated: false syntax: content: 'scope: MemoryInterface' @@ -61,7 +56,6 @@ properties: summary: Template name. fullName: templateName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templateName: string' @@ -76,7 +70,6 @@ methods: Get current instance id. If two target has the same Id, we can say they have the same template evaluation result. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getId(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Evaluator.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Evaluator.yml index c60f726c..f16a9398 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Evaluator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Evaluator.yml @@ -5,18 +5,16 @@ package: botbuilder-lg summary: Evaluation runtime engine fullName: Evaluator remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Evaluator(Templates, EvaluationOptions)' + - name: Evaluator(Templates, EvaluationOptions) uid: botbuilder-lg.Evaluator.constructor package: botbuilder-lg summary: >- Creates a new instance of the [Evaluator](xref:botbuilder-lg.Evaluator) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Evaluator(templates: Templates, opt?: EvaluationOptions)' @@ -26,8 +24,7 @@ constructors: description: Templates. - id: opt type: - description: | - Options for LG. + description: Options for LG. properties: - name: activityAttachmentFunctionName uid: botbuilder-lg.Evaluator.activityAttachmentFunctionName @@ -35,7 +32,6 @@ properties: summary: '' fullName: activityAttachmentFunctionName remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,7 +46,6 @@ properties: summary: '' fullName: expandTextFunctionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static expandTextFunctionName: "expandText" = "expandText"' @@ -63,7 +58,6 @@ properties: summary: Expression parser. fullName: expressionParser remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionParser: ExpressionParser' @@ -76,7 +70,6 @@ properties: summary: '' fullName: fromFileFunctionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static fromFileFunctionName: "fromFile" = "fromFile"' @@ -89,7 +82,6 @@ properties: summary: '' fullName: isTemplateFunctionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static isTemplateFunctionName: "isTemplate" = "isTemplate"' @@ -102,7 +94,6 @@ properties: summary: '' fullName: LGType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static LGType: "lgType" = "lgType"' @@ -115,7 +106,6 @@ properties: summary: '' fullName: ReExecuteSuffix remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static ReExecuteSuffix: "!" = "!"' @@ -128,7 +118,6 @@ properties: summary: '' fullName: templateFunctionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static templateFunctionName: "template" = "template"' @@ -141,20 +130,18 @@ properties: summary: TemplateMap. fullName: templateMap remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'templateMap: [key: string]: Template' + content: 'templateMap: {[name: string]: Template}' return: description: '' - type: '[key: string]\: ' + type: '{[name: string]: }' - name: templates uid: botbuilder-lg.Evaluator.templates package: botbuilder-lg summary: Templates. fullName: templates remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templates: Templates' @@ -165,12 +152,12 @@ inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.Evaluator.visit package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation calls on the specified tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): unknown' @@ -185,8 +172,9 @@ inheritedMethods: - name: visitChildren(RuleNode) uid: botbuilder-lg.Evaluator.visitChildren package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation initializes the aggregate result to [defaultResult()](xref:%23defaultResult). Before visiting each child, it calls [shouldVisitNextChild](xref:%23shouldVisitNextChild); if the result @@ -199,7 +187,6 @@ inheritedMethods: the tree structure. Visitors that modify the tree should override this method to behave properly in respect to the specific algorithm in use. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): unknown' @@ -214,12 +201,12 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.Evaluator.visitErrorNode package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): unknown' @@ -234,12 +221,12 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: botbuilder-lg.Evaluator.visitTerminal package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): unknown' @@ -252,18 +239,17 @@ inheritedMethods: type: unknown inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitTerminal methods: - - name: 'checkExpressionResult(string, string, unknown, string, string, string)' + - name: checkExpressionResult(string, string, unknown, string, string, string) uid: botbuilder-lg.Evaluator.checkExpressionResult package: botbuilder-lg summary: Checks an expression result and throws the corresponding error. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function checkExpressionResult(exp: string, error: string, - result: unknown, templateName: string, inlineContent: string, - errorPrefix: string) + result: unknown, templateName: string, inlineContent?: string, + errorPrefix?: string) parameters: - id: exp type: string @@ -282,14 +268,12 @@ methods: description: Optional. In line content. - id: errorPrefix type: string - description: | - Optional. Error prefix. - - name: 'concatErrorMsg(string, string)' + description: Optional. Error prefix. + - name: concatErrorMsg(string, string) uid: botbuilder-lg.Evaluator.concatErrorMsg package: botbuilder-lg summary: Concatenates two error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -305,7 +289,7 @@ methods: return: description: The concatenated error messages. type: string - - name: 'constructScope(string, unknown[], Template[])' + - name: constructScope(string, unknown[], Template[]) uid: botbuilder-lg.Evaluator.constructScope package: botbuilder-lg summary: >- @@ -315,7 +299,6 @@ methods: Throws errors if certain errors detected [TemplateErrors](xref:botbuilder-lg.TemplateErrors). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -326,10 +309,10 @@ methods: type: string description: Template name to evaluate. - id: args - type: 'unknown[]' + type: unknown[] description: Arguments to map to the template parameters. - id: allTemplates - type: '[]' + type: [] description: All templates. return: description: >- @@ -339,12 +322,11 @@ methods: with the mapping of the parameter name to the argument value added to the scope. type: MemoryInterface - - name: 'evaluateTemplate(string, unknown)' + - name: evaluateTemplate(string, unknown) uid: botbuilder-lg.Evaluator.evaluateTemplate package: botbuilder-lg summary: Evaluate a template with given name and scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -367,7 +349,6 @@ methods: Visit a parse tree produced by the ifElseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitIfElseBody(ctx: IfElseBodyContext): unknown' @@ -385,7 +366,6 @@ methods: Visit a parse tree produced by the normalBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitNormalBody(ctx: NormalBodyContext): unknown' @@ -401,7 +381,6 @@ methods: package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -419,7 +398,6 @@ methods: package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateString. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -437,7 +415,6 @@ methods: package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.structuredTemplateBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -457,7 +434,6 @@ methods: Visit a parse tree produced by the switchCaseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitSwitchCaseBody(ctx: SwitchCaseBodyContext): unknown' @@ -468,12 +444,11 @@ methods: return: description: The string result of visiting the switch case body. type: unknown - - name: 'wrappedEvalTextContainsExpression(string, RegExp)' + - name: wrappedEvalTextContainsExpression(string, RegExp) uid: botbuilder-lg.Evaluator.wrappedEvalTextContainsExpression package: botbuilder-lg summary: Replaces an expression contained in text. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Expander.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Expander.yml index db410534..552f03ba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Expander.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Expander.yml @@ -5,16 +5,14 @@ package: botbuilder-lg summary: LG template expander. fullName: Expander remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Expander(Templates, EvaluationOptions)' + - name: Expander(Templates, EvaluationOptions) uid: botbuilder-lg.Expander.constructor package: botbuilder-lg summary: Creates a new instance of the Expander class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Expander(templates: Templates, opt?: EvaluationOptions)' @@ -24,8 +22,7 @@ constructors: description: Template list. - id: opt type: - description: | - Options for LG. + description: Options for LG. properties: - name: templateMap uid: botbuilder-lg.Expander.templateMap @@ -33,20 +30,18 @@ properties: summary: TemplateMap. fullName: templateMap remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'templateMap: [key: string]: Template' + content: 'templateMap: {[name: string]: Template}' return: description: '' - type: '[key: string]\: ' + type: '{[name: string]: }' - name: templates uid: botbuilder-lg.Expander.templates package: botbuilder-lg summary: Templates. fullName: templates remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templates: Templates' @@ -57,12 +52,12 @@ inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.Expander.visit package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation calls on the specified tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): unknown[]' @@ -72,13 +67,14 @@ inheritedMethods: description: '' return: description: '' - type: 'unknown[]' + type: unknown[] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visit - name: visitChildren(RuleNode) uid: botbuilder-lg.Expander.visitChildren package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation initializes the aggregate result to [defaultResult()](xref:%23defaultResult). Before visiting each child, it calls [shouldVisitNextChild](xref:%23shouldVisitNextChild); if the result @@ -91,7 +87,6 @@ inheritedMethods: the tree structure. Visitors that modify the tree should override this method to behave properly in respect to the specific algorithm in use. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): unknown[]' @@ -101,17 +96,17 @@ inheritedMethods: description: '' return: description: '' - type: 'unknown[]' + type: unknown[] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitChildren - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.Expander.visitErrorNode package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): unknown[]' @@ -121,17 +116,17 @@ inheritedMethods: description: '' return: description: '' - type: 'unknown[]' + type: unknown[] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitErrorNode - name: visitTerminal(TerminalNode) uid: botbuilder-lg.Expander.visitTerminal package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): unknown[]' @@ -141,17 +136,16 @@ inheritedMethods: description: '' return: description: '' - type: 'unknown[]' + type: unknown[] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitTerminal methods: - - name: 'constructScope(string, unknown[], Template[])' + - name: constructScope(string, unknown[], Template[]) uid: botbuilder-lg.Expander.constructScope package: botbuilder-lg summary: >- Constructs the scope for mapping the values of arguments to the parameters of the template. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -162,10 +156,10 @@ methods: type: string description: The template name to evaluate. - id: args - type: 'unknown[]' + type: unknown[] description: Arguments to map to the template parameters. - id: allTemplates - type: '[]' + type: [] description: All templates. return: description: >- @@ -175,12 +169,11 @@ methods: with the mapping of the parameter name to the argument value added to the scope. type: MemoryInterface - - name: 'expandTemplate(string, unknown)' + - name: expandTemplate(string, unknown) uid: botbuilder-lg.Expander.expandTemplate package: botbuilder-lg summary: Expand the results of a template with given name and scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expandTemplate(templateName: string, scope: unknown): unknown[]' @@ -193,7 +186,7 @@ methods: description: Given scope. return: description: All possiable results. - type: 'unknown[]' + type: unknown[] - name: visitIfElseBody(IfElseBodyContext) uid: botbuilder-lg.Expander.visitIfElseBody package: botbuilder-lg @@ -201,7 +194,6 @@ methods: Visit a parse tree produced by the ifElseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitIfElseBody(ctx: IfElseBodyContext): unknown[]' @@ -211,7 +203,7 @@ methods: description: The parse tree. return: description: The result of visiting if-else body. - type: 'unknown[]' + type: unknown[] - name: visitNormalBody(NormalBodyContext) uid: botbuilder-lg.Expander.visitNormalBody package: botbuilder-lg @@ -219,7 +211,6 @@ methods: Visit a parse tree produced by the normalBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitNormalBody(ctx: NormalBodyContext): unknown[]' @@ -229,13 +220,12 @@ methods: description: The parse tree. return: description: The result of visiting the normal body. - type: 'unknown[]' + type: unknown[] - name: visitNormalTemplateBody(NormalTemplateBodyContext) uid: botbuilder-lg.Expander.visitNormalTemplateBody package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -247,13 +237,12 @@ methods: description: The parse tree. return: description: The result of visiting the normal template body. - type: 'unknown[]' + type: unknown[] - name: visitNormalTemplateString(NormalTemplateStringContext) uid: botbuilder-lg.Expander.visitNormalTemplateString package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateString. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -265,13 +254,12 @@ methods: description: The parse tree. return: description: The result of visiting NormalTemplateString. - type: 'unknown[]' + type: unknown[] - name: visitStructuredBody(StructuredBodyContext) uid: botbuilder-lg.Expander.visitStructuredBody package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.structuredBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitStructuredBody(ctx: StructuredBodyContext): unknown[]' @@ -281,7 +269,7 @@ methods: description: The parse tree. return: description: The result of visiting the structured body. - type: 'unknown[]' + type: unknown[] - name: visitSwitchCaseBody(SwitchCaseBodyContext) uid: botbuilder-lg.Expander.visitSwitchCaseBody package: botbuilder-lg @@ -289,7 +277,6 @@ methods: Visit a parse tree produced by the switchCaseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitSwitchCaseBody(ctx: SwitchCaseBodyContext): unknown[]' @@ -299,5 +286,5 @@ methods: description: The parse tree. return: description: The result of visiting the switch case body. - type: 'unknown[]' -extends: 'AbstractParseTreeVisitor<unknown[]>' + type: unknown[] +extends: AbstractParseTreeVisitor<unknown[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionContext.yml index 78ac9841..51e851c7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ExpressionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ExpressionContext(ParserRuleContext | undefined, number)' + - name: ExpressionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ExpressionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ExpressionContext(parent: ParserRuleContext | undefined, + new ExpressionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ExpressionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ExpressionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ExpressionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ExpressionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ExpressionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ExpressionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ExpressionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ExpressionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ExpressionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ExpressionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ExpressionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ExpressionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ExpressionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ExpressionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ExpressionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ExpressionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ExpressionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ExpressionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ExpressionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ExpressionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ExpressionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ExpressionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ExpressionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ExpressionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ExpressionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ExpressionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,7 +819,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function EXPRESSION(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionInStructureContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionInStructureContext.yml index 6c5343f9..3d439a4a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionInStructureContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ExpressionInStructureContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ExpressionInStructureContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ExpressionInStructureContext(ParserRuleContext | undefined, number)' + - name: ExpressionInStructureContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ExpressionInStructureContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ExpressionInStructureContext(parent: ParserRuleContext | undefined, + new ExpressionInStructureContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ExpressionInStructureContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ExpressionInStructureContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ExpressionInStructureContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ExpressionInStructureContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ExpressionInStructureContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ExpressionInStructureContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ExpressionInStructureContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ExpressionInStructureContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ExpressionInStructureContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ExpressionInStructureContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ExpressionInStructureContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ExpressionInStructureContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ExpressionInStructureContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionInStructureContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ExpressionInStructureContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionInStructureContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ExpressionInStructureContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ExpressionInStructureContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ExpressionInStructureContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ExpressionInStructureContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ExpressionInStructureContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ExpressionInStructureContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ExpressionInStructureContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ExpressionInStructureContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ExpressionInStructureContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ExpressionInStructureContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ExpressionInStructureContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionInStructureContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ExpressionInStructureContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ExpressionInStructureContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,7 +819,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function EXPRESSION_IN_STRUCTURE_BODY(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Extractor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Extractor.yml index b118ab4f..ba0b8a49 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Extractor.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Extractor.yml @@ -5,26 +5,23 @@ package: botbuilder-lg summary: Lg template extracter. fullName: Extractor remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Extractor(Template[])' + - name: Extractor(Template[]) uid: botbuilder-lg.Extractor.constructor package: botbuilder-lg summary: >- Creates a new instance of the [Extractor](xref:botbuilder-lg.Extractor) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Extractor(templates: Template[])' parameters: - id: templates - type: '[]' - description: | - Template list. + type: [] + description: Template list. properties: - name: templateMap uid: botbuilder-lg.Extractor.templateMap @@ -32,36 +29,34 @@ properties: summary: '' fullName: templateMap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templateMap: Record' return: description: '' - type: 'Record<string, >' + type: Record<string, > - name: templates uid: botbuilder-lg.Extractor.templates package: botbuilder-lg summary: '' fullName: templates remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templates: Template[]' return: description: '' - type: '[]' + type: [] inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.Extractor.visit package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation calls on the specified tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): Map' @@ -71,13 +66,14 @@ inheritedMethods: description: '' return: description: '' - type: 'Map<string, string[]>' + type: Map<string, string[]> inheritanceDescription: Inherited From AbstractParseTreeVisitor.visit - name: visitChildren(RuleNode) uid: botbuilder-lg.Extractor.visitChildren package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation initializes the aggregate result to [defaultResult()](xref:%23defaultResult). Before visiting each child, it calls [shouldVisitNextChild](xref:%23shouldVisitNextChild); if the result @@ -90,7 +86,6 @@ inheritedMethods: the tree structure. Visitors that modify the tree should override this method to behave properly in respect to the specific algorithm in use. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): Map' @@ -100,17 +95,17 @@ inheritedMethods: description: '' return: description: '' - type: 'Map<string, string[]>' + type: Map<string, string[]> inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitChildren - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.Extractor.visitErrorNode package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): Map' @@ -120,17 +115,17 @@ inheritedMethods: description: '' return: description: '' - type: 'Map<string, string[]>' + type: Map<string, string[]> inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitErrorNode - name: visitTerminal(TerminalNode) uid: botbuilder-lg.Extractor.visitTerminal package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): Map' @@ -140,7 +135,7 @@ inheritedMethods: description: '' return: description: '' - type: 'Map<string, string[]>' + type: Map<string, string[]> inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitTerminal methods: - name: extract() @@ -148,13 +143,12 @@ methods: package: botbuilder-lg summary: Extracts the templates and returns a map with their names and bodies. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function extract(): Map>[]' return: description: Map object with template names and bodies. - type: 'Map<string, string[] | Map<string, string[]>>[]' + type: Map<string, string[] | Map<string, string[]>>[] - name: visitIfElseBody(IfElseBodyContext) uid: botbuilder-lg.Extractor.visitIfElseBody package: botbuilder-lg @@ -162,7 +156,6 @@ methods: Visit a parse tree produced by the ifElseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -174,13 +167,12 @@ methods: description: The parse tree. return: description: The result of visiting the if else body. - type: 'Map<string, string[]>' + type: Map<string, string[]> - name: visitNormalTemplateBody(NormalTemplateBodyContext) uid: botbuilder-lg.Extractor.visitNormalTemplateBody package: botbuilder-lg summary: Visit a parse tree produced by LGTemplateParser.normalTemplateBody. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -192,7 +184,7 @@ methods: description: The parse tree. return: description: The result of visiting the normal template body. - type: 'Map<string, string[]>' + type: Map<string, string[]> - name: visitStructuredBody(StructuredBodyContext) uid: botbuilder-lg.Extractor.visitStructuredBody package: botbuilder-lg @@ -200,7 +192,6 @@ methods: Visit a parse tree produced by the structuredBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -212,7 +203,7 @@ methods: description: The parse tree. return: description: The result of visiting the structured body. - type: 'Map<string, string[]>' + type: Map<string, string[]> - name: visitSwitchCaseBody(SwitchCaseBodyContext) uid: botbuilder-lg.Extractor.visitSwitchCaseBody package: botbuilder-lg @@ -220,7 +211,6 @@ methods: Visit a parse tree produced by the switchCaseBody labeled alternative in LGTemplateParser.body. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -232,5 +222,5 @@ methods: description: The parse tree. return: description: The result of visiting the switch case body. - type: 'Map<string, string[]>' -extends: 'AbstractParseTreeVisitor<Map<string, string[]>>' + type: Map<string, string[]> +extends: AbstractParseTreeVisitor<Map<string, string[]>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileContext.yml index 403334e2..9d0fda9e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: FileContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'FileContext(ParserRuleContext | undefined, number)' + - name: FileContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.FileContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new FileContext(parent: ParserRuleContext | undefined, invokingState: + new FileContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.FileContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.FileContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.FileContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.FileContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.FileContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.FileContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.FileContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: FileContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.FileContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.FileContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.FileContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.FileContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.FileContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.FileContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.FileContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.FileContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.FileContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.FileContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.FileContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.FileContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.FileContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.FileContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.FileContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.FileContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.FileContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.FileContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.FileContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.FileContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.FileContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.FileContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function EOF(): TerminalNode' @@ -861,7 +816,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -874,19 +828,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function paragraph(): ParagraphContext[]' return: description: '' - type: '[]' + type: [] - name: paragraph(number) uid: botbuilder-lg.FileContext.paragraph_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function paragraph(i: number): ParagraphContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileFormat.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileFormat.yml index 01532960..604c6413 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileFormat.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/FileFormat.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: Filr formats. fullName: FileFormat remarks: '' -isPreview: false isDeprecated: false fields: - name: Binary diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionContext.yml index 44f413bb..087c9c6d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: IfConditionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'IfConditionContext(ParserRuleContext | undefined, number)' + - name: IfConditionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.IfConditionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new IfConditionContext(parent: ParserRuleContext | undefined, + new IfConditionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.IfConditionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.IfConditionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.IfConditionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.IfConditionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.IfConditionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.IfConditionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.IfConditionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: IfConditionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.IfConditionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.IfConditionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.IfConditionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.IfConditionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.IfConditionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.IfConditionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.IfConditionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.IfConditionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.IfConditionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.IfConditionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.IfConditionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.IfConditionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.IfConditionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.IfConditionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.IfConditionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.IfConditionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.IfConditionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.IfConditionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function DASH(): TerminalNode' @@ -850,31 +806,28 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ELSE(): TerminalNode | undefined' + content: 'function ELSE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: ELSEIF() uid: botbuilder-lg.IfConditionContext.ELSEIF package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function ELSEIF(): TerminalNode | undefined' + content: 'function ELSEIF(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(LGTemplateParserListener) uid: botbuilder-lg.IfConditionContext.enterRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -887,7 +840,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -900,19 +852,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext[]' return: description: '' - type: '[]' + type: [] - name: expression(number) uid: botbuilder-lg.IfConditionContext.expression_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(i: number): ExpressionContext' @@ -928,31 +878,28 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function IF(): TerminalNode | undefined' + content: 'function IF(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TEXT() uid: botbuilder-lg.IfConditionContext.TEXT package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT(number) uid: botbuilder-lg.IfConditionContext.TEXT_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT(i: number): TerminalNode' @@ -968,19 +915,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function WS(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: WS(number) uid: botbuilder-lg.IfConditionContext.WS_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function WS(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionRuleContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionRuleContext.yml index bb5447c5..d10c8e5a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionRuleContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfConditionRuleContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: IfConditionRuleContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'IfConditionRuleContext(ParserRuleContext | undefined, number)' + - name: IfConditionRuleContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.IfConditionRuleContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new IfConditionRuleContext(parent: ParserRuleContext | undefined, + new IfConditionRuleContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.IfConditionRuleContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.IfConditionRuleContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.IfConditionRuleContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.IfConditionRuleContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.IfConditionRuleContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.IfConditionRuleContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.IfConditionRuleContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: IfConditionRuleContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.IfConditionRuleContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.IfConditionRuleContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.IfConditionRuleContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.IfConditionRuleContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.IfConditionRuleContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionRuleContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.IfConditionRuleContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionRuleContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.IfConditionRuleContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.IfConditionRuleContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.IfConditionRuleContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.IfConditionRuleContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.IfConditionRuleContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.IfConditionRuleContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.IfConditionRuleContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.IfConditionRuleContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.IfConditionRuleContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.IfConditionRuleContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.IfConditionRuleContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionRuleContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfConditionRuleContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.IfConditionRuleContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,7 +819,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifCondition(): IfConditionContext' @@ -876,11 +830,10 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function normalTemplateBody(): NormalTemplateBodyContext | undefined' + content: 'function normalTemplateBody(): undefined | NormalTemplateBodyContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseBodyContext.yml index 67d702ff..40066b2b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseBodyContext.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: IfElseBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new IfElseBodyContext(ctx: BodyContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: botbuilder-lg.IfElseBodyContext.ruleIndex - package: botbuilder-lg - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: botbuilder-lg.IfElseBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [BodyContext.altNumber](xref:botbuilder-lg.BodyContext.altNumber) - name: childCount uid: botbuilder-lg.IfElseBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [BodyContext.childCount](xref:botbuilder-lg.BodyContext.childCount) - name: children uid: botbuilder-lg.IfElseBodyContext.children package: botbuilder-lg @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [BodyContext.children](xref:botbuilder-lg.BodyContext.children) - name: exception uid: botbuilder-lg.IfElseBodyContext.exception package: botbuilder-lg @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [BodyContext.exception](xref:botbuilder-lg.BodyContext.exception) - name: invokingState uid: botbuilder-lg.IfElseBodyContext.invokingState package: botbuilder-lg summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [BodyContext.invokingState](xref:botbuilder-lg.BodyContext.invokingState) - name: isEmpty uid: botbuilder-lg.IfElseBodyContext.isEmpty package: botbuilder-lg @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [BodyContext.isEmpty](xref:botbuilder-lg.BodyContext.isEmpty) - name: parent uid: botbuilder-lg.IfElseBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [BodyContext.parent](xref:botbuilder-lg.BodyContext.parent) - name: payload uid: botbuilder-lg.IfElseBodyContext.payload package: botbuilder-lg summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [BodyContext.payload](xref:botbuilder-lg.BodyContext.payload) - name: ruleContext uid: botbuilder-lg.IfElseBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: IfElseBodyContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [BodyContext.ruleContext](xref:botbuilder-lg.BodyContext.ruleContext) + - name: ruleIndex + uid: botbuilder-lg.IfElseBodyContext.ruleIndex + package: botbuilder-lg + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [BodyContext.ruleIndex](xref:botbuilder-lg.BodyContext.ruleIndex) - name: sourceInterval uid: botbuilder-lg.IfElseBodyContext.sourceInterval package: botbuilder-lg summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [BodyContext.sourceInterval](xref:botbuilder-lg.BodyContext.sourceInterval) - name: start uid: botbuilder-lg.IfElseBodyContext.start package: botbuilder-lg @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [BodyContext.start](xref:botbuilder-lg.BodyContext.start) - name: stop uid: botbuilder-lg.IfElseBodyContext.stop package: botbuilder-lg @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [BodyContext.stop](xref:botbuilder-lg.BodyContext.stop) - name: text uid: botbuilder-lg.IfElseBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [BodyContext.text](xref:botbuilder-lg.BodyContext.text) inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.IfElseBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [BodyContext.addAnyChild](xref:botbuilder-lg.BodyContext.addAnyChild) - name: addChild(RuleContext) uid: botbuilder-lg.IfElseBodyContext.addChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(TerminalNode) uid: botbuilder-lg.IfElseBodyContext.addChild package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(Token) uid: botbuilder-lg.IfElseBodyContext.addChild_2 package: botbuilder-lg @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addErrorNode(ErrorNode) uid: botbuilder-lg.IfElseBodyContext.addErrorNode package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: addErrorNode(Token) uid: botbuilder-lg.IfElseBodyContext.addErrorNode_1 package: botbuilder-lg @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: copyFrom(BodyContext) uid: botbuilder-lg.IfElseBodyContext.copyFrom package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: BodyContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [BodyContext.depth](xref:botbuilder-lg.BodyContext.depth) - name: emptyContext() uid: botbuilder-lg.IfElseBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [BodyContext.emptyContext](xref:botbuilder-lg.BodyContext.emptyContext) - name: getChild(number) uid: botbuilder-lg.IfElseBodyContext.getChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.IfElseBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChildContext](xref:botbuilder-lg.BodyContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContext](xref:botbuilder-lg.BodyContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.IfElseBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContexts](xref:botbuilder-lg.BodyContext.getRuleContexts) + - name: getToken(number, number) uid: botbuilder-lg.IfElseBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [BodyContext.getToken](xref:botbuilder-lg.BodyContext.getToken) - name: getTokens(number) uid: botbuilder-lg.IfElseBodyContext.getTokens package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [BodyContext.getTokens](xref:botbuilder-lg.BodyContext.getTokens) - name: removeLastChild() uid: botbuilder-lg.IfElseBodyContext.removeLastChild package: botbuilder-lg @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [BodyContext.removeLastChild](xref:botbuilder-lg.BodyContext.removeLastChild) - name: setParent(RuleContext) uid: botbuilder-lg.IfElseBodyContext.setParent package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [BodyContext.setParent](xref:botbuilder-lg.BodyContext.setParent) - name: toInfoString(Parser) uid: botbuilder-lg.IfElseBodyContext.toInfoString package: botbuilder-lg @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [BodyContext.toInfoString](xref:botbuilder-lg.BodyContext.toInfoString) - name: toString() uid: botbuilder-lg.IfElseBodyContext.toString package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer) uid: botbuilder-lg.IfElseBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.IfElseBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[]) uid: botbuilder-lg.IfElseBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.IfElseBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) - name: toStringTree() uid: botbuilder-lg.IfElseBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) - name: toStringTree(Parser) uid: botbuilder-lg.IfElseBodyContext.toStringTree package: botbuilder-lg @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.IfElseBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetChild](xref:botbuilder-lg.BodyContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetRuleContext](xref:botbuilder-lg.BodyContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: botbuilder-lg.IfElseBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetToken](xref:botbuilder-lg.BodyContext.tryGetToken) methods: - name: accept(LGTemplateParserVisitor) uid: botbuilder-lg.IfElseBodyContext.accept package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -825,7 +867,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -838,7 +879,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -851,7 +891,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifElseTemplateBody(): IfElseTemplateBodyContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseTemplateBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseTemplateBodyContext.yml index d278028c..d6f4dd46 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseTemplateBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/IfElseTemplateBodyContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: IfElseTemplateBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'IfElseTemplateBodyContext(ParserRuleContext | undefined, number)' + - name: IfElseTemplateBodyContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.IfElseTemplateBodyContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new IfElseTemplateBodyContext(parent: ParserRuleContext | undefined, + new IfElseTemplateBodyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.IfElseTemplateBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.IfElseTemplateBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.IfElseTemplateBodyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.IfElseTemplateBodyContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.IfElseTemplateBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.IfElseTemplateBodyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.IfElseTemplateBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: IfElseTemplateBodyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.IfElseTemplateBodyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.IfElseTemplateBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.IfElseTemplateBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.IfElseTemplateBodyContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.IfElseTemplateBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseTemplateBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.IfElseTemplateBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseTemplateBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.IfElseTemplateBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.IfElseTemplateBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.IfElseTemplateBodyContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.IfElseTemplateBodyContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.IfElseTemplateBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.IfElseTemplateBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.IfElseTemplateBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.IfElseTemplateBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.IfElseTemplateBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.IfElseTemplateBodyContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.IfElseTemplateBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseTemplateBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.IfElseTemplateBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.IfElseTemplateBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifConditionRule(): IfConditionRuleContext[]' return: description: '' - type: '[]' + type: [] - name: ifConditionRule(number) uid: botbuilder-lg.IfElseTemplateBodyContext.ifConditionRule_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifConditionRule(i: number): IfConditionRuleContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportDefinitionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportDefinitionContext.yml index 35c108dd..3e274fa1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportDefinitionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportDefinitionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ImportDefinitionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ImportDefinitionContext(ParserRuleContext | undefined, number)' + - name: ImportDefinitionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ImportDefinitionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ImportDefinitionContext(parent: ParserRuleContext | undefined, + new ImportDefinitionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ImportDefinitionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ImportDefinitionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ImportDefinitionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ImportDefinitionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ImportDefinitionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ImportDefinitionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ImportDefinitionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ImportDefinitionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ImportDefinitionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ImportDefinitionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ImportDefinitionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ImportDefinitionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ImportDefinitionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ImportDefinitionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ImportDefinitionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ImportDefinitionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ImportDefinitionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ImportDefinitionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ImportDefinitionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ImportDefinitionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ImportDefinitionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ImportDefinitionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ImportDefinitionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ImportDefinitionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ImportDefinitionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ImportDefinitionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ImportDefinitionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ImportDefinitionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ImportDefinitionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ImportDefinitionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -862,7 +817,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function IMPORT(): TerminalNode' @@ -874,11 +828,10 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportResolverDelegate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportResolverDelegate.yml index dd4fb763..38cbfaf7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportResolverDelegate.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ImportResolverDelegate.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: ImportResolverDelegate remarks: '' -isPreview: false isDeprecated: false syntax: | type ImportResolverDelegate = ( diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureLineContext.yml index 1a2fc8da..a6d36b26 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: KeyValueStructureLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'KeyValueStructureLineContext(ParserRuleContext | undefined, number)' + - name: KeyValueStructureLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.KeyValueStructureLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new KeyValueStructureLineContext(parent: ParserRuleContext | undefined, + new KeyValueStructureLineContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.KeyValueStructureLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.KeyValueStructureLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.KeyValueStructureLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.KeyValueStructureLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.KeyValueStructureLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.KeyValueStructureLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.KeyValueStructureLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: KeyValueStructureLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.KeyValueStructureLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.KeyValueStructureLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.KeyValueStructureLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.KeyValueStructureLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.KeyValueStructureLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.KeyValueStructureLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.KeyValueStructureLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.KeyValueStructureLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.KeyValueStructureLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.KeyValueStructureLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.KeyValueStructureLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.KeyValueStructureLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.KeyValueStructureLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.KeyValueStructureLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.KeyValueStructureLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.KeyValueStructureLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.KeyValueStructureLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValueStructureValue(): KeyValueStructureValueContext[]' return: description: '' - type: '[]' + type: [] - name: keyValueStructureValue(number) uid: botbuilder-lg.KeyValueStructureLineContext.keyValueStructureValue_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -894,7 +847,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_EQUALS(): TerminalNode' @@ -906,7 +858,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_IDENTIFIER(): TerminalNode' @@ -918,19 +869,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_OR_MARK(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRUCTURE_OR_MARK(number) uid: botbuilder-lg.KeyValueStructureLineContext.STRUCTURE_OR_MARK_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURE_OR_MARK(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureValueContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureValueContext.yml index 9834a664..a90e55e0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureValueContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/KeyValueStructureValueContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: KeyValueStructureValueContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'KeyValueStructureValueContext(ParserRuleContext | undefined, number)' + - name: KeyValueStructureValueContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.KeyValueStructureValueContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new KeyValueStructureValueContext(parent: ParserRuleContext | undefined, + new KeyValueStructureValueContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.KeyValueStructureValueContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.KeyValueStructureValueContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.KeyValueStructureValueContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.KeyValueStructureValueContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.KeyValueStructureValueContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.KeyValueStructureValueContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.KeyValueStructureValueContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: KeyValueStructureValueContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.KeyValueStructureValueContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.KeyValueStructureValueContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.KeyValueStructureValueContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.KeyValueStructureValueContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.KeyValueStructureValueContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureValueContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.KeyValueStructureValueContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureValueContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureValueContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.KeyValueStructureValueContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.KeyValueStructureValueContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.KeyValueStructureValueContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.KeyValueStructureValueContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.KeyValueStructureValueContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.KeyValueStructureValueContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.KeyValueStructureValueContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.KeyValueStructureValueContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.KeyValueStructureValueContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.KeyValueStructureValueContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureValueContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.KeyValueStructureValueContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.KeyValueStructureValueContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -852,20 +808,18 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER_IN_STRUCTURE_BODY(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: ESCAPE_CHARACTER_IN_STRUCTURE_BODY(number) uid: >- botbuilder-lg.KeyValueStructureValueContext.ESCAPE_CHARACTER_IN_STRUCTURE_BODY_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER_IN_STRUCTURE_BODY(i: number): TerminalNode' @@ -881,7 +835,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -894,19 +847,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expressionInStructure(): ExpressionInStructureContext[]' return: description: '' - type: '[]' + type: [] - name: expressionInStructure(number) uid: botbuilder-lg.KeyValueStructureValueContext.expressionInStructure_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expressionInStructure(i: number): ExpressionInStructureContext' @@ -922,19 +873,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_IN_STRUCTURE_BODY(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT_IN_STRUCTURE_BODY(number) uid: botbuilder-lg.KeyValueStructureValueContext.TEXT_IN_STRUCTURE_BODY_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT_IN_STRUCTURE_BODY(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGCacheScope.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGCacheScope.yml index 486c99e4..ce22c926 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGCacheScope.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGCacheScope.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: LG cache scope options. fullName: LGCacheScope remarks: '' -isPreview: false isDeprecated: false fields: - name: Global diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileLexer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileLexer.yml index 634063c0..cafed901 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileLexer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileLexer.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: LGFileLexer remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LGFileLexer(input: CharStream)' @@ -29,36 +27,33 @@ properties: summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static channelNames: string[] = [\r\n\t\t\"DEFAULT_TOKEN_CHANNEL\", \"HIDDEN\",\r\n\t]" + content: 'channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: channelNames uid: botbuilder-lg.LGFileLexer.channelNames package: botbuilder-lg summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] channelNames' + content: 'static channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: COMMENT uid: botbuilder-lg.LGFileLexer.COMMENT package: botbuilder-lg summary: '' fullName: COMMENT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COMMENT: 3 = 3' + content: 'static COMMENT: 3 = 3' return: description: '' type: '3' @@ -68,10 +63,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER: 11 = 11' + content: 'static ESCAPE_CHARACTER: 11 = 11' return: description: '' type: '11' @@ -81,10 +75,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -94,10 +87,9 @@ properties: summary: '' fullName: IMPORT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IMPORT: 4 = 4' + content: 'static IMPORT: 4 = 4' return: description: '' type: '4' @@ -107,10 +99,9 @@ properties: summary: '' fullName: INLINE_MULTILINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INLINE_MULTILINE: 6 = 6' + content: 'static INLINE_MULTILINE: 6 = 6' return: description: '' type: '6' @@ -120,10 +111,9 @@ properties: summary: '' fullName: INVALID_LINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INVALID_LINE: 9 = 9' + content: 'static INVALID_LINE: 9 = 9' return: description: '' type: '9' @@ -133,36 +123,33 @@ properties: summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static modeNames: string[] = [\r\n\t\t\"DEFAULT_MODE\", \"MULTILINE_MODE\",\r\n\t]" + content: 'modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: modeNames uid: botbuilder-lg.LGFileLexer.modeNames package: botbuilder-lg summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] modeNames' + content: 'static modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: MULTILINE_MODE uid: botbuilder-lg.LGFileLexer.MULTILINE_MODE package: botbuilder-lg summary: '' fullName: MULTILINE_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_MODE: 1 = 1' + content: 'static MULTILINE_MODE: 1 = 1' return: description: '' type: '1' @@ -172,10 +159,9 @@ properties: summary: '' fullName: MULTILINE_PREFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_PREFIX: 7 = 7' + content: 'static MULTILINE_PREFIX: 7 = 7' return: description: '' type: '7' @@ -185,10 +171,9 @@ properties: summary: '' fullName: MULTILINE_SUFFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_SUFFIX: 10 = 10' + content: 'static MULTILINE_SUFFIX: 10 = 10' return: description: '' type: '10' @@ -198,10 +183,9 @@ properties: summary: '' fullName: MULTILINE_TEXT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_TEXT: 12 = 12' + content: 'static MULTILINE_TEXT: 12 = 12' return: description: '' type: '12' @@ -211,10 +195,9 @@ properties: summary: '' fullName: NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE: 1 = 1' + content: 'static NEWLINE: 1 = 1' return: description: '' type: '1' @@ -224,10 +207,9 @@ properties: summary: '' fullName: OPTION remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPTION: 2 = 2' + content: 'static OPTION: 2 = 2' return: description: '' type: '2' @@ -237,36 +219,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\r\n\t\t\"WHITESPACE\", \"NEWLINE\", \"OPTION\", \"COMMENT\", \"IMPORT\", \"TEMPLATE_NAME_LINE\", \r\n\t\t\"INLINE_MULTILINE\", \"MULTILINE_PREFIX\", \"TEMPLATE_BODY\", \"INVALID_LINE\", \r\n\t\t\"MULTILINE_SUFFIX\", \"ESCAPE_CHARACTER\", \"MULTILINE_TEXT\",\r\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: botbuilder-lg.LGFileLexer.ruleNames package: botbuilder-lg summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: serializedATN uid: botbuilder-lg.LGFileLexer.serializedATN package: botbuilder-lg summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -276,10 +255,9 @@ properties: summary: '' fullName: startTemplate remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'startTemplate: boolean = false' + content: 'startTemplate: boolean' return: description: '' type: boolean @@ -289,10 +267,9 @@ properties: summary: '' fullName: TEMPLATE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEMPLATE_BODY: 8 = 8' + content: 'static TEMPLATE_BODY: 8 = 8' return: description: '' type: '8' @@ -302,39 +279,33 @@ properties: summary: '' fullName: TEMPLATE_NAME_LINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEMPLATE_NAME_LINE: 5 = 5' + content: 'static TEMPLATE_NAME_LINE: 5 = 5' return: description: '' type: '5' - - name: VOCABULARY - uid: botbuilder-lg.LGFileLexer.VOCABULARY + - name: vocabulary + uid: botbuilder-lg.LGFileLexer.vocabulary package: botbuilder-lg summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(LGFileLexer._LITERAL_NAMES, LGFileLexer._SYMBOLIC_NAMES, - []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: botbuilder-lg.LGFileLexer.vocabulary + - name: VOCABULARY + uid: botbuilder-lg.LGFileLexer.VOCABULARY package: botbuilder-lg summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -347,21 +318,21 @@ inheritedProperties: recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by the + recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Lexer.atn - name: channel uid: botbuilder-lg.LGFileLexer.channel package: botbuilder-lg summary: '' fullName: channel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channel: number' @@ -375,7 +346,6 @@ inheritedProperties: summary: What is the index of the current character of lookahead? fullName: charIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charIndex: number' @@ -389,7 +359,6 @@ inheritedProperties: summary: '' fullName: charPositionInLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charPositionInLine: number' @@ -403,7 +372,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_MODE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_MODE: number' @@ -417,7 +385,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_TOKEN_CHANNEL remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_TOKEN_CHANNEL: number' @@ -431,21 +398,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Lexer.EOF - name: HIDDEN uid: botbuilder-lg.LGFileLexer.HIDDEN package: botbuilder-lg summary: '' fullName: HIDDEN remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static HIDDEN: number' @@ -459,7 +424,6 @@ inheritedProperties: summary: Set the char stream and reset the lexer fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: CharStream' @@ -473,21 +437,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: LexerATNSimulator' return: description: '' type: LexerATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Lexer.interpreter - name: line uid: botbuilder-lg.LGFileLexer.line package: botbuilder-lg summary: '' fullName: line remarks: '' - isPreview: false isDeprecated: false syntax: content: 'line: number' @@ -501,7 +463,6 @@ inheritedProperties: summary: '' fullName: MAX_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MAX_CHAR_VALUE: number' @@ -515,7 +476,6 @@ inheritedProperties: summary: '' fullName: MIN_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MIN_CHAR_VALUE: number' @@ -529,7 +489,6 @@ inheritedProperties: summary: '' fullName: MORE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MORE: number' @@ -545,21 +504,19 @@ inheritedProperties: for each decision in recognizer in a ParseInfo object. fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> - inheritanceDescription: Inherited From Recognizer.parseInfo + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Lexer.parseInfo - name: SKIP uid: botbuilder-lg.LGFileLexer.SKIP package: botbuilder-lg summary: '' fullName: SKIP remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static SKIP: number' @@ -573,7 +530,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -593,14 +549,13 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Lexer.state - name: text uid: botbuilder-lg.LGFileLexer.text package: botbuilder-lg @@ -609,7 +564,6 @@ inheritedProperties: changes to the text. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -623,13 +577,12 @@ inheritedProperties: summary: Override if emitting multiple tokens. fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'token: Token | undefined' + content: 'token: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From Lexer.token - name: tokenFactory uid: botbuilder-lg.LGFileLexer.tokenFactory @@ -637,7 +590,6 @@ inheritedProperties: summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -651,7 +603,6 @@ inheritedProperties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: number' @@ -665,7 +616,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -673,7 +623,7 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Lexer.addErrorListener - name: emit() uid: botbuilder-lg.LGFileLexer.emit_1 package: botbuilder-lg @@ -683,7 +633,6 @@ inheritedMethods: and getToken (to push tokens into a list and pull from that list rather than a single variable as this implementation does). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(): Token' @@ -701,7 +650,6 @@ inheritedMethods: use that to set the token's text. Override this method to emit custom Token objects or provide a new factory. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(token: Token): Token' @@ -718,7 +666,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEOF(): Token' @@ -733,20 +680,18 @@ inheritedMethods: Return a list of all Token objects in input char stream. Forces load of all tokens. Does not include EOF token. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllTokens(): Token[]' return: description: '' - type: 'Token[]' + type: Token[] inheritanceDescription: Inherited From Lexer.getAllTokens - name: getCharErrorDisplay(number) uid: botbuilder-lg.LGFileLexer.getCharErrorDisplay package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCharErrorDisplay(c: number): string' @@ -763,7 +708,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorDisplay(s: string | number): string' @@ -778,9 +722,8 @@ inheritedMethods: - name: getErrorHeader(RecognitionException) uid: botbuilder-lg.LGFileLexer.getErrorHeader package: botbuilder-lg - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -791,54 +734,51 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Lexer.getErrorHeader - name: getErrorListenerDispatch() uid: botbuilder-lg.LGFileLexer.getErrorListenerDispatch package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ANTLRErrorListener' return: description: '' type: ANTLRErrorListener<number> - inheritanceDescription: Inherited From Recognizer.getErrorListenerDispatch + inheritanceDescription: Inherited From Lexer.getErrorListenerDispatch - name: getErrorListeners() uid: botbuilder-lg.LGFileLexer.getErrorListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<number>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<number>[] + inheritanceDescription: Inherited From Lexer.getErrorListeners - name: getRuleIndexMap() uid: botbuilder-lg.LGFileLexer.getRuleIndexMap package: botbuilder-lg - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getRuleIndexMap - name: getTokenType(string) uid: botbuilder-lg.LGFileLexer.getTokenType package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -849,28 +789,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Lexer.getTokenType - name: getTokenTypeMap() uid: botbuilder-lg.LGFileLexer.getTokenTypeMap package: botbuilder-lg - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getTokenTypeMap - name: mode(number) uid: botbuilder-lg.LGFileLexer.mode package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function mode(m: number)' @@ -884,7 +823,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function more() @@ -896,7 +834,6 @@ inheritedMethods: Return a token from this source; i.e., match a token on the char stream. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function nextToken(): Token' @@ -909,7 +846,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyListeners(e: LexerNoViableAltException)' @@ -923,7 +859,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function popMode(): number' @@ -931,20 +866,19 @@ inheritedMethods: description: '' type: number inheritanceDescription: Inherited From Lexer.popMode - - name: 'precpred(RuleContext | undefined, number)' + - name: precpred(undefined | RuleContext, number) uid: botbuilder-lg.LGFileLexer.precpred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function precpred(localctx: RuleContext | undefined, precedence: + function precpred(localctx: undefined | RuleContext, precedence: number): boolean parameters: - id: localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: precedence type: number @@ -952,13 +886,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.precpred + inheritanceDescription: Inherited From Lexer.precpred - name: pushMode(number) uid: botbuilder-lg.LGFileLexer.pushMode package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function pushMode(m: number)' @@ -972,7 +905,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: LexerNoViableAltException)' @@ -990,7 +922,6 @@ inheritedMethods: it all works out. You can instead use the rule invocation stack to do sophisticated error recovery if you are in a fragment rule. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: RecognitionException)' @@ -1004,7 +935,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -1012,23 +942,21 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Lexer.removeErrorListener - name: removeErrorListeners() uid: botbuilder-lg.LGFileLexer.removeErrorListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Lexer.removeErrorListeners - name: reset() uid: botbuilder-lg.LGFileLexer.reset package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -1038,7 +966,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -1057,18 +984,16 @@ inheritedMethods: if token==undefined at end of any token rule, it creates one for you and emits it. remarks: '' - isPreview: false isDeprecated: false syntax: content: function skip() inheritanceDescription: Inherited From Lexer.skip methods: - - name: 'action(RuleContext, number, number)' + - name: action(RuleContext, number, number) uid: botbuilder-lg.LGFileLexer.action package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1084,12 +1009,11 @@ methods: - id: actionIndex type: number description: '' - - name: 'sempred(RuleContext, number, number)' + - name: sempred(RuleContext, number, number) uid: botbuilder-lg.LGFileLexer.sempred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParser.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParser.yml index 1e2ba378..73a1cf24 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParser.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParser.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: LGFileParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LGFileParser(input: TokenStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: COMMENT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COMMENT: 3 = 3' + content: 'static COMMENT: 3 = 3' return: description: '' type: '3' @@ -42,10 +39,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER: 11 = 11' + content: 'static ESCAPE_CHARACTER: 11 = 11' return: description: '' type: '11' @@ -55,10 +51,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -68,10 +63,9 @@ properties: summary: '' fullName: IMPORT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IMPORT: 4 = 4' + content: 'static IMPORT: 4 = 4' return: description: '' type: '4' @@ -81,10 +75,9 @@ properties: summary: '' fullName: INLINE_MULTILINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INLINE_MULTILINE: 6 = 6' + content: 'static INLINE_MULTILINE: 6 = 6' return: description: '' type: '6' @@ -94,10 +87,9 @@ properties: summary: '' fullName: INVALID_LINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INVALID_LINE: 9 = 9' + content: 'static INVALID_LINE: 9 = 9' return: description: '' type: '9' @@ -107,10 +99,9 @@ properties: summary: '' fullName: MULTILINE_PREFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_PREFIX: 7 = 7' + content: 'static MULTILINE_PREFIX: 7 = 7' return: description: '' type: '7' @@ -120,10 +111,9 @@ properties: summary: '' fullName: MULTILINE_SUFFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_SUFFIX: 10 = 10' + content: 'static MULTILINE_SUFFIX: 10 = 10' return: description: '' type: '10' @@ -133,10 +123,9 @@ properties: summary: '' fullName: MULTILINE_TEXT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_TEXT: 12 = 12' + content: 'static MULTILINE_TEXT: 12 = 12' return: description: '' type: '12' @@ -146,10 +135,9 @@ properties: summary: '' fullName: NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE: 1 = 1' + content: 'static NEWLINE: 1 = 1' return: description: '' type: '1' @@ -159,10 +147,9 @@ properties: summary: '' fullName: OPTION remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static OPTION: 2 = 2' + content: 'static OPTION: 2 = 2' return: description: '' type: '2' @@ -172,36 +159,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\r\n\t\t\"file\", \"paragraph\", \"commentDefinition\", \"importDefinition\", \"optionDefinition\", \r\n\t\t\"errorDefinition\", \"templateDefinition\", \"templateNameLine\", \"templateBody\", \r\n\t\t\"templateBodyLine\",\r\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: botbuilder-lg.LGFileParser.ruleNames package: botbuilder-lg summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: RULE_commentDefinition uid: botbuilder-lg.LGFileParser.RULE_commentDefinition package: botbuilder-lg summary: '' fullName: RULE_commentDefinition remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_commentDefinition: 2 = 2' + content: 'static RULE_commentDefinition: 2 = 2' return: description: '' type: '2' @@ -211,10 +195,9 @@ properties: summary: '' fullName: RULE_errorDefinition remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_errorDefinition: 5 = 5' + content: 'static RULE_errorDefinition: 5 = 5' return: description: '' type: '5' @@ -224,10 +207,9 @@ properties: summary: '' fullName: RULE_file remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_file: 0 = 0' + content: 'static RULE_file: 0 = 0' return: description: '' type: '0' @@ -237,10 +219,9 @@ properties: summary: '' fullName: RULE_importDefinition remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_importDefinition: 3 = 3' + content: 'static RULE_importDefinition: 3 = 3' return: description: '' type: '3' @@ -250,10 +231,9 @@ properties: summary: '' fullName: RULE_optionDefinition remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_optionDefinition: 4 = 4' + content: 'static RULE_optionDefinition: 4 = 4' return: description: '' type: '4' @@ -263,10 +243,9 @@ properties: summary: '' fullName: RULE_paragraph remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_paragraph: 1 = 1' + content: 'static RULE_paragraph: 1 = 1' return: description: '' type: '1' @@ -276,10 +255,9 @@ properties: summary: '' fullName: RULE_templateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_templateBody: 8 = 8' + content: 'static RULE_templateBody: 8 = 8' return: description: '' type: '8' @@ -289,10 +267,9 @@ properties: summary: '' fullName: RULE_templateBodyLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_templateBodyLine: 9 = 9' + content: 'static RULE_templateBodyLine: 9 = 9' return: description: '' type: '9' @@ -302,10 +279,9 @@ properties: summary: '' fullName: RULE_templateDefinition remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_templateDefinition: 6 = 6' + content: 'static RULE_templateDefinition: 6 = 6' return: description: '' type: '6' @@ -315,10 +291,9 @@ properties: summary: '' fullName: RULE_templateNameLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_templateNameLine: 7 = 7' + content: 'static RULE_templateNameLine: 7 = 7' return: description: '' type: '7' @@ -328,10 +303,9 @@ properties: summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -341,10 +315,9 @@ properties: summary: '' fullName: TEMPLATE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEMPLATE_BODY: 8 = 8' + content: 'static TEMPLATE_BODY: 8 = 8' return: description: '' type: '8' @@ -354,39 +327,33 @@ properties: summary: '' fullName: TEMPLATE_NAME_LINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEMPLATE_NAME_LINE: 5 = 5' + content: 'static TEMPLATE_NAME_LINE: 5 = 5' return: description: '' type: '5' - - name: VOCABULARY - uid: botbuilder-lg.LGFileParser.VOCABULARY + - name: vocabulary + uid: botbuilder-lg.LGFileParser.vocabulary package: botbuilder-lg summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(LGFileParser._LITERAL_NAMES, - LGFileParser._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: botbuilder-lg.LGFileParser.vocabulary + - name: VOCABULARY + uid: botbuilder-lg.LGFileParser.VOCABULARY package: botbuilder-lg summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -399,22 +366,24 @@ inheritedProperties: recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by the + recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Parser.atn - name: buildParseTree uid: botbuilder-lg.LGFileParser.buildParseTree package: botbuilder-lg - summary: | + summary: |- Track the objects during the parse and hook them up using the list so that it forms a parse tree. The returned from the start rule represents the root of the parse tree. + Note that if we are not building parse trees, rule contexts only point upwards. When a rule exits, it returns the context but that gets garbage collected if nobody holds a reference. It points upwards but nobody @@ -425,7 +394,6 @@ inheritedProperties: for garbage collection. fullName: buildParseTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buildParseTree: boolean' @@ -439,7 +407,6 @@ inheritedProperties: summary: '' fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: ParserRuleContext' @@ -455,7 +422,6 @@ inheritedProperties: into the label for the associated token ref; e.g., x=ID. fullName: currentToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'currentToken: Token' @@ -469,21 +435,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Parser.EOF - name: errorHandler uid: botbuilder-lg.LGFileParser.errorHandler package: botbuilder-lg summary: '' fullName: errorHandler remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorHandler: ANTLRErrorStrategy' @@ -497,7 +461,6 @@ inheritedProperties: summary: Set the token stream and reset the parser. fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: TokenStream' @@ -511,21 +474,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: ParserATNSimulator' return: description: '' type: ParserATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Parser.interpreter - name: isMatchedEOF uid: botbuilder-lg.LGFileParser.isMatchedEOF package: botbuilder-lg summary: '' fullName: isMatchedEOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isMatchedEOF: boolean' @@ -541,7 +502,6 @@ inheritedProperties: events as well as token matches. This is for quick and dirty debugging. fullName: isTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTrace: boolean' @@ -559,7 +519,6 @@ inheritedProperties: See #notifyErrorListeners fullName: numberOfSyntaxErrors remarks: '' - isPreview: false isDeprecated: false syntax: content: 'numberOfSyntaxErrors: number' @@ -573,13 +532,12 @@ inheritedProperties: summary: '' fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> + type: Promise<undefined | ParseInfo> inheritanceDescription: Inherited From Parser.parseInfo - name: precedence uid: botbuilder-lg.LGFileParser.precedence @@ -587,12 +545,13 @@ inheritedProperties: summary: Get the precedence level for the top-most precedence rule. fullName: precedence remarks: '' - isPreview: false isDeprecated: false syntax: content: 'precedence: number' return: - description: '' + description: |- + The precedence level for the top-most precedence rule, or -1 if + the parser context is not nested within a precedence rule. type: number inheritanceDescription: Inherited From Parser.precedence - name: ruleContext @@ -601,7 +560,6 @@ inheritedProperties: summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ruleContext: ParserRuleContext' @@ -615,7 +573,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -635,21 +592,19 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Parser.state - name: tokenFactory uid: botbuilder-lg.LGFileParser.tokenFactory package: botbuilder-lg summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -658,20 +613,19 @@ inheritedProperties: type: TokenFactory inheritanceDescription: Inherited From Parser.tokenFactory inheritedMethods: - - name: 'action(RuleContext | undefined, number, number)' + - name: action(undefined | RuleContext, number, number) uid: botbuilder-lg.LGFileParser.action package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function action(_localctx: RuleContext | undefined, ruleIndex: number, + function action(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number) parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -679,13 +633,12 @@ inheritedMethods: - id: actionIndex type: number description: '' - inheritanceDescription: Inherited From Recognizer.action + inheritanceDescription: Inherited From Parser.action - name: addErrorListener(ANTLRErrorListener) uid: botbuilder-lg.LGFileParser.addErrorListener package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -693,12 +646,13 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Parser.addErrorListener - name: addParseListener(ParseTreeListener) uid: botbuilder-lg.LGFileParser.addParseListener package: botbuilder-lg - summary: | + summary: |- Registers `listener` to receive events during the parsing process. + To support output-preserving grammar transformations (including but not limited to left-recursion removal, automated left-factoring, and optimized code generation), calls to listener methods during the parse @@ -719,24 +673,23 @@ inheritedMethods: * Changing the version of the ANTLR Tool used to generate the parser may change the behavior of the listener calls. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to add + description: the listener to add inheritanceDescription: Inherited From Parser.addParseListener - - name: 'compileParseTreePattern(string, number)' + - name: compileParseTreePattern(string, number) uid: botbuilder-lg.LGFileParser.compileParseTreePattern package: botbuilder-lg - summary: > + summary: >- The preferred method of getting a tree pattern. For example, here's a sample use: + ``` let t: ParseTree = parser.expr(); @@ -750,7 +703,6 @@ inheritedMethods: ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -767,7 +719,7 @@ inheritedMethods: description: '' type: Promise<ParseTreePattern> inheritanceDescription: Inherited From Parser.compileParseTreePattern - - name: 'compileParseTreePattern(string, number, Lexer)' + - name: compileParseTreePattern(string, number, Lexer) uid: botbuilder-lg.LGFileParser.compileParseTreePattern_1 package: botbuilder-lg summary: >- @@ -777,7 +729,6 @@ inheritedMethods: rather than trying to deduce it from this parser. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -800,9 +751,10 @@ inheritedMethods: - name: consume() uid: botbuilder-lg.LGFileParser.consume package: botbuilder-lg - summary: > + summary: >- Consume and return the [current symbol](`currentToken`). + E.g., given the following input with `A` being the current lookahead symbol, this function moves the cursor to `B` and returns @@ -837,7 +789,6 @@ inheritedMethods: listeners. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function consume(): Token' @@ -845,14 +796,13 @@ inheritedMethods: description: '' type: Token inheritanceDescription: Inherited From Parser.consume - - name: 'createErrorNode(ParserRuleContext, Token)' + - name: createErrorNode(ParserRuleContext, Token) uid: botbuilder-lg.LGFileParser.createErrorNode package: botbuilder-lg summary: |- How to create an error node, given a token, associated with a parent. Typically, the error node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createErrorNode(parent: ParserRuleContext, t: Token): ErrorNode' @@ -867,14 +817,13 @@ inheritedMethods: description: '' type: ErrorNode inheritanceDescription: Inherited From Parser.createErrorNode - - name: 'createTerminalNode(ParserRuleContext, Token)' + - name: createTerminalNode(ParserRuleContext, Token) uid: botbuilder-lg.LGFileParser.createTerminalNode package: botbuilder-lg summary: |- How to create a token leaf node associated with a parent. Typically, the terminal node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -896,17 +845,15 @@ inheritedMethods: package: botbuilder-lg summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: function dumpDFA() inheritanceDescription: Inherited From Parser.dumpDFA - - name: 'enterLeftFactoredRule(ParserRuleContext, number, number)' + - name: enterLeftFactoredRule(ParserRuleContext, number, number) uid: botbuilder-lg.LGFileParser.enterLeftFactoredRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -923,12 +870,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterLeftFactoredRule - - name: 'enterOuterAlt(ParserRuleContext, number)' + - name: enterOuterAlt(ParserRuleContext, number) uid: botbuilder-lg.LGFileParser.enterOuterAlt package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterOuterAlt(localctx: ParserRuleContext, altNum: number)' @@ -940,12 +886,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterOuterAlt - - name: 'enterRecursionRule(ParserRuleContext, number, number, number)' + - name: enterRecursionRule(ParserRuleContext, number, number, number) uid: botbuilder-lg.LGFileParser.enterRecursionRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -965,14 +910,13 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterRecursionRule - - name: 'enterRule(ParserRuleContext, number, number)' + - name: enterRule(ParserRuleContext, number, number) uid: botbuilder-lg.LGFileParser.enterRule package: botbuilder-lg summary: |- Always called by generated parsers upon entry to a rule. Access field get the current context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -994,7 +938,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function exitRule() @@ -1002,13 +945,13 @@ inheritedMethods: - name: getATNWithBypassAlts() uid: botbuilder-lg.LGFileParser.getATNWithBypassAlts package: botbuilder-lg - summary: | + summary: |- The ATN with bypass alternatives is expensive to create so we create it lazily. + @ if the current parser does not implement the `serializedATN` property. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getATNWithBypassAlts(): ATN' @@ -1021,20 +964,18 @@ inheritedMethods: package: botbuilder-lg summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getDFAStrings(): string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getDFAStrings - name: getErrorHeader(RecognitionException) uid: botbuilder-lg.LGFileParser.getErrorHeader package: botbuilder-lg - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -1045,13 +986,12 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Parser.getErrorHeader - name: getErrorListenerDispatch() uid: botbuilder-lg.LGFileParser.getErrorListenerDispatch package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ParserErrorListener' @@ -1064,14 +1004,13 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<Token>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<Token>[] + inheritanceDescription: Inherited From Parser.getErrorListeners - name: getExpectedTokens() uid: botbuilder-lg.LGFileParser.getExpectedTokens package: botbuilder-lg @@ -1086,7 +1025,6 @@ inheritedMethods: See ATN#getExpectedTokens(int, RuleContext) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokens(): IntervalSet' @@ -1099,7 +1037,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokensWithinCurrentRule(): IntervalSet' @@ -1112,39 +1049,36 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function getInvokingContext(ruleIndex: number): ParserRuleContext | - undefined + function getInvokingContext(ruleIndex: number): undefined | + ParserRuleContext parameters: - id: ruleIndex type: number description: '' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From Parser.getInvokingContext - name: getParseListeners() uid: botbuilder-lg.LGFileParser.getParseListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getParseListeners(): ParseTreeListener[]' return: description: '' - type: 'ParseTreeListener[]' + type: ParseTreeListener[] inheritanceDescription: Inherited From Parser.getParseListeners - name: getRuleIndex(string) uid: botbuilder-lg.LGFileParser.getRuleIndex package: botbuilder-lg - summary: 'Get a rule''s index (i.e., `RULE_ruleName` field) or -1 if not found.' + summary: Get a rule's index (i.e., `RULE_ruleName` field) or -1 if not found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndex(ruleName: string): number' @@ -1159,29 +1093,29 @@ inheritedMethods: - name: getRuleIndexMap() uid: botbuilder-lg.LGFileParser.getRuleIndexMap package: botbuilder-lg - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getRuleIndexMap - name: getRuleInvocationStack(RuleContext) uid: botbuilder-lg.LGFileParser.getRuleInvocationStack package: botbuilder-lg - summary: | + summary: |- Return List<String> of the rule names in your parser instance leading up to a call to the current rule. You could override if you want more details such as the file/line info of where in the ATN a rule is invoked. + This is very useful for error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleInvocationStack(ctx?: RuleContext): string[]' @@ -1191,14 +1125,13 @@ inheritedMethods: description: '' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getRuleInvocationStack - name: getTokenType(string) uid: botbuilder-lg.LGFileParser.getTokenType package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -1209,28 +1142,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Parser.getTokenType - name: getTokenTypeMap() uid: botbuilder-lg.LGFileParser.getTokenTypeMap package: botbuilder-lg - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getTokenTypeMap - name: inContext(string) uid: botbuilder-lg.LGFileParser.inContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function inContext(context: string): boolean' @@ -1245,16 +1177,16 @@ inheritedMethods: - name: isExpectedToken(number) uid: botbuilder-lg.LGFileParser.isExpectedToken package: botbuilder-lg - summary: | + summary: |- Checks whether or not `symbol` can follow the current state in the ATN. The behavior of this method is equivalent to the following, but is implemented such that the complete context-sensitive follow set does not need to be explicitly constructed. + ``` return getExpectedTokens().contains(symbol); ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isExpectedToken(symbol: number): boolean' @@ -1271,13 +1203,14 @@ inheritedMethods: - name: match(number) uid: botbuilder-lg.LGFileParser.match package: botbuilder-lg - summary: > + summary: >- Match current input symbol against `ttype`. If the symbol type matches, and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -1293,7 +1226,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function match(ttype: number): Token' @@ -1312,13 +1244,14 @@ inheritedMethods: - name: matchWildcard() uid: botbuilder-lg.LGFileParser.matchWildcard package: botbuilder-lg - summary: > + summary: >- Match current input symbol as a wildcard. If the symbol type matches (i.e. has a value greater than 0), and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -1334,7 +1267,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function matchWildcard(): Token' @@ -1355,7 +1287,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyErrorListeners(msg: string)' @@ -1365,35 +1296,33 @@ inheritedMethods: description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - name: >- - notifyErrorListeners(string, Token | null, RecognitionException | - undefined) + notifyErrorListeners(string, null | Token, undefined | + RecognitionException) uid: botbuilder-lg.LGFileParser.notifyErrorListeners_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function notifyErrorListeners(msg: string, offendingToken: Token | null, - e: RecognitionException | undefined) + function notifyErrorListeners(msg: string, offendingToken: null | Token, + e: undefined | RecognitionException) parameters: - id: msg type: string description: '' - id: offendingToken - type: Token | null + type: null | Token description: '' - id: e - type: RecognitionException | undefined + type: undefined | RecognitionException description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - - name: 'precpred(RuleContext, number)' + - name: precpred(RuleContext, number) uid: botbuilder-lg.LGFileParser.precpred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function precpred(localctx: RuleContext, precedence: number): boolean' @@ -1408,14 +1337,13 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From Parser.precpred - - name: 'pushNewRecursionContext(ParserRuleContext, number, number)' + - name: pushNewRecursionContext(ParserRuleContext, number, number) uid: botbuilder-lg.LGFileParser.pushNewRecursionContext package: botbuilder-lg summary: |- Like but for recursive rules. Make the current context the child of the incoming localctx. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1437,7 +1365,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -1445,37 +1372,34 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Parser.removeErrorListener - name: removeErrorListeners() uid: botbuilder-lg.LGFileParser.removeErrorListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Parser.removeErrorListeners - name: removeParseListener(ParseTreeListener) uid: botbuilder-lg.LGFileParser.removeParseListener package: botbuilder-lg summary: |- Remove `listener` from the list of parse listeners. + If `listener` is `undefined` or has not been added as a parse listener, this method does nothing. - See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to remove + description: the listener to remove inheritanceDescription: Inherited From Parser.removeParseListener - name: removeParseListeners() uid: botbuilder-lg.LGFileParser.removeParseListeners @@ -1485,7 +1409,6 @@ inheritedMethods: See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeParseListeners() @@ -1495,7 +1418,6 @@ inheritedMethods: package: botbuilder-lg summary: reset the parser's state remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -1505,7 +1427,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -1514,20 +1435,19 @@ inheritedMethods: type: boolean description: '' inheritanceDescription: Inherited From Parser.reset - - name: 'sempred(RuleContext | undefined, number, number)' + - name: sempred(undefined | RuleContext, number, number) uid: botbuilder-lg.LGFileParser.sempred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function sempred(_localctx: RuleContext | undefined, ruleIndex: number, + function sempred(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number): boolean parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -1538,13 +1458,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.sempred + inheritanceDescription: Inherited From Parser.sempred - name: setProfile(boolean) uid: botbuilder-lg.LGFileParser.setProfile package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setProfile(profile: boolean): Promise' @@ -1561,7 +1480,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unrollRecursionContexts(_parentctx: ParserRuleContext)' @@ -1576,7 +1494,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function commentDefinition(): CommentDefinitionContext' @@ -1588,7 +1505,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorDefinition(): ErrorDefinitionContext' @@ -1600,7 +1516,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function file(): FileContext' @@ -1612,7 +1527,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function importDefinition(): ImportDefinitionContext' @@ -1624,7 +1538,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function optionDefinition(): OptionDefinitionContext' @@ -1636,7 +1549,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function paragraph(): ParagraphContext' @@ -1648,7 +1560,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateBody(): TemplateBodyContext' @@ -1660,7 +1571,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateBodyLine(): TemplateBodyLineContext' @@ -1672,7 +1582,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateDefinition(): TemplateDefinitionContext' @@ -1684,7 +1593,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateNameLine(): TemplateNameLineContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserListener.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserListener.yml index d9590f89..43d7c030 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserListener.yml @@ -7,7 +7,6 @@ summary: |- `LGFileParser`. fullName: LGFileParserListener remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.commentDefinition`. fullName: enterCommentDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterCommentDefinition?: (ctx: CommentDefinitionContext) => void' @@ -30,7 +28,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.errorDefinition`. fullName: enterErrorDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterErrorDefinition?: (ctx: ErrorDefinitionContext) => void' @@ -43,7 +40,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.file`. fullName: enterFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterFile?: (ctx: FileContext) => void' @@ -56,7 +52,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.importDefinition`. fullName: enterImportDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterImportDefinition?: (ctx: ImportDefinitionContext) => void' @@ -69,7 +64,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.optionDefinition`. fullName: enterOptionDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterOptionDefinition?: (ctx: OptionDefinitionContext) => void' @@ -82,7 +76,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.paragraph`. fullName: enterParagraph remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterParagraph?: (ctx: ParagraphContext) => void' @@ -95,7 +88,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.templateBody`. fullName: enterTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTemplateBody?: (ctx: TemplateBodyContext) => void' @@ -108,7 +100,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.templateBodyLine`. fullName: enterTemplateBodyLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTemplateBodyLine?: (ctx: TemplateBodyLineContext) => void' @@ -121,7 +112,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.templateDefinition`. fullName: enterTemplateDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTemplateDefinition?: (ctx: TemplateDefinitionContext) => void' @@ -134,7 +124,6 @@ properties: summary: Enter a parse tree produced by `LGFileParser.templateNameLine`. fullName: enterTemplateNameLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTemplateNameLine?: (ctx: TemplateNameLineContext) => void' @@ -147,7 +136,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.commentDefinition`. fullName: exitCommentDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitCommentDefinition?: (ctx: CommentDefinitionContext) => void' @@ -160,7 +148,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.errorDefinition`. fullName: exitErrorDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitErrorDefinition?: (ctx: ErrorDefinitionContext) => void' @@ -173,7 +160,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.file`. fullName: exitFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitFile?: (ctx: FileContext) => void' @@ -186,7 +172,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.importDefinition`. fullName: exitImportDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitImportDefinition?: (ctx: ImportDefinitionContext) => void' @@ -199,7 +184,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.optionDefinition`. fullName: exitOptionDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitOptionDefinition?: (ctx: OptionDefinitionContext) => void' @@ -212,7 +196,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.paragraph`. fullName: exitParagraph remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitParagraph?: (ctx: ParagraphContext) => void' @@ -225,7 +208,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.templateBody`. fullName: exitTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTemplateBody?: (ctx: TemplateBodyContext) => void' @@ -238,7 +220,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.templateBodyLine`. fullName: exitTemplateBodyLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTemplateBodyLine?: (ctx: TemplateBodyLineContext) => void' @@ -251,7 +232,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.templateDefinition`. fullName: exitTemplateDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTemplateDefinition?: (ctx: TemplateDefinitionContext) => void' @@ -264,7 +244,6 @@ properties: summary: Exit a parse tree produced by `LGFileParser.templateNameLine`. fullName: exitTemplateNameLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTemplateNameLine?: (ctx: TemplateNameLineContext) => void' @@ -278,7 +257,6 @@ inheritedProperties: summary: '' fullName: enterEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterEveryRule?: (ctx: ParserRuleContext) => void' @@ -292,7 +270,6 @@ inheritedProperties: summary: '' fullName: exitEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitEveryRule?: (ctx: ParserRuleContext) => void' @@ -306,7 +283,6 @@ inheritedProperties: summary: '' fullName: visitErrorNode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorNode?: (node: ErrorNode) => void' @@ -320,7 +296,6 @@ inheritedProperties: summary: '' fullName: visitTerminal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTerminal?: (node: TerminalNode) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserVisitor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserVisitor.yml index 4b4a215b..f9105476 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserVisitor.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGFileParserVisitor.yml @@ -7,7 +7,6 @@ summary: |- by `LGFileParser`. fullName: LGFileParserVisitor remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.commentDefinition`. fullName: visitCommentDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitCommentDefinition?: (ctx: CommentDefinitionContext) => Result' @@ -30,7 +28,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.errorDefinition`. fullName: visitErrorDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorDefinition?: (ctx: ErrorDefinitionContext) => Result' @@ -43,7 +40,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.file`. fullName: visitFile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitFile?: (ctx: FileContext) => Result' @@ -56,7 +52,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.importDefinition`. fullName: visitImportDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitImportDefinition?: (ctx: ImportDefinitionContext) => Result' @@ -69,7 +64,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.optionDefinition`. fullName: visitOptionDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitOptionDefinition?: (ctx: OptionDefinitionContext) => Result' @@ -82,7 +76,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.paragraph`. fullName: visitParagraph remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitParagraph?: (ctx: ParagraphContext) => Result' @@ -95,7 +88,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.templateBody`. fullName: visitTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTemplateBody?: (ctx: TemplateBodyContext) => Result' @@ -108,7 +100,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.templateBodyLine`. fullName: visitTemplateBodyLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTemplateBodyLine?: (ctx: TemplateBodyLineContext) => Result' @@ -121,7 +112,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.templateDefinition`. fullName: visitTemplateDefinition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTemplateDefinition?: (ctx: TemplateDefinitionContext) => Result' @@ -134,7 +124,6 @@ properties: summary: Visit a parse tree produced by `LGFileParser.templateNameLine`. fullName: visitTemplateNameLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTemplateNameLine?: (ctx: TemplateNameLineContext) => Result' @@ -145,16 +134,15 @@ inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.LGFileParserVisitor.visit package: botbuilder-lg - summary: 'Visit a parse tree, and return a user-defined result of the operation.' + summary: Visit a parse tree, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): Result' parameters: - id: tree type: ParseTree - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the parse tree. type: Result @@ -166,14 +154,13 @@ inheritedMethods: Visit the children of a node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): Result' parameters: - id: node type: RuleNode - description: 'The whose children should be visited.' + description: The whose children should be visited. return: description: The result of visiting the children of the node. type: Result @@ -181,16 +168,15 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.LGFileParserVisitor.visitErrorNode package: botbuilder-lg - summary: 'Visit an error node, and return a user-defined result of the operation.' + summary: Visit an error node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): Result' parameters: - id: node type: ErrorNode - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the node. type: Result @@ -198,16 +184,15 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: botbuilder-lg.LGFileParserVisitor.visitTerminal package: botbuilder-lg - summary: 'Visit a terminal node, and return a user-defined result of the operation.' + summary: Visit a terminal node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): Result' parameters: - id: node type: TerminalNode - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the node. type: Result diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGLineBreakStyle.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGLineBreakStyle.yml index 69c01589..082dc09e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGLineBreakStyle.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGLineBreakStyle.yml @@ -7,7 +7,6 @@ summary: |- Licensed under the MIT License. fullName: LGLineBreakStyle remarks: '' -isPreview: false isDeprecated: false fields: - name: Default diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGResource.yml index e4475e77..76822874 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGResource.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGResource.yml @@ -2,21 +2,19 @@ name: LGResource uid: botbuilder-lg.LGResource package: botbuilder-lg -summary: 'LG resource entity, contains some core data structure.' +summary: LG resource entity, contains some core data structure. fullName: LGResource remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'LGResource(string, string, string)' + - name: LGResource(string, string, string) uid: botbuilder-lg.LGResource.constructor package: botbuilder-lg summary: >- Creates a new instance of the [LGResource](xref:botbuilder-lg.LGResource) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LGResource(id: string, fullName: string, content: string)' @@ -29,8 +27,7 @@ constructors: description: The full path to the resource on disk. - id: content type: string - description: | - Resource content. + description: Resource content. properties: - name: content uid: botbuilder-lg.LGResource.content @@ -38,7 +35,6 @@ properties: summary: Resource content. fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content: string' @@ -51,7 +47,6 @@ properties: summary: The full path to the resource on disk. fullName: fullName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fullName: string' @@ -64,7 +59,6 @@ properties: summary: esource id. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateLexer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateLexer.yml index 97eadd73..dc8a5908 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateLexer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateLexer.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: LGTemplateLexer remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LGTemplateLexer(input: CharStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: beginOfStructureProperty remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'beginOfStructureProperty: boolean = false' + content: 'beginOfStructureProperty: boolean' return: description: '' type: boolean @@ -42,10 +39,9 @@ properties: summary: '' fullName: beginOfTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'beginOfTemplateBody: boolean = true' + content: 'beginOfTemplateBody: boolean' return: description: '' type: boolean @@ -55,10 +51,9 @@ properties: summary: '' fullName: beginOfTemplateLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'beginOfTemplateLine: boolean = false' + content: 'beginOfTemplateLine: boolean' return: description: '' type: boolean @@ -68,10 +63,9 @@ properties: summary: '' fullName: CASE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CASE: 14 = 14' + content: 'static CASE: 14 = 14' return: description: '' type: '14' @@ -81,36 +75,33 @@ properties: summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static channelNames: string[] = [\r\n\t\t\"DEFAULT_TOKEN_CHANNEL\", \"HIDDEN\",\r\n\t]" + content: 'channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: channelNames uid: botbuilder-lg.LGTemplateLexer.channelNames package: botbuilder-lg summary: '' fullName: channelNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] channelNames' + content: 'static channelNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: COMMENTS uid: botbuilder-lg.LGTemplateLexer.COMMENTS package: botbuilder-lg summary: '' fullName: COMMENTS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COMMENTS: 3 = 3' + content: 'static COMMENTS: 3 = 3' return: description: '' type: '3' @@ -120,10 +111,9 @@ properties: summary: '' fullName: DASH remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DASH: 4 = 4' + content: 'static DASH: 4 = 4' return: description: '' type: '4' @@ -133,10 +123,9 @@ properties: summary: '' fullName: DEFAULT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DEFAULT: 15 = 15' + content: 'static DEFAULT: 15 = 15' return: description: '' type: '15' @@ -146,10 +135,9 @@ properties: summary: '' fullName: ELSE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ELSE: 12 = 12' + content: 'static ELSE: 12 = 12' return: description: '' type: '12' @@ -159,10 +147,9 @@ properties: summary: '' fullName: ELSEIF remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ELSEIF: 11 = 11' + content: 'static ELSEIF: 11 = 11' return: description: '' type: '11' @@ -172,10 +159,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER: 16 = 16' + content: 'static ESCAPE_CHARACTER: 16 = 16' return: description: '' type: '16' @@ -185,10 +171,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER_IN_STRUCTURE_BODY: 31 = 31' + content: 'static ESCAPE_CHARACTER_IN_STRUCTURE_BODY: 31 = 31' return: description: '' type: '31' @@ -198,10 +183,9 @@ properties: summary: '' fullName: EXPRESSION remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EXPRESSION: 17 = 17' + content: 'static EXPRESSION: 17 = 17' return: description: '' type: '17' @@ -211,10 +195,9 @@ properties: summary: '' fullName: EXPRESSION_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EXPRESSION_IN_STRUCTURE_BODY: 32 = 32' + content: 'static EXPRESSION_IN_STRUCTURE_BODY: 32 = 32' return: description: '' type: '32' @@ -224,10 +207,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -237,10 +219,9 @@ properties: summary: '' fullName: IF remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IF: 10 = 10' + content: 'static IF: 10 = 10' return: description: '' type: '10' @@ -250,10 +231,9 @@ properties: summary: '' fullName: ignoreWS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ignoreWS: boolean = true' + content: 'ignoreWS: boolean' return: description: '' type: boolean @@ -263,10 +243,9 @@ properties: summary: '' fullName: inMultiline remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inMultiline: boolean = false' + content: 'inMultiline: boolean' return: description: '' type: boolean @@ -276,10 +255,9 @@ properties: summary: '' fullName: inStructuredValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inStructuredValue: boolean = false' + content: 'inStructuredValue: boolean' return: description: '' type: boolean @@ -289,10 +267,9 @@ properties: summary: '' fullName: INVALID_TOKEN remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INVALID_TOKEN: 6 = 6' + content: 'static INVALID_TOKEN: 6 = 6' return: description: '' type: '6' @@ -302,10 +279,9 @@ properties: summary: '' fullName: LEFT_SQUARE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LEFT_SQUARE_BRACKET: 5 = 5' + content: 'static LEFT_SQUARE_BRACKET: 5 = 5' return: description: '' type: '5' @@ -315,36 +291,33 @@ properties: summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static modeNames: string[] = [\r\n\t\t\"DEFAULT_MODE\", \"NORMAL_TEMPLATE_BODY_MODE\", \"MULTILINE_MODE\", \"STRUCTURE_NAME_MODE\", \r\n\t\t\"STRUCTURE_BODY_MODE\",\r\n\t]" + content: 'modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: modeNames uid: botbuilder-lg.LGTemplateLexer.modeNames package: botbuilder-lg summary: '' fullName: modeNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] modeNames' + content: 'static modeNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: MULTILINE_MODE uid: botbuilder-lg.LGTemplateLexer.MULTILINE_MODE package: botbuilder-lg summary: '' fullName: MULTILINE_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_MODE: 2 = 2' + content: 'static MULTILINE_MODE: 2 = 2' return: description: '' type: '2' @@ -354,10 +327,9 @@ properties: summary: '' fullName: MULTILINE_PREFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_PREFIX: 8 = 8' + content: 'static MULTILINE_PREFIX: 8 = 8' return: description: '' type: '8' @@ -367,10 +339,9 @@ properties: summary: '' fullName: MULTILINE_SUFFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_SUFFIX: 19 = 19' + content: 'static MULTILINE_SUFFIX: 19 = 19' return: description: '' type: '19' @@ -380,10 +351,9 @@ properties: summary: '' fullName: NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE: 2 = 2' + content: 'static NEWLINE: 2 = 2' return: description: '' type: '2' @@ -393,10 +363,9 @@ properties: summary: '' fullName: NEWLINE_IN_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE_IN_BODY: 9 = 9' + content: 'static NEWLINE_IN_BODY: 9 = 9' return: description: '' type: '9' @@ -406,10 +375,9 @@ properties: summary: '' fullName: NEWLINE_IN_STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE_IN_STRUCTURE_NAME: 21 = 21' + content: 'static NEWLINE_IN_STRUCTURE_NAME: 21 = 21' return: description: '' type: '21' @@ -419,10 +387,9 @@ properties: summary: '' fullName: NORMAL_TEMPLATE_BODY_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NORMAL_TEMPLATE_BODY_MODE: 1 = 1' + content: 'static NORMAL_TEMPLATE_BODY_MODE: 1 = 1' return: description: '' type: '1' @@ -432,36 +399,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\r\n\t\t\"A\", \"C\", \"D\", \"E\", \"F\", \"H\", \"I\", \"L\", \"S\", \"T\", \"U\", \"W\", \"LETTER\", \r\n\t\t\"NUMBER\", \"WHITESPACE\", \"STRING_LITERAL\", \"STRING_INTERPOLATION\", \"ESCAPE_CHARACTER_FRAGMENT\", \r\n\t\t\"IDENTIFIER\", \"OBJECT_DEFINITION\", \"EXPRESSION_FRAGMENT\", \"NEWLINE_FRAGMENT\", \r\n\t\t\"WS\", \"NEWLINE\", \"COMMENTS\", \"DASH\", \"LEFT_SQUARE_BRACKET\", \"INVALID_TOKEN\", \r\n\t\t\"WS_IN_BODY\", \"MULTILINE_PREFIX\", \"NEWLINE_IN_BODY\", \"IF\", \"ELSEIF\", \"ELSE\", \r\n\t\t\"SWITCH\", \"CASE\", \"DEFAULT\", \"ESCAPE_CHARACTER\", \"EXPRESSION\", \"TEXT\", \r\n\t\t\"MULTILINE_SUFFIX\", \"MULTILINE_ESCAPE_CHARACTER\", \"MULTILINE_EXPRESSION\", \r\n\t\t\"MULTILINE_TEXT\", \"WS_IN_STRUCTURE_NAME\", \"NEWLINE_IN_STRUCTURE_NAME\", \r\n\t\t\"STRUCTURE_NAME\", \"TEXT_IN_STRUCTURE_NAME\", \"STRUCTURED_COMMENTS\", \"WS_IN_STRUCTURE_BODY\", \r\n\t\t\"STRUCTURED_NEWLINE\", \"STRUCTURED_BODY_END\", \"STRUCTURE_IDENTIFIER\", \"STRUCTURE_EQUALS\", \r\n\t\t\"STRUCTURE_OR_MARK\", \"ESCAPE_CHARACTER_IN_STRUCTURE_BODY\", \"EXPRESSION_IN_STRUCTURE_BODY\", \r\n\t\t\"TEXT_IN_STRUCTURE_BODY\",\r\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: botbuilder-lg.LGTemplateLexer.ruleNames package: botbuilder-lg summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: serializedATN uid: botbuilder-lg.LGTemplateLexer.serializedATN package: botbuilder-lg summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -471,10 +435,9 @@ properties: summary: '' fullName: STRUCTURED_BODY_END remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURED_BODY_END: 27 = 27' + content: 'static STRUCTURED_BODY_END: 27 = 27' return: description: '' type: '27' @@ -484,10 +447,9 @@ properties: summary: '' fullName: STRUCTURED_COMMENTS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURED_COMMENTS: 24 = 24' + content: 'static STRUCTURED_COMMENTS: 24 = 24' return: description: '' type: '24' @@ -497,10 +459,9 @@ properties: summary: '' fullName: STRUCTURED_NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURED_NEWLINE: 26 = 26' + content: 'static STRUCTURED_NEWLINE: 26 = 26' return: description: '' type: '26' @@ -510,10 +471,9 @@ properties: summary: '' fullName: STRUCTURE_BODY_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_BODY_MODE: 4 = 4' + content: 'static STRUCTURE_BODY_MODE: 4 = 4' return: description: '' type: '4' @@ -523,10 +483,9 @@ properties: summary: '' fullName: STRUCTURE_EQUALS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_EQUALS: 29 = 29' + content: 'static STRUCTURE_EQUALS: 29 = 29' return: description: '' type: '29' @@ -536,10 +495,9 @@ properties: summary: '' fullName: STRUCTURE_IDENTIFIER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_IDENTIFIER: 28 = 28' + content: 'static STRUCTURE_IDENTIFIER: 28 = 28' return: description: '' type: '28' @@ -549,10 +507,9 @@ properties: summary: '' fullName: STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_NAME: 22 = 22' + content: 'static STRUCTURE_NAME: 22 = 22' return: description: '' type: '22' @@ -562,10 +519,9 @@ properties: summary: '' fullName: STRUCTURE_NAME_MODE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_NAME_MODE: 3 = 3' + content: 'static STRUCTURE_NAME_MODE: 3 = 3' return: description: '' type: '3' @@ -575,10 +531,9 @@ properties: summary: '' fullName: STRUCTURE_OR_MARK remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_OR_MARK: 30 = 30' + content: 'static STRUCTURE_OR_MARK: 30 = 30' return: description: '' type: '30' @@ -588,10 +543,9 @@ properties: summary: '' fullName: SWITCH remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SWITCH: 13 = 13' + content: 'static SWITCH: 13 = 13' return: description: '' type: '13' @@ -601,10 +555,9 @@ properties: summary: '' fullName: TEXT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT: 18 = 18' + content: 'static TEXT: 18 = 18' return: description: '' type: '18' @@ -614,10 +567,9 @@ properties: summary: '' fullName: TEXT_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT_IN_STRUCTURE_BODY: 33 = 33' + content: 'static TEXT_IN_STRUCTURE_BODY: 33 = 33' return: description: '' type: '33' @@ -627,39 +579,33 @@ properties: summary: '' fullName: TEXT_IN_STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT_IN_STRUCTURE_NAME: 23 = 23' + content: 'static TEXT_IN_STRUCTURE_NAME: 23 = 23' return: description: '' type: '23' - - name: VOCABULARY - uid: botbuilder-lg.LGTemplateLexer.VOCABULARY + - name: vocabulary + uid: botbuilder-lg.LGTemplateLexer.vocabulary package: botbuilder-lg summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(LGTemplateLexer._LITERAL_NAMES, - LGTemplateLexer._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: botbuilder-lg.LGTemplateLexer.vocabulary + - name: VOCABULARY + uid: botbuilder-lg.LGTemplateLexer.VOCABULARY package: botbuilder-lg summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -669,10 +615,9 @@ properties: summary: '' fullName: WS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS: 1 = 1' + content: 'static WS: 1 = 1' return: description: '' type: '1' @@ -682,10 +627,9 @@ properties: summary: '' fullName: WS_IN_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS_IN_BODY: 7 = 7' + content: 'static WS_IN_BODY: 7 = 7' return: description: '' type: '7' @@ -695,10 +639,9 @@ properties: summary: '' fullName: WS_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS_IN_STRUCTURE_BODY: 25 = 25' + content: 'static WS_IN_STRUCTURE_BODY: 25 = 25' return: description: '' type: '25' @@ -708,10 +651,9 @@ properties: summary: '' fullName: WS_IN_STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS_IN_STRUCTURE_NAME: 20 = 20' + content: 'static WS_IN_STRUCTURE_NAME: 20 = 20' return: description: '' type: '20' @@ -724,21 +666,21 @@ inheritedProperties: recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by the + recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Lexer.atn - name: channel uid: botbuilder-lg.LGTemplateLexer.channel package: botbuilder-lg summary: '' fullName: channel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channel: number' @@ -752,7 +694,6 @@ inheritedProperties: summary: What is the index of the current character of lookahead? fullName: charIndex remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charIndex: number' @@ -766,7 +707,6 @@ inheritedProperties: summary: '' fullName: charPositionInLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'charPositionInLine: number' @@ -780,7 +720,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_MODE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_MODE: number' @@ -794,7 +733,6 @@ inheritedProperties: summary: '' fullName: DEFAULT_TOKEN_CHANNEL remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static DEFAULT_TOKEN_CHANNEL: number' @@ -808,21 +746,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Lexer.EOF - name: HIDDEN uid: botbuilder-lg.LGTemplateLexer.HIDDEN package: botbuilder-lg summary: '' fullName: HIDDEN remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static HIDDEN: number' @@ -836,7 +772,6 @@ inheritedProperties: summary: Set the char stream and reset the lexer fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: CharStream' @@ -850,21 +785,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: LexerATNSimulator' return: description: '' type: LexerATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Lexer.interpreter - name: line uid: botbuilder-lg.LGTemplateLexer.line package: botbuilder-lg summary: '' fullName: line remarks: '' - isPreview: false isDeprecated: false syntax: content: 'line: number' @@ -878,7 +811,6 @@ inheritedProperties: summary: '' fullName: MAX_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MAX_CHAR_VALUE: number' @@ -892,7 +824,6 @@ inheritedProperties: summary: '' fullName: MIN_CHAR_VALUE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MIN_CHAR_VALUE: number' @@ -906,7 +837,6 @@ inheritedProperties: summary: '' fullName: MORE remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static MORE: number' @@ -922,21 +852,19 @@ inheritedProperties: for each decision in recognizer in a ParseInfo object. fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> - inheritanceDescription: Inherited From Recognizer.parseInfo + type: Promise<undefined | ParseInfo> + inheritanceDescription: Inherited From Lexer.parseInfo - name: SKIP uid: botbuilder-lg.LGTemplateLexer.SKIP package: botbuilder-lg summary: '' fullName: SKIP remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static SKIP: number' @@ -950,7 +878,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -970,14 +897,13 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Lexer.state - name: text uid: botbuilder-lg.LGTemplateLexer.text package: botbuilder-lg @@ -986,7 +912,6 @@ inheritedProperties: changes to the text. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -1000,13 +925,12 @@ inheritedProperties: summary: Override if emitting multiple tokens. fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'token: Token | undefined' + content: 'token: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From Lexer.token - name: tokenFactory uid: botbuilder-lg.LGTemplateLexer.tokenFactory @@ -1014,7 +938,6 @@ inheritedProperties: summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -1028,7 +951,6 @@ inheritedProperties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: number' @@ -1042,7 +964,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -1050,7 +971,7 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Lexer.addErrorListener - name: emit() uid: botbuilder-lg.LGTemplateLexer.emit_1 package: botbuilder-lg @@ -1060,7 +981,6 @@ inheritedMethods: and getToken (to push tokens into a list and pull from that list rather than a single variable as this implementation does). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(): Token' @@ -1078,7 +998,6 @@ inheritedMethods: use that to set the token's text. Override this method to emit custom Token objects or provide a new factory. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(token: Token): Token' @@ -1095,7 +1014,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEOF(): Token' @@ -1110,20 +1028,18 @@ inheritedMethods: Return a list of all Token objects in input char stream. Forces load of all tokens. Does not include EOF token. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllTokens(): Token[]' return: description: '' - type: 'Token[]' + type: Token[] inheritanceDescription: Inherited From Lexer.getAllTokens - name: getCharErrorDisplay(number) uid: botbuilder-lg.LGTemplateLexer.getCharErrorDisplay package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCharErrorDisplay(c: number): string' @@ -1140,7 +1056,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorDisplay(s: string | number): string' @@ -1155,9 +1070,8 @@ inheritedMethods: - name: getErrorHeader(RecognitionException) uid: botbuilder-lg.LGTemplateLexer.getErrorHeader package: botbuilder-lg - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -1168,54 +1082,51 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Lexer.getErrorHeader - name: getErrorListenerDispatch() uid: botbuilder-lg.LGTemplateLexer.getErrorListenerDispatch package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ANTLRErrorListener' return: description: '' type: ANTLRErrorListener<number> - inheritanceDescription: Inherited From Recognizer.getErrorListenerDispatch + inheritanceDescription: Inherited From Lexer.getErrorListenerDispatch - name: getErrorListeners() uid: botbuilder-lg.LGTemplateLexer.getErrorListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<number>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<number>[] + inheritanceDescription: Inherited From Lexer.getErrorListeners - name: getRuleIndexMap() uid: botbuilder-lg.LGTemplateLexer.getRuleIndexMap package: botbuilder-lg - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getRuleIndexMap - name: getTokenType(string) uid: botbuilder-lg.LGTemplateLexer.getTokenType package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -1226,28 +1137,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Lexer.getTokenType - name: getTokenTypeMap() uid: botbuilder-lg.LGTemplateLexer.getTokenTypeMap package: botbuilder-lg - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Lexer.getTokenTypeMap - name: mode(number) uid: botbuilder-lg.LGTemplateLexer.mode package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function mode(m: number)' @@ -1261,7 +1171,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function more() @@ -1273,7 +1182,6 @@ inheritedMethods: Return a token from this source; i.e., match a token on the char stream. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function nextToken(): Token' @@ -1286,7 +1194,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyListeners(e: LexerNoViableAltException)' @@ -1300,7 +1207,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function popMode(): number' @@ -1308,20 +1214,19 @@ inheritedMethods: description: '' type: number inheritanceDescription: Inherited From Lexer.popMode - - name: 'precpred(RuleContext | undefined, number)' + - name: precpred(undefined | RuleContext, number) uid: botbuilder-lg.LGTemplateLexer.precpred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function precpred(localctx: RuleContext | undefined, precedence: + function precpred(localctx: undefined | RuleContext, precedence: number): boolean parameters: - id: localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: precedence type: number @@ -1329,13 +1234,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.precpred + inheritanceDescription: Inherited From Lexer.precpred - name: pushMode(number) uid: botbuilder-lg.LGTemplateLexer.pushMode package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function pushMode(m: number)' @@ -1349,7 +1253,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: LexerNoViableAltException)' @@ -1367,7 +1270,6 @@ inheritedMethods: it all works out. You can instead use the rule invocation stack to do sophisticated error recovery if you are in a fragment rule. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function recover(re: RecognitionException)' @@ -1381,7 +1283,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -1389,23 +1290,21 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<number> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Lexer.removeErrorListener - name: removeErrorListeners() uid: botbuilder-lg.LGTemplateLexer.removeErrorListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Lexer.removeErrorListeners - name: reset() uid: botbuilder-lg.LGTemplateLexer.reset package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -1415,7 +1314,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -1434,18 +1332,16 @@ inheritedMethods: if token==undefined at end of any token rule, it creates one for you and emits it. remarks: '' - isPreview: false isDeprecated: false syntax: content: function skip() inheritanceDescription: Inherited From Lexer.skip methods: - - name: 'action(RuleContext, number, number)' + - name: action(RuleContext, number, number) uid: botbuilder-lg.LGTemplateLexer.action package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1461,12 +1357,11 @@ methods: - id: actionIndex type: number description: '' - - name: 'sempred(RuleContext, number, number)' + - name: sempred(RuleContext, number, number) uid: botbuilder-lg.LGTemplateLexer.sempred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParser.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParser.yml index da77910b..db61a7cf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParser.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParser.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: LGTemplateParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LGTemplateParser(input: TokenStream)' @@ -29,10 +27,9 @@ properties: summary: '' fullName: CASE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static CASE: 14 = 14' + content: 'static CASE: 14 = 14' return: description: '' type: '14' @@ -42,10 +39,9 @@ properties: summary: '' fullName: COMMENTS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static COMMENTS: 3 = 3' + content: 'static COMMENTS: 3 = 3' return: description: '' type: '3' @@ -55,10 +51,9 @@ properties: summary: '' fullName: DASH remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DASH: 4 = 4' + content: 'static DASH: 4 = 4' return: description: '' type: '4' @@ -68,10 +63,9 @@ properties: summary: '' fullName: DEFAULT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static DEFAULT: 15 = 15' + content: 'static DEFAULT: 15 = 15' return: description: '' type: '15' @@ -81,10 +75,9 @@ properties: summary: '' fullName: ELSE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ELSE: 12 = 12' + content: 'static ELSE: 12 = 12' return: description: '' type: '12' @@ -94,10 +87,9 @@ properties: summary: '' fullName: ELSEIF remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ELSEIF: 11 = 11' + content: 'static ELSEIF: 11 = 11' return: description: '' type: '11' @@ -107,10 +99,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER: 16 = 16' + content: 'static ESCAPE_CHARACTER: 16 = 16' return: description: '' type: '16' @@ -120,10 +111,9 @@ properties: summary: '' fullName: ESCAPE_CHARACTER_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static ESCAPE_CHARACTER_IN_STRUCTURE_BODY: 31 = 31' + content: 'static ESCAPE_CHARACTER_IN_STRUCTURE_BODY: 31 = 31' return: description: '' type: '31' @@ -133,10 +123,9 @@ properties: summary: '' fullName: EXPRESSION remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EXPRESSION: 17 = 17' + content: 'static EXPRESSION: 17 = 17' return: description: '' type: '17' @@ -146,10 +135,9 @@ properties: summary: '' fullName: EXPRESSION_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static EXPRESSION_IN_STRUCTURE_BODY: 32 = 32' + content: 'static EXPRESSION_IN_STRUCTURE_BODY: 32 = 32' return: description: '' type: '32' @@ -159,10 +147,9 @@ properties: summary: '' fullName: grammarFileName remarks: '' - isPreview: false isDeprecated: false syntax: - content: string grammarFileName + content: 'grammarFileName: string' return: description: '' type: string @@ -172,10 +159,9 @@ properties: summary: '' fullName: IF remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static IF: 10 = 10' + content: 'static IF: 10 = 10' return: description: '' type: '10' @@ -185,10 +171,9 @@ properties: summary: '' fullName: INVALID_TOKEN remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static INVALID_TOKEN: 6 = 6' + content: 'static INVALID_TOKEN: 6 = 6' return: description: '' type: '6' @@ -198,10 +183,9 @@ properties: summary: '' fullName: LEFT_SQUARE_BRACKET remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static LEFT_SQUARE_BRACKET: 5 = 5' + content: 'static LEFT_SQUARE_BRACKET: 5 = 5' return: description: '' type: '5' @@ -211,10 +195,9 @@ properties: summary: '' fullName: MULTILINE_PREFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_PREFIX: 8 = 8' + content: 'static MULTILINE_PREFIX: 8 = 8' return: description: '' type: '8' @@ -224,10 +207,9 @@ properties: summary: '' fullName: MULTILINE_SUFFIX remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static MULTILINE_SUFFIX: 19 = 19' + content: 'static MULTILINE_SUFFIX: 19 = 19' return: description: '' type: '19' @@ -237,10 +219,9 @@ properties: summary: '' fullName: NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE: 2 = 2' + content: 'static NEWLINE: 2 = 2' return: description: '' type: '2' @@ -250,10 +231,9 @@ properties: summary: '' fullName: NEWLINE_IN_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE_IN_BODY: 9 = 9' + content: 'static NEWLINE_IN_BODY: 9 = 9' return: description: '' type: '9' @@ -263,10 +243,9 @@ properties: summary: '' fullName: NEWLINE_IN_STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static NEWLINE_IN_STRUCTURE_NAME: 21 = 21' + content: 'static NEWLINE_IN_STRUCTURE_NAME: 21 = 21' return: description: '' type: '21' @@ -276,36 +255,33 @@ properties: summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: "public static ruleNames: string[] = [\r\n\t\t\"template\", \"body\", \"structuredTemplateBody\", \"structuredBodyNameLine\", \r\n\t\t\"errorStructuredName\", \"structuredBodyContentLine\", \"errorStructureLine\", \r\n\t\t\"keyValueStructureLine\", \"keyValueStructureValue\", \"structuredBodyEndLine\", \r\n\t\t\"normalTemplateBody\", \"templateString\", \"normalTemplateString\", \"errorTemplateString\", \r\n\t\t\"ifElseTemplateBody\", \"ifConditionRule\", \"ifCondition\", \"switchCaseTemplateBody\", \r\n\t\t\"switchCaseRule\", \"switchCaseStat\", \"expression\", \"expressionInStructure\",\r\n\t]" + content: 'ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: ruleNames uid: botbuilder-lg.LGTemplateParser.ruleNames package: botbuilder-lg summary: '' fullName: ruleNames remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'string[] ruleNames' + content: 'static ruleNames: string[]' return: description: '' - type: 'string[]' + type: string[] - name: RULE_body uid: botbuilder-lg.LGTemplateParser.RULE_body package: botbuilder-lg summary: '' fullName: RULE_body remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_body: 1 = 1' + content: 'static RULE_body: 1 = 1' return: description: '' type: '1' @@ -315,10 +291,9 @@ properties: summary: '' fullName: RULE_errorStructuredName remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_errorStructuredName: 4 = 4' + content: 'static RULE_errorStructuredName: 4 = 4' return: description: '' type: '4' @@ -328,10 +303,9 @@ properties: summary: '' fullName: RULE_errorStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_errorStructureLine: 6 = 6' + content: 'static RULE_errorStructureLine: 6 = 6' return: description: '' type: '6' @@ -341,10 +315,9 @@ properties: summary: '' fullName: RULE_errorTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_errorTemplateString: 13 = 13' + content: 'static RULE_errorTemplateString: 13 = 13' return: description: '' type: '13' @@ -354,10 +327,9 @@ properties: summary: '' fullName: RULE_expression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_expression: 20 = 20' + content: 'static RULE_expression: 20 = 20' return: description: '' type: '20' @@ -367,10 +339,9 @@ properties: summary: '' fullName: RULE_expressionInStructure remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_expressionInStructure: 21 = 21' + content: 'static RULE_expressionInStructure: 21 = 21' return: description: '' type: '21' @@ -380,10 +351,9 @@ properties: summary: '' fullName: RULE_ifCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_ifCondition: 16 = 16' + content: 'static RULE_ifCondition: 16 = 16' return: description: '' type: '16' @@ -393,10 +363,9 @@ properties: summary: '' fullName: RULE_ifConditionRule remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_ifConditionRule: 15 = 15' + content: 'static RULE_ifConditionRule: 15 = 15' return: description: '' type: '15' @@ -406,10 +375,9 @@ properties: summary: '' fullName: RULE_ifElseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_ifElseTemplateBody: 14 = 14' + content: 'static RULE_ifElseTemplateBody: 14 = 14' return: description: '' type: '14' @@ -419,10 +387,9 @@ properties: summary: '' fullName: RULE_keyValueStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_keyValueStructureLine: 7 = 7' + content: 'static RULE_keyValueStructureLine: 7 = 7' return: description: '' type: '7' @@ -432,10 +399,9 @@ properties: summary: '' fullName: RULE_keyValueStructureValue remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_keyValueStructureValue: 8 = 8' + content: 'static RULE_keyValueStructureValue: 8 = 8' return: description: '' type: '8' @@ -445,10 +411,9 @@ properties: summary: '' fullName: RULE_normalTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_normalTemplateBody: 10 = 10' + content: 'static RULE_normalTemplateBody: 10 = 10' return: description: '' type: '10' @@ -458,10 +423,9 @@ properties: summary: '' fullName: RULE_normalTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_normalTemplateString: 12 = 12' + content: 'static RULE_normalTemplateString: 12 = 12' return: description: '' type: '12' @@ -471,10 +435,9 @@ properties: summary: '' fullName: RULE_structuredBodyContentLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_structuredBodyContentLine: 5 = 5' + content: 'static RULE_structuredBodyContentLine: 5 = 5' return: description: '' type: '5' @@ -484,10 +447,9 @@ properties: summary: '' fullName: RULE_structuredBodyEndLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_structuredBodyEndLine: 9 = 9' + content: 'static RULE_structuredBodyEndLine: 9 = 9' return: description: '' type: '9' @@ -497,10 +459,9 @@ properties: summary: '' fullName: RULE_structuredBodyNameLine remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_structuredBodyNameLine: 3 = 3' + content: 'static RULE_structuredBodyNameLine: 3 = 3' return: description: '' type: '3' @@ -510,10 +471,9 @@ properties: summary: '' fullName: RULE_structuredTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_structuredTemplateBody: 2 = 2' + content: 'static RULE_structuredTemplateBody: 2 = 2' return: description: '' type: '2' @@ -523,10 +483,9 @@ properties: summary: '' fullName: RULE_switchCaseRule remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_switchCaseRule: 18 = 18' + content: 'static RULE_switchCaseRule: 18 = 18' return: description: '' type: '18' @@ -536,10 +495,9 @@ properties: summary: '' fullName: RULE_switchCaseStat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_switchCaseStat: 19 = 19' + content: 'static RULE_switchCaseStat: 19 = 19' return: description: '' type: '19' @@ -549,10 +507,9 @@ properties: summary: '' fullName: RULE_switchCaseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_switchCaseTemplateBody: 17 = 17' + content: 'static RULE_switchCaseTemplateBody: 17 = 17' return: description: '' type: '17' @@ -562,10 +519,9 @@ properties: summary: '' fullName: RULE_template remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_template: 0 = 0' + content: 'static RULE_template: 0 = 0' return: description: '' type: '0' @@ -575,10 +531,9 @@ properties: summary: '' fullName: RULE_templateString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static RULE_templateString: 11 = 11' + content: 'static RULE_templateString: 11 = 11' return: description: '' type: '11' @@ -588,10 +543,9 @@ properties: summary: '' fullName: serializedATN remarks: '' - isPreview: false isDeprecated: false syntax: - content: string serializedATN + content: 'serializedATN: string' return: description: '' type: string @@ -601,10 +555,9 @@ properties: summary: '' fullName: STRUCTURED_BODY_END remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURED_BODY_END: 27 = 27' + content: 'static STRUCTURED_BODY_END: 27 = 27' return: description: '' type: '27' @@ -614,10 +567,9 @@ properties: summary: '' fullName: STRUCTURED_COMMENTS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURED_COMMENTS: 24 = 24' + content: 'static STRUCTURED_COMMENTS: 24 = 24' return: description: '' type: '24' @@ -627,10 +579,9 @@ properties: summary: '' fullName: STRUCTURED_NEWLINE remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURED_NEWLINE: 26 = 26' + content: 'static STRUCTURED_NEWLINE: 26 = 26' return: description: '' type: '26' @@ -640,10 +591,9 @@ properties: summary: '' fullName: STRUCTURE_EQUALS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_EQUALS: 29 = 29' + content: 'static STRUCTURE_EQUALS: 29 = 29' return: description: '' type: '29' @@ -653,10 +603,9 @@ properties: summary: '' fullName: STRUCTURE_IDENTIFIER remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_IDENTIFIER: 28 = 28' + content: 'static STRUCTURE_IDENTIFIER: 28 = 28' return: description: '' type: '28' @@ -666,10 +615,9 @@ properties: summary: '' fullName: STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_NAME: 22 = 22' + content: 'static STRUCTURE_NAME: 22 = 22' return: description: '' type: '22' @@ -679,10 +627,9 @@ properties: summary: '' fullName: STRUCTURE_OR_MARK remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static STRUCTURE_OR_MARK: 30 = 30' + content: 'static STRUCTURE_OR_MARK: 30 = 30' return: description: '' type: '30' @@ -692,10 +639,9 @@ properties: summary: '' fullName: SWITCH remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static SWITCH: 13 = 13' + content: 'static SWITCH: 13 = 13' return: description: '' type: '13' @@ -705,10 +651,9 @@ properties: summary: '' fullName: TEXT remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT: 18 = 18' + content: 'static TEXT: 18 = 18' return: description: '' type: '18' @@ -718,10 +663,9 @@ properties: summary: '' fullName: TEXT_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT_IN_STRUCTURE_BODY: 33 = 33' + content: 'static TEXT_IN_STRUCTURE_BODY: 33 = 33' return: description: '' type: '33' @@ -731,39 +675,33 @@ properties: summary: '' fullName: TEXT_IN_STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static TEXT_IN_STRUCTURE_NAME: 23 = 23' + content: 'static TEXT_IN_STRUCTURE_NAME: 23 = 23' return: description: '' type: '23' - - name: VOCABULARY - uid: botbuilder-lg.LGTemplateParser.VOCABULARY + - name: vocabulary + uid: botbuilder-lg.LGTemplateParser.vocabulary package: botbuilder-lg summary: '' - fullName: VOCABULARY + fullName: vocabulary remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - public static VOCABULARY: Vocabulary = new - VocabularyImpl(LGTemplateParser._LITERAL_NAMES, - LGTemplateParser._SYMBOLIC_NAMES, []) + content: 'vocabulary: Vocabulary' return: description: '' type: Vocabulary - - name: vocabulary - uid: botbuilder-lg.LGTemplateParser.vocabulary + - name: VOCABULARY + uid: botbuilder-lg.LGTemplateParser.VOCABULARY package: botbuilder-lg summary: '' - fullName: vocabulary + fullName: VOCABULARY remarks: '' - isPreview: false isDeprecated: false syntax: - content: Vocabulary vocabulary + content: 'static VOCABULARY: Vocabulary' return: description: '' type: Vocabulary @@ -773,10 +711,9 @@ properties: summary: '' fullName: WS remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS: 1 = 1' + content: 'static WS: 1 = 1' return: description: '' type: '1' @@ -786,10 +723,9 @@ properties: summary: '' fullName: WS_IN_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS_IN_BODY: 7 = 7' + content: 'static WS_IN_BODY: 7 = 7' return: description: '' type: '7' @@ -799,10 +735,9 @@ properties: summary: '' fullName: WS_IN_STRUCTURE_BODY remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS_IN_STRUCTURE_BODY: 25 = 25' + content: 'static WS_IN_STRUCTURE_BODY: 25 = 25' return: description: '' type: '25' @@ -812,10 +747,9 @@ properties: summary: '' fullName: WS_IN_STRUCTURE_NAME remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'public static WS_IN_STRUCTURE_NAME: 20 = 20' + content: 'static WS_IN_STRUCTURE_NAME: 20 = 20' return: description: '' type: '20' @@ -828,22 +762,24 @@ inheritedProperties: recognizer for prediction. fullName: atn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'atn: ATN' return: - description: '' + description: >- + The used by the + recognizer for prediction. type: ATN - inheritanceDescription: Inherited From Recognizer.atn + inheritanceDescription: Inherited From Parser.atn - name: buildParseTree uid: botbuilder-lg.LGTemplateParser.buildParseTree package: botbuilder-lg - summary: | + summary: |- Track the objects during the parse and hook them up using the list so that it forms a parse tree. The returned from the start rule represents the root of the parse tree. + Note that if we are not building parse trees, rule contexts only point upwards. When a rule exits, it returns the context but that gets garbage collected if nobody holds a reference. It points upwards but nobody @@ -854,7 +790,6 @@ inheritedProperties: for garbage collection. fullName: buildParseTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buildParseTree: boolean' @@ -868,7 +803,6 @@ inheritedProperties: summary: '' fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: ParserRuleContext' @@ -884,7 +818,6 @@ inheritedProperties: into the label for the associated token ref; e.g., x=ID. fullName: currentToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'currentToken: Token' @@ -898,21 +831,19 @@ inheritedProperties: summary: '' fullName: EOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EOF: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.EOF + inheritanceDescription: Inherited From Parser.EOF - name: errorHandler uid: botbuilder-lg.LGTemplateParser.errorHandler package: botbuilder-lg summary: '' fullName: errorHandler remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorHandler: ANTLRErrorStrategy' @@ -926,7 +857,6 @@ inheritedProperties: summary: Set the token stream and reset the parser. fullName: inputStream remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputStream: TokenStream' @@ -940,21 +870,19 @@ inheritedProperties: summary: Set the ATN interpreter used by the recognizer for prediction. fullName: interpreter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'interpreter: ParserATNSimulator' return: description: '' type: ParserATNSimulator - inheritanceDescription: Inherited From Recognizer.interpreter + inheritanceDescription: Inherited From Parser.interpreter - name: isMatchedEOF uid: botbuilder-lg.LGTemplateParser.isMatchedEOF package: botbuilder-lg summary: '' fullName: isMatchedEOF remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isMatchedEOF: boolean' @@ -970,7 +898,6 @@ inheritedProperties: events as well as token matches. This is for quick and dirty debugging. fullName: isTrace remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isTrace: boolean' @@ -988,7 +915,6 @@ inheritedProperties: See #notifyErrorListeners fullName: numberOfSyntaxErrors remarks: '' - isPreview: false isDeprecated: false syntax: content: 'numberOfSyntaxErrors: number' @@ -1002,13 +928,12 @@ inheritedProperties: summary: '' fullName: parseInfo remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parseInfo: Promise' + content: 'parseInfo: Promise' return: description: '' - type: Promise<ParseInfo | undefined> + type: Promise<undefined | ParseInfo> inheritanceDescription: Inherited From Parser.parseInfo - name: precedence uid: botbuilder-lg.LGTemplateParser.precedence @@ -1016,12 +941,13 @@ inheritedProperties: summary: Get the precedence level for the top-most precedence rule. fullName: precedence remarks: '' - isPreview: false isDeprecated: false syntax: content: 'precedence: number' return: - description: '' + description: |- + The precedence level for the top-most precedence rule, or -1 if + the parser context is not nested within a precedence rule. type: number inheritanceDescription: Inherited From Parser.precedence - name: ruleContext @@ -1030,7 +956,6 @@ inheritedProperties: summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ruleContext: ParserRuleContext' @@ -1044,7 +969,6 @@ inheritedProperties: summary: '' fullName: sourceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceName: string' @@ -1064,21 +988,19 @@ inheritedProperties: configuration information. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: number' return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.state + inheritanceDescription: Inherited From Parser.state - name: tokenFactory uid: botbuilder-lg.LGTemplateParser.tokenFactory package: botbuilder-lg summary: '' fullName: tokenFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenFactory: TokenFactory' @@ -1087,20 +1009,19 @@ inheritedProperties: type: TokenFactory inheritanceDescription: Inherited From Parser.tokenFactory inheritedMethods: - - name: 'action(RuleContext | undefined, number, number)' + - name: action(undefined | RuleContext, number, number) uid: botbuilder-lg.LGTemplateParser.action package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function action(_localctx: RuleContext | undefined, ruleIndex: number, + function action(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number) parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -1108,13 +1029,12 @@ inheritedMethods: - id: actionIndex type: number description: '' - inheritanceDescription: Inherited From Recognizer.action + inheritanceDescription: Inherited From Parser.action - name: addErrorListener(ANTLRErrorListener) uid: botbuilder-lg.LGTemplateParser.addErrorListener package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorListener(listener: ANTLRErrorListener)' @@ -1122,12 +1042,13 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.addErrorListener + inheritanceDescription: Inherited From Parser.addErrorListener - name: addParseListener(ParseTreeListener) uid: botbuilder-lg.LGTemplateParser.addParseListener package: botbuilder-lg - summary: | + summary: |- Registers `listener` to receive events during the parsing process. + To support output-preserving grammar transformations (including but not limited to left-recursion removal, automated left-factoring, and optimized code generation), calls to listener methods during the parse @@ -1148,24 +1069,23 @@ inheritedMethods: * Changing the version of the ANTLR Tool used to generate the parser may change the behavior of the listener calls. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to add + description: the listener to add inheritanceDescription: Inherited From Parser.addParseListener - - name: 'compileParseTreePattern(string, number)' + - name: compileParseTreePattern(string, number) uid: botbuilder-lg.LGTemplateParser.compileParseTreePattern package: botbuilder-lg - summary: > + summary: >- The preferred method of getting a tree pattern. For example, here's a sample use: + ``` let t: ParseTree = parser.expr(); @@ -1179,7 +1099,6 @@ inheritedMethods: ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1196,7 +1115,7 @@ inheritedMethods: description: '' type: Promise<ParseTreePattern> inheritanceDescription: Inherited From Parser.compileParseTreePattern - - name: 'compileParseTreePattern(string, number, Lexer)' + - name: compileParseTreePattern(string, number, Lexer) uid: botbuilder-lg.LGTemplateParser.compileParseTreePattern_1 package: botbuilder-lg summary: >- @@ -1206,7 +1125,6 @@ inheritedMethods: rather than trying to deduce it from this parser. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1229,9 +1147,10 @@ inheritedMethods: - name: consume() uid: botbuilder-lg.LGTemplateParser.consume package: botbuilder-lg - summary: > + summary: >- Consume and return the [current symbol](`currentToken`). + E.g., given the following input with `A` being the current lookahead symbol, this function moves the cursor to `B` and returns @@ -1266,7 +1185,6 @@ inheritedMethods: listeners. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function consume(): Token' @@ -1274,14 +1192,13 @@ inheritedMethods: description: '' type: Token inheritanceDescription: Inherited From Parser.consume - - name: 'createErrorNode(ParserRuleContext, Token)' + - name: createErrorNode(ParserRuleContext, Token) uid: botbuilder-lg.LGTemplateParser.createErrorNode package: botbuilder-lg summary: |- How to create an error node, given a token, associated with a parent. Typically, the error node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createErrorNode(parent: ParserRuleContext, t: Token): ErrorNode' @@ -1296,14 +1213,13 @@ inheritedMethods: description: '' type: ErrorNode inheritanceDescription: Inherited From Parser.createErrorNode - - name: 'createTerminalNode(ParserRuleContext, Token)' + - name: createTerminalNode(ParserRuleContext, Token) uid: botbuilder-lg.LGTemplateParser.createTerminalNode package: botbuilder-lg summary: |- How to create a token leaf node associated with a parent. Typically, the terminal node to create is not a function of the parent. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1325,17 +1241,15 @@ inheritedMethods: package: botbuilder-lg summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: function dumpDFA() inheritanceDescription: Inherited From Parser.dumpDFA - - name: 'enterLeftFactoredRule(ParserRuleContext, number, number)' + - name: enterLeftFactoredRule(ParserRuleContext, number, number) uid: botbuilder-lg.LGTemplateParser.enterLeftFactoredRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1352,12 +1266,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterLeftFactoredRule - - name: 'enterOuterAlt(ParserRuleContext, number)' + - name: enterOuterAlt(ParserRuleContext, number) uid: botbuilder-lg.LGTemplateParser.enterOuterAlt package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterOuterAlt(localctx: ParserRuleContext, altNum: number)' @@ -1369,12 +1282,11 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterOuterAlt - - name: 'enterRecursionRule(ParserRuleContext, number, number, number)' + - name: enterRecursionRule(ParserRuleContext, number, number, number) uid: botbuilder-lg.LGTemplateParser.enterRecursionRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1394,14 +1306,13 @@ inheritedMethods: type: number description: '' inheritanceDescription: Inherited From Parser.enterRecursionRule - - name: 'enterRule(ParserRuleContext, number, number)' + - name: enterRule(ParserRuleContext, number, number) uid: botbuilder-lg.LGTemplateParser.enterRule package: botbuilder-lg summary: |- Always called by generated parsers upon entry to a rule. Access field get the current context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1423,7 +1334,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function exitRule() @@ -1431,13 +1341,13 @@ inheritedMethods: - name: getATNWithBypassAlts() uid: botbuilder-lg.LGTemplateParser.getATNWithBypassAlts package: botbuilder-lg - summary: | + summary: |- The ATN with bypass alternatives is expensive to create so we create it lazily. + @ if the current parser does not implement the `serializedATN` property. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getATNWithBypassAlts(): ATN' @@ -1450,20 +1360,18 @@ inheritedMethods: package: botbuilder-lg summary: For debugging and other purposes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getDFAStrings(): string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getDFAStrings - name: getErrorHeader(RecognitionException) uid: botbuilder-lg.LGTemplateParser.getErrorHeader package: botbuilder-lg - summary: 'What is the error header, normally line/character position information?' + summary: What is the error header, normally line/character position information? remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorHeader(e: RecognitionException): string' @@ -1474,13 +1382,12 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From Recognizer.getErrorHeader + inheritanceDescription: Inherited From Parser.getErrorHeader - name: getErrorListenerDispatch() uid: botbuilder-lg.LGTemplateParser.getErrorListenerDispatch package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getErrorListenerDispatch(): ParserErrorListener' @@ -1493,14 +1400,13 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getErrorListeners(): Array>' + content: 'function getErrorListeners(): ANTLRErrorListener[]' return: description: '' - type: Array<ANTLRErrorListener<Token>> - inheritanceDescription: Inherited From Recognizer.getErrorListeners + type: ANTLRErrorListener<Token>[] + inheritanceDescription: Inherited From Parser.getErrorListeners - name: getExpectedTokens() uid: botbuilder-lg.LGTemplateParser.getExpectedTokens package: botbuilder-lg @@ -1515,7 +1421,6 @@ inheritedMethods: See ATN#getExpectedTokens(int, RuleContext) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokens(): IntervalSet' @@ -1528,7 +1433,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExpectedTokensWithinCurrentRule(): IntervalSet' @@ -1541,39 +1445,36 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function getInvokingContext(ruleIndex: number): ParserRuleContext | - undefined + function getInvokingContext(ruleIndex: number): undefined | + ParserRuleContext parameters: - id: ruleIndex type: number description: '' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From Parser.getInvokingContext - name: getParseListeners() uid: botbuilder-lg.LGTemplateParser.getParseListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getParseListeners(): ParseTreeListener[]' return: description: '' - type: 'ParseTreeListener[]' + type: ParseTreeListener[] inheritanceDescription: Inherited From Parser.getParseListeners - name: getRuleIndex(string) uid: botbuilder-lg.LGTemplateParser.getRuleIndex package: botbuilder-lg - summary: 'Get a rule''s index (i.e., `RULE_ruleName` field) or -1 if not found.' + summary: Get a rule's index (i.e., `RULE_ruleName` field) or -1 if not found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndex(ruleName: string): number' @@ -1588,29 +1489,29 @@ inheritedMethods: - name: getRuleIndexMap() uid: botbuilder-lg.LGTemplateParser.getRuleIndexMap package: botbuilder-lg - summary: | + summary: |- Get a map from rule names to rule indexes. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleIndexMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getRuleIndexMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getRuleIndexMap - name: getRuleInvocationStack(RuleContext) uid: botbuilder-lg.LGTemplateParser.getRuleInvocationStack package: botbuilder-lg - summary: | + summary: |- Return List<String> of the rule names in your parser instance leading up to a call to the current rule. You could override if you want more details such as the file/line info of where in the ATN a rule is invoked. + This is very useful for error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRuleInvocationStack(ctx?: RuleContext): string[]' @@ -1620,14 +1521,13 @@ inheritedMethods: description: '' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: Inherited From Parser.getRuleInvocationStack - name: getTokenType(string) uid: botbuilder-lg.LGTemplateParser.getTokenType package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenType(tokenName: string): number' @@ -1638,28 +1538,27 @@ inheritedMethods: return: description: '' type: number - inheritanceDescription: Inherited From Recognizer.getTokenType + inheritanceDescription: Inherited From Parser.getTokenType - name: getTokenTypeMap() uid: botbuilder-lg.LGTemplateParser.getTokenTypeMap package: botbuilder-lg - summary: | + summary: |- Get a map from token names to token types. + Used for XPath and tree pattern compilation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenTypeMap(): ReadonlyMap' return: description: '' - type: 'ReadonlyMap<string, number>' - inheritanceDescription: Inherited From Recognizer.getTokenTypeMap + type: ReadonlyMap<string, number> + inheritanceDescription: Inherited From Parser.getTokenTypeMap - name: inContext(string) uid: botbuilder-lg.LGTemplateParser.inContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function inContext(context: string): boolean' @@ -1674,16 +1573,16 @@ inheritedMethods: - name: isExpectedToken(number) uid: botbuilder-lg.LGTemplateParser.isExpectedToken package: botbuilder-lg - summary: | + summary: |- Checks whether or not `symbol` can follow the current state in the ATN. The behavior of this method is equivalent to the following, but is implemented such that the complete context-sensitive follow set does not need to be explicitly constructed. + ``` return getExpectedTokens().contains(symbol); ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isExpectedToken(symbol: number): boolean' @@ -1700,13 +1599,14 @@ inheritedMethods: - name: match(number) uid: botbuilder-lg.LGTemplateParser.match package: botbuilder-lg - summary: > + summary: >- Match current input symbol against `ttype`. If the symbol type matches, and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -1722,7 +1622,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function match(ttype: number): Token' @@ -1741,13 +1640,14 @@ inheritedMethods: - name: matchWildcard() uid: botbuilder-lg.LGTemplateParser.matchWildcard package: botbuilder-lg - summary: > + summary: >- Match current input symbol as a wildcard. If the symbol type matches (i.e. has a value greater than 0), and are called to complete the match process. + If the symbol type does not match, is called on the current error @@ -1763,7 +1663,6 @@ inheritedMethods: . remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function matchWildcard(): Token' @@ -1784,7 +1683,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function notifyErrorListeners(msg: string)' @@ -1794,35 +1692,33 @@ inheritedMethods: description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - name: >- - notifyErrorListeners(string, Token | null, RecognitionException | - undefined) + notifyErrorListeners(string, null | Token, undefined | + RecognitionException) uid: botbuilder-lg.LGTemplateParser.notifyErrorListeners_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function notifyErrorListeners(msg: string, offendingToken: Token | null, - e: RecognitionException | undefined) + function notifyErrorListeners(msg: string, offendingToken: null | Token, + e: undefined | RecognitionException) parameters: - id: msg type: string description: '' - id: offendingToken - type: Token | null + type: null | Token description: '' - id: e - type: RecognitionException | undefined + type: undefined | RecognitionException description: '' inheritanceDescription: Inherited From Parser.notifyErrorListeners - - name: 'precpred(RuleContext, number)' + - name: precpred(RuleContext, number) uid: botbuilder-lg.LGTemplateParser.precpred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function precpred(localctx: RuleContext, precedence: number): boolean' @@ -1837,14 +1733,13 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From Parser.precpred - - name: 'pushNewRecursionContext(ParserRuleContext, number, number)' + - name: pushNewRecursionContext(ParserRuleContext, number, number) uid: botbuilder-lg.LGTemplateParser.pushNewRecursionContext package: botbuilder-lg summary: |- Like but for recursive rules. Make the current context the child of the incoming localctx. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1866,7 +1761,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeErrorListener(listener: ANTLRErrorListener)' @@ -1874,37 +1768,34 @@ inheritedMethods: - id: listener type: ANTLRErrorListener<Token> description: '' - inheritanceDescription: Inherited From Recognizer.removeErrorListener + inheritanceDescription: Inherited From Parser.removeErrorListener - name: removeErrorListeners() uid: botbuilder-lg.LGTemplateParser.removeErrorListeners package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeErrorListeners() - inheritanceDescription: Inherited From Recognizer.removeErrorListeners + inheritanceDescription: Inherited From Parser.removeErrorListeners - name: removeParseListener(ParseTreeListener) uid: botbuilder-lg.LGTemplateParser.removeParseListener package: botbuilder-lg summary: |- Remove `listener` from the list of parse listeners. + If `listener` is `undefined` or has not been added as a parse listener, this method does nothing. - See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeParseListener(listener: ParseTreeListener)' parameters: - id: listener type: ParseTreeListener - description: | - the listener to remove + description: the listener to remove inheritanceDescription: Inherited From Parser.removeParseListener - name: removeParseListeners() uid: botbuilder-lg.LGTemplateParser.removeParseListeners @@ -1914,7 +1805,6 @@ inheritedMethods: See #addParseListener remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeParseListeners() @@ -1924,7 +1814,6 @@ inheritedMethods: package: botbuilder-lg summary: reset the parser's state remarks: '' - isPreview: false isDeprecated: false syntax: content: function reset() @@ -1934,7 +1823,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reset(resetInput: boolean)' @@ -1943,20 +1831,19 @@ inheritedMethods: type: boolean description: '' inheritanceDescription: Inherited From Parser.reset - - name: 'sempred(RuleContext | undefined, number, number)' + - name: sempred(undefined | RuleContext, number, number) uid: botbuilder-lg.LGTemplateParser.sempred package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function sempred(_localctx: RuleContext | undefined, ruleIndex: number, + function sempred(_localctx: undefined | RuleContext, ruleIndex: number, actionIndex: number): boolean parameters: - id: _localctx - type: RuleContext | undefined + type: undefined | RuleContext description: '' - id: ruleIndex type: number @@ -1967,13 +1854,12 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: Inherited From Recognizer.sempred + inheritanceDescription: Inherited From Parser.sempred - name: setProfile(boolean) uid: botbuilder-lg.LGTemplateParser.setProfile package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setProfile(profile: boolean): Promise' @@ -1990,7 +1876,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unrollRecursionContexts(_parentctx: ParserRuleContext)' @@ -2005,7 +1890,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function body(): BodyContext' @@ -2017,7 +1901,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorStructuredName(): ErrorStructuredNameContext' @@ -2029,7 +1912,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorStructureLine(): ErrorStructureLineContext' @@ -2041,7 +1923,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorTemplateString(): ErrorTemplateStringContext' @@ -2053,7 +1934,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext' @@ -2065,7 +1945,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expressionInStructure(): ExpressionInStructureContext' @@ -2077,7 +1956,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifCondition(): IfConditionContext' @@ -2089,7 +1967,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifConditionRule(): IfConditionRuleContext' @@ -2101,7 +1978,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ifElseTemplateBody(): IfElseTemplateBodyContext' @@ -2113,7 +1989,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValueStructureLine(): KeyValueStructureLineContext' @@ -2125,7 +2000,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keyValueStructureValue(): KeyValueStructureValueContext' @@ -2137,7 +2011,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function normalTemplateBody(): NormalTemplateBodyContext' @@ -2149,7 +2022,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function normalTemplateString(): NormalTemplateStringContext' @@ -2161,7 +2033,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredBodyContentLine(): StructuredBodyContentLineContext' @@ -2173,7 +2044,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredBodyEndLine(): StructuredBodyEndLineContext' @@ -2185,7 +2055,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredBodyNameLine(): StructuredBodyNameLineContext' @@ -2197,7 +2066,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredTemplateBody(): StructuredTemplateBodyContext' @@ -2209,7 +2077,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseRule(): SwitchCaseRuleContext' @@ -2221,7 +2088,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseStat(): SwitchCaseStatContext' @@ -2233,7 +2099,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseTemplateBody(): SwitchCaseTemplateBodyContext' @@ -2245,7 +2110,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function template(): TemplateContext' @@ -2257,7 +2121,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateString(): TemplateStringContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserListener.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserListener.yml index ba6b8c18..7f47624f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserListener.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserListener.yml @@ -7,7 +7,6 @@ summary: |- `LGTemplateParser`. fullName: LGTemplateParserListener remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.body`. fullName: enterBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterBody?: (ctx: BodyContext) => void' @@ -30,7 +28,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.errorStructuredName`. fullName: enterErrorStructuredName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterErrorStructuredName?: (ctx: ErrorStructuredNameContext) => void' @@ -43,7 +40,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.errorStructureLine`. fullName: enterErrorStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterErrorStructureLine?: (ctx: ErrorStructureLineContext) => void' @@ -56,7 +52,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.errorTemplateString`. fullName: enterErrorTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterErrorTemplateString?: (ctx: ErrorTemplateStringContext) => void' @@ -69,7 +64,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.expression`. fullName: enterExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterExpression?: (ctx: ExpressionContext) => void' @@ -82,7 +76,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.expressionInStructure`. fullName: enterExpressionInStructure remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterExpressionInStructure?: (ctx: ExpressionInStructureContext) => void' @@ -95,7 +88,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.ifCondition`. fullName: enterIfCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterIfCondition?: (ctx: IfConditionContext) => void' @@ -108,7 +100,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.ifConditionRule`. fullName: enterIfConditionRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterIfConditionRule?: (ctx: IfConditionRuleContext) => void' @@ -123,7 +114,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: enterIfElseBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterIfElseBody?: (ctx: IfElseBodyContext) => void' @@ -136,7 +126,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.ifElseTemplateBody`. fullName: enterIfElseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterIfElseTemplateBody?: (ctx: IfElseTemplateBodyContext) => void' @@ -149,7 +138,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.keyValueStructureLine`. fullName: enterKeyValueStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterKeyValueStructureLine?: (ctx: KeyValueStructureLineContext) => void' @@ -162,7 +150,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.keyValueStructureValue`. fullName: enterKeyValueStructureValue remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -179,7 +166,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: enterNormalBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNormalBody?: (ctx: NormalBodyContext) => void' @@ -192,7 +178,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.normalTemplateBody`. fullName: enterNormalTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNormalTemplateBody?: (ctx: NormalTemplateBodyContext) => void' @@ -205,7 +190,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.normalTemplateString`. fullName: enterNormalTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterNormalTemplateString?: (ctx: NormalTemplateStringContext) => void' @@ -220,7 +204,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: enterStructuredBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterStructuredBody?: (ctx: StructuredBodyContext) => void' @@ -235,7 +218,6 @@ properties: `LGTemplateParser.structuredBodyContentLine`. fullName: enterStructuredBodyContentLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -250,7 +232,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.structuredBodyEndLine`. fullName: enterStructuredBodyEndLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterStructuredBodyEndLine?: (ctx: StructuredBodyEndLineContext) => void' @@ -263,7 +244,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.structuredBodyNameLine`. fullName: enterStructuredBodyNameLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -278,7 +258,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.structuredTemplateBody`. fullName: enterStructuredTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -295,7 +274,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: enterSwitchCaseBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterSwitchCaseBody?: (ctx: SwitchCaseBodyContext) => void' @@ -308,7 +286,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.switchCaseRule`. fullName: enterSwitchCaseRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterSwitchCaseRule?: (ctx: SwitchCaseRuleContext) => void' @@ -321,7 +298,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.switchCaseStat`. fullName: enterSwitchCaseStat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterSwitchCaseStat?: (ctx: SwitchCaseStatContext) => void' @@ -334,7 +310,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.switchCaseTemplateBody`. fullName: enterSwitchCaseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -349,7 +324,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.template`. fullName: enterTemplate remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTemplate?: (ctx: TemplateContext) => void' @@ -362,7 +336,6 @@ properties: summary: Enter a parse tree produced by `LGTemplateParser.templateString`. fullName: enterTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterTemplateString?: (ctx: TemplateStringContext) => void' @@ -375,7 +348,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.body`. fullName: exitBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitBody?: (ctx: BodyContext) => void' @@ -388,7 +360,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.errorStructuredName`. fullName: exitErrorStructuredName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitErrorStructuredName?: (ctx: ErrorStructuredNameContext) => void' @@ -401,7 +372,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.errorStructureLine`. fullName: exitErrorStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitErrorStructureLine?: (ctx: ErrorStructureLineContext) => void' @@ -414,7 +384,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.errorTemplateString`. fullName: exitErrorTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitErrorTemplateString?: (ctx: ErrorTemplateStringContext) => void' @@ -427,7 +396,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.expression`. fullName: exitExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitExpression?: (ctx: ExpressionContext) => void' @@ -440,7 +408,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.expressionInStructure`. fullName: exitExpressionInStructure remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitExpressionInStructure?: (ctx: ExpressionInStructureContext) => void' @@ -453,7 +420,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.ifCondition`. fullName: exitIfCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitIfCondition?: (ctx: IfConditionContext) => void' @@ -466,7 +432,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.ifConditionRule`. fullName: exitIfConditionRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitIfConditionRule?: (ctx: IfConditionRuleContext) => void' @@ -481,7 +446,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: exitIfElseBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitIfElseBody?: (ctx: IfElseBodyContext) => void' @@ -494,7 +458,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.ifElseTemplateBody`. fullName: exitIfElseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitIfElseTemplateBody?: (ctx: IfElseTemplateBodyContext) => void' @@ -507,7 +470,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.keyValueStructureLine`. fullName: exitKeyValueStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitKeyValueStructureLine?: (ctx: KeyValueStructureLineContext) => void' @@ -520,7 +482,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.keyValueStructureValue`. fullName: exitKeyValueStructureValue remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -537,7 +498,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: exitNormalBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNormalBody?: (ctx: NormalBodyContext) => void' @@ -550,7 +510,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.normalTemplateBody`. fullName: exitNormalTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNormalTemplateBody?: (ctx: NormalTemplateBodyContext) => void' @@ -563,7 +522,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.normalTemplateString`. fullName: exitNormalTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitNormalTemplateString?: (ctx: NormalTemplateStringContext) => void' @@ -578,7 +536,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: exitStructuredBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitStructuredBody?: (ctx: StructuredBodyContext) => void' @@ -593,7 +550,6 @@ properties: `LGTemplateParser.structuredBodyContentLine`. fullName: exitStructuredBodyContentLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -608,7 +564,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.structuredBodyEndLine`. fullName: exitStructuredBodyEndLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitStructuredBodyEndLine?: (ctx: StructuredBodyEndLineContext) => void' @@ -621,7 +576,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.structuredBodyNameLine`. fullName: exitStructuredBodyNameLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -636,7 +590,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.structuredTemplateBody`. fullName: exitStructuredTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -653,7 +606,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: exitSwitchCaseBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitSwitchCaseBody?: (ctx: SwitchCaseBodyContext) => void' @@ -666,7 +618,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.switchCaseRule`. fullName: exitSwitchCaseRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitSwitchCaseRule?: (ctx: SwitchCaseRuleContext) => void' @@ -679,7 +630,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.switchCaseStat`. fullName: exitSwitchCaseStat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitSwitchCaseStat?: (ctx: SwitchCaseStatContext) => void' @@ -692,7 +642,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.switchCaseTemplateBody`. fullName: exitSwitchCaseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -707,7 +656,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.template`. fullName: exitTemplate remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTemplate?: (ctx: TemplateContext) => void' @@ -720,7 +668,6 @@ properties: summary: Exit a parse tree produced by `LGTemplateParser.templateString`. fullName: exitTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitTemplateString?: (ctx: TemplateStringContext) => void' @@ -734,7 +681,6 @@ inheritedProperties: summary: '' fullName: enterEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'enterEveryRule?: (ctx: ParserRuleContext) => void' @@ -748,7 +694,6 @@ inheritedProperties: summary: '' fullName: exitEveryRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exitEveryRule?: (ctx: ParserRuleContext) => void' @@ -762,7 +707,6 @@ inheritedProperties: summary: '' fullName: visitErrorNode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorNode?: (node: ErrorNode) => void' @@ -776,7 +720,6 @@ inheritedProperties: summary: '' fullName: visitTerminal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTerminal?: (node: TerminalNode) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserVisitor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserVisitor.yml index 088c92c2..6f7fcef4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserVisitor.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/LGTemplateParserVisitor.yml @@ -7,7 +7,6 @@ summary: |- by `LGTemplateParser`. fullName: LGTemplateParserVisitor remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.body`. fullName: visitBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitBody?: (ctx: BodyContext) => Result' @@ -30,7 +28,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.errorStructuredName`. fullName: visitErrorStructuredName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorStructuredName?: (ctx: ErrorStructuredNameContext) => Result' @@ -43,7 +40,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.errorStructureLine`. fullName: visitErrorStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorStructureLine?: (ctx: ErrorStructureLineContext) => Result' @@ -56,7 +52,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.errorTemplateString`. fullName: visitErrorTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitErrorTemplateString?: (ctx: ErrorTemplateStringContext) => Result' @@ -69,7 +64,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.expression`. fullName: visitExpression remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitExpression?: (ctx: ExpressionContext) => Result' @@ -82,7 +76,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.expressionInStructure`. fullName: visitExpressionInStructure remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -97,7 +90,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.ifCondition`. fullName: visitIfCondition remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitIfCondition?: (ctx: IfConditionContext) => Result' @@ -110,7 +102,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.ifConditionRule`. fullName: visitIfConditionRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitIfConditionRule?: (ctx: IfConditionRuleContext) => Result' @@ -125,7 +116,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: visitIfElseBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitIfElseBody?: (ctx: IfElseBodyContext) => Result' @@ -138,7 +128,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.ifElseTemplateBody`. fullName: visitIfElseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitIfElseTemplateBody?: (ctx: IfElseTemplateBodyContext) => Result' @@ -151,7 +140,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.keyValueStructureLine`. fullName: visitKeyValueStructureLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -166,7 +154,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.keyValueStructureValue`. fullName: visitKeyValueStructureValue remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -183,7 +170,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: visitNormalBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNormalBody?: (ctx: NormalBodyContext) => Result' @@ -196,7 +182,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.normalTemplateBody`. fullName: visitNormalTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNormalTemplateBody?: (ctx: NormalTemplateBodyContext) => Result' @@ -209,7 +194,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.normalTemplateString`. fullName: visitNormalTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitNormalTemplateString?: (ctx: NormalTemplateStringContext) => Result' @@ -224,7 +208,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: visitStructuredBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitStructuredBody?: (ctx: StructuredBodyContext) => Result' @@ -239,7 +222,6 @@ properties: `LGTemplateParser.structuredBodyContentLine`. fullName: visitStructuredBodyContentLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -254,7 +236,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.structuredBodyEndLine`. fullName: visitStructuredBodyEndLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -269,7 +250,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.structuredBodyNameLine`. fullName: visitStructuredBodyNameLine remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -284,7 +264,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.structuredTemplateBody`. fullName: visitStructuredTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -301,7 +280,6 @@ properties: labeled alternative in `LGTemplateParser.body`. fullName: visitSwitchCaseBody remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitSwitchCaseBody?: (ctx: SwitchCaseBodyContext) => Result' @@ -314,7 +292,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.switchCaseRule`. fullName: visitSwitchCaseRule remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitSwitchCaseRule?: (ctx: SwitchCaseRuleContext) => Result' @@ -327,7 +304,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.switchCaseStat`. fullName: visitSwitchCaseStat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitSwitchCaseStat?: (ctx: SwitchCaseStatContext) => Result' @@ -340,7 +316,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.switchCaseTemplateBody`. fullName: visitSwitchCaseTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -355,7 +330,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.template`. fullName: visitTemplate remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTemplate?: (ctx: TemplateContext) => Result' @@ -368,7 +342,6 @@ properties: summary: Visit a parse tree produced by `LGTemplateParser.templateString`. fullName: visitTemplateString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'visitTemplateString?: (ctx: TemplateStringContext) => Result' @@ -379,16 +352,15 @@ inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.LGTemplateParserVisitor.visit package: botbuilder-lg - summary: 'Visit a parse tree, and return a user-defined result of the operation.' + summary: Visit a parse tree, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): Result' parameters: - id: tree type: ParseTree - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the parse tree. type: Result @@ -400,14 +372,13 @@ inheritedMethods: Visit the children of a node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): Result' parameters: - id: node type: RuleNode - description: 'The whose children should be visited.' + description: The whose children should be visited. return: description: The result of visiting the children of the node. type: Result @@ -415,16 +386,15 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.LGTemplateParserVisitor.visitErrorNode package: botbuilder-lg - summary: 'Visit an error node, and return a user-defined result of the operation.' + summary: Visit an error node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): Result' parameters: - id: node type: ErrorNode - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the node. type: Result @@ -432,16 +402,15 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: botbuilder-lg.LGTemplateParserVisitor.visitTerminal package: botbuilder-lg - summary: 'Visit a terminal node, and return a user-defined result of the operation.' + summary: Visit a terminal node, and return a user-defined result of the operation. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): Result' parameters: - id: node type: TerminalNode - description: 'The to visit.' + description: The to visit. return: description: The result of visiting the node. type: Result diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/MultiLanguageLG.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/MultiLanguageLG.yml index 3aa2a5b6..e3c5efc4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/MultiLanguageLG.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/MultiLanguageLG.yml @@ -10,37 +10,34 @@ summary: >- evaluation. fullName: MultiLanguageLG remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- - MultiLanguageLG(Map | undefined, Map | - undefined, string) + MultiLanguageLG(undefined | Map, undefined | + Map, string) uid: botbuilder-lg.MultiLanguageLG.constructor package: botbuilder-lg summary: Initializes a new instance of the MultiLanguageLG class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new MultiLanguageLG(templatesPerLocale: Map | - undefined, filePerLocale: Map | undefined, + new MultiLanguageLG(templatesPerLocale: undefined | Map, filePerLocale: undefined | Map, defaultLanguage?: string) parameters: - id: templatesPerLocale type: >- - Map<string, > | - undefined + undefined | Map<string, > description: A map of LG file templates per locale. - id: filePerLocale - type: 'Map<string, string> | undefined' + type: undefined | Map<string, string> description: A map of locale and LG file. - id: defaultLanguage type: string - description: | - Default language. + description: Default language. properties: - name: languagePolicy uid: botbuilder-lg.MultiLanguageLG.languagePolicy @@ -48,33 +45,30 @@ properties: summary: '' fullName: languagePolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languagePolicy: Map' return: description: '' - type: 'Map<string, string[]>' + type: Map<string, string[]> - name: lgPerLocale uid: botbuilder-lg.MultiLanguageLG.lgPerLocale package: botbuilder-lg summary: '' fullName: lgPerLocale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'lgPerLocale: Map' return: description: '' - type: 'Map<string, >' + type: Map<string, > methods: - - name: 'generate(string, object, string)' + - name: generate(string, object, string) uid: botbuilder-lg.MultiLanguageLG.generate package: botbuilder-lg summary: Generate template evaluate result. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generate(template: string, data?: object, locale?: string): any' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalBodyContext.yml index 820e61ca..74542217 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalBodyContext.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: NormalBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new NormalBodyContext(ctx: BodyContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: botbuilder-lg.NormalBodyContext.ruleIndex - package: botbuilder-lg - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: botbuilder-lg.NormalBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [BodyContext.altNumber](xref:botbuilder-lg.BodyContext.altNumber) - name: childCount uid: botbuilder-lg.NormalBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [BodyContext.childCount](xref:botbuilder-lg.BodyContext.childCount) - name: children uid: botbuilder-lg.NormalBodyContext.children package: botbuilder-lg @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [BodyContext.children](xref:botbuilder-lg.BodyContext.children) - name: exception uid: botbuilder-lg.NormalBodyContext.exception package: botbuilder-lg @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [BodyContext.exception](xref:botbuilder-lg.BodyContext.exception) - name: invokingState uid: botbuilder-lg.NormalBodyContext.invokingState package: botbuilder-lg summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [BodyContext.invokingState](xref:botbuilder-lg.BodyContext.invokingState) - name: isEmpty uid: botbuilder-lg.NormalBodyContext.isEmpty package: botbuilder-lg @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [BodyContext.isEmpty](xref:botbuilder-lg.BodyContext.isEmpty) - name: parent uid: botbuilder-lg.NormalBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [BodyContext.parent](xref:botbuilder-lg.BodyContext.parent) - name: payload uid: botbuilder-lg.NormalBodyContext.payload package: botbuilder-lg summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [BodyContext.payload](xref:botbuilder-lg.BodyContext.payload) - name: ruleContext uid: botbuilder-lg.NormalBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: NormalBodyContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [BodyContext.ruleContext](xref:botbuilder-lg.BodyContext.ruleContext) + - name: ruleIndex + uid: botbuilder-lg.NormalBodyContext.ruleIndex + package: botbuilder-lg + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [BodyContext.ruleIndex](xref:botbuilder-lg.BodyContext.ruleIndex) - name: sourceInterval uid: botbuilder-lg.NormalBodyContext.sourceInterval package: botbuilder-lg summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [BodyContext.sourceInterval](xref:botbuilder-lg.BodyContext.sourceInterval) - name: start uid: botbuilder-lg.NormalBodyContext.start package: botbuilder-lg @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [BodyContext.start](xref:botbuilder-lg.BodyContext.start) - name: stop uid: botbuilder-lg.NormalBodyContext.stop package: botbuilder-lg @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [BodyContext.stop](xref:botbuilder-lg.BodyContext.stop) - name: text uid: botbuilder-lg.NormalBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [BodyContext.text](xref:botbuilder-lg.BodyContext.text) inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.NormalBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [BodyContext.addAnyChild](xref:botbuilder-lg.BodyContext.addAnyChild) - name: addChild(RuleContext) uid: botbuilder-lg.NormalBodyContext.addChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(TerminalNode) uid: botbuilder-lg.NormalBodyContext.addChild package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(Token) uid: botbuilder-lg.NormalBodyContext.addChild_2 package: botbuilder-lg @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addErrorNode(ErrorNode) uid: botbuilder-lg.NormalBodyContext.addErrorNode package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: addErrorNode(Token) uid: botbuilder-lg.NormalBodyContext.addErrorNode_1 package: botbuilder-lg @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: copyFrom(BodyContext) uid: botbuilder-lg.NormalBodyContext.copyFrom package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: BodyContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [BodyContext.depth](xref:botbuilder-lg.BodyContext.depth) - name: emptyContext() uid: botbuilder-lg.NormalBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [BodyContext.emptyContext](xref:botbuilder-lg.BodyContext.emptyContext) - name: getChild(number) uid: botbuilder-lg.NormalBodyContext.getChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.NormalBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.NormalBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChildContext](xref:botbuilder-lg.BodyContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.NormalBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContext](xref:botbuilder-lg.BodyContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.NormalBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContexts](xref:botbuilder-lg.BodyContext.getRuleContexts) + - name: getToken(number, number) uid: botbuilder-lg.NormalBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [BodyContext.getToken](xref:botbuilder-lg.BodyContext.getToken) - name: getTokens(number) uid: botbuilder-lg.NormalBodyContext.getTokens package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [BodyContext.getTokens](xref:botbuilder-lg.BodyContext.getTokens) - name: removeLastChild() uid: botbuilder-lg.NormalBodyContext.removeLastChild package: botbuilder-lg @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [BodyContext.removeLastChild](xref:botbuilder-lg.BodyContext.removeLastChild) - name: setParent(RuleContext) uid: botbuilder-lg.NormalBodyContext.setParent package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [BodyContext.setParent](xref:botbuilder-lg.BodyContext.setParent) - name: toInfoString(Parser) uid: botbuilder-lg.NormalBodyContext.toInfoString package: botbuilder-lg @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [BodyContext.toInfoString](xref:botbuilder-lg.BodyContext.toInfoString) - name: toString() uid: botbuilder-lg.NormalBodyContext.toString package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer) uid: botbuilder-lg.NormalBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.NormalBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[]) uid: botbuilder-lg.NormalBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.NormalBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) - name: toStringTree() uid: botbuilder-lg.NormalBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) - name: toStringTree(Parser) uid: botbuilder-lg.NormalBodyContext.toStringTree package: botbuilder-lg @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.NormalBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.NormalBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetChild](xref:botbuilder-lg.BodyContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.NormalBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetRuleContext](xref:botbuilder-lg.BodyContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: botbuilder-lg.NormalBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetToken](xref:botbuilder-lg.BodyContext.tryGetToken) methods: - name: accept(LGTemplateParserVisitor) uid: botbuilder-lg.NormalBodyContext.accept package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -825,7 +867,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -838,7 +879,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -851,7 +891,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function normalTemplateBody(): NormalTemplateBodyContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateBodyContext.yml index 628ae0e5..21e5bd23 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateBodyContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: NormalTemplateBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NormalTemplateBodyContext(ParserRuleContext | undefined, number)' + - name: NormalTemplateBodyContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.NormalTemplateBodyContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new NormalTemplateBodyContext(parent: ParserRuleContext | undefined, + new NormalTemplateBodyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.NormalTemplateBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.NormalTemplateBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.NormalTemplateBodyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.NormalTemplateBodyContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.NormalTemplateBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.NormalTemplateBodyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.NormalTemplateBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: NormalTemplateBodyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.NormalTemplateBodyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.NormalTemplateBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.NormalTemplateBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.NormalTemplateBodyContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.NormalTemplateBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.NormalTemplateBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.NormalTemplateBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.NormalTemplateBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.NormalTemplateBodyContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.NormalTemplateBodyContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.NormalTemplateBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.NormalTemplateBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.NormalTemplateBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.NormalTemplateBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.NormalTemplateBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.NormalTemplateBodyContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.NormalTemplateBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.NormalTemplateBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateString(): TemplateStringContext[]' return: description: '' - type: '[]' + type: [] - name: templateString(number) uid: botbuilder-lg.NormalTemplateBodyContext.templateString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateString(i: number): TemplateStringContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateStringContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateStringContext.yml index 32cdaa28..35a68745 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateStringContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/NormalTemplateStringContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: NormalTemplateStringContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NormalTemplateStringContext(ParserRuleContext | undefined, number)' + - name: NormalTemplateStringContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.NormalTemplateStringContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new NormalTemplateStringContext(parent: ParserRuleContext | undefined, + new NormalTemplateStringContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.NormalTemplateStringContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.NormalTemplateStringContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.NormalTemplateStringContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.NormalTemplateStringContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.NormalTemplateStringContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.NormalTemplateStringContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.NormalTemplateStringContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: NormalTemplateStringContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.NormalTemplateStringContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.NormalTemplateStringContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.NormalTemplateStringContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.NormalTemplateStringContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.NormalTemplateStringContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateStringContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.NormalTemplateStringContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateStringContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.NormalTemplateStringContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.NormalTemplateStringContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.NormalTemplateStringContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.NormalTemplateStringContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.NormalTemplateStringContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.NormalTemplateStringContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.NormalTemplateStringContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.NormalTemplateStringContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.NormalTemplateStringContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.NormalTemplateStringContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.NormalTemplateStringContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateStringContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.NormalTemplateStringContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.NormalTemplateStringContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function DASH(): TerminalNode' @@ -850,7 +806,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -863,19 +818,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: ESCAPE_CHARACTER(number) uid: botbuilder-lg.NormalTemplateStringContext.ESCAPE_CHARACTER_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER(i: number): TerminalNode' @@ -891,7 +844,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -904,19 +856,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext[]' return: description: '' - type: '[]' + type: [] - name: expression(number) uid: botbuilder-lg.NormalTemplateStringContext.expression_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(i: number): ExpressionContext' @@ -932,43 +882,39 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MULTILINE_PREFIX(): TerminalNode | undefined' + content: 'function MULTILINE_PREFIX(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MULTILINE_SUFFIX() uid: botbuilder-lg.NormalTemplateStringContext.MULTILINE_SUFFIX package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MULTILINE_SUFFIX(): TerminalNode | undefined' + content: 'function MULTILINE_SUFFIX(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TEXT() uid: botbuilder-lg.NormalTemplateStringContext.TEXT package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT(number) uid: botbuilder-lg.NormalTemplateStringContext.TEXT_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/OptionDefinitionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/OptionDefinitionContext.yml index fb094f81..90536700 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/OptionDefinitionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/OptionDefinitionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: OptionDefinitionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'OptionDefinitionContext(ParserRuleContext | undefined, number)' + - name: OptionDefinitionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.OptionDefinitionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new OptionDefinitionContext(parent: ParserRuleContext | undefined, + new OptionDefinitionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.OptionDefinitionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.OptionDefinitionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.OptionDefinitionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.OptionDefinitionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.OptionDefinitionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.OptionDefinitionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.OptionDefinitionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: OptionDefinitionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.OptionDefinitionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.OptionDefinitionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.OptionDefinitionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.OptionDefinitionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.OptionDefinitionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.OptionDefinitionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.OptionDefinitionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.OptionDefinitionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.OptionDefinitionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.OptionDefinitionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.OptionDefinitionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.OptionDefinitionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.OptionDefinitionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.OptionDefinitionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.OptionDefinitionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.OptionDefinitionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.OptionDefinitionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.OptionDefinitionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.OptionDefinitionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.OptionDefinitionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.OptionDefinitionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.OptionDefinitionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -862,19 +817,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: OPTION() uid: botbuilder-lg.OptionDefinitionContext.OPTION package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function OPTION(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ParagraphContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ParagraphContext.yml index fde8839a..4d74d816 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ParagraphContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/ParagraphContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: ParagraphContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ParagraphContext(ParserRuleContext | undefined, number)' + - name: ParagraphContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.ParagraphContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new ParagraphContext(parent: ParserRuleContext | undefined, + new ParagraphContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.ParagraphContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.ParagraphContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.ParagraphContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.ParagraphContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.ParagraphContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.ParagraphContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.ParagraphContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: ParagraphContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.ParagraphContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.ParagraphContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.ParagraphContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.ParagraphContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.ParagraphContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.ParagraphContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.ParagraphContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ParagraphContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.ParagraphContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.ParagraphContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.ParagraphContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.ParagraphContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.ParagraphContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.ParagraphContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.ParagraphContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.ParagraphContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.ParagraphContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.ParagraphContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.ParagraphContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.ParagraphContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.ParagraphContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.ParagraphContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,19 +793,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function commentDefinition(): CommentDefinitionContext | undefined' + content: 'function commentDefinition(): undefined | CommentDefinitionContext' return: description: '' - type: | undefined + type: undefined | - name: enterRule(LGFileParserListener) uid: botbuilder-lg.ParagraphContext.enterRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -861,31 +816,28 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function EOF(): TerminalNode | undefined' + content: 'function EOF(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: errorDefinition() uid: botbuilder-lg.ParagraphContext.errorDefinition package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function errorDefinition(): ErrorDefinitionContext | undefined' + content: 'function errorDefinition(): undefined | ErrorDefinitionContext' return: description: '' - type: | undefined + type: undefined | - name: exitRule(LGFileParserListener) uid: botbuilder-lg.ParagraphContext.exitRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -898,47 +850,43 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function importDefinition(): ImportDefinitionContext | undefined' + content: 'function importDefinition(): undefined | ImportDefinitionContext' return: description: '' - type: | undefined + type: undefined | - name: NEWLINE() uid: botbuilder-lg.ParagraphContext.NEWLINE package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: optionDefinition() uid: botbuilder-lg.ParagraphContext.optionDefinition package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function optionDefinition(): OptionDefinitionContext | undefined' + content: 'function optionDefinition(): undefined | OptionDefinitionContext' return: description: '' - type: | undefined + type: undefined | - name: templateDefinition() uid: botbuilder-lg.ParagraphContext.templateDefinition package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function templateDefinition(): TemplateDefinitionContext | undefined' + content: 'function templateDefinition(): undefined | TemplateDefinitionContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Position.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Position.yml index cc94c443..8b5b231c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Position.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Position.yml @@ -5,18 +5,16 @@ package: botbuilder-lg summary: Position class fullName: Position remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Position(number, number)' + - name: Position(number, number) uid: botbuilder-lg.Position.constructor package: botbuilder-lg summary: >- Creates a new instance of the [Position](xref:botbuilder-lg.Position) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Position(line: number, character: number)' @@ -26,8 +24,7 @@ constructors: description: Line number of the current position. - id: character type: number - description: | - Character number of the current line. + description: Character number of the current line. properties: - name: character uid: botbuilder-lg.Position.character @@ -35,7 +32,6 @@ properties: summary: '' fullName: character remarks: '' - isPreview: false isDeprecated: false syntax: content: 'character: number' @@ -48,23 +44,21 @@ properties: summary: '' fullName: line remarks: '' - isPreview: false isDeprecated: false syntax: content: 'line: number' return: description: '' type: number -methods: - - name: toString() + - name: toString uid: botbuilder-lg.Position.toString package: botbuilder-lg summary: '' + fullName: toString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(): string' + content: 'toString: () => string' return: description: '' - type: string + type: () => string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Range.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Range.yml index 757faceb..551c283e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Range.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Range.yml @@ -5,16 +5,14 @@ package: botbuilder-lg summary: Range class fullName: Range remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Range(number, number, number, number)' + - name: Range(number, number, number, number) uid: botbuilder-lg.Range.constructor_1 package: botbuilder-lg - summary: 'Creates a new instance of the [Range](xref:botbuilder-lg.Range) class.' + summary: Creates a new instance of the [Range](xref:botbuilder-lg.Range) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,25 +30,22 @@ constructors: description: Ending line number in a file. - id: endChar type: number - description: | - Ending character number in the end line. - - name: 'Range(Position, Position)' + description: Ending character number in the end line. + - name: Range(Position, Position) uid: botbuilder-lg.Range.constructor package: botbuilder-lg - summary: 'Creates a new instance of the [Range](xref:botbuilder-lg.Range) class.' + summary: Creates a new instance of the [Range](xref:botbuilder-lg.Range) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Range(start: Position, end: Position)' parameters: - id: start type: - description: 'Starting [Position](xref:botbuilder-lg.Position).' + description: Starting [Position](xref:botbuilder-lg.Position). - id: end type: - description: | - Ending [Position](xref:botbuilder-lg.Position). + description: Ending [Position](xref:botbuilder-lg.Position). properties: - name: DefaultRange uid: botbuilder-lg.Range.DefaultRange @@ -58,10 +53,9 @@ properties: summary: '' fullName: DefaultRange remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static DefaultRange: Range = new Range(1, 0, 1, 0)' + content: 'static DefaultRange: Range' return: description: '' type: @@ -71,7 +65,6 @@ properties: summary: '' fullName: end remarks: '' - isPreview: false isDeprecated: false syntax: content: 'end: Position' @@ -84,23 +77,21 @@ properties: summary: '' fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Position' return: description: '' type: -methods: - - name: toString() + - name: toString uid: botbuilder-lg.Range.toString package: botbuilder-lg summary: '' + fullName: toString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(): string' + content: 'toString: () => string' return: description: '' - type: string + type: () => string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SourceRange.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SourceRange.yml deleted file mode 100644 index ca54b062..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SourceRange.yml +++ /dev/null @@ -1,80 +0,0 @@ -### YamlMime:TSType -name: SourceRange -uid: botbuilder-lg.SourceRange -package: botbuilder-lg -summary: Position class -fullName: SourceRange -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'SourceRange(ParserRuleContext, string, number)' - uid: botbuilder-lg.SourceRange.constructor - package: botbuilder-lg - summary: >- - Creates a new instance of the - [SourceRange](xref:botbuilder-lg.SourceRange) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SourceRange(parseTree: ParserRuleContext, source?: string, offset?: - number) - parameters: - - id: parseTree - type: ParserRuleContext - description: '`ParserRuleContext`. Rule invocation record for parsing.' - - id: source - type: string - description: 'Optional. Source, used as the lg file path.' - - id: offset - type: number - description: | - Optional. Offset in the parse tree. - - name: 'SourceRange(Range, string)' - uid: botbuilder-lg.SourceRange.constructor_1 - package: botbuilder-lg - summary: >- - Creates a new instance of the - [SourceRange](xref:botbuilder-lg.SourceRange) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new SourceRange(range: Range, source?: string)' - parameters: - - id: range - type: - description: '(xref:botbuilder-lg.Range) of block.' - - id: source - type: string - description: 'Optional. Source, used as the lg file path.' -properties: - - name: range - uid: botbuilder-lg.SourceRange.range - package: botbuilder-lg - summary: Range of block. - fullName: range - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'range: Range' - return: - description: '' - type: - - name: source - uid: botbuilder-lg.SourceRange.source - package: botbuilder-lg - summary: 'Code source, used as the lg file path.' - fullName: source - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'source: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StaticChecker.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StaticChecker.yml index d1d48b49..88a790cc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StaticChecker.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StaticChecker.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: LG managed code checker. fullName: StaticChecker remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,25 +15,23 @@ constructors: Creates a new instance of the [StaticChecker](xref:botbuilder-lg.StaticChecker) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StaticChecker(templates: Templates)' parameters: - id: templates type: - description: | - (xref:botbuilder-lg.Templates) to be checked. + description: '[Templates](xref:botbuilder-lg.Templates) to be checked.' inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.StaticChecker.visit package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation calls on the specified tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree): Diagnostic[]' @@ -44,13 +41,14 @@ inheritedMethods: description: '' return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visit - name: visitChildren(RuleNode) uid: botbuilder-lg.StaticChecker.visitChildren package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation initializes the aggregate result to [defaultResult()](xref:%23defaultResult). Before visiting each child, it calls [shouldVisitNextChild](xref:%23shouldVisitNextChild); if the result @@ -63,7 +61,6 @@ inheritedMethods: the tree structure. Visitors that modify the tree should override this method to behave properly in respect to the specific algorithm in use. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode): Diagnostic[]' @@ -73,17 +70,17 @@ inheritedMethods: description: '' return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitChildren - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.StaticChecker.visitErrorNode package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode): Diagnostic[]' @@ -93,17 +90,17 @@ inheritedMethods: description: '' return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitErrorNode - name: visitTerminal(TerminalNode) uid: botbuilder-lg.StaticChecker.visitTerminal package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode): Diagnostic[]' @@ -113,7 +110,7 @@ inheritedMethods: description: '' return: description: '' - type: '[]' + type: [] inheritanceDescription: Inherited From AbstractParseTreeVisitor.visitTerminal methods: - name: check() @@ -121,13 +118,12 @@ methods: package: botbuilder-lg summary: Return error messages list. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function check(): Diagnostic[]' return: description: Report result. - type: '[]' + type: [] - name: visitIfElseBody(IfElseBodyContext) uid: botbuilder-lg.StaticChecker.visitIfElseBody package: botbuilder-lg @@ -135,7 +131,6 @@ methods: Visit a parse tree produced by the `ifElseBody` labeled alternative in `LGTemplateParser.body`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitIfElseBody(context: IfElseBodyContext): Diagnostic[]' @@ -145,13 +140,12 @@ methods: description: The parse tree. return: description: The result of visiting if-else body. - type: '[]' + type: [] - name: visitNormalTemplateBody(NormalTemplateBodyContext) uid: botbuilder-lg.StaticChecker.visitNormalTemplateBody package: botbuilder-lg summary: Visit a parse tree produced by `LGTemplateParser.normalTemplateBody`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,13 +157,12 @@ methods: description: The parse tree. return: description: The result of visiting normal template body. - type: '[]' + type: [] - name: visitNormalTemplateString(NormalTemplateStringContext) uid: botbuilder-lg.StaticChecker.visitNormalTemplateString package: botbuilder-lg summary: Visit a parse tree produced by `LGTemplateParser.normalTemplateString`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -181,13 +174,12 @@ methods: description: The parse tree. return: description: The result of visiting normal template string. - type: '[]' + type: [] - name: visitStructuredTemplateBody(StructuredTemplateBodyContext) uid: botbuilder-lg.StaticChecker.visitStructuredTemplateBody package: botbuilder-lg summary: Visit a parse tree produced by `LGTemplateParser.structuredTemplateBody`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -199,7 +191,7 @@ methods: description: The parse tree. return: description: The result of visiting structured template body. - type: '[]' + type: [] - name: visitSwitchCaseBody(SwitchCaseBodyContext) uid: botbuilder-lg.StaticChecker.visitSwitchCaseBody package: botbuilder-lg @@ -207,7 +199,6 @@ methods: Visit a parse tree produced by the `switchCaseBody` labeled alternative in `LGTemplateParser.body`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -219,5 +210,5 @@ methods: description: The parse tree. return: description: The result of visiting switch-case body. - type: '[]' -extends: 'AbstractParseTreeVisitor<[]>' + type: [] +extends: AbstractParseTreeVisitor<[]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContentLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContentLineContext.yml index 2a5ff5b5..a7f8a633 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContentLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContentLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: StructuredBodyContentLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'StructuredBodyContentLineContext(ParserRuleContext | undefined, number)' + - name: StructuredBodyContentLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.StructuredBodyContentLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new StructuredBodyContentLineContext(parent: ParserRuleContext | - undefined, invokingState: number) + new StructuredBodyContentLineContext(parent: undefined | + ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.StructuredBodyContentLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.StructuredBodyContentLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.StructuredBodyContentLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.StructuredBodyContentLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.StructuredBodyContentLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.StructuredBodyContentLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.StructuredBodyContentLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StructuredBodyContentLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.StructuredBodyContentLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.StructuredBodyContentLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.StructuredBodyContentLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.StructuredBodyContentLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.StructuredBodyContentLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContentLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.StructuredBodyContentLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContentLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContentLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.StructuredBodyContentLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.StructuredBodyContentLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.StructuredBodyContentLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.StructuredBodyContentLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.StructuredBodyContentLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.StructuredBodyContentLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.StructuredBodyContentLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.StructuredBodyContentLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.StructuredBodyContentLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.StructuredBodyContentLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContentLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContentLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.StructuredBodyContentLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,27 +819,25 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function expressionInStructure(): ExpressionInStructureContext | - undefined + function expressionInStructure(): undefined | + ExpressionInStructureContext return: description: '' - type: | undefined + type: undefined | - name: keyValueStructureLine() uid: botbuilder-lg.StructuredBodyContentLineContext.keyValueStructureLine package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function keyValueStructureLine(): KeyValueStructureLineContext | - undefined + function keyValueStructureLine(): undefined | + KeyValueStructureLineContext return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContext.yml index c3360141..9ad4fd5a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyContext.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: StructuredBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StructuredBodyContext(ctx: BodyContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: botbuilder-lg.StructuredBodyContext.ruleIndex - package: botbuilder-lg - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: botbuilder-lg.StructuredBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [BodyContext.altNumber](xref:botbuilder-lg.BodyContext.altNumber) - name: childCount uid: botbuilder-lg.StructuredBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [BodyContext.childCount](xref:botbuilder-lg.BodyContext.childCount) - name: children uid: botbuilder-lg.StructuredBodyContext.children package: botbuilder-lg @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [BodyContext.children](xref:botbuilder-lg.BodyContext.children) - name: exception uid: botbuilder-lg.StructuredBodyContext.exception package: botbuilder-lg @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [BodyContext.exception](xref:botbuilder-lg.BodyContext.exception) - name: invokingState uid: botbuilder-lg.StructuredBodyContext.invokingState package: botbuilder-lg summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [BodyContext.invokingState](xref:botbuilder-lg.BodyContext.invokingState) - name: isEmpty uid: botbuilder-lg.StructuredBodyContext.isEmpty package: botbuilder-lg @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [BodyContext.isEmpty](xref:botbuilder-lg.BodyContext.isEmpty) - name: parent uid: botbuilder-lg.StructuredBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [BodyContext.parent](xref:botbuilder-lg.BodyContext.parent) - name: payload uid: botbuilder-lg.StructuredBodyContext.payload package: botbuilder-lg summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [BodyContext.payload](xref:botbuilder-lg.BodyContext.payload) - name: ruleContext uid: botbuilder-lg.StructuredBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StructuredBodyContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [BodyContext.ruleContext](xref:botbuilder-lg.BodyContext.ruleContext) + - name: ruleIndex + uid: botbuilder-lg.StructuredBodyContext.ruleIndex + package: botbuilder-lg + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [BodyContext.ruleIndex](xref:botbuilder-lg.BodyContext.ruleIndex) - name: sourceInterval uid: botbuilder-lg.StructuredBodyContext.sourceInterval package: botbuilder-lg summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [BodyContext.sourceInterval](xref:botbuilder-lg.BodyContext.sourceInterval) - name: start uid: botbuilder-lg.StructuredBodyContext.start package: botbuilder-lg @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [BodyContext.start](xref:botbuilder-lg.BodyContext.start) - name: stop uid: botbuilder-lg.StructuredBodyContext.stop package: botbuilder-lg @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [BodyContext.stop](xref:botbuilder-lg.BodyContext.stop) - name: text uid: botbuilder-lg.StructuredBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [BodyContext.text](xref:botbuilder-lg.BodyContext.text) inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.StructuredBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [BodyContext.addAnyChild](xref:botbuilder-lg.BodyContext.addAnyChild) - name: addChild(RuleContext) uid: botbuilder-lg.StructuredBodyContext.addChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(TerminalNode) uid: botbuilder-lg.StructuredBodyContext.addChild package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(Token) uid: botbuilder-lg.StructuredBodyContext.addChild_2 package: botbuilder-lg @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addErrorNode(ErrorNode) uid: botbuilder-lg.StructuredBodyContext.addErrorNode package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: addErrorNode(Token) uid: botbuilder-lg.StructuredBodyContext.addErrorNode_1 package: botbuilder-lg @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: copyFrom(BodyContext) uid: botbuilder-lg.StructuredBodyContext.copyFrom package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: BodyContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [BodyContext.depth](xref:botbuilder-lg.BodyContext.depth) - name: emptyContext() uid: botbuilder-lg.StructuredBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [BodyContext.emptyContext](xref:botbuilder-lg.BodyContext.emptyContext) - name: getChild(number) uid: botbuilder-lg.StructuredBodyContext.getChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.StructuredBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChildContext](xref:botbuilder-lg.BodyContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContext](xref:botbuilder-lg.BodyContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContexts](xref:botbuilder-lg.BodyContext.getRuleContexts) + - name: getToken(number, number) uid: botbuilder-lg.StructuredBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [BodyContext.getToken](xref:botbuilder-lg.BodyContext.getToken) - name: getTokens(number) uid: botbuilder-lg.StructuredBodyContext.getTokens package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [BodyContext.getTokens](xref:botbuilder-lg.BodyContext.getTokens) - name: removeLastChild() uid: botbuilder-lg.StructuredBodyContext.removeLastChild package: botbuilder-lg @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [BodyContext.removeLastChild](xref:botbuilder-lg.BodyContext.removeLastChild) - name: setParent(RuleContext) uid: botbuilder-lg.StructuredBodyContext.setParent package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [BodyContext.setParent](xref:botbuilder-lg.BodyContext.setParent) - name: toInfoString(Parser) uid: botbuilder-lg.StructuredBodyContext.toInfoString package: botbuilder-lg @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [BodyContext.toInfoString](xref:botbuilder-lg.BodyContext.toInfoString) - name: toString() uid: botbuilder-lg.StructuredBodyContext.toString package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer) uid: botbuilder-lg.StructuredBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.StructuredBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[]) uid: botbuilder-lg.StructuredBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.StructuredBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) - name: toStringTree() uid: botbuilder-lg.StructuredBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) - name: toStringTree(Parser) uid: botbuilder-lg.StructuredBodyContext.toStringTree package: botbuilder-lg @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.StructuredBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetChild](xref:botbuilder-lg.BodyContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetRuleContext](xref:botbuilder-lg.BodyContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: botbuilder-lg.StructuredBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetToken](xref:botbuilder-lg.BodyContext.tryGetToken) methods: - name: accept(LGTemplateParserVisitor) uid: botbuilder-lg.StructuredBodyContext.accept package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -825,7 +867,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -838,7 +879,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -851,7 +891,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredTemplateBody(): StructuredTemplateBodyContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyEndLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyEndLineContext.yml index 6baaad4c..66f22664 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyEndLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyEndLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: StructuredBodyEndLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'StructuredBodyEndLineContext(ParserRuleContext | undefined, number)' + - name: StructuredBodyEndLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.StructuredBodyEndLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new StructuredBodyEndLineContext(parent: ParserRuleContext | undefined, + new StructuredBodyEndLineContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.StructuredBodyEndLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.StructuredBodyEndLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.StructuredBodyEndLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.StructuredBodyEndLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.StructuredBodyEndLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.StructuredBodyEndLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.StructuredBodyEndLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StructuredBodyEndLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.StructuredBodyEndLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.StructuredBodyEndLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.StructuredBodyEndLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.StructuredBodyEndLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.StructuredBodyEndLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyEndLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.StructuredBodyEndLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyEndLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.StructuredBodyEndLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.StructuredBodyEndLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.StructuredBodyEndLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.StructuredBodyEndLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.StructuredBodyEndLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.StructuredBodyEndLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.StructuredBodyEndLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.StructuredBodyEndLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.StructuredBodyEndLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.StructuredBodyEndLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.StructuredBodyEndLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyEndLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyEndLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.StructuredBodyEndLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,7 +819,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURED_BODY_END(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyNameLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyNameLineContext.yml index eef19475..87f51a18 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyNameLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredBodyNameLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: StructuredBodyNameLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'StructuredBodyNameLineContext(ParserRuleContext | undefined, number)' + - name: StructuredBodyNameLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.StructuredBodyNameLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new StructuredBodyNameLineContext(parent: ParserRuleContext | undefined, + new StructuredBodyNameLineContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.StructuredBodyNameLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.StructuredBodyNameLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.StructuredBodyNameLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.StructuredBodyNameLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.StructuredBodyNameLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.StructuredBodyNameLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.StructuredBodyNameLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StructuredBodyNameLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.StructuredBodyNameLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.StructuredBodyNameLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.StructuredBodyNameLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.StructuredBodyNameLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.StructuredBodyNameLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyNameLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.StructuredBodyNameLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyNameLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.StructuredBodyNameLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.StructuredBodyNameLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.StructuredBodyNameLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.StructuredBodyNameLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.StructuredBodyNameLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.StructuredBodyNameLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.StructuredBodyNameLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.StructuredBodyNameLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.StructuredBodyNameLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.StructuredBodyNameLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.StructuredBodyNameLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyNameLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredBodyNameLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.StructuredBodyNameLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,19 +807,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function errorStructuredName(): ErrorStructuredNameContext | undefined' + content: 'function errorStructuredName(): undefined | ErrorStructuredNameContext' return: description: '' - type: | undefined + type: undefined | - name: exitRule(LGTemplateParserListener) uid: botbuilder-lg.StructuredBodyNameLineContext.exitRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -876,7 +830,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function LEFT_SQUARE_BRACKET(): TerminalNode' @@ -888,11 +841,10 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function STRUCTURE_NAME(): TerminalNode | undefined' + content: 'function STRUCTURE_NAME(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredTemplateBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredTemplateBodyContext.yml index 0af70bfa..a068eeca 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredTemplateBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/StructuredTemplateBodyContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: StructuredTemplateBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'StructuredTemplateBodyContext(ParserRuleContext | undefined, number)' + - name: StructuredTemplateBodyContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.StructuredTemplateBodyContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new StructuredTemplateBodyContext(parent: ParserRuleContext | undefined, + new StructuredTemplateBodyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.StructuredTemplateBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.StructuredTemplateBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.StructuredTemplateBodyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.StructuredTemplateBodyContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.StructuredTemplateBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.StructuredTemplateBodyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.StructuredTemplateBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: StructuredTemplateBodyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.StructuredTemplateBodyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.StructuredTemplateBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.StructuredTemplateBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.StructuredTemplateBodyContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.StructuredTemplateBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredTemplateBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.StructuredTemplateBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredTemplateBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.StructuredTemplateBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.StructuredTemplateBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.StructuredTemplateBodyContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.StructuredTemplateBodyContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.StructuredTemplateBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.StructuredTemplateBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.StructuredTemplateBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.StructuredTemplateBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.StructuredTemplateBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.StructuredTemplateBodyContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.StructuredTemplateBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredTemplateBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.StructuredTemplateBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.StructuredTemplateBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,19 +807,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorStructureLine(): ErrorStructureLineContext[]' return: description: '' - type: '[]' + type: [] - name: errorStructureLine(number) uid: botbuilder-lg.StructuredTemplateBodyContext.errorStructureLine_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorStructureLine(i: number): ErrorStructureLineContext' @@ -879,7 +833,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -892,19 +845,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredBodyContentLine(): StructuredBodyContentLineContext[]' return: description: '' - type: '[]' + type: [] - name: structuredBodyContentLine(number) uid: botbuilder-lg.StructuredTemplateBodyContext.structuredBodyContentLine_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -922,21 +873,19 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function structuredBodyEndLine(): StructuredBodyEndLineContext | - undefined + function structuredBodyEndLine(): undefined | + StructuredBodyEndLineContext return: description: '' - type: | undefined + type: undefined | - name: structuredBodyNameLine() uid: botbuilder-lg.StructuredTemplateBodyContext.structuredBodyNameLine package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function structuredBodyNameLine(): StructuredBodyNameLineContext' @@ -948,19 +897,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURED_NEWLINE(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: STRUCTURED_NEWLINE(number) uid: botbuilder-lg.StructuredTemplateBodyContext.STRUCTURED_NEWLINE_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function STRUCTURED_NEWLINE(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseBodyContext.yml index 07ba7fc1..4ddf5153 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseBodyContext.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: '' fullName: SwitchCaseBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SwitchCaseBodyContext(ctx: BodyContext)' @@ -22,55 +20,42 @@ constructors: - id: ctx type: description: '' -properties: - - name: ruleIndex - uid: botbuilder-lg.SwitchCaseBodyContext.ruleIndex - package: botbuilder-lg - summary: '' - fullName: ruleIndex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: number ruleIndex - return: - description: '' - type: number inheritedProperties: - name: altNumber uid: botbuilder-lg.SwitchCaseBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: >- + Inherited From + [BodyContext.altNumber](xref:botbuilder-lg.BodyContext.altNumber) - name: childCount uid: botbuilder-lg.SwitchCaseBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' return: description: '' type: number - inheritanceDescription: Inherited From ParserRuleContext.childCount + inheritanceDescription: >- + Inherited From + [BodyContext.childCount](xref:botbuilder-lg.BodyContext.childCount) - name: children uid: botbuilder-lg.SwitchCaseBodyContext.children package: botbuilder-lg @@ -82,14 +67,15 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' - inheritanceDescription: Inherited From ParserRuleContext.children + type: ParseTree[] + inheritanceDescription: >- + Inherited From + [BodyContext.children](xref:botbuilder-lg.BodyContext.children) - name: exception uid: botbuilder-lg.SwitchCaseBodyContext.exception package: botbuilder-lg @@ -98,28 +84,30 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' return: description: '' type: RecognitionException - inheritanceDescription: Inherited From ParserRuleContext.exception + inheritanceDescription: >- + Inherited From + [BodyContext.exception](xref:botbuilder-lg.BodyContext.exception) - name: invokingState uid: botbuilder-lg.SwitchCaseBodyContext.invokingState package: botbuilder-lg summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: >- + Inherited From + [BodyContext.invokingState](xref:botbuilder-lg.BodyContext.invokingState) - name: isEmpty uid: botbuilder-lg.SwitchCaseBodyContext.isEmpty package: botbuilder-lg @@ -128,70 +116,90 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: >- + Inherited From + [BodyContext.isEmpty](xref:botbuilder-lg.BodyContext.isEmpty) - name: parent uid: botbuilder-lg.SwitchCaseBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined - inheritanceDescription: Inherited From ParserRuleContext.parent + type: undefined | ParserRuleContext + inheritanceDescription: >- + Inherited From + [BodyContext.parent](xref:botbuilder-lg.BodyContext.parent) - name: payload uid: botbuilder-lg.SwitchCaseBodyContext.payload package: botbuilder-lg summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: >- + Inherited From + [BodyContext.payload](xref:botbuilder-lg.BodyContext.payload) - name: ruleContext uid: botbuilder-lg.SwitchCaseBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: SwitchCaseBodyContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [BodyContext.ruleContext](xref:botbuilder-lg.BodyContext.ruleContext) + - name: ruleIndex + uid: botbuilder-lg.SwitchCaseBodyContext.ruleIndex + package: botbuilder-lg + summary: '' + fullName: ruleIndex + remarks: '' + isDeprecated: false + syntax: + content: 'ruleIndex: number' return: description: '' - type: this - inheritanceDescription: Inherited From ParserRuleContext.ruleContext + type: number + inheritanceDescription: >- + Inherited From + [BodyContext.ruleIndex](xref:botbuilder-lg.BodyContext.ruleIndex) - name: sourceInterval uid: botbuilder-lg.SwitchCaseBodyContext.sourceInterval package: botbuilder-lg summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' return: description: '' type: Interval - inheritanceDescription: Inherited From ParserRuleContext.sourceInterval + inheritanceDescription: >- + Inherited From + [BodyContext.sourceInterval](xref:botbuilder-lg.BodyContext.sourceInterval) - name: start uid: botbuilder-lg.SwitchCaseBodyContext.start package: botbuilder-lg @@ -205,14 +213,15 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' return: description: '' type: Token - inheritanceDescription: Inherited From ParserRuleContext.start + inheritanceDescription: >- + Inherited From + [BodyContext.start](xref:botbuilder-lg.BodyContext.start) - name: stop uid: botbuilder-lg.SwitchCaseBodyContext.stop package: botbuilder-lg @@ -226,49 +235,50 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined - inheritanceDescription: Inherited From ParserRuleContext.stop + type: undefined | Token + inheritanceDescription: >- + Inherited From + [BodyContext.stop](xref:botbuilder-lg.BodyContext.stop) - name: text uid: botbuilder-lg.SwitchCaseBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: >- + Inherited From + [BodyContext.text](xref:botbuilder-lg.BodyContext.text) inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.SwitchCaseBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -279,13 +289,14 @@ inheritedMethods: return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.addAnyChild + inheritanceDescription: >- + Inherited From + [BodyContext.addAnyChild](xref:botbuilder-lg.BodyContext.addAnyChild) - name: addChild(RuleContext) uid: botbuilder-lg.SwitchCaseBodyContext.addChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -293,13 +304,14 @@ inheritedMethods: - id: ruleInvocation type: RuleContext description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(TerminalNode) uid: botbuilder-lg.SwitchCaseBodyContext.addChild package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -307,7 +319,9 @@ inheritedMethods: - id: t type: TerminalNode description: '' - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addChild(Token) uid: botbuilder-lg.SwitchCaseBodyContext.addChild_2 package: botbuilder-lg @@ -321,7 +335,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -333,13 +346,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.addChild + inheritanceDescription: >- + Inherited From + [BodyContext.addChild](xref:botbuilder-lg.BodyContext.addChild) - name: addErrorNode(ErrorNode) uid: botbuilder-lg.SwitchCaseBodyContext.addErrorNode package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -350,7 +364,9 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: addErrorNode(Token) uid: botbuilder-lg.SwitchCaseBodyContext.addErrorNode_1 package: botbuilder-lg @@ -364,7 +380,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -376,13 +391,14 @@ inheritedMethods: return: description: '' type: ErrorNode - inheritanceDescription: Inherited From ParserRuleContext.addErrorNode + inheritanceDescription: >- + Inherited From + [BodyContext.addErrorNode](xref:botbuilder-lg.BodyContext.addErrorNode) - name: copyFrom(BodyContext) uid: botbuilder-lg.SwitchCaseBodyContext.copyFrom package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: BodyContext)' @@ -398,33 +414,34 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: >- + Inherited From + [BodyContext.depth](xref:botbuilder-lg.BodyContext.depth) - name: emptyContext() uid: botbuilder-lg.SwitchCaseBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' return: description: '' type: ParserRuleContext - inheritanceDescription: Inherited From ParserRuleContext.emptyContext + inheritanceDescription: >- + Inherited From + [BodyContext.emptyContext](xref:botbuilder-lg.BodyContext.emptyContext) - name: getChild(number) uid: botbuilder-lg.SwitchCaseBodyContext.getChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -435,33 +452,35 @@ inheritedMethods: return: description: '' type: ParseTree - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + inheritanceDescription: >- + Inherited From + [BodyContext.getChild](xref:botbuilder-lg.BodyContext.getChild) + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.SwitchCaseBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -477,50 +496,53 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.getChildContext](xref:botbuilder-lg.BodyContext.getChildContext) + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T - inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContext](xref:botbuilder-lg.BodyContext.getRuleContext) + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.SwitchCaseBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' - inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + type: T[] + inheritanceDescription: >- + Inherited From + [BodyContext.getRuleContexts](xref:botbuilder-lg.BodyContext.getRuleContexts) + - name: getToken(number, number) uid: botbuilder-lg.SwitchCaseBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -534,13 +556,14 @@ inheritedMethods: return: description: '' type: TerminalNode - inheritanceDescription: Inherited From ParserRuleContext.getToken + inheritanceDescription: >- + Inherited From + [BodyContext.getToken](xref:botbuilder-lg.BodyContext.getToken) - name: getTokens(number) uid: botbuilder-lg.SwitchCaseBodyContext.getTokens package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -550,8 +573,10 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' - inheritanceDescription: Inherited From ParserRuleContext.getTokens + type: TerminalNode[] + inheritanceDescription: >- + Inherited From + [BodyContext.getTokens](xref:botbuilder-lg.BodyContext.getTokens) - name: removeLastChild() uid: botbuilder-lg.SwitchCaseBodyContext.removeLastChild package: botbuilder-lg @@ -560,17 +585,17 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() - inheritanceDescription: Inherited From ParserRuleContext.removeLastChild + inheritanceDescription: >- + Inherited From + [BodyContext.removeLastChild](xref:botbuilder-lg.BodyContext.removeLastChild) - name: setParent(RuleContext) uid: botbuilder-lg.SwitchCaseBodyContext.setParent package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -578,7 +603,9 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: >- + Inherited From + [BodyContext.setParent](xref:botbuilder-lg.BodyContext.setParent) - name: toInfoString(Parser) uid: botbuilder-lg.SwitchCaseBodyContext.toInfoString package: botbuilder-lg @@ -586,7 +613,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -597,111 +623,119 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From ParserRuleContext.toInfoString + inheritanceDescription: >- + Inherited From + [BodyContext.toInfoString](xref:botbuilder-lg.BodyContext.toInfoString) - name: toString() uid: botbuilder-lg.SwitchCaseBodyContext.toString package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer) uid: botbuilder-lg.SwitchCaseBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.SwitchCaseBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[]) uid: botbuilder-lg.SwitchCaseBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.SwitchCaseBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: >- + Inherited From + [BodyContext.toString](xref:botbuilder-lg.BodyContext.toString) - name: toStringTree() uid: botbuilder-lg.SwitchCaseBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) - name: toStringTree(Parser) uid: botbuilder-lg.SwitchCaseBodyContext.toStringTree package: botbuilder-lg @@ -710,7 +744,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -721,75 +754,83 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.SwitchCaseBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: >- + Inherited From + [BodyContext.toStringTree](xref:botbuilder-lg.BodyContext.toStringTree) + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetChild](xref:botbuilder-lg.BodyContext.tryGetChild) + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + type: undefined | T + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetRuleContext](xref:botbuilder-lg.BodyContext.tryGetRuleContext) + - name: tryGetToken(number, number) uid: botbuilder-lg.SwitchCaseBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -799,15 +840,16 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined - inheritanceDescription: Inherited From ParserRuleContext.tryGetToken + type: undefined | TerminalNode + inheritanceDescription: >- + Inherited From + [BodyContext.tryGetToken](xref:botbuilder-lg.BodyContext.tryGetToken) methods: - name: accept(LGTemplateParserVisitor) uid: botbuilder-lg.SwitchCaseBodyContext.accept package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -825,7 +867,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -838,7 +879,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -851,7 +891,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseTemplateBody(): SwitchCaseTemplateBodyContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseRuleContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseRuleContext.yml index 68815733..3f1e7e8c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseRuleContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseRuleContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: SwitchCaseRuleContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'SwitchCaseRuleContext(ParserRuleContext | undefined, number)' + - name: SwitchCaseRuleContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.SwitchCaseRuleContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new SwitchCaseRuleContext(parent: ParserRuleContext | undefined, + new SwitchCaseRuleContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.SwitchCaseRuleContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.SwitchCaseRuleContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.SwitchCaseRuleContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.SwitchCaseRuleContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.SwitchCaseRuleContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.SwitchCaseRuleContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.SwitchCaseRuleContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: SwitchCaseRuleContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.SwitchCaseRuleContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.SwitchCaseRuleContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.SwitchCaseRuleContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.SwitchCaseRuleContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.SwitchCaseRuleContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseRuleContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.SwitchCaseRuleContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseRuleContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.SwitchCaseRuleContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.SwitchCaseRuleContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.SwitchCaseRuleContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.SwitchCaseRuleContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.SwitchCaseRuleContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.SwitchCaseRuleContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.SwitchCaseRuleContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.SwitchCaseRuleContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.SwitchCaseRuleContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.SwitchCaseRuleContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.SwitchCaseRuleContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseRuleContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseRuleContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.SwitchCaseRuleContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function normalTemplateBody(): NormalTemplateBodyContext | undefined' + content: 'function normalTemplateBody(): undefined | NormalTemplateBodyContext' return: description: '' - type: | undefined + type: undefined | - name: switchCaseStat() uid: botbuilder-lg.SwitchCaseRuleContext.switchCaseStat package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseStat(): SwitchCaseStatContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseStatContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseStatContext.yml index cde51386..f57d5249 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseStatContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseStatContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: SwitchCaseStatContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'SwitchCaseStatContext(ParserRuleContext | undefined, number)' + - name: SwitchCaseStatContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.SwitchCaseStatContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new SwitchCaseStatContext(parent: ParserRuleContext | undefined, + new SwitchCaseStatContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.SwitchCaseStatContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.SwitchCaseStatContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.SwitchCaseStatContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.SwitchCaseStatContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.SwitchCaseStatContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.SwitchCaseStatContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.SwitchCaseStatContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: SwitchCaseStatContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.SwitchCaseStatContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.SwitchCaseStatContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.SwitchCaseStatContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.SwitchCaseStatContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.SwitchCaseStatContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseStatContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.SwitchCaseStatContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseStatContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.SwitchCaseStatContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.SwitchCaseStatContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.SwitchCaseStatContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.SwitchCaseStatContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.SwitchCaseStatContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.SwitchCaseStatContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.SwitchCaseStatContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.SwitchCaseStatContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.SwitchCaseStatContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.SwitchCaseStatContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.SwitchCaseStatContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseStatContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseStatContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.SwitchCaseStatContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,19 +795,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function CASE(): TerminalNode | undefined' + content: 'function CASE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: DASH() uid: botbuilder-lg.SwitchCaseStatContext.DASH package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function DASH(): TerminalNode' @@ -862,19 +817,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function DEFAULT(): TerminalNode | undefined' + content: 'function DEFAULT(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: enterRule(LGTemplateParserListener) uid: botbuilder-lg.SwitchCaseStatContext.enterRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -887,7 +840,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -900,19 +852,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(): ExpressionContext[]' return: description: '' - type: '[]' + type: [] - name: expression(number) uid: botbuilder-lg.SwitchCaseStatContext.expression_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function expression(i: number): ExpressionContext' @@ -928,31 +878,28 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function SWITCH(): TerminalNode | undefined' + content: 'function SWITCH(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TEXT() uid: botbuilder-lg.SwitchCaseStatContext.TEXT package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: TEXT(number) uid: botbuilder-lg.SwitchCaseStatContext.TEXT_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEXT(i: number): TerminalNode' @@ -968,19 +915,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function WS(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: WS(number) uid: botbuilder-lg.SwitchCaseStatContext.WS_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function WS(i: number): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseTemplateBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseTemplateBodyContext.yml index 886d806c..848cbb85 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseTemplateBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/SwitchCaseTemplateBodyContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: SwitchCaseTemplateBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'SwitchCaseTemplateBodyContext(ParserRuleContext | undefined, number)' + - name: SwitchCaseTemplateBodyContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new SwitchCaseTemplateBodyContext(parent: ParserRuleContext | undefined, + new SwitchCaseTemplateBodyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.SwitchCaseTemplateBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.SwitchCaseTemplateBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.SwitchCaseTemplateBodyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.SwitchCaseTemplateBodyContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.SwitchCaseTemplateBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.SwitchCaseTemplateBodyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.SwitchCaseTemplateBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: SwitchCaseTemplateBodyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.SwitchCaseTemplateBodyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.SwitchCaseTemplateBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.SwitchCaseTemplateBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseTemplateBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseTemplateBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.SwitchCaseTemplateBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.SwitchCaseTemplateBodyContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseTemplateBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.SwitchCaseTemplateBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,7 +807,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -864,19 +819,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseRule(): SwitchCaseRuleContext[]' return: description: '' - type: '[]' + type: [] - name: switchCaseRule(number) uid: botbuilder-lg.SwitchCaseTemplateBodyContext.switchCaseRule_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function switchCaseRule(i: number): SwitchCaseRuleContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Template.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Template.yml index ee3e89bd..1f0cfb8e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Template.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Template.yml @@ -9,18 +9,16 @@ summary: >- wether it's evalator, static checker, anayler.. etc fullName: Template remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'Template(string, string[], string, SourceRange)' + - name: Template(string, string[], string, SourceRange) uid: botbuilder-lg.Template.constructor package: botbuilder-lg summary: >- Creates a new instance of the [Template](xref:botbuilder-lg.Template) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,15 +29,14 @@ constructors: type: string description: Template name without parameters. - id: parameters - type: 'string[]' + type: string[] description: Parameter list. - id: templatebody type: string description: Template content. - id: sourceRange - type: - description: | - (xref:botbuilder-lg.SourceRange) of template. + type: SourceRange + description: '[SourceRange](xref:botbuilder-lg.SourceRange) of template.' properties: - name: body uid: botbuilder-lg.Template.body @@ -49,7 +46,6 @@ properties: Parameters. fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body: string' @@ -59,10 +55,9 @@ properties: - name: name uid: botbuilder-lg.Template.name package: botbuilder-lg - summary: 'Name of the template, what''s followed by ''#'' in a LG file' + summary: Name of the template, what's followed by '#' in a LG file fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -75,46 +70,42 @@ properties: summary: Parameter list of this template fullName: parameters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'parameters: string[]' return: description: '' - type: 'string[]' + type: string[] - name: properties uid: botbuilder-lg.Template.properties package: botbuilder-lg summary: The extended properties for the object. fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'properties?: Record' return: description: '' - type: 'Record<string, unknown>' + type: Record<string, unknown> - name: sourceRange uid: botbuilder-lg.Template.sourceRange package: botbuilder-lg summary: Source of this template fullName: sourceRange remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceRange: SourceRange' return: description: '' - type: + type: SourceRange - name: templateBodyParseTree uid: botbuilder-lg.Template.templateBodyParseTree package: botbuilder-lg summary: Parse tree of this template. fullName: templateBodyParseTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'templateBodyParseTree: BodyContext' @@ -129,10 +120,9 @@ methods: Returns a string representing the current [Template](xref:botbuilder-lg.Template) object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: - description: 'A string representing the [Template](xref:botbuilder-lg.Template).' + description: A string representing the [Template](xref:botbuilder-lg.Template). type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyContext.yml index f767bc35..63427a3e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: TemplateBodyContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateBodyContext(ParserRuleContext | undefined, number)' + - name: TemplateBodyContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.TemplateBodyContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateBodyContext(parent: ParserRuleContext | undefined, + new TemplateBodyContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.TemplateBodyContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.TemplateBodyContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.TemplateBodyContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.TemplateBodyContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.TemplateBodyContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.TemplateBodyContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.TemplateBodyContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TemplateBodyContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.TemplateBodyContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.TemplateBodyContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.TemplateBodyContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.TemplateBodyContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.TemplateBodyContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.TemplateBodyContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.TemplateBodyContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.TemplateBodyContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.TemplateBodyContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.TemplateBodyContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.TemplateBodyContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.TemplateBodyContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.TemplateBodyContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.TemplateBodyContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.TemplateBodyContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.TemplateBodyContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.TemplateBodyContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.TemplateBodyContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -862,19 +817,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateBodyLine(): TemplateBodyLineContext[]' return: description: '' - type: '[]' + type: [] - name: templateBodyLine(number) uid: botbuilder-lg.TemplateBodyContext.templateBodyLine_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateBodyLine(i: number): TemplateBodyLineContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyLineContext.yml index ad60a7e9..ad1dff5d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateBodyLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: TemplateBodyLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateBodyLineContext(ParserRuleContext | undefined, number)' + - name: TemplateBodyLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.TemplateBodyLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateBodyLineContext(parent: ParserRuleContext | undefined, + new TemplateBodyLineContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.TemplateBodyLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.TemplateBodyLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.TemplateBodyLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.TemplateBodyLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.TemplateBodyLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.TemplateBodyLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.TemplateBodyLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TemplateBodyLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.TemplateBodyLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.TemplateBodyLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.TemplateBodyLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.TemplateBodyLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.TemplateBodyLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.TemplateBodyLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.TemplateBodyLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.TemplateBodyLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.TemplateBodyLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.TemplateBodyLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.TemplateBodyLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.TemplateBodyLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.TemplateBodyLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.TemplateBodyLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.TemplateBodyLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.TemplateBodyLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.TemplateBodyLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateBodyLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.TemplateBodyLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,19 +805,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: ESCAPE_CHARACTER(number) uid: botbuilder-lg.TemplateBodyLineContext.ESCAPE_CHARACTER_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ESCAPE_CHARACTER(i: number): TerminalNode' @@ -877,7 +831,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -890,55 +843,50 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function INLINE_MULTILINE(): TerminalNode | undefined' + content: 'function INLINE_MULTILINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MULTILINE_PREFIX() uid: botbuilder-lg.TemplateBodyLineContext.MULTILINE_PREFIX package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MULTILINE_PREFIX(): TerminalNode | undefined' + content: 'function MULTILINE_PREFIX(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MULTILINE_SUFFIX() uid: botbuilder-lg.TemplateBodyLineContext.MULTILINE_SUFFIX package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function MULTILINE_SUFFIX(): TerminalNode | undefined' + content: 'function MULTILINE_SUFFIX(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: MULTILINE_TEXT() uid: botbuilder-lg.TemplateBodyLineContext.MULTILINE_TEXT package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function MULTILINE_TEXT(): TerminalNode[]' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] - name: MULTILINE_TEXT(number) uid: botbuilder-lg.TemplateBodyLineContext.MULTILINE_TEXT_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function MULTILINE_TEXT(i: number): TerminalNode' @@ -954,23 +902,21 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TEMPLATE_BODY() uid: botbuilder-lg.TemplateBodyLineContext.TEMPLATE_BODY package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function TEMPLATE_BODY(): TerminalNode | undefined' + content: 'function TEMPLATE_BODY(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateContext.yml index 1d395b6f..ea344e1a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: TemplateContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateContext(ParserRuleContext | undefined, number)' + - name: TemplateContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.TemplateContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateContext(parent: ParserRuleContext | undefined, + new TemplateContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.TemplateContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.TemplateContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.TemplateContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.TemplateContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.TemplateContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.TemplateContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.TemplateContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TemplateContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.TemplateContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.TemplateContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.TemplateContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.TemplateContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.TemplateContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.TemplateContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.TemplateContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.TemplateContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.TemplateContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.TemplateContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.TemplateContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.TemplateContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.TemplateContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.TemplateContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.TemplateContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.TemplateContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.TemplateContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.TemplateContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function body(): BodyContext' @@ -850,7 +806,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -863,7 +818,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function EOF(): TerminalNode' @@ -875,7 +829,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateDefinitionContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateDefinitionContext.yml index 71218546..de262eff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateDefinitionContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateDefinitionContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: TemplateDefinitionContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateDefinitionContext(ParserRuleContext | undefined, number)' + - name: TemplateDefinitionContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.TemplateDefinitionContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateDefinitionContext(parent: ParserRuleContext | undefined, + new TemplateDefinitionContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.TemplateDefinitionContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.TemplateDefinitionContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.TemplateDefinitionContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.TemplateDefinitionContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.TemplateDefinitionContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.TemplateDefinitionContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.TemplateDefinitionContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TemplateDefinitionContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.TemplateDefinitionContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.TemplateDefinitionContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.TemplateDefinitionContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.TemplateDefinitionContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.TemplateDefinitionContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateDefinitionContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.TemplateDefinitionContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateDefinitionContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.TemplateDefinitionContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.TemplateDefinitionContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.TemplateDefinitionContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.TemplateDefinitionContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.TemplateDefinitionContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.TemplateDefinitionContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.TemplateDefinitionContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.TemplateDefinitionContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.TemplateDefinitionContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.TemplateDefinitionContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.TemplateDefinitionContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateDefinitionContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateDefinitionContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.TemplateDefinitionContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -862,7 +817,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateBody(): TemplateBodyContext' @@ -874,7 +828,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function templateNameLine(): TemplateNameLineContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateErrors.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateErrors.yml index 8dafe024..b0978143 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateErrors.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateErrors.yml @@ -5,37 +5,102 @@ package: botbuilder-lg summary: Centralized LG errors. fullName: TemplateErrors remarks: '' -isPreview: false isDeprecated: false type: class properties: + - name: argumentMismatch + uid: botbuilder-lg.TemplateErrors.argumentMismatch + package: botbuilder-lg + summary: '' + fullName: argumentMismatch + remarks: '' + isDeprecated: false + syntax: + content: >- + static argumentMismatch: (templateName: string, expectedCount: number, + actualCount: number) => string + return: + description: '' + type: >- + (templateName: string, expectedCount: number, actualCount: number) + => string + - name: duplicatedTemplateInDiffTemplate + uid: botbuilder-lg.TemplateErrors.duplicatedTemplateInDiffTemplate + package: botbuilder-lg + summary: '' + fullName: duplicatedTemplateInDiffTemplate + remarks: '' + isDeprecated: false + syntax: + content: >- + static duplicatedTemplateInDiffTemplate: (templateName: string, source: + string) => string + return: + description: '' + type: '(templateName: string, source: string) => string' + - name: duplicatedTemplateInSameTemplate + uid: botbuilder-lg.TemplateErrors.duplicatedTemplateInSameTemplate + package: botbuilder-lg + summary: '' + fullName: duplicatedTemplateInSameTemplate + remarks: '' + isDeprecated: false + syntax: + content: >- + static duplicatedTemplateInSameTemplate: (templateName: string) => + string + return: + description: '' + type: '(templateName: string) => string' - name: emptyStrucContent uid: botbuilder-lg.TemplateErrors.emptyStrucContent package: botbuilder-lg summary: '' fullName: emptyStrucContent remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static emptyStrucContent: string = "Invalid structure body. Body cannot - be empty." + content: 'static emptyStrucContent: string' return: description: '' type: string + - name: errorExpression + uid: botbuilder-lg.TemplateErrors.errorExpression + package: botbuilder-lg + summary: '' + fullName: errorExpression + remarks: '' + isDeprecated: false + syntax: + content: >- + static errorExpression: (refFullText: string, templateName: string, + prefixText: string) => string + return: + description: '' + type: >- + (refFullText: string, templateName: string, prefixText: string) => + string + - name: expressionParseError + uid: botbuilder-lg.TemplateErrors.expressionParseError + package: botbuilder-lg + summary: '' + fullName: expressionParseError + remarks: '' + isDeprecated: false + syntax: + content: 'static expressionParseError: (exp: string) => string' + return: + description: '' + type: '(exp: string) => string' - name: extraExpressionInCondition uid: botbuilder-lg.TemplateErrors.extraExpressionInCondition package: botbuilder-lg summary: '' fullName: extraExpressionInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static extraExpressionInCondition: string = "Invalid condition. 'ELSE' - definition cannot include an expression." + content: 'static extraExpressionInCondition: string' return: description: '' type: string @@ -45,12 +110,9 @@ properties: summary: '' fullName: extraExpressionInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static extraExpressionInSwitchCase: string = "Invalid condition. - 'DEFAULT' statement cannot include an expression." + content: 'static extraExpressionInSwitchCase: string' return: description: '' type: string @@ -60,12 +122,9 @@ properties: summary: '' fullName: importFormatError remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static importFormatError: string = "Import format should follow '[x](y)' - or '[x](y) as z'." + content: 'static importFormatError: string' return: description: '' type: string @@ -75,12 +134,9 @@ properties: summary: '' fullName: invalidExpressionInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidExpressionInCondition: string = "Invalid condition. 'IF', - 'ELSEIF' definitions must include a valid expression." + content: 'static invalidExpressionInCondition: string' return: description: '' type: string @@ -90,12 +146,9 @@ properties: summary: '' fullName: invalidExpressionInSwiathCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidExpressionInSwiathCase: string = "Invalid condition. - 'SWITCH' and 'CASE' statements must include a valid expression." + content: 'static invalidExpressionInSwiathCase: string' return: description: '' type: string @@ -105,10 +158,9 @@ properties: summary: '' fullName: invalidMemory remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static invalidMemory: string = "Scope is not a LG customized memory."' + content: 'static invalidMemory: string' return: description: '' type: string @@ -118,57 +170,93 @@ properties: summary: '' fullName: invalidMiddleInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidMiddleInCondition: string = "Invalid template body. - Expecting 'ELSEIF'." + content: 'static invalidMiddleInCondition: string' return: description: '' type: string + - name: invalidParameter + uid: botbuilder-lg.TemplateErrors.invalidParameter + package: botbuilder-lg + summary: '' + fullName: invalidParameter + remarks: '' + isDeprecated: false + syntax: + content: 'static invalidParameter: (invalidParameter: string) => string' + return: + description: '' + type: '(invalidParameter: string) => string' - name: invalidStatementInMiddlerOfSwitchCase uid: botbuilder-lg.TemplateErrors.invalidStatementInMiddlerOfSwitchCase package: botbuilder-lg summary: '' fullName: invalidStatementInMiddlerOfSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidStatementInMiddlerOfSwitchCase: string = "Invalid template - body. Expecting a 'CASE' statement." + content: 'static invalidStatementInMiddlerOfSwitchCase: string' return: description: '' type: string + - name: invalidStrucBody + uid: botbuilder-lg.TemplateErrors.invalidStrucBody + package: botbuilder-lg + summary: '' + fullName: invalidStrucBody + remarks: '' + isDeprecated: false + syntax: + content: 'static invalidStrucBody: (invalidBody: string) => string' + return: + description: '' + type: '(invalidBody: string) => string' + - name: invalidStrucName + uid: botbuilder-lg.TemplateErrors.invalidStrucName + package: botbuilder-lg + summary: '' + fullName: invalidStrucName + remarks: '' + isDeprecated: false + syntax: + content: 'static invalidStrucName: (invalidName: string) => string' + return: + description: '' + type: '(invalidName: string) => string' - name: invalidTemplateBody uid: botbuilder-lg.TemplateErrors.invalidTemplateBody package: botbuilder-lg summary: '' fullName: invalidTemplateBody remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidTemplateBody: string = "Invalid template body. Expecting - '-' prefix." + content: 'static invalidTemplateBody: string' return: description: '' type: string + - name: invalidTemplateName + uid: botbuilder-lg.TemplateErrors.invalidTemplateName + package: botbuilder-lg + summary: '' + fullName: invalidTemplateName + remarks: '' + isDeprecated: false + syntax: + content: 'static invalidTemplateName: (invalidTemplateName: string) => string' + return: + description: '' + type: '(invalidTemplateName: string) => string' - name: invalidTemplateNameType uid: botbuilder-lg.TemplateErrors.invalidTemplateNameType package: botbuilder-lg summary: '' fullName: invalidTemplateNameType remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidTemplateNameType: string = "Expected string type for the - parameter of template function." + content: 'static invalidTemplateNameType: string' return: description: '' type: string @@ -178,12 +266,9 @@ properties: summary: '' fullName: invalidWhitespaceInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidWhitespaceInCondition: string = "Invalid condition: At - most 1 whitespace allowed between 'IF/ELSEIF/ELSE' and ':'." + content: 'static invalidWhitespaceInCondition: string' return: description: '' type: string @@ -193,12 +278,9 @@ properties: summary: '' fullName: invalidWhitespaceInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static invalidWhitespaceInSwitchCase: string = "Invalid condition: At - most 1 whitespace allowed between 'SWITCH/CASE/DEFAULT' and ':'." + content: 'static invalidWhitespaceInSwitchCase: string' return: description: '' type: string @@ -208,10 +290,9 @@ properties: summary: '' fullName: loopDetected remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static loopDetected: string = "Loop detected:"' + content: 'static loopDetected: string' return: description: '' type: string @@ -221,12 +302,9 @@ properties: summary: '' fullName: missingCaseInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static missingCaseInSwitchCase: string = "Invalid template body. - Expecting at least one 'CASE' statement." + content: 'static missingCaseInSwitchCase: string' return: description: '' type: string @@ -236,12 +314,9 @@ properties: summary: '' fullName: missingStrucEnd remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static missingStrucEnd: string = "Invalid structure body. Expecting ']' - at the end of the body." + content: 'static missingStrucEnd: string' return: description: '' type: string @@ -251,12 +326,9 @@ properties: summary: '' fullName: missingTemplateBodyInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static missingTemplateBodyInCondition: string = "Invalid condition body. - Conditions must include a valid body." + content: 'static missingTemplateBodyInCondition: string' return: description: '' type: string @@ -266,12 +338,9 @@ properties: summary: '' fullName: missingTemplateBodyInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static missingTemplateBodyInSwitchCase: string = "Invalid condition - body. Expecing valid body inside a 'CASE' or 'DEFAULT' block." + content: 'static missingTemplateBodyInSwitchCase: string' return: description: '' type: string @@ -281,13 +350,9 @@ properties: summary: '' fullName: multipleIfInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static multipleIfInCondition: string = "Invalid template body. There - cannot be more than one 'IF' condition. Expecting 'IFELSE' or 'ELSE' - statement." + content: 'static multipleIfInCondition: string' return: description: '' type: string @@ -297,13 +362,9 @@ properties: summary: '' fullName: multipleSwithStatementInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static multipleSwithStatementInSwitchCase: string = "Invalid template - body. There cannot be more than one 'SWITCH' statement. Expecting 'CASE' - or 'DEFAULT' statement." + content: 'static multipleSwithStatementInSwitchCase: string' return: description: '' type: string @@ -313,10 +374,9 @@ properties: summary: '' fullName: noCloseBracket remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static noCloseBracket: string = "Close } is missing in Expression."' + content: 'static noCloseBracket: string' return: description: '' type: string @@ -326,12 +386,9 @@ properties: summary: '' fullName: noEndingInMultiline remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static noEndingInMultiline: string = "Expecting "```" to close the - multi-line block." + content: 'static noEndingInMultiline: string' return: description: '' type: string @@ -341,27 +398,33 @@ properties: summary: '' fullName: noTemplate remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static noTemplate: string = "LG file must have at least one template - definition." + content: 'static noTemplate: string' return: description: '' type: string + - name: noTemplateBody + uid: botbuilder-lg.TemplateErrors.noTemplateBody + package: botbuilder-lg + summary: '' + fullName: noTemplateBody + remarks: '' + isDeprecated: false + syntax: + content: 'static noTemplateBody: (templateName: string) => string' + return: + description: '' + type: '(templateName: string) => string' - name: notEndWithDefaultInSwitchCase uid: botbuilder-lg.TemplateErrors.notEndWithDefaultInSwitchCase package: botbuilder-lg summary: '' fullName: notEndWithDefaultInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static notEndWithDefaultInSwitchCase: string = "Conditional response - template does not end with 'DEFAULT' condition." + content: 'static notEndWithDefaultInSwitchCase: string' return: description: '' type: string @@ -371,12 +434,9 @@ properties: summary: '' fullName: notEndWithElseInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static notEndWithElseInCondition: string = "Conditional response - template does not end with 'ELSE' condition." + content: 'static notEndWithElseInCondition: string' return: description: '' type: string @@ -386,12 +446,9 @@ properties: summary: '' fullName: notStartWithIfInCondition remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static notStartWithIfInCondition: string = "Invalid condition: - Conditions must start with 'IF/ELSEIF/ELSE' prefix." + content: 'static notStartWithIfInCondition: string' return: description: '' type: string @@ -401,275 +458,69 @@ properties: summary: '' fullName: notStartWithSwitchInSwitchCase remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static notStartWithSwitchInSwitchCase: string = "Invalid conditional - response template. Expecting a 'SWITCH' statement?" + content: 'static notStartWithSwitchInSwitchCase: string' return: description: '' type: string - - name: staticFailure - uid: botbuilder-lg.TemplateErrors.staticFailure - package: botbuilder-lg - summary: '' - fullName: staticFailure - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static staticFailure: string = "Static failure with the following - error." - return: - description: '' - type: string -methods: - - name: 'argumentMismatch(string, number, number)' - uid: botbuilder-lg.TemplateErrors.argumentMismatch - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function argumentMismatch(templateName: string, expectedCount: - number, actualCount: number): string - parameters: - - id: templateName - type: string - description: '' - - id: expectedCount - type: number - description: '' - - id: actualCount - type: number - description: '' - return: - description: '' - type: string - - name: 'duplicatedTemplateInDiffTemplate(string, string)' - uid: botbuilder-lg.TemplateErrors.duplicatedTemplateInDiffTemplate - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function duplicatedTemplateInDiffTemplate(templateName: string, - source: string): string - parameters: - - id: templateName - type: string - description: '' - - id: source - type: string - description: '' - return: - description: '' - type: string - - name: duplicatedTemplateInSameTemplate(string) - uid: botbuilder-lg.TemplateErrors.duplicatedTemplateInSameTemplate - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function duplicatedTemplateInSameTemplate(templateName: string): - string - parameters: - - id: templateName - type: string - description: '' - return: - description: '' - type: string - - name: 'errorExpression(string, string, string)' - uid: botbuilder-lg.TemplateErrors.errorExpression - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function errorExpression(refFullText: string, templateName: - string, prefixText: string): string - parameters: - - id: refFullText - type: string - description: '' - - id: templateName - type: string - description: '' - - id: prefixText - type: string - description: '' - return: - description: '' - type: string - - name: expressionParseError(string) - uid: botbuilder-lg.TemplateErrors.expressionParseError - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function expressionParseError(exp: string): string' - parameters: - - id: exp - type: string - description: '' - return: - description: '' - type: string - - name: invalidParameter(string) - uid: botbuilder-lg.TemplateErrors.invalidParameter - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function invalidParameter(invalidParameter: string): string' - parameters: - - id: invalidParameter - type: string - description: '' - return: - description: '' - type: string - - name: invalidStrucBody(string) - uid: botbuilder-lg.TemplateErrors.invalidStrucBody - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function invalidStrucBody(invalidBody: string): string' - parameters: - - id: invalidBody - type: string - description: '' - return: - description: '' - type: string - - name: invalidStrucName(string) - uid: botbuilder-lg.TemplateErrors.invalidStrucName - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function invalidStrucName(invalidName: string): string' - parameters: - - id: invalidName - type: string - description: '' - return: - description: '' - type: string - - name: invalidTemplateName(string) - uid: botbuilder-lg.TemplateErrors.invalidTemplateName - package: botbuilder-lg - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function invalidTemplateName(invalidTemplateName: string): string' - parameters: - - id: invalidTemplateName - type: string - description: '' - return: - description: '' - type: string - - name: noTemplateBody(string) - uid: botbuilder-lg.TemplateErrors.noTemplateBody + - name: nullExpression + uid: botbuilder-lg.TemplateErrors.nullExpression package: botbuilder-lg summary: '' + fullName: nullExpression remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function noTemplateBody(templateName: string): string' - parameters: - - id: templateName - type: string - description: '' + content: 'static nullExpression: (expression: string) => string' return: description: '' - type: string - - name: nullExpression(string) - uid: botbuilder-lg.TemplateErrors.nullExpression + type: '(expression: string) => string' + - name: staticFailure + uid: botbuilder-lg.TemplateErrors.staticFailure package: botbuilder-lg summary: '' + fullName: staticFailure remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function nullExpression(expression: string): string' - parameters: - - id: expression - type: string - description: '' + content: 'static staticFailure: string' return: description: '' type: string - - name: syntaxError(string) + - name: syntaxError uid: botbuilder-lg.TemplateErrors.syntaxError package: botbuilder-lg summary: '' + fullName: syntaxError remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function syntaxError(unexpectedContent: string): string' - parameters: - - id: unexpectedContent - type: string - description: '' + content: 'static syntaxError: (unexpectedContent: string) => string' return: description: '' - type: string - - name: templateExist(string) + type: '(unexpectedContent: string) => string' + - name: templateExist uid: botbuilder-lg.TemplateErrors.templateExist package: botbuilder-lg summary: '' + fullName: templateExist remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function templateExist(templateName: string): string' - parameters: - - id: templateName - type: string - description: '' + content: 'static templateExist: (templateName: string) => string' return: description: '' - type: string - - name: templateNotExist(string) + type: '(templateName: string) => string' + - name: templateNotExist uid: botbuilder-lg.TemplateErrors.templateNotExist package: botbuilder-lg summary: '' + fullName: templateNotExist remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function templateNotExist(templateName: string): string' - parameters: - - id: templateName - type: string - description: '' + content: 'static templateNotExist: (templateName: string) => string' return: description: '' - type: string + type: '(templateName: string) => string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateException.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateException.yml index 7fdec9da..445668e3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateException.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateException.yml @@ -5,18 +5,16 @@ package: botbuilder-lg summary: LG Exception that contains diagnostics. fullName: TemplateException remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateException(string, Diagnostic[])' + - name: TemplateException(string, Diagnostic[]) uid: botbuilder-lg.TemplateException.constructor package: botbuilder-lg summary: >- Creates a new instance of the [TemplateException](xref:botbuilder-lg.TemplateException) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TemplateException(m: string, diagnostics: Diagnostic[])' @@ -25,23 +23,8 @@ constructors: type: string description: Error message. - id: diagnostics - type: '[]' - description: | - List of [Diagnostic](xref:botbuilder-lg.Diagnostic) to throw. -properties: - - name: Error - uid: botbuilder-lg.TemplateException.Error - package: botbuilder-lg - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor + type: [] + description: List of [Diagnostic](xref:botbuilder-lg.Diagnostic) to throw. inheritedProperties: - name: message uid: botbuilder-lg.TemplateException.message @@ -49,7 +32,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -63,7 +45,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -71,13 +52,28 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: botbuilder-lg.TemplateException.prepareStackTrace + package: botbuilder-lg + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: botbuilder-lg.TemplateException.stack package: botbuilder-lg summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -85,13 +81,44 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: botbuilder-lg.TemplateException.stackTraceLimit + package: botbuilder-lg + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: botbuilder-lg.TemplateException.captureStackTrace + package: botbuilder-lg + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace methods: - name: getDiagnostic() uid: botbuilder-lg.TemplateException.getDiagnostic package: botbuilder-lg summary: Diagnostics. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getDiagnostic(): Diagnostic[]' @@ -99,5 +126,5 @@ methods: description: >- A diagnostic of the error or warning (range, message, severity, source, code). - type: '[]' + type: [] extends: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateExtensions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateExtensions.yml index b2095acf..d71e3955 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateExtensions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateExtensions.yml @@ -5,16 +5,14 @@ package: botbuilder-lg summary: Extension methods for LG. fullName: TemplateExtensions remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'convertToRange(ParserRuleContext, number)' + - name: convertToRange(ParserRuleContext, number) uid: botbuilder-lg.TemplateExtensions.convertToRange package: botbuilder-lg summary: Convert antlr parser into Range. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -26,7 +24,7 @@ methods: description: Antlr parse context. - id: lineOffset type: number - description: '' + description: Line offset. return: description: Range object. type: @@ -35,7 +33,6 @@ methods: package: botbuilder-lg summary: Escape \ from text. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function evalEscape(exp: string): string' @@ -51,7 +48,6 @@ methods: package: botbuilder-lg summary: Get prefix error message from normal template sting context. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -69,7 +65,6 @@ methods: package: botbuilder-lg summary: If a value is pure Expression. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -80,14 +75,13 @@ methods: type: description: Key value structure value context. return: - description: 'True if the value is pure Expression, false otherwise.' + description: True if the value is pure Expression, false otherwise. type: boolean - name: newGuid() uid: botbuilder-lg.TemplateExtensions.newGuid package: botbuilder-lg summary: Generate new guid string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function newGuid(): string' @@ -108,7 +102,6 @@ methods: This allows author to use ../foo.lg or ..\foo.lg as equivelents for importing. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function normalizePath(ambiguousPath: string): string' @@ -124,7 +117,6 @@ methods: package: botbuilder-lg summary: Read line from text. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function readLine(input: string): string[]' @@ -134,13 +126,12 @@ methods: description: Text content. return: description: Split read line. - type: 'string[]' + type: string[] - name: trimExpression(string) uid: botbuilder-lg.TemplateExtensions.trimExpression package: botbuilder-lg - summary: 'Trim expression. ${abc} => abc, ${a == {}} => a == {}.' + summary: Trim expression. ${abc} => abc, ${a == {}} => a == {}. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function trimExpression(expression: string): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateImport.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateImport.yml index 733f5df1..1670e22d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateImport.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateImport.yml @@ -7,18 +7,16 @@ summary: >- definition in LG files easily. fullName: TemplateImport remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateImport(string, string, SourceRange, string)' + - name: TemplateImport(string, string, SourceRange, string) uid: botbuilder-lg.TemplateImport.constructor package: botbuilder-lg summary: >- Creates a new instance of the [TemplateImport](xref:botbuilder-lg.TemplateImport) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,17 +25,16 @@ constructors: parameters: - id: description type: string - description: 'Import description, which is in [].' + description: Import description, which is in []. - id: id type: string - description: 'Import id, which is a path, in ().' + description: Import id, which is a path, in (). - id: sourceRange - type: - description: '(xref:botbuilder-lg.SourceRange) of template.' + type: SourceRange + description: '[SourceRange](xref:botbuilder-lg.SourceRange) of template.' - id: alias type: string - description: | - Imports alias. + description: Imports alias. properties: - name: alias uid: botbuilder-lg.TemplateImport.alias @@ -45,7 +42,6 @@ properties: summary: 'Alias for templates. For example: [import](path) as myAlias.' fullName: alias remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alias?: string' @@ -55,10 +51,9 @@ properties: - name: description uid: botbuilder-lg.TemplateImport.description package: botbuilder-lg - summary: 'Description of the import, what''s included by ''[]'' in a lg file.' + summary: Description of the import, what's included by '[]' in a lg file. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -71,7 +66,6 @@ properties: summary: Id of this import. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -84,23 +78,21 @@ properties: summary: origin root source of the import. fullName: sourceRange remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceRange: SourceRange' return: description: '' - type: -methods: - - name: toString() + type: SourceRange + - name: toString uid: botbuilder-lg.TemplateImport.toString package: botbuilder-lg summary: '' + fullName: toString remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(): string' + content: 'toString: () => string' return: description: '' - type: string + type: () => string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateNameLineContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateNameLineContext.yml index 75657ebd..17175ec8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateNameLineContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateNameLineContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: TemplateNameLineContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateNameLineContext(ParserRuleContext | undefined, number)' + - name: TemplateNameLineContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.TemplateNameLineContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateNameLineContext(parent: ParserRuleContext | undefined, + new TemplateNameLineContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.TemplateNameLineContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.TemplateNameLineContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.TemplateNameLineContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.TemplateNameLineContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.TemplateNameLineContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.TemplateNameLineContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.TemplateNameLineContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TemplateNameLineContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.TemplateNameLineContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.TemplateNameLineContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.TemplateNameLineContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.TemplateNameLineContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.TemplateNameLineContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateNameLineContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.TemplateNameLineContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateNameLineContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.TemplateNameLineContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.TemplateNameLineContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.TemplateNameLineContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.TemplateNameLineContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.TemplateNameLineContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.TemplateNameLineContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.TemplateNameLineContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.TemplateNameLineContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.TemplateNameLineContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.TemplateNameLineContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.TemplateNameLineContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateNameLineContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateNameLineContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.TemplateNameLineContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGFileParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function accept(visitor: LGFileParserVisitor): Result' @@ -836,7 +793,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGFileParserListener)' @@ -849,7 +805,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGFileParserListener)' @@ -862,19 +817,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function NEWLINE(): TerminalNode | undefined' + content: 'function NEWLINE(): undefined | TerminalNode' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode - name: TEMPLATE_NAME_LINE() uid: botbuilder-lg.TemplateNameLineContext.TEMPLATE_NAME_LINE package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function TEMPLATE_NAME_LINE(): TerminalNode' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateStringContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateStringContext.yml index 8a7807a2..31d53bb8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateStringContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplateStringContext.yml @@ -5,24 +5,22 @@ package: botbuilder-lg summary: '' fullName: TemplateStringContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TemplateStringContext(ParserRuleContext | undefined, number)' + - name: TemplateStringContext(undefined | ParserRuleContext, number) uid: botbuilder-lg.TemplateStringContext.constructor package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new TemplateStringContext(parent: ParserRuleContext | undefined, + new TemplateStringContext(parent: undefined | ParserRuleContext, invokingState: number) parameters: - id: parent - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext description: '' - id: invokingState type: number @@ -34,10 +32,9 @@ properties: summary: '' fullName: ruleIndex remarks: '' - isPreview: false isDeprecated: false syntax: - content: number ruleIndex + content: 'ruleIndex: number' return: description: '' type: number @@ -45,30 +42,27 @@ inheritedProperties: - name: altNumber uid: botbuilder-lg.TemplateStringContext.altNumber package: botbuilder-lg - summary: | + summary: |- Set the outer alternative number for this context node. Default implementation does nothing to avoid backing field overhead for trees that don't need it. Create a subclass of ParserRuleContext with backing field and set option contextSuperClass. - @since 4.5.3 fullName: altNumber remarks: '' - isPreview: false isDeprecated: false syntax: content: 'altNumber: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.altNumber + inheritanceDescription: Inherited From ParserRuleContext.altNumber - name: childCount uid: botbuilder-lg.TemplateStringContext.childCount package: botbuilder-lg summary: '' fullName: childCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'childCount: number' @@ -87,13 +81,12 @@ inheritedProperties: how we parse this rule. fullName: children remarks: '' - isPreview: false isDeprecated: false syntax: content: 'children?: ParseTree[]' return: description: '' - type: 'ParseTree[]' + type: ParseTree[] inheritanceDescription: Inherited From ParserRuleContext.children - name: exception uid: botbuilder-lg.TemplateStringContext.exception @@ -103,7 +96,6 @@ inheritedProperties: completed, this is `undefined`. fullName: exception remarks: '' - isPreview: false isDeprecated: false syntax: content: 'exception?: RecognitionException' @@ -117,14 +109,13 @@ inheritedProperties: summary: '' fullName: invokingState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'invokingState: number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.invokingState + inheritanceDescription: Inherited From ParserRuleContext.invokingState - name: isEmpty uid: botbuilder-lg.TemplateStringContext.isEmpty package: botbuilder-lg @@ -133,27 +124,25 @@ inheritedProperties: current context. fullName: isEmpty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isEmpty: boolean' return: description: '' type: boolean - inheritanceDescription: Inherited From RuleContext.isEmpty + inheritanceDescription: Inherited From ParserRuleContext.isEmpty - name: parent uid: botbuilder-lg.TemplateStringContext.parent package: botbuilder-lg summary: '' fullName: parent remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'parent: ParserRuleContext | undefined' + content: 'parent: undefined | ParserRuleContext' return: description: '' - type: ParserRuleContext | undefined + type: undefined | ParserRuleContext inheritanceDescription: Inherited From ParserRuleContext.parent - name: payload uid: botbuilder-lg.TemplateStringContext.payload @@ -161,27 +150,25 @@ inheritedProperties: summary: '' fullName: payload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payload: RuleContext' return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.payload + inheritanceDescription: Inherited From ParserRuleContext.payload - name: ruleContext uid: botbuilder-lg.TemplateStringContext.ruleContext package: botbuilder-lg summary: '' fullName: ruleContext remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'ruleContext: this' + content: 'ruleContext: TemplateStringContext' return: description: '' - type: this + type: inheritanceDescription: Inherited From ParserRuleContext.ruleContext - name: sourceInterval uid: botbuilder-lg.TemplateStringContext.sourceInterval @@ -189,7 +176,6 @@ inheritedProperties: summary: '' fullName: sourceInterval remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sourceInterval: Interval' @@ -210,7 +196,6 @@ inheritedProperties: stop. fullName: start remarks: '' - isPreview: false isDeprecated: false syntax: content: 'start: Token' @@ -231,49 +216,46 @@ inheritedProperties: start. fullName: stop remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'stop: Token | undefined' + content: 'stop: undefined | Token' return: description: '' - type: Token | undefined + type: undefined | Token inheritanceDescription: Inherited From ParserRuleContext.stop - name: text uid: botbuilder-lg.TemplateStringContext.text package: botbuilder-lg - summary: | + summary: |- Return the combined text of all child nodes. This method only considers tokens which have been added to the parse tree. + Since tokens on hidden channels (e.g. whitespace or comments) are not added to the parse trees, they will not appear in the output of this method. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.text + inheritanceDescription: Inherited From ParserRuleContext.text inheritedMethods: - name: addAnyChild(T) uid: botbuilder-lg.TemplateStringContext.addAnyChild package: botbuilder-lg - summary: | + summary: |- Add a parse tree node to this as a child. Works for internal and leaf nodes. Does not set parent link; other add methods must do that. Other addChild methods call this. + We cannot set the parent pointer of the incoming node because the existing interfaces do not have a setParent() method and I don't want to break backward compatibility for this. - - @since 4.7 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addAnyChild(t: T): T' @@ -290,7 +272,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(ruleInvocation: RuleContext)' @@ -304,7 +285,6 @@ inheritedMethods: package: botbuilder-lg summary: Add a token leaf node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addChild(t: TerminalNode)' @@ -326,7 +306,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -344,7 +323,6 @@ inheritedMethods: package: botbuilder-lg summary: Add an error node child and force its parent to be this node. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addErrorNode(errorNode: ErrorNode): ErrorNode' @@ -369,7 +347,6 @@ inheritedMethods: in for compatibility but the parser doesn't use this anymore. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use another overload instead. syntax: @@ -385,10 +362,11 @@ inheritedMethods: - name: copyFrom(ParserRuleContext) uid: botbuilder-lg.TemplateStringContext.copyFrom package: botbuilder-lg - summary: | + summary: |- COPY a ctx (I'm deliberately not using copy constructor) to avoid confusion with creating node with parent. Does not copy children (except error leaves). + This is used in the generated parser code to flip a generic XContext node for rule X to a YContext for alt label Y. In that sense, it is not really a generic copy function. @@ -397,7 +375,6 @@ inheritedMethods: to the generic XContext so this function must copy those nodes to the YContext as well else they are lost! remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function copyFrom(ctx: ParserRuleContext)' @@ -411,20 +388,18 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function depth(): number' return: description: '' type: number - inheritanceDescription: Inherited From RuleContext.depth + inheritanceDescription: Inherited From ParserRuleContext.depth - name: emptyContext() uid: botbuilder-lg.TemplateStringContext.emptyContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function emptyContext(): ParserRuleContext' @@ -437,7 +412,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getChild(i: number): ParseTree' @@ -449,32 +423,30 @@ inheritedMethods: description: '' type: ParseTree inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChild(number, { })' + - name: 'getChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateStringContext.getChild_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getChild(i: number, ctxType: { }): T' + content: 'function getChild(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getChild - - name: 'getChildContext(RuleContext, number)' + - name: getChildContext(RuleContext, number) uid: botbuilder-lg.TemplateStringContext.getChildContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -490,50 +462,47 @@ inheritedMethods: return: description: '' type: RuleContext - inheritanceDescription: Inherited From RuleContext.getChildContext - - name: 'getRuleContext(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.getChildContext + - name: 'getRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateStringContext.getRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContext(i: number, ctxType: { }): T' + content: 'function getRuleContext(i: number, ctxType: (args: any[]) => T): T' parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' type: T inheritanceDescription: Inherited From ParserRuleContext.getRuleContext - - name: 'getRuleContexts({ })' + - name: 'getRuleContexts((args: any[]) => T)' uid: botbuilder-lg.TemplateStringContext.getRuleContexts package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getRuleContexts(ctxType: { }): T[]' + content: 'function getRuleContexts(ctxType: (args: any[]) => T): T[]' parameters: - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: 'T[]' + type: T[] inheritanceDescription: Inherited From ParserRuleContext.getRuleContexts - - name: 'getToken(number, number)' + - name: getToken(number, number) uid: botbuilder-lg.TemplateStringContext.getToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(ttype: number, i: number): TerminalNode' @@ -553,7 +522,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokens(ttype: number): TerminalNode[]' @@ -563,7 +531,7 @@ inheritedMethods: description: '' return: description: '' - type: 'TerminalNode[]' + type: TerminalNode[] inheritanceDescription: Inherited From ParserRuleContext.getTokens - name: removeLastChild() uid: botbuilder-lg.TemplateStringContext.removeLastChild @@ -573,7 +541,6 @@ inheritedMethods: we entered a rule. If we have # label, we will need to remove generic ruleContext object. remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeLastChild() @@ -583,7 +550,6 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setParent(parent: RuleContext)' @@ -591,7 +557,7 @@ inheritedMethods: - id: parent type: RuleContext description: '' - inheritanceDescription: Inherited From RuleContext.setParent + inheritanceDescription: Inherited From ParserRuleContext.setParent - name: toInfoString(Parser) uid: botbuilder-lg.TemplateStringContext.toInfoString package: botbuilder-lg @@ -599,7 +565,6 @@ inheritedMethods: Used for rule context info debugging during parse-time, not so much for ATN debugging remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toInfoString(recognizer: Parser): string' @@ -616,105 +581,99 @@ inheritedMethods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer) uid: botbuilder-lg.TemplateStringContext.toString_1 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(recog: Recognizer | undefined): string' + content: 'function toString(recog: undefined | Recognizer): string' parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(Recognizer | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | Recognizer, undefined | RuleContext) uid: botbuilder-lg.TemplateStringContext.toString_3 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(recog: Recognizer | undefined, stop: - RuleContext | undefined): string + function toString(recog: undefined | Recognizer, stop: + undefined | RuleContext): string parameters: - id: recog - type: 'Recognizer<any, any> | undefined' + type: undefined | Recognizer<any, any> description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[]) uid: botbuilder-lg.TemplateStringContext.toString_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toString(ruleNames: string[] | undefined): string' + content: 'function toString(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString - - name: 'toString(string[] | undefined, RuleContext | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toString + - name: toString(undefined | string[], undefined | RuleContext) uid: botbuilder-lg.TemplateStringContext.toString_4 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function toString(ruleNames: string[] | undefined, stop: RuleContext | - undefined): string + function toString(ruleNames: undefined | string[], stop: undefined | + RuleContext): string parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' - id: stop - type: RuleContext | undefined + type: undefined | RuleContext description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toString + inheritanceDescription: Inherited From ParserRuleContext.toString - name: toStringTree() uid: botbuilder-lg.TemplateStringContext.toStringTree_2 package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(): string' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree + inheritanceDescription: Inherited From ParserRuleContext.toStringTree - name: toStringTree(Parser) uid: botbuilder-lg.TemplateStringContext.toStringTree package: botbuilder-lg @@ -723,7 +682,6 @@ inheritedMethods: (root child1 .. childN). Print just a node if this is a leaf. We have to know the recognizer so we can get rule names. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toStringTree(recog: Parser): string' @@ -734,75 +692,75 @@ inheritedMethods: return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'toStringTree(string[] | undefined)' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: toStringTree(undefined | string[]) uid: botbuilder-lg.TemplateStringContext.toStringTree_1 package: botbuilder-lg summary: |- Print out a whole tree, not just a node, in LISP format (root child1 .. childN). Print just a node if this is a leaf. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function toStringTree(ruleNames: string[] | undefined): string' + content: 'function toStringTree(ruleNames: undefined | string[]): string' parameters: - id: ruleNames - type: 'string[] | undefined' + type: undefined | string[] description: '' return: description: '' type: string - inheritanceDescription: Inherited From RuleContext.toStringTree - - name: 'tryGetChild(number, { })' + inheritanceDescription: Inherited From ParserRuleContext.toStringTree + - name: 'tryGetChild(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateStringContext.tryGetChild package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetChild(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetChild(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetChild - - name: 'tryGetRuleContext(number, { })' + - name: 'tryGetRuleContext(number, (args: any[]) => T)' uid: botbuilder-lg.TemplateStringContext.tryGetRuleContext package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetRuleContext(i: number, ctxType: { }): T | undefined' + content: >- + function tryGetRuleContext(i: number, ctxType: (args: any[]) => T): + undefined | T parameters: - id: i type: number description: '' - id: ctxType - type: '{ }' + type: '(args: any[]) => T' description: '' return: description: '' - type: T | undefined + type: undefined | T inheritanceDescription: Inherited From ParserRuleContext.tryGetRuleContext - - name: 'tryGetToken(number, number)' + - name: tryGetToken(number, number) uid: botbuilder-lg.TemplateStringContext.tryGetToken package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function tryGetToken(ttype: number, i: number): TerminalNode | undefined' + content: 'function tryGetToken(ttype: number, i: number): undefined | TerminalNode' parameters: - id: ttype type: number @@ -812,7 +770,7 @@ inheritedMethods: description: '' return: description: '' - type: TerminalNode | undefined + type: undefined | TerminalNode inheritanceDescription: Inherited From ParserRuleContext.tryGetToken methods: - name: accept(LGTemplateParserVisitor) @@ -820,7 +778,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -838,7 +795,6 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function enterRule(listener: LGTemplateParserListener)' @@ -851,19 +807,17 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function errorTemplateString(): ErrorTemplateStringContext | undefined' + content: 'function errorTemplateString(): undefined | ErrorTemplateStringContext' return: description: '' - type: | undefined + type: undefined | - name: exitRule(LGTemplateParserListener) uid: botbuilder-lg.TemplateStringContext.exitRule package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function exitRule(listener: LGTemplateParserListener)' @@ -876,11 +830,10 @@ methods: package: botbuilder-lg summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function normalTemplateString(): NormalTemplateStringContext | undefined' + content: 'function normalTemplateString(): undefined | NormalTemplateStringContext' return: description: '' - type: | undefined + type: undefined | extends: ParserRuleContext diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Templates.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Templates.yml index 9c7d32b5..53c9e288 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Templates.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/Templates.yml @@ -2,10 +2,9 @@ name: Templates uid: botbuilder-lg.Templates package: botbuilder-lg -summary: 'LG entrance, including properties that LG file has, and evaluate functions.' +summary: LG entrance, including properties that LG file has, and evaluate functions. fullName: Templates remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: Creates a new instance of the [Templates](xref:botbuilder-lg.Templates) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,20 +28,20 @@ constructors: source?: string, namedReferences?: Record) parameters: - id: items - type: '[]' - description: 'Optional. List of [Template](xref:botbuilder-lg.Template) instances.' + type: [] + description: Optional. List of [Template](xref:botbuilder-lg.Template) instances. - id: imports - type: '[]' + type: [] description: >- Optional. List of [TemplateImport](xref:botbuilder-lg.TemplateImport) instances. - id: diagnostics - type: '[]' + type: [] description: >- Optional. List of [Diagnostic](xref:botbuilder-lg.Diagnostic) instances. - id: references - type: '[]' + type: [] description: >- Optional. List of [Templates](xref:botbuilder-lg.Templates) instances. @@ -63,7 +61,7 @@ constructors: type: description: Optional. Resolver to resolve LG import id to template text. - id: options - type: 'string[]' + type: string[] description: >- Optional. List of strings representing the options during evaluation of the templates. @@ -71,8 +69,8 @@ constructors: type: string description: Optional. Templates source. - id: namedReferences - type: 'Record<string, >' - description: > + type: Record<string, > + description: >- Optional. eferences that imported with the "as" syntax，for example: [import](path.lg) as myAlias. properties: @@ -82,33 +80,30 @@ properties: summary: Gets all diagnostics from current lg file and reference lg files. fullName: allDiagnostics remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'Diagnostic[] allDiagnostics' + content: 'allDiagnostics: Diagnostic[]' return: description: All diagnostics from current lg file and reference lg files. - type: '[]' + type: [] - name: allTemplates uid: botbuilder-lg.Templates.allTemplates package: botbuilder-lg summary: Gets all templates from current lg file and reference lg files. fullName: allTemplates remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'Template[] allTemplates' + content: 'allTemplates: Template[]' return: description: All templates from current lg file and reference lg files. - type: '[]' + type: [] - name: content uid: botbuilder-lg.Templates.content package: botbuilder-lg summary: LG content. fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content: string' @@ -121,23 +116,21 @@ properties: summary: diagnostics. fullName: diagnostics remarks: '' - isPreview: false isDeprecated: false syntax: content: 'diagnostics: Diagnostic[]' return: description: '' - type: '[]' + type: [] - name: enableFromFile uid: botbuilder-lg.Templates.enableFromFile package: botbuilder-lg summary: Indicates whether fromFile is allowed in LG templates. fullName: enableFromFile remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static enableFromFile: boolean = false' + content: 'static enableFromFile: boolean' return: description: '' type: boolean @@ -147,7 +140,6 @@ properties: summary: expression parser. fullName: expressionParser remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expressionParser: ExpressionParser' @@ -160,7 +152,6 @@ properties: summary: Id of the lg resource. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -173,7 +164,6 @@ properties: summary: Delegate for resolving resource id of imported lg file. fullName: importResolver remarks: '' - isPreview: false isDeprecated: false syntax: content: 'importResolver: ImportResolverDelegate' @@ -186,40 +176,35 @@ properties: summary: import elements that this LG file contains directly. fullName: imports remarks: '' - isPreview: false isDeprecated: false syntax: content: 'imports: TemplateImport[]' return: description: '' - type: '[]' + type: [] - name: inlineTemplateIdPrefix uid: botbuilder-lg.Templates.inlineTemplateIdPrefix package: botbuilder-lg summary: Temp Template ID for inline content. fullName: inlineTemplateIdPrefix remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static inlineTemplateIdPrefix: string = "__temp__"' + content: 'static inlineTemplateIdPrefix: string' return: description: '' type: string - name: lgOptions uid: botbuilder-lg.Templates.lgOptions package: botbuilder-lg - summary: | - Gets the evluation options for the current LG file. - @returns A value indicating whether the options when evaluating LG templates. + summary: Gets the evluation options for the current LG file. fullName: lgOptions remarks: '' - isPreview: false isDeprecated: false syntax: - content: EvaluationOptions lgOptions + content: 'lgOptions: EvaluationOptions' return: - description: '' + description: A value indicating whether the options when evaluating LG templates. type: - name: namedReferences uid: botbuilder-lg.Templates.namedReferences @@ -227,27 +212,25 @@ properties: summary: Map from import alias to templates. fullName: namedReferences remarks: '' - isPreview: false isDeprecated: false syntax: content: 'namedReferences: Record' return: description: '' - type: 'Record<string, >' + type: Record<string, > - name: namespace uid: botbuilder-lg.Templates.namespace package: botbuilder-lg - summary: | - Gets the namespace to register for the current LG file. - @returns A string value representing the namespace to register for the current LG file. + summary: Gets the namespace to register for the current LG file. fullName: namespace remarks: '' - isPreview: false isDeprecated: false syntax: - content: string namespace + content: 'namespace: string' return: - description: '' + description: >- + A string value representing the namespace to register for the current + LG file. type: string - name: options uid: botbuilder-lg.Templates.options @@ -255,13 +238,12 @@ properties: summary: LG file options. fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: string[]' return: description: '' - type: 'string[]' + type: string[] - name: references uid: botbuilder-lg.Templates.references package: botbuilder-lg @@ -272,20 +254,18 @@ properties: so, reference count may >= imports count. fullName: references remarks: '' - isPreview: false isDeprecated: false syntax: content: 'references: Templates[]' return: description: '' - type: '[]' + type: [] - name: source uid: botbuilder-lg.Templates.source package: botbuilder-lg summary: Source of the lg resource. Full path for lg file. fullName: source remarks: '' - isPreview: false isDeprecated: false syntax: content: 'source: string' @@ -293,12 +273,11 @@ properties: description: '' type: string methods: - - name: 'addTemplate(string, string[], string)' + - name: addTemplate(string, string[], string) uid: botbuilder-lg.Templates.addTemplate package: botbuilder-lg summary: Add a new template and return LG file. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -309,7 +288,7 @@ methods: type: string description: New template name. - id: parameters - type: 'string[]' + type: string[] description: New params. - id: templateBody type: string @@ -317,14 +296,13 @@ methods: return: description: New lg file. type: - - name: 'analyzeTemplate(string, AnalyzerOptions)' + - name: analyzeTemplate(string, AnalyzerOptions) uid: botbuilder-lg.Templates.analyzeTemplate package: botbuilder-lg summary: >- Analyze a template to get the static analyzer results including variables and template references. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -345,7 +323,6 @@ methods: package: botbuilder-lg summary: Delete an exist template. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deleteTemplate(templateName: string): Templates' @@ -356,16 +333,15 @@ methods: return: description: Return the new lg file. type: - - name: 'evaluate(string, object, EvaluationOptions)' + - name: evaluate(string, object, EvaluationOptions) uid: botbuilder-lg.Templates.evaluate package: botbuilder-lg summary: Evaluate a template with given name and scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function evaluate(templateName: string, scope?: object, opt: + function evaluate(templateName: string, scope?: object, opt?: EvaluationOptions): any parameters: - id: templateName @@ -380,16 +356,15 @@ methods: return: description: Evaluate result. type: any - - name: 'evaluateText(string, object, EvaluationOptions)' + - name: evaluateText(string, object, EvaluationOptions) uid: botbuilder-lg.Templates.evaluateText package: botbuilder-lg summary: Use to evaluate an inline template str. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function evaluateText(inlineStr: string, scope?: object, opt: + function evaluateText(inlineStr: string, scope?: object, opt?: EvaluationOptions): any parameters: - id: inlineStr @@ -404,18 +379,17 @@ methods: return: description: Evaluated result object. type: any - - name: 'expandTemplate(string, object, EvaluationOptions)' + - name: expandTemplate(string, object, EvaluationOptions) uid: botbuilder-lg.Templates.expandTemplate package: botbuilder-lg summary: |- Expand a template with given name and scope. Return all possible responses instead of random one. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function expandTemplate(templateName: string, scope?: object, opt: + function expandTemplate(templateName: string, scope?: object, opt?: EvaluationOptions): any[] parameters: - id: templateName @@ -429,13 +403,12 @@ methods: description: EvaluationOptions in expanding a template. return: description: Expand result. - type: 'any[]' - - name: 'parseFile(string, ImportResolverDelegate, ExpressionParser)' + type: any[] + - name: parseFile(string, ImportResolverDelegate, ExpressionParser) uid: botbuilder-lg.Templates.parseFile package: botbuilder-lg summary: Parse a file and return LG file. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -454,12 +427,11 @@ methods: return: description: New lg file. type: - - name: 'parseResource(LGResource, ImportResolverDelegate, ExpressionParser)' + - name: parseResource(LGResource, ImportResolverDelegate, ExpressionParser) uid: botbuilder-lg.Templates.parseResource package: botbuilder-lg summary: Parser to turn lg content into a Templates. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -478,17 +450,16 @@ methods: return: description: Entity. type: - - name: 'parseText(string, string, ImportResolverDelegate, ExpressionParser)' + - name: parseText(string, string, ImportResolverDelegate, ExpressionParser) uid: botbuilder-lg.Templates.parseText package: botbuilder-lg summary: Parser to turn lg content into a Templates. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: This method will soon be deprecated. Use ParseResource instead. syntax: content: >- - static function parseText(content: string, id: string, importResolver?: + static function parseText(content: string, id?: string, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates parameters: - id: content @@ -508,32 +479,29 @@ methods: return: description: Entity. type: - - name: 'push(Template[])' + - name: push(Template[]) uid: botbuilder-lg.Templates.push package: botbuilder-lg summary: Appends 1 or more templates to the collection. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function push(args: Template[])' parameters: - id: args - type: '[]' - description: | - List of templates to add. + type: [] + description: List of templates to add. - name: toArray() uid: botbuilder-lg.Templates.toArray package: botbuilder-lg summary: Gets the collection of templates. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toArray(): Template[]' return: description: A reference to the internal list of collection templates. - type: '[]' + type: [] - name: toString() uid: botbuilder-lg.Templates.toString package: botbuilder-lg @@ -541,7 +509,6 @@ methods: Returns a string representation of a [Templates](xref:botbuilder-lg.Templates) content. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toString(): string' @@ -550,12 +517,11 @@ methods: A string representation of a [Templates](xref:botbuilder-lg.Templates) content. type: string - - name: 'updateTemplate(string, string, string[], string)' + - name: updateTemplate(string, string, string[], string) uid: botbuilder-lg.Templates.updateTemplate package: botbuilder-lg summary: Update a template and return LG file. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -569,7 +535,7 @@ methods: type: string description: New template name. - id: parameters - type: 'string[]' + type: string[] description: New params. - id: templateBody type: string @@ -577,3 +543,14 @@ methods: return: description: New lg file. type: + - name: '[iterator]()' + uid: botbuilder-lg.Templates.[iterator] + package: botbuilder-lg + summary: Iterates over values in the template collection. + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): Iterator' + return: + description: A new iterator for the template collection. + type: Iterator<, any, undefined> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesParser.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesParser.yml index 177a3334..c1c3edb5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesParser.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesParser.yml @@ -5,7 +5,6 @@ package: botbuilder-lg summary: LG Parser fullName: TemplatesParser remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,12 +14,9 @@ properties: summary: Import regex. fullName: importRegex remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static importRegex: RegExp = new - RegExp(/\[([^\]]*)\]\(([^)]*)\)([\w\s]*)/) + content: 'static importRegex: RegExp' return: description: '' type: RegExp @@ -30,10 +26,9 @@ properties: summary: Inline text id. fullName: inlineContentId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static inlineContentId: string = "inline content"' + content: 'static inlineContentId: string' return: description: '' type: string @@ -43,10 +38,9 @@ properties: summary: option regex. fullName: optionRegex remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static optionRegex: RegExp = new RegExp(/>\s*!#(.*)$/)' + content: 'static optionRegex: RegExp' return: description: '' type: RegExp @@ -56,7 +50,6 @@ methods: package: botbuilder-lg summary: Parse LG content and return the AST. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function antlrParseTemplates(resource: LGResource): FileContext' @@ -67,14 +60,13 @@ methods: return: description: The abstract syntax tree of lg file. type: - - name: 'defaultFileResolver(LGResource, string)' + - name: defaultFileResolver(LGResource, string) uid: botbuilder-lg.TemplatesParser.defaultFileResolver package: botbuilder-lg summary: >- Default import resolver, using relative/absolute file path to access the file content. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -90,12 +82,11 @@ methods: return: description: Accessed lg resource. type: - - name: 'parseFile(string, ImportResolverDelegate, ExpressionParser)' + - name: parseFile(string, ImportResolverDelegate, ExpressionParser) uid: botbuilder-lg.TemplatesParser.parseFile package: botbuilder-lg summary: Parse a file and return LG file. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,12 +105,11 @@ methods: return: description: New lg file. type: - - name: 'parseResource(LGResource, ImportResolverDelegate, ExpressionParser)' + - name: parseResource(LGResource, ImportResolverDelegate, ExpressionParser) uid: botbuilder-lg.TemplatesParser.parseResource package: botbuilder-lg summary: Parser to turn lg content into a Templates. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -138,17 +128,16 @@ methods: return: description: Entity. type: - - name: 'parseText(string, string, ImportResolverDelegate, ExpressionParser)' + - name: parseText(string, string, ImportResolverDelegate, ExpressionParser) uid: botbuilder-lg.TemplatesParser.parseText package: botbuilder-lg summary: Parser to turn lg content into a Templates. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: This method will soon be deprecated. Use ParseResource instead. syntax: content: >- - static function parseText(content: string, id: string, importResolver?: + static function parseText(content: string, id?: string, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates parameters: - id: content @@ -168,14 +157,13 @@ methods: return: description: Entity. type: - - name: 'parseTextWithRef(string, Templates)' + - name: parseTextWithRef(string, Templates) uid: botbuilder-lg.TemplatesParser.parseTextWithRef package: botbuilder-lg summary: >- Parser to turn lg content into a Templates based on the original Templates. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesTransformer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesTransformer.yml index b85d12d0..0023f5fb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesTransformer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/TemplatesTransformer.yml @@ -7,7 +7,6 @@ summary: >- object. fullName: TemplatesTransformer remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,25 +17,23 @@ constructors: Creates a new instance of the [TemplatesTransformer](xref:botbuilder-lg.TemplatesTransformer) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new TemplatesTransformer(templates: Templates)' parameters: - id: templates type: - description: | - Templates. + description: Templates. inheritedMethods: - name: visit(ParseTree) uid: botbuilder-lg.TemplatesTransformer.visit package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation calls on the specified tree. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visit(tree: ParseTree)' @@ -48,8 +45,9 @@ inheritedMethods: - name: visitChildren(RuleNode) uid: botbuilder-lg.TemplatesTransformer.visitChildren package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation initializes the aggregate result to [defaultResult()](xref:%23defaultResult). Before visiting each child, it calls [shouldVisitNextChild](xref:%23shouldVisitNextChild); if the result @@ -62,7 +60,6 @@ inheritedMethods: the tree structure. Visitors that modify the tree should override this method to behave properly in respect to the specific algorithm in use. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitChildren(node: RuleNode)' @@ -74,12 +71,12 @@ inheritedMethods: - name: visitErrorNode(ErrorNode) uid: botbuilder-lg.TemplatesTransformer.visitErrorNode package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorNode(node: ErrorNode)' @@ -91,12 +88,12 @@ inheritedMethods: - name: visitTerminal(TerminalNode) uid: botbuilder-lg.TemplatesTransformer.visitTerminal package: botbuilder-lg - summary: | + summary: |- {@inheritDoc} + The default implementation returns the result of [defaultResult](xref:%23defaultResult). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTerminal(node: TerminalNode)' @@ -111,7 +108,6 @@ methods: package: botbuilder-lg summary: Transform the parse tree into templates. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function transform(parseTree: ParseTree): Templates' @@ -127,55 +123,47 @@ methods: package: botbuilder-lg summary: Visit a parse tree produced by `LGFileParser.errorDefinition`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitErrorDefinition(context: ErrorDefinitionContext)' parameters: - id: context type: - description: | - The parse tree. + description: The parse tree. - name: visitImportDefinition(ImportDefinitionContext) uid: botbuilder-lg.TemplatesTransformer.visitImportDefinition package: botbuilder-lg summary: Visit a parse tree produced by `LGFileParser.importDefinition`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitImportDefinition(context: ImportDefinitionContext)' parameters: - id: context type: - description: | - The parse tree. + description: The parse tree. - name: visitOptionDefinition(OptionDefinitionContext) uid: botbuilder-lg.TemplatesTransformer.visitOptionDefinition package: botbuilder-lg summary: Visit a parse tree produced by `LGFileParser.optionDefinition`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitOptionDefinition(context: OptionDefinitionContext)' parameters: - id: context type: - description: | - The parse tree. + description: The parse tree. - name: visitTemplateDefinition(TemplateDefinitionContext) uid: botbuilder-lg.TemplatesTransformer.visitTemplateDefinition package: botbuilder-lg summary: Visit a parse tree produced by `LGFileParser.templateDefinition`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function visitTemplateDefinition(context: TemplateDefinitionContext)' parameters: - id: context type: - description: | - The parse tree. + description: The parse tree. extends: AbstractParseTreeVisitor<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/index.yml index b01dd0a3..fac00e27 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-lg/index.yml @@ -3,47 +3,53 @@ uid: botbuilder-lg name: botbuilder-lg summary: '' type: package +enums: + - botbuilder-lg.DiagnosticSeverity + - botbuilder-lg.FileFormat + - botbuilder-lg.LGCacheScope + - botbuilder-lg.LGLineBreakStyle classes: - botbuilder-lg.Analyzer - botbuilder-lg.AnalyzerOptions - botbuilder-lg.AnalyzerResult + - botbuilder-lg.BodyContext + - botbuilder-lg.CommentDefinitionContext - botbuilder-lg.CustomizedMemory - botbuilder-lg.Diagnostic + - botbuilder-lg.ErrorDefinitionContext - botbuilder-lg.ErrorListener + - botbuilder-lg.ErrorStructureLineContext + - botbuilder-lg.ErrorStructuredNameContext + - botbuilder-lg.ErrorTemplateStringContext - botbuilder-lg.EvaluationOptions - botbuilder-lg.EvaluationTarget - botbuilder-lg.Evaluator - botbuilder-lg.Expander - - botbuilder-lg.Extractor - - botbuilder-lg.LGFileLexer - - botbuilder-lg.CommentDefinitionContext - - botbuilder-lg.ErrorDefinitionContext - - botbuilder-lg.FileContext - - botbuilder-lg.ImportDefinitionContext - - botbuilder-lg.LGFileParser - - botbuilder-lg.OptionDefinitionContext - - botbuilder-lg.ParagraphContext - - botbuilder-lg.TemplateBodyContext - - botbuilder-lg.TemplateBodyLineContext - - botbuilder-lg.TemplateDefinitionContext - - botbuilder-lg.TemplateNameLineContext - - botbuilder-lg.LGTemplateLexer - - botbuilder-lg.BodyContext - - botbuilder-lg.ErrorStructureLineContext - - botbuilder-lg.ErrorStructuredNameContext - - botbuilder-lg.ErrorTemplateStringContext - botbuilder-lg.ExpressionContext - botbuilder-lg.ExpressionInStructureContext + - botbuilder-lg.Extractor + - botbuilder-lg.FileContext - botbuilder-lg.IfConditionContext - botbuilder-lg.IfConditionRuleContext - botbuilder-lg.IfElseBodyContext - botbuilder-lg.IfElseTemplateBodyContext + - botbuilder-lg.ImportDefinitionContext - botbuilder-lg.KeyValueStructureLineContext - botbuilder-lg.KeyValueStructureValueContext + - botbuilder-lg.LGFileLexer + - botbuilder-lg.LGFileParser + - botbuilder-lg.LGResource + - botbuilder-lg.LGTemplateLexer - botbuilder-lg.LGTemplateParser + - botbuilder-lg.MultiLanguageLG - botbuilder-lg.NormalBodyContext - botbuilder-lg.NormalTemplateBodyContext - botbuilder-lg.NormalTemplateStringContext + - botbuilder-lg.OptionDefinitionContext + - botbuilder-lg.ParagraphContext + - botbuilder-lg.Position + - botbuilder-lg.Range + - botbuilder-lg.StaticChecker - botbuilder-lg.StructuredBodyContentLineContext - botbuilder-lg.StructuredBodyContext - botbuilder-lg.StructuredBodyEndLineContext @@ -53,27 +59,20 @@ classes: - botbuilder-lg.SwitchCaseRuleContext - botbuilder-lg.SwitchCaseStatContext - botbuilder-lg.SwitchCaseTemplateBodyContext - - botbuilder-lg.TemplateContext - - botbuilder-lg.TemplateStringContext - - botbuilder-lg.LGResource - - botbuilder-lg.MultiLanguageLG - - botbuilder-lg.Position - - botbuilder-lg.Range - - botbuilder-lg.SourceRange - - botbuilder-lg.StaticChecker - botbuilder-lg.Template + - botbuilder-lg.TemplateBodyContext + - botbuilder-lg.TemplateBodyLineContext + - botbuilder-lg.TemplateContext + - botbuilder-lg.TemplateDefinitionContext - botbuilder-lg.TemplateErrors - botbuilder-lg.TemplateException - botbuilder-lg.TemplateExtensions - botbuilder-lg.TemplateImport + - botbuilder-lg.TemplateNameLineContext + - botbuilder-lg.TemplateStringContext - botbuilder-lg.Templates - botbuilder-lg.TemplatesParser - botbuilder-lg.TemplatesTransformer -enums: - - botbuilder-lg.DiagnosticSeverity - - botbuilder-lg.LGCacheScope - - botbuilder-lg.LGLineBreakStyle - - botbuilder-lg.FileFormat interfaces: - botbuilder-lg.LGFileParserListener - botbuilder-lg.LGFileParserVisitor diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Extends.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Extends.yml new file mode 100644 index 00000000..edb6073a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Extends.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: Extends +uid: botbuilder-stdlib.Extends +package: botbuilder-stdlib +summary: '' +fullName: Extends +remarks: '' +isDeprecated: false +syntax: | + type Extends = Function & { prototype: T } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Maybe.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Maybe.yml new file mode 100644 index 00000000..f1ec6110 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Maybe.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: Maybe +uid: botbuilder-stdlib.Maybe +package: botbuilder-stdlib +summary: '' +fullName: Maybe +remarks: '' +isDeprecated: false +syntax: | + type Maybe = T | Nil diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Newable.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Newable.yml new file mode 100644 index 00000000..244e9b58 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Newable.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: Newable +uid: botbuilder-stdlib.Newable +package: botbuilder-stdlib +summary: '' +fullName: Newable +remarks: '' +isDeprecated: false +syntax: | + type Newable = (args: A) => T diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Nil.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Nil.yml new file mode 100644 index 00000000..5e22767f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/Nil.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: Nil +uid: botbuilder-stdlib.Nil +package: botbuilder-stdlib +summary: '' +fullName: Nil +remarks: '' +isDeprecated: false +syntax: | + type Nil = null | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/index.yml new file mode 100644 index 00000000..f70bd3d1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/index.yml @@ -0,0 +1,145 @@ +### YamlMime:TSPackage +uid: botbuilder-stdlib +name: botbuilder-stdlib +summary: '' +type: package +typeAliases: + - botbuilder-stdlib.Extends + - botbuilder-stdlib.Maybe + - botbuilder-stdlib.Newable + - botbuilder-stdlib.Nil +functions: + - name: delay(Promise, number) + uid: botbuilder-stdlib.delay + package: botbuilder-stdlib + summary: Delay resolution of `promise` + remarks: '' + isDeprecated: false + syntax: + content: 'function delay(promise: Promise, milliseconds: number): Promise' + parameters: + - id: promise + type: Promise<T> + description: an optional promise to delay + - id: milliseconds + type: number + description: how long to delay + return: + description: >- + a promise that will resolve to the result of `promise`, delayed by + `milliseconds`. + type: Promise<T> + - name: delay(number) + uid: botbuilder-stdlib.delay_1 + package: botbuilder-stdlib + summary: Return a promise that resolves after `milliseconds`. + remarks: '' + isDeprecated: false + syntax: + content: 'function delay(milliseconds: number): Promise' + parameters: + - id: milliseconds + type: number + description: how long to delay + return: + description: >- + a promise that will resolve to the result of `promise`, delayed by + `milliseconds`. + type: Promise<void> + - name: maybeCast(unknown, Newable) + uid: botbuilder-stdlib.maybeCast + package: botbuilder-stdlib + summary: Maybe cast value to a particular type + remarks: '' + isDeprecated: false + syntax: + content: 'function maybeCast(value: unknown, ctor?: Newable): T' + parameters: + - id: value + type: unknown + description: value to maybe cast + - id: ctor + type: <T, unknown[]> + description: optional class to perform instanceof check + return: + description: value, maybe casted to T + type: T + - name: 'retry((n: number) => Promise, number, number)' + uid: botbuilder-stdlib.retry + package: botbuilder-stdlib + summary: Retry a given promise with gradually increasing delay. + remarks: '' + isDeprecated: false + syntax: + content: >- + function retry(promise: (n: number) => Promise, maxRetries: + number, initialDelay?: number): Promise + parameters: + - id: promise + type: '(n: number) => Promise<T>' + description: a function that returns a promise to retry + - id: maxRetries + type: number + description: the maximum number of times to retry + - id: initialDelay + type: number + description: the initial value to delay before retrying (in milliseconds) + return: + description: >- + a promise resolving to the result of the promise from the promise + generating function, or undefined + type: Promise<T | undefined> + - name: 'stringify(any, (key: string, value: any) => any, string | number)' + uid: botbuilder-stdlib.stringify + package: botbuilder-stdlib + summary: >+ + Encapsulates JSON.stringify function to detect and handle different types + of errors (eg. Circular Structure). + + + **Example** + + + ```ts + + // Circular Structure: + { + "item": { + "name": "parent", + "parent": null, + "child": { + "name": "child", + "parent": "[Circular *.item]" // => obj.item.child.parent = obj.item + } + } + } + ``` + + remarks: |- + Circular Structure: + - It detects when the provided value has circular references and replaces them with [Circular *.{path to the value being referenced}]. + + _replacer internal function: + - Have similar functionality as the JSON.stringify internal toJSON function, but with the difference that only affects this stringify functionality. + isDeprecated: false + syntax: + content: >- + function stringify(value: any, replacer?: (key: string, value: any) => + any, space?: string | number): string + parameters: + - id: value + type: any + description: — A JavaScript value, usually an object or array, to be converted. + - id: replacer + type: '(key: string, value: any) => any' + description: — A function that transforms the results. + - id: space + type: string | number + description: >- + — Adds indentation, white space, and line break characters to the + return-value JSON text to make it easier to read. + return: + description: >- + The converted JavaScript value to a JavaScript Object Notation (JSON) + string. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/stringExt.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/stringExt.yml new file mode 100644 index 00000000..b60200c3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-stdlib/stringExt.yml @@ -0,0 +1,22 @@ +### YamlMime:TSPackage +uid: botbuilder-stdlib.stringExt +name: stringExt +type: module +package: botbuilder-stdlib +summary: '' +functions: + - name: isNilOrEmpty(string | Nil) + uid: botbuilder-stdlib.stringExt.isNilOrEmpty + package: botbuilder-stdlib + summary: Check if a string is nil or empty. + remarks: '' + isDeprecated: false + syntax: + content: 'function isNilOrEmpty(val: string | Nil): boolean' + parameters: + - id: val + type: string | + description: a value that may be a string + return: + description: true if the string is nil or empty + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestClient.yml index efae10c3..eaed21f2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestClient.yml @@ -5,11 +5,12 @@ package: botbuilder-testing summary: A client for testing dialogs in isolation. fullName: DialogTestClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DialogTestClient(string, Dialog, unknown, Middleware[], ConversationState)' + - name: >- + DialogTestClient(string, Dialog<{}>, unknown, Middleware[], + ConversationState) uid: botbuilder-testing.DialogTestClient.constructor package: botbuilder-testing summary: >- @@ -27,11 +28,10 @@ constructors: ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new DialogTestClient(channelId: string, targetDialog: Dialog, + new DialogTestClient(channelId: string, targetDialog: Dialog<{}>, initialDialogOptions?: unknown, middlewares?: Middleware[], conversationState?: ConversationState) parameters: @@ -46,7 +46,7 @@ constructors: Otherwise, it is recommended that you use the id for the channel(s) your bot will be using and write a test case for each channel. - id: targetDialog - type: Dialog + type: Dialog<{}> description: >- The [Dialog](xref:botbuilder-dialogs.Dialog) to be tested. This will be the root dialog for the test client. @@ -56,18 +56,18 @@ constructors: Optional. Additional argument(s) to pass to the [Dialog](xref:botbuilder-dialogs.Dialog) being started. - id: middlewares - type: 'Middleware[]' + type: Middleware[] description: >- Optional. A [Middleware](xref:botbuilder-core.Middleware) list to be added to the test adapter. - id: conversationState type: ConversationState - description: > + description: >- Optional. A [ConversationState](xref:botbuilder-core.ConversationState) instance to use in the test client. - name: >- - DialogTestClient(TestAdapter, Dialog, unknown, Middleware[], + DialogTestClient(TestAdapter, Dialog<{}>, unknown, Middleware[], ConversationState) uid: botbuilder-testing.DialogTestClient.constructor_1 package: botbuilder-testing @@ -86,19 +86,18 @@ constructors: ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new DialogTestClient(testAdapter: TestAdapter, targetDialog: Dialog, + new DialogTestClient(testAdapter: TestAdapter, targetDialog: Dialog<{}>, initialDialogOptions?: unknown, middlewares?: Middleware[], conversationState?: ConversationState) parameters: - id: testAdapter type: TestAdapter - description: 'The [TestAdapter](xref:botbuilder-core.TestAdapter) to use.' + description: The [TestAdapter](xref:botbuilder-core.TestAdapter) to use. - id: targetDialog - type: Dialog + type: Dialog<{}> description: >- The [Dialog](xref:botbuilder-dialogs.Dialog) to be tested. This will be the root dialog for the test client. @@ -108,13 +107,13 @@ constructors: Optional. Additional argument(s) to pass to the [Dialog](xref:botbuilder-dialogs.Dialog) being started. - id: middlewares - type: 'Middleware[]' + type: Middleware[] description: >- Optional. A [Middleware](xref:botbuilder-core.Middleware) list to be added to the test adapter. - id: conversationState type: ConversationState - description: > + description: >- Optional. A [ConversationState](xref:botbuilder-core.ConversationState) instance to use in the test client. @@ -125,7 +124,6 @@ properties: summary: A ConversationState instance for the current test client. fullName: conversationState remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationState: ConversationState' @@ -137,10 +135,7 @@ properties: package: botbuilder-testing summary: Gets a reference for the DialogContext. fullName: dialogContext - remarks: >- - This property will be null until at least one activity is sent to - DialogTestClient. - isPreview: false + remarks: '' isDeprecated: false syntax: content: DialogContext dialogContext @@ -153,44 +148,42 @@ properties: summary: A DialogTurnResult instance with the result of the last turn. fullName: dialogTurnResult remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'dialogTurnResult: DialogTurnResult' + content: 'dialogTurnResult: DialogTurnResult' return: description: '' - type: DialogTurnResult + type: DialogTurnResult<any> methods: - name: getNextReply() uid: botbuilder-testing.DialogTestClient.getNextReply package: botbuilder-testing summary: Get the next reply waiting to be delivered (if one exists) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getNextReply(): Partial' return: description: the next reply type: Partial<Activity> - - name: sendActivity(Partial | string) + - name: sendActivity(string | Partial) uid: botbuilder-testing.DialogTestClient.sendActivity package: botbuilder-testing - summary: | + summary: |- Send an activity into the dialog. + ```javascript await DialogTest.send('hello').assertReply('hello yourself').startTest(); ``` remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function sendActivity(activity: Partial | string): + function sendActivity(activity: string | Partial): Promise parameters: - id: activity - type: Partial<Activity> | string + type: string | Partial<Activity> description: an activity potentially with text return: description: a TestFlow that can be used to assert replies etc diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestLogger.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestLogger.yml index 3ac04289..bf50045a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestLogger.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/DialogTestLogger.yml @@ -2,12 +2,13 @@ name: DialogTestLogger uid: botbuilder-testing.DialogTestLogger package: botbuilder-testing -summary: > +summary: >- Log a transcript of messages from a dialog to the console, along with additional diagnostic information. For use with the `DialogTestClient` class. + Example: ```javascript @@ -17,7 +18,6 @@ summary: > ``` fullName: DialogTestLogger remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -28,22 +28,19 @@ constructors: Initializes a new instance of the [DialogTestLogger](xref:botbuilder-testing.DialogTestLogger) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DialogTestLogger(logger?: Logger)' parameters: - id: logger type: - description: | - A logger object with a `log` function. + description: A logger object with a `log` function. methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder-testing.DialogTestLogger.onTurn package: botbuilder-testing summary: Called each time the bot receives a new request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -53,8 +50,8 @@ methods: - id: context type: TurnContext description: >- - (xref:botbuilder-core.TurnContext) for current turn of conversation - with the user. + [TurnContext](xref:botbuilder-core.TurnContext) for current turn of + conversation with the user. - id: next type: () => Promise<void> description: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/Logger.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/Logger.yml index 363df1e6..f4bfbbbb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/Logger.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder-testing/Logger.yml @@ -2,10 +2,9 @@ name: Logger uid: botbuilder-testing.Logger package: botbuilder-testing -summary: 'Logger describes something that can log data, i.e. console' +summary: Logger describes something that can log data, i.e. console fullName: Logger remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Log some data fullName: log remarks: '' - isPreview: false isDeprecated: false syntax: content: 'log: (args: unknown[]) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AceCardSize.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AceCardSize.yml new file mode 100644 index 00000000..bfb231c8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AceCardSize.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: AceCardSize +uid: botbuilder.AceCardSize +package: botbuilder +summary: SharePoint ACE Card Size +fullName: AceCardSize +remarks: '' +isDeprecated: false +syntax: | + type AceCardSize = "Medium" | "Large" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AceData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AceData.yml new file mode 100644 index 00000000..9c228146 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AceData.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: AceData +uid: botbuilder.AceData +package: botbuilder +summary: SharePoint ACE Data object +fullName: AceData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardSize + uid: botbuilder.AceData.cardSize + package: botbuilder + summary: The card size. + fullName: cardSize + remarks: '' + isDeprecated: false + syntax: + content: 'cardSize: AceCardSize' + return: + description: '' + type: + - name: dataVersion + uid: botbuilder.AceData.dataVersion + package: botbuilder + summary: >- + The value of this property is stored in the serialized data of the + Adaptive Card Extension. + + It can be used to manage versioning of the Adaptive Card Extension. + fullName: dataVersion + remarks: >- + - although there is no restriction on the format of this property, it is + recommended to use semantic versioning. + isDeprecated: false + syntax: + content: 'dataVersion: string' + return: + description: '' + type: string + - name: description + uid: botbuilder.AceData.description + package: botbuilder + summary: The description of the ACE. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description: string' + return: + description: '' + type: string + - name: iconProperty + uid: botbuilder.AceData.iconProperty + package: botbuilder + summary: The icon of the ACE. + fullName: iconProperty + remarks: '' + isDeprecated: false + syntax: + content: 'iconProperty: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.AceData.id + package: botbuilder + summary: The unique id (Guid) of the ACE. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: isVisible + uid: botbuilder.AceData.isVisible + package: botbuilder + summary: |- + The visibility of the Adaptive Card Extension. + true if not specified. + fullName: isVisible + remarks: '' + isDeprecated: false + syntax: + content: 'isVisible?: boolean' + return: + description: '' + type: boolean + - name: properties + uid: botbuilder.AceData.properties + package: botbuilder + summary: The properties of the ACE. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties: any' + return: + description: '' + type: any + - name: title + uid: botbuilder.AceData.title + package: botbuilder + summary: The title of the ACE. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AceRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AceRequest.yml new file mode 100644 index 00000000..c379a055 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AceRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AceRequest +uid: botbuilder.AceRequest +package: botbuilder +summary: ACE invoke request payload. +fullName: AceRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder.AceRequest.data + package: botbuilder + summary: User ACE request data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + - name: properties + uid: botbuilder.AceRequest.properties + package: botbuilder + summary: ACE properties data. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Action.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Action.yml new file mode 100644 index 00000000..eee7cea5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Action.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Action +uid: botbuilder.Action +package: botbuilder +summary: |- + Defines values for Action. + Possible values include: 'accept', 'decline' +fullName: Action +remarks: '' +isDeprecated: false +syntax: | + type Action = "accept" | "decline" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActionTypes.yml new file mode 100644 index 00000000..cc753aa9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActionTypes.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: ActionTypes +uid: botbuilder.ActionTypes +package: botbuilder +summary: >- + Defines values for ActionTypes. + + Possible values include: 'openUrl', 'imBack', 'postBack', 'playAudio', + 'playVideo', 'showImage', + + 'downloadFile', 'signin', 'call', messageBack', 'openApp' +fullName: ActionTypes +remarks: '' +isDeprecated: false +fields: + - name: Call + uid: botbuilder.ActionTypes.Call + package: botbuilder + summary: '' + - name: DownloadFile + uid: botbuilder.ActionTypes.DownloadFile + package: botbuilder + summary: '' + - name: ImBack + uid: botbuilder.ActionTypes.ImBack + package: botbuilder + summary: '' + - name: MessageBack + uid: botbuilder.ActionTypes.MessageBack + package: botbuilder + summary: '' + - name: OpenApp + uid: botbuilder.ActionTypes.OpenApp + package: botbuilder + summary: '' + - name: OpenUrl + uid: botbuilder.ActionTypes.OpenUrl + package: botbuilder + summary: '' + - name: Payment + uid: botbuilder.ActionTypes.Payment + package: botbuilder + summary: '' + - name: PlayAudio + uid: botbuilder.ActionTypes.PlayAudio + package: botbuilder + summary: '' + - name: PlayVideo + uid: botbuilder.ActionTypes.PlayVideo + package: botbuilder + summary: '' + - name: PostBack + uid: botbuilder.ActionTypes.PostBack + package: botbuilder + summary: '' + - name: ShowImage + uid: botbuilder.ActionTypes.ShowImage + package: botbuilder + summary: '' + - name: Signin + uid: botbuilder.ActionTypes.Signin + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Activity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Activity.yml new file mode 100644 index 00000000..8c0da708 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Activity.yml @@ -0,0 +1,594 @@ +### YamlMime:TSType +name: Activity +uid: botbuilder.Activity +package: botbuilder +summary: >- + An Activity is the basic communication type for the Bot Framework 3.0 + protocol. +fullName: Activity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder.Activity.action + package: botbuilder + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string + - name: attachmentLayout + uid: botbuilder.Activity.attachmentLayout + package: botbuilder + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + - name: attachments + uid: botbuilder.Activity.attachments + package: botbuilder + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + - name: callerId + uid: botbuilder.Activity.callerId + package: botbuilder + summary: >- + A string containing a URI identifying the caller of a bot. This field is + not intended to be transmitted over + + the wire, but is instead populated by bots and clients based on + cryptographically verifiable data that asserts + + the identity of the callers (e.g. tokens). + fullName: callerId + remarks: '' + isDeprecated: false + syntax: + content: 'callerId: string' + return: + description: '' + type: string + - name: channelData + uid: botbuilder.Activity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + - name: channelId + uid: botbuilder.Activity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: code + uid: botbuilder.Activity.code + package: botbuilder + summary: >- + The a code for endOfConversation activities that indicates why the + conversation ended. + + Possible values include: 'unknown', 'completedSuccessfully', + 'userCancelled', 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + - name: conversation + uid: botbuilder.Activity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: deliveryMode + uid: botbuilder.Activity.deliveryMode + package: botbuilder + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification', 'expectReplies', 'ephemeral' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + - name: entities + uid: botbuilder.Activity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + - name: expiration + uid: botbuilder.Activity.expiration + package: botbuilder + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + - name: from + uid: botbuilder.Activity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + - name: historyDisclosed + uid: botbuilder.Activity.historyDisclosed + package: botbuilder + summary: Indicates whether the prior history of the channel is disclosed. + fullName: historyDisclosed + remarks: '' + isDeprecated: false + syntax: + content: 'historyDisclosed?: boolean' + return: + description: '' + type: boolean + - name: id + uid: botbuilder.Activity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: importance + uid: botbuilder.Activity.importance + package: botbuilder + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + - name: inputHint + uid: botbuilder.Activity.inputHint + package: botbuilder + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder.Activity.label + package: botbuilder + summary: A descriptive label for the activity. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: listenFor + uid: botbuilder.Activity.listenFor + package: botbuilder + summary: >- + List of phrases and references that speech and language priming systems + should listen for + fullName: listenFor + remarks: '' + isDeprecated: false + syntax: + content: 'listenFor: string[]' + return: + description: '' + type: string[] + - name: locale + uid: botbuilder.Activity.locale + package: botbuilder + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: localTimestamp + uid: botbuilder.Activity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + - name: localTimezone + uid: botbuilder.Activity.localTimezone + package: botbuilder + summary: >- + Contains the name of the local timezone of the message, expressed in IANA + Time Zone database format. + + For example, America/Los_Angeles. + fullName: localTimezone + remarks: '' + isDeprecated: false + syntax: + content: 'localTimezone: string' + return: + description: '' + type: string + - name: membersAdded + uid: botbuilder.Activity.membersAdded + package: botbuilder + summary: The collection of members added to the conversation. + fullName: membersAdded + remarks: '' + isDeprecated: false + syntax: + content: 'membersAdded?: ChannelAccount[]' + return: + description: '' + type: [] + - name: membersRemoved + uid: botbuilder.Activity.membersRemoved + package: botbuilder + summary: The collection of members removed from the conversation. + fullName: membersRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'membersRemoved?: ChannelAccount[]' + return: + description: '' + type: [] + - name: name + uid: botbuilder.Activity.name + package: botbuilder + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: reactionsAdded + uid: botbuilder.Activity.reactionsAdded + package: botbuilder + summary: The collection of reactions added to the conversation. + fullName: reactionsAdded + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsAdded?: MessageReaction[]' + return: + description: '' + type: [] + - name: reactionsRemoved + uid: botbuilder.Activity.reactionsRemoved + package: botbuilder + summary: The collection of reactions removed from the conversation. + fullName: reactionsRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsRemoved?: MessageReaction[]' + return: + description: '' + type: [] + - name: recipient + uid: botbuilder.Activity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + - name: relatesTo + uid: botbuilder.Activity.relatesTo + package: botbuilder + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: replyToId + uid: botbuilder.Activity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + - name: semanticAction + uid: botbuilder.Activity.semanticAction + package: botbuilder + summary: An optional programmatic action accompanying this request + fullName: semanticAction + remarks: '' + isDeprecated: false + syntax: + content: 'semanticAction?: SemanticAction' + return: + description: '' + type: + - name: serviceUrl + uid: botbuilder.Activity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + - name: speak + uid: botbuilder.Activity.speak + package: botbuilder + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + - name: suggestedActions + uid: botbuilder.Activity.suggestedActions + package: botbuilder + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: summary + uid: botbuilder.Activity.summary + package: botbuilder + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.Activity.text + package: botbuilder + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: textFormat + uid: botbuilder.Activity.textFormat + package: botbuilder + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + - name: textHighlights + uid: botbuilder.Activity.textHighlights + package: botbuilder + summary: >- + The collection of text fragments to highlight when the activity contains a + ReplyToId value. + fullName: textHighlights + remarks: '' + isDeprecated: false + syntax: + content: 'textHighlights?: TextHighlight[]' + return: + description: '' + type: [] + - name: timestamp + uid: botbuilder.Activity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + - name: topicName + uid: botbuilder.Activity.topicName + package: botbuilder + summary: The updated topic name of the conversation. + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.Activity.type + package: botbuilder + summary: >- + Contains the activity type. Possible values include: 'message', + 'contactRelationUpdate', + + 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', + 'deleteUserData', + + 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', + 'suggestion', + + 'trace', 'handoff' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.Activity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + - name: valueType + uid: botbuilder.Activity.valueType + package: botbuilder + summary: The type of the activity's value object. + fullName: valueType + remarks: '' + isDeprecated: false + syntax: + content: 'valueType: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEventNames.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEventNames.yml new file mode 100644 index 00000000..a309bd2e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEventNames.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: ActivityEventNames +uid: botbuilder.ActivityEventNames +package: botbuilder +summary: |- + Defines values for ActivityEventNames. + Possible values include: 'continueConversation', 'createConversation' +fullName: ActivityEventNames +remarks: '' +isDeprecated: false +fields: + - name: ContinueConversation + uid: botbuilder.ActivityEventNames.ContinueConversation + package: botbuilder + summary: '' + - name: CreateConversation + uid: botbuilder.ActivityEventNames.CreateConversation + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEx.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEx.yml new file mode 100644 index 00000000..14b63d2b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityEx.yml @@ -0,0 +1,609 @@ +### YamlMime:TSPackage +uid: botbuilder.ActivityEx +name: ActivityEx +type: module +package: botbuilder +summary: '' +functions: + - name: asCommandActivity(Partial) + uid: botbuilder.ActivityEx.asCommandActivity + package: botbuilder + summary: >- + Returns the source activity as an ICommandActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asCommandActivity(source: Partial): + Partial> + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a command activity; or null. + type: Partial<<T>> + - name: asCommandResultActivity(Partial) + uid: botbuilder.ActivityEx.asCommandResultActivity + package: botbuilder + summary: >- + Returns the source activity as an ICommandResultActivity object; or null, + if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asCommandResultActivity(source: Partial): + Partial> + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a command result activity; or null. + type: >- + Partial<<T>> + - name: asContactRelationUpdateActivity(Partial) + uid: botbuilder.ActivityEx.asContactRelationUpdateActivity + package: botbuilder + summary: >- + Returns the source activity as an IContactRelationUpdateActivity object; + or null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asContactRelationUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a contact relation update activity; or null. + type: >- + Partial<> + - name: asConversationUpdateActivity(Partial) + uid: botbuilder.ActivityEx.asConversationUpdateActivity + package: botbuilder + summary: >- + Returns the source activity as an IConversationUpdateActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asConversationUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an conversation update activity; or null. + type: Partial<> + - name: asEndOfConversationActivity(Partial) + uid: botbuilder.ActivityEx.asEndOfConversationActivity + package: botbuilder + summary: >- + Returns the source activity as an IEndOfConversationActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asEndOfConversationActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an end of conversation activity; or null. + type: Partial<> + - name: asEventActivity(Partial) + uid: botbuilder.ActivityEx.asEventActivity + package: botbuilder + summary: >- + Returns the source activity as an IEventActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asEventActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an event activity; or null. + type: Partial<> + - name: asHandoffActivity(Partial) + uid: botbuilder.ActivityEx.asHandoffActivity + package: botbuilder + summary: >- + Returns the source activity as an IHandoffActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asHandoffActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a handoff activity; or null. + type: Partial<> + - name: asInstallationUpdateActivity(Partial) + uid: botbuilder.ActivityEx.asInstallationUpdateActivity + package: botbuilder + summary: >- + Returns the source activity as an IInstallationUpdateActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asInstallationUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an installation update activity; or null. + type: Partial<> + - name: asInvokeActivity(Partial) + uid: botbuilder.ActivityEx.asInvokeActivity + package: botbuilder + summary: >- + Returns the source activity as an IInvokeActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asInvokeActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as an invoke activity; or null. + type: Partial<> + - name: asMessageActivity(Partial) + uid: botbuilder.ActivityEx.asMessageActivity + package: botbuilder + summary: >- + Returns the source activity as an IMessageActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message activity; or null. + type: Partial<> + - name: asMessageDeleteActivity(Partial) + uid: botbuilder.ActivityEx.asMessageDeleteActivity + package: botbuilder + summary: >- + Returns the source activity as an IMessageDeleteActivity object; or null, + if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageDeleteActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message delete request; or null. + type: Partial<> + - name: asMessageReactionActivity(Partial) + uid: botbuilder.ActivityEx.asMessageReactionActivity + package: botbuilder + summary: >- + Returns the source activity as an IMessageReactionActivity object; or + null, if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageReactionActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message reaction activity; or null. + type: Partial<> + - name: asMessageUpdateActivity(Partial) + uid: botbuilder.ActivityEx.asMessageUpdateActivity + package: botbuilder + summary: >- + Returns the source activity as an IMessageUpdateActivity object; or null, + if this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asMessageUpdateActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a message update request; or null. + type: Partial<> + - name: asSuggestionActivity(Partial) + uid: botbuilder.ActivityEx.asSuggestionActivity + package: botbuilder + summary: >- + Returns the source activity as an ISuggestionActivity object; or null, if + this is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asSuggestionActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a suggestion activity; or null. + type: Partial<> + - name: asTraceActivity(Partial) + uid: botbuilder.ActivityEx.asTraceActivity + package: botbuilder + summary: >- + Returns the source activity as an ITraceActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asTraceActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a trace activity; or null. + type: Partial<> + - name: asTypingActivity(Partial) + uid: botbuilder.ActivityEx.asTypingActivity + package: botbuilder + summary: >- + Returns the source activity as an ITypingActivity object; or null, if this + is not that type of activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function asTypingActivity(source: Partial): + Partial + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: This activity as a typing activity; or null. + type: Partial<> + - name: createContactRelationUpdateActivity() + uid: botbuilder.ActivityEx.createContactRelationUpdateActivity + package: botbuilder + summary: Creates an Activity as an IContactRelationUpdateActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createContactRelationUpdateActivity(): + Partial + return: + description: The new contact relation update activity. + type: >- + Partial<> + - name: createConversationUpdateActivity() + uid: botbuilder.ActivityEx.createConversationUpdateActivity + package: botbuilder + summary: Creates an Activity as an IConversationUpdateActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createConversationUpdateActivity(): + Partial + return: + description: The new conversation update activity. + type: Partial<> + - name: createEndOfConversationActivity() + uid: botbuilder.ActivityEx.createEndOfConversationActivity + package: botbuilder + summary: Creates an Activity as an IEndOfConversationActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createEndOfConversationActivity(): + Partial + return: + description: The new end of conversation activity. + type: Partial<> + - name: createEventActivity() + uid: botbuilder.ActivityEx.createEventActivity + package: botbuilder + summary: Creates an Activity as an IEventActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createEventActivity(): Partial' + return: + description: The new event activity. + type: Partial<> + - name: createHandoffActivity() + uid: botbuilder.ActivityEx.createHandoffActivity + package: botbuilder + summary: Creates an Activity as an IHandoffActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createHandoffActivity(): Partial' + return: + description: The new handoff activity. + type: Partial<> + - name: createInvokeActivity() + uid: botbuilder.ActivityEx.createInvokeActivity + package: botbuilder + summary: Creates an Activity as an IInvokeActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createInvokeActivity(): Partial' + return: + description: The new invoke activity. + type: Partial<> + - name: createMessageActivity() + uid: botbuilder.ActivityEx.createMessageActivity + package: botbuilder + summary: Creates an Activity as an IMessageActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createMessageActivity(): Partial' + return: + description: The new message activity. + type: Partial<> + - name: createReply(Activity, string, string) + uid: botbuilder.ActivityEx.createReply + package: botbuilder + summary: Creates a new message activity as a response to this activity. + remarks: The new activity sets up routing information based on this activity. + isDeprecated: false + syntax: + content: >- + function createReply(source: Activity, text?: string, locale?: string): + Activity + parameters: + - id: source + type: + description: The activity to respond. + - id: text + type: string + description: The text of the reply. + - id: locale + type: string + description: The language code for the + return: + description: The new message activity. + type: + - name: createTrace(Activity, string, unknown, string, string) + uid: botbuilder.ActivityEx.createTrace + package: botbuilder + summary: Creates a new trace activity based on the source activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTrace(source: Activity, name: string, value?: unknown, + valueType?: string, label?: string): ITraceActivity + parameters: + - id: source + type: + description: The activity to base the trace. + - id: name + type: string + description: The name of the trace operation to create. + - id: value + type: unknown + description: Optional, the content for this trace operation. + - id: valueType + type: string + description: Optional, identifier for the format of the + - id: label + type: string + description: Optional, a descriptive label for this trace operation. + return: + description: The new trace activity. + type: + - name: createTraceActivity(string, string, unknown, string) + uid: botbuilder.ActivityEx.createTraceActivity + package: botbuilder + summary: Creates an Activity as an ITraceActivity object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createTraceActivity(name: string, valueType?: string, value?: + unknown, label?: string): Partial + parameters: + - id: name + type: string + description: The name of the trace operation to create. + - id: valueType + type: string + description: Optional, identifier for the format of the + - id: value + type: unknown + description: . Default is the name of type of the + - id: label + type: string + description: Optional, a descriptive label for this trace operation. + return: + description: The new trace activity. + type: Partial<> + - name: createTypingActivity() + uid: botbuilder.ActivityEx.createTypingActivity + package: botbuilder + summary: Creates an Activity as an ITypingActivity object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createTypingActivity(): Partial' + return: + description: The new typing activity. + type: Partial<> + - name: getContinuationActivity(Partial) + uid: botbuilder.ActivityEx.getContinuationActivity + package: botbuilder + summary: Creates an Activity from conversation reference as it is posted to bot. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getContinuationActivity(reference: + Partial): Partial + parameters: + - id: reference + type: Partial<> + description: the conversation reference + return: + description: the activity + type: Partial<> + - name: getConversationReference(Partial) + uid: botbuilder.ActivityEx.getConversationReference + package: botbuilder + summary: Creates a ConversationReference based on the source activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getConversationReference(source: Partial): + ConversationReference + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: >- + A conversation reference for the conversation that contains the + activity. + type: + - name: getMentions(Partial) + uid: botbuilder.ActivityEx.getMentions + package: botbuilder + summary: |- + Resolves the mentions from the entities of the source activity. + + See cref="entities" . + See cref="mention" . + remarks: >- + This method is only intended for use with a message activity, where the + Activity Type is set to Message. + isDeprecated: false + syntax: + content: 'function getMentions(source: Partial): Mention[]' + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: The array of mentions; or an empty array, if none are found. + type: [] + - name: hasContent(Partial) + uid: botbuilder.ActivityEx.hasContent + package: botbuilder + summary: Indicates whether the source activity has content. + remarks: >- + This method is only intended for use with a message activity, where the + Activity Type is set to Message. + isDeprecated: false + syntax: + content: 'function hasContent(source: Partial): boolean' + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: True, if this activity has any content to send; otherwise, false. + type: boolean + - name: isActivity(Partial, string) + uid: botbuilder.ActivityEx.isActivity + package: botbuilder + summary: Indicates whether this activity is of a specified activity type. + remarks: '' + isDeprecated: false + syntax: + content: >- + function isActivity(source: Partial, activityType: string): + boolean + parameters: + - id: source + type: Partial<> + description: The source activity. + - id: activityType + type: string + description: The activity type to check for. + return: + description: >- + True if the activity is of the specified activity type; otherwise, + false. + type: boolean + - name: isFromStreamingConnection(Partial) + uid: botbuilder.ActivityEx.isFromStreamingConnection + package: botbuilder + summary: >- + Determines if the Activity was sent via an Http/Https connection or + Streaming. + + This can be determined by looking at the ServiceUrl property: + + (1) All channels that send messages via http/https are not streaming + + (2) Channels that send messages via streaming have a ServiceUrl that does + not begin with http/https. + remarks: '' + isDeprecated: false + syntax: + content: 'function isFromStreamingConnection(source: Partial): boolean' + parameters: + - id: source + type: Partial<> + description: The source activity. + return: + description: True if the Activity was originate from a streaming connection. + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityFactory.yml new file mode 100644 index 00000000..481f3022 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityFactory.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: ActivityFactory +uid: botbuilder.ActivityFactory +package: botbuilder +summary: >- + The ActivityFactory + + to generate text and then uses simple markdown semantics like chatdown to + create Activity. +fullName: ActivityFactory +remarks: '' +isDeprecated: false +type: class +methods: + - name: fromObject(any) + uid: botbuilder.ActivityFactory.fromObject + package: botbuilder + summary: Generate the activity. + remarks: '' + isDeprecated: false + syntax: + content: 'static function fromObject(lgResult: any): Partial' + parameters: + - id: lgResult + type: any + description: string result from languageGenerator. + return: + description: The generated MessageActivity. + type: Partial<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBot.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandler.yml similarity index 64% rename from botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBot.yml rename to botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandler.yml index 4cc35837..c3a3207c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder-dialogs-adaptive-runtime/CoreBot.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandler.yml @@ -1,118 +1,128 @@ ### YamlMime:TSType -name: CoreBot -uid: botbuilder-dialogs-adaptive-runtime.CoreBot -package: botbuilder-dialogs-adaptive-runtime -summary: Implements an instance of CoreBot. -fullName: CoreBot -remarks: '' -isPreview: false +name: ActivityHandler +uid: botbuilder.ActivityHandler +package: botbuilder +summary: >- + Event-emitting activity handler for bots. Extends + [ActivityHandlerBase](xref:botbuilder-core.ActivityHandlerBase). +fullName: ActivityHandler +remarks: >- + This provides an extensible class for handling incoming activities in an + event-driven way. + + You can register an arbitrary set of handlers for each event type. + + + To register a handler for an event, use the corresponding _on event_ method. + If multiple handlers are + + registered for an event, they are run in the order in which they were + registered. + + + This object emits a series of _events_ as it processes an incoming activity. + + A handler can stop the propagation of the event by not calling the + continuation function. + + + | Event type | Description | + + | :--- | :--- | + + | Turn | Emitted first for every activity. | + + | Type-specific | Emitted for the specific activity type, before emitting an + event for any sub-type. | + + | Sub-type | Emitted for certain specialized events, based on activity + content. | + + | Dialog | Emitted as the final activity processing event. | + + + For example: + + + ```typescript + + const bot = new ActivityHandler(); + + + server.post('/api/messages', (req, res) => { + adapter.processActivity(req, res, async (context) => { + // Route to bot's activity logic. + await bot.run(context); + }); + }); + + + bot.onTurn(async (context, next) => { + // Handle a "turn" event. + await context.sendActivity(`${ context.activity.type } activity received.`); + // Continue with further processing. + await next(); + }) + .onMessage(async (context, next) => { + // Handle a message activity. + await context.sendActivity(`Echo: ${ context.activity.text }`); + // Continue with further processing. + await next(); + }); + ``` + + + **See also** + + - The [Bot Framework Activity schema](https://aka.ms/botSpecs-activitySchema) isDeprecated: false type: class -constructors: - - name: >- - CoreBot(ResourceExplorer, UserState, ConversationState, - BotFrameworkAuthentication, SkillConversationIdFactoryBase, - BotTelemetryClient, string, string, MemoryScope[], PathResolver[]) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.constructor - package: botbuilder-dialogs-adaptive-runtime - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new CoreBot(resourceExplorer: ResourceExplorer, userState: UserState, - conversationState: ConversationState, botFrameworkAuthentication: - BotFrameworkAuthentication, skillConversationIdFactory: - SkillConversationIdFactoryBase, botTelemetryClient: BotTelemetryClient, - defaultLocale: string, defaultRootDialog: string, memoryScopes: - MemoryScope[], pathResolvers: PathResolver[]) - parameters: - - id: resourceExplorer - type: ResourceExplorer - description: Services to access resources. - - id: userState - type: UserState - description: Stored user state. - - id: conversationState - type: ConversationState - description: Stored conversation state. - - id: botFrameworkAuthentication - type: BotFrameworkAuthentication - description: >- - Cloud environment to authenticate Bot Framework Protocol network - calls within this environment. - - id: skillConversationIdFactory - type: SkillConversationIdFactoryBase - description: Methods to create unique conversation IDs for skill conversations. - - id: botTelemetryClient - type: BotTelemetryClient - description: Bot client to telemetry. - - id: defaultLocale - type: string - description: The default locale used to determine language-specific behavior. - - id: defaultRootDialog - type: string - description: Default bot root dialog. - - id: memoryScopes - type: 'MemoryScope[]' - description: >- - Named root-level objects, which can exist in the dialog context or - outside the turn state. - - id: pathResolvers - type: 'PathResolver[]' - description: | - Shortcut behavior for transform paths. -inheritedMethods: +methods: - name: onCommand(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onCommand - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onCommand + package: botbuilder summary: Registers an activity event handler for the _command_ activity. remarks: >- To handle a Command event, use the [onCommand](xref:botbuilder-core.ActivityHandler.onCommand) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onCommand(handler: BotHandler): this' + content: 'function onCommand(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onCommand + type: - name: onCommandResult(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onCommandResult - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onCommandResult + package: botbuilder summary: Registers an activity event handler for the _CommandResult_ activity. remarks: >- To handle a CommandResult event, use the [onCommandResult](xref:botbuilder-core.ActivityHandler.onCommandResult) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onCommandResult(handler: BotHandler): this' + content: 'function onCommandResult(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onCommandResult + type: - name: onConversationUpdate(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onConversationUpdate - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onConversationUpdate + package: botbuilder summary: >- Registers an activity event handler for the _conversation update_ event, emitted for every incoming @@ -132,44 +142,40 @@ inheritedMethods: [onMembersRemoved](xref:botbuilder-core.ActivityHandler.onMembersRemoved) sub-type event handlers. - isPreview: false isDeprecated: false syntax: - content: 'function onConversationUpdate(handler: BotHandler): this' + content: 'function onConversationUpdate(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onConversationUpdate + type: - name: onDialog(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onDialog - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onDialog + package: botbuilder summary: >- Registers an activity event handler for the _dialog_ event, emitted as the last event for an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onDialog(handler: BotHandler): this' + content: 'function onDialog(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onDialog + type: - name: onEndOfConversation(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onEndOfConversation - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onEndOfConversation + package: botbuilder summary: >- Registers an activity event handler for the _end of conversation_ activity. @@ -182,23 +188,21 @@ inheritedMethods: [onEndOfConversation](xref:botbuilder-core.ActivityHandler.onEndOfConversation) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onEndOfConversation(handler: BotHandler): this' + content: 'function onEndOfConversation(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onEndOfConversation + type: - name: onEvent(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onEvent - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onEvent + package: botbuilder summary: >- Registers an activity event handler for the _event_ event, emitted for every incoming event activity. @@ -226,57 +230,52 @@ inheritedMethods: sub-type event handler. To handle other named events, add logic to this handler. - isPreview: false isDeprecated: false syntax: - content: 'function onEvent(handler: BotHandler): this' + content: 'function onEvent(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onEvent + type: - name: onInstallationUpdate(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onInstallationUpdate - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onInstallationUpdate + package: botbuilder summary: Registers an activity event handler for the _installationupdate_ activity. remarks: >- To handle a InstallationUpdate event, use the [onInstallationUpdate](xref:botbuilder-core.ActivityHandler.onInstallationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdate(handler: BotHandler): this' + content: 'function onInstallationUpdate(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onInstallationUpdate + type: - name: onInstallationUpdateAdd(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onInstallationUpdateAdd - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onInstallationUpdateAdd + package: botbuilder summary: >- Registers an activity event handler for the _installationupdate add_ activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdateAdd(handler: BotHandler): this' + content: 'function onInstallationUpdateAdd(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- @@ -287,11 +286,10 @@ inheritedMethods: [onInstallationUpdateAdd](xref:botbuilder-core.ActivityHandler.onInstallationUpdateAdd) type-specific event handler. - type: this - inheritanceDescription: Inherited From ActivityHandler.onInstallationUpdateAdd + type: - name: onInstallationUpdateRemove(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onInstallationUpdateRemove - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onInstallationUpdateRemove + package: botbuilder summary: >- Registers an activity event handler for the _installationupdate remove_ activity. @@ -300,23 +298,23 @@ inheritedMethods: [onInstallationUpdateRemove](xref:botbuilder-core.ActivityHandler.onInstallationUpdateRemove) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdateRemove(handler: BotHandler): this' + content: >- + function onInstallationUpdateRemove(handler: BotHandler): + ActivityHandler parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onInstallationUpdateRemove + type: - name: onMembersAdded(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onMembersAdded - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onMembersAdded + package: botbuilder summary: >- Registers an activity event handler for the _members added_ event, emitted for any incoming @@ -334,23 +332,21 @@ inheritedMethods: [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onMembersAdded(handler: BotHandler): this' + content: 'function onMembersAdded(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMembersAdded + type: - name: onMembersRemoved(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onMembersRemoved - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onMembersRemoved + package: botbuilder summary: >- Registers an activity event handler for the _members removed_ event, emitted for any incoming @@ -370,23 +366,21 @@ inheritedMethods: [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onMembersRemoved(handler: BotHandler): this' + content: 'function onMembersRemoved(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMembersRemoved + type: - name: onMessage(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onMessage - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onMessage + package: botbuilder summary: >- Registers an activity event handler for the _message_ event, emitted for every incoming message activity. @@ -401,23 +395,53 @@ inheritedMethods: [text](xref:botframework-schema.Activity.text) property can be `null` or `undefined`. - isPreview: false isDeprecated: false syntax: - content: 'function onMessage(handler: BotHandler): this' + content: 'function onMessage(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMessage + type: + - name: onMessageDelete(BotHandler) + uid: botbuilder.ActivityHandler.onMessageDelete + package: botbuilder + summary: >- + Registers an activity event handler for the _message delete_ event, + emitted for every incoming message activity. + remarks: >- + Message delete activities represent a deletion of an existing message + activity within a conversation. + + The deleted activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity. + + Message delete activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageDelete`. + isDeprecated: false + syntax: + content: 'function onMessageDelete(handler: BotHandler): ActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: - name: onMessageReaction(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onMessageReaction - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onMessageReaction + package: botbuilder summary: >- Registers an activity event handler for the _message reaction_ event, emitted for every incoming @@ -446,23 +470,56 @@ inheritedMethods: [onReactionsRemoved](xref:botbuilder-core.ActivityHandler.onReactionsRemoved) sub-type event handlers. - isPreview: false isDeprecated: false syntax: - content: 'function onMessageReaction(handler: BotHandler): this' + content: 'function onMessageReaction(handler: BotHandler): ActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + - name: onMessageUpdate(BotHandler) + uid: botbuilder.ActivityHandler.onMessageUpdate + package: botbuilder + summary: >- + Registers an activity event handler for the _message update_ event, + emitted for every incoming message activity. + remarks: >- + Message update activities represent an update of an existing message + activity within a conversation. + + The updated activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity, and the + + message update activity contains all fields in the revised message + activity. + + Message update activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageUpdate`. + isDeprecated: false + syntax: + content: 'function onMessageUpdate(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMessageReaction + type: - name: onReactionsAdded(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onReactionsAdded - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onReactionsAdded + package: botbuilder summary: >- Registers an activity event handler for the _reactions added_ event, emitted for any incoming @@ -480,23 +537,21 @@ inheritedMethods: [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onReactionsAdded(handler: BotHandler): this' + content: 'function onReactionsAdded(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onReactionsAdded + type: - name: onReactionsRemoved(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onReactionsRemoved - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onReactionsRemoved + package: botbuilder summary: >- Registers an activity event handler for the _reactions removed_ event, emitted for any incoming @@ -514,23 +569,21 @@ inheritedMethods: [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onReactionsRemoved(handler: BotHandler): this' + content: 'function onReactionsRemoved(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onReactionsRemoved + type: - name: onTokenResponseEvent(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onTokenResponseEvent - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onTokenResponseEvent + package: botbuilder summary: >- Registers an activity event handler for the _tokens-response_ event, emitted for any incoming @@ -553,67 +606,61 @@ inheritedMethods: [onEvent](xref:botbuilder-core.ActivityHandler.onEvent) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onTokenResponseEvent(handler: BotHandler): this' + content: 'function onTokenResponseEvent(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onTokenResponseEvent + type: - name: onTurn(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onTurn - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onTurn + package: botbuilder summary: >- Registers an activity event handler for the _turn_ event, emitted for every incoming activity, regardless of type. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onTurn(handler: BotHandler): this' + content: 'function onTurn(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onTurn + type: - name: onTyping(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onTyping - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onTyping + package: botbuilder summary: Registers an activity event handler for the _typing_ activity. remarks: >- To handle a Typing event, use the [onTyping](xref:botbuilder-core.ActivityHandler.onTyping) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onTyping(handler: BotHandler): this' + content: 'function onTyping(handler: BotHandler): ActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onTyping + type: - name: onUnrecognizedActivityType(BotHandler) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.onUnrecognizedActivityType - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.onUnrecognizedActivityType + package: botbuilder summary: >- Registers an activity event handler for the _unrecognized activity type_ event, emitted for an @@ -638,23 +685,23 @@ inheritedMethods: The activity's [type](xref:botframework-schema.Activity.type) property contains the activity type. - isPreview: false isDeprecated: false syntax: - content: 'function onUnrecognizedActivityType(handler: BotHandler): this' + content: >- + function onUnrecognizedActivityType(handler: BotHandler): + ActivityHandler parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onUnrecognizedActivityType + type: - name: run(TurnContext) - uid: botbuilder-dialogs-adaptive-runtime.CoreBot.run - package: botbuilder-dialogs-adaptive-runtime + uid: botbuilder.ActivityHandler.run + package: botbuilder summary: Called to initiate the event emission process. remarks: >- Typically, you would provide this method as the function handler that the @@ -683,17 +730,14 @@ inheritedMethods: - [BotFrameworkAdapter.processActivity](xref:botbuilder.BotFrameworkAdapter.processActivity) - isPreview: false isDeprecated: false syntax: content: 'function run(context: TurnContext): Promise' parameters: - id: context - type: TurnContext - description: | - The context object for the current turn. + type: + description: The context object for the current turn. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From ActivityHandler.run -extends: ActivityHandler +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandlerBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandlerBase.yml new file mode 100644 index 00000000..20ccd7a6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityHandlerBase.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: ActivityHandlerBase +uid: botbuilder.ActivityHandlerBase +package: botbuilder +summary: Defines the core behavior for event-emitting activity handlers for bots. +fullName: ActivityHandlerBase +remarks: >- + This provides an extensible class for handling incoming activities in an + event-driven way. + + You can register an arbitrary set of handlers for each event type. + + + To register a handler for an event, use the corresponding _on event_ method. + If multiple handlers are + + registered for an event, they are run in the order in which they were + registered. + + + This object emits a series of _events_ as it processes an incoming activity. + + A handler can stop the propagation of the event by not calling the + continuation function. + + + | Event type | Description | + + | :--- | :--- | + + | Type-specific | Emitted for the specific activity type, before emitting an + event for any sub-type. | + + | Sub-type | Emitted for certain specialized events, based on activity + content. | + + + **See also** + + - The [Bot Framework Activity schema](https://aka.ms/botSpecs-activitySchema) +isDeprecated: false +type: class +methods: + - name: run(TurnContext) + uid: botbuilder.ActivityHandlerBase.run + package: botbuilder + summary: Called to initiate the event emission process. + remarks: >- + Typically, you would provide this method as the function handler that the + adapter calls + + to perform the bot's logic after the received activity has been + pre-processed by the adapter + + and routed through any middleware. + + + For example: + + ```javascript + server.post('/api/messages', (req, res) => { + adapter.processActivity(req, res, async (context) => { + // Route to main dialog. + await bot.run(context); + }); + }); + + ``` + + + **See also** + + - + [BotFrameworkAdapter.processActivity](xref:botbuilder.BotFrameworkAdapter.processActivity) + isDeprecated: false + syntax: + content: 'function run(context: TurnContext): Promise' + parameters: + - id: context + type: + description: The context object for the current turn. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImageType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImageType.yml new file mode 100644 index 00000000..eb92509b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImageType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ActivityImageType +uid: botbuilder.ActivityImageType +package: botbuilder +summary: |- + Defines values for ActivityImageType. + Possible values include: 'avatar', 'article' +fullName: ActivityImageType +remarks: '' +isDeprecated: false +syntax: | + type ActivityImageType = "avatar" | "article" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImportance.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImportance.yml new file mode 100644 index 00000000..3d8f1d42 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityImportance.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: ActivityImportance +uid: botbuilder.ActivityImportance +package: botbuilder +summary: |- + Defines values for ActivityImportance. + Possible values include: 'low', 'normal', 'high' +fullName: ActivityImportance +remarks: '' +isDeprecated: false +fields: + - name: High + uid: botbuilder.ActivityImportance.High + package: botbuilder + summary: '' + - name: Low + uid: botbuilder.ActivityImportance.Low + package: botbuilder + summary: '' + - name: Normal + uid: botbuilder.ActivityImportance.Normal + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTimestamps.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTimestamps.yml new file mode 100644 index 00000000..fa0fe907 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTimestamps.yml @@ -0,0 +1,739 @@ +### YamlMime:TSType +name: ActivityTimestamps +uid: botbuilder.ActivityTimestamps +package: botbuilder +summary: >- + This interface is used to preserve the original string values of dates on + Activities. + + When an Activity is received, timestamps are converted to Dates. Due to how + Javascript + + Date objects are UTC, timezone offset values are lost. +fullName: ActivityTimestamps +remarks: '' +isDeprecated: false +type: interface +properties: + - name: rawExpiration + uid: botbuilder.ActivityTimestamps.rawExpiration + package: botbuilder + summary: '' + fullName: rawExpiration + remarks: '' + isDeprecated: false + syntax: + content: 'rawExpiration?: string' + return: + description: '' + type: string + - name: rawLocalTimestamp + uid: botbuilder.ActivityTimestamps.rawLocalTimestamp + package: botbuilder + summary: '' + fullName: rawLocalTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'rawLocalTimestamp?: string' + return: + description: '' + type: string + - name: rawTimestamp + uid: botbuilder.ActivityTimestamps.rawTimestamp + package: botbuilder + summary: '' + fullName: rawTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'rawTimestamp?: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botbuilder.ActivityTimestamps.action + package: botbuilder + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.action](xref:botbuilder.Activity.action) + - name: attachmentLayout + uid: botbuilder.ActivityTimestamps.attachmentLayout + package: botbuilder + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.attachmentLayout](xref:botbuilder.Activity.attachmentLayout) + - name: attachments + uid: botbuilder.ActivityTimestamps.attachments + package: botbuilder + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.attachments](xref:botbuilder.Activity.attachments) + - name: callerId + uid: botbuilder.ActivityTimestamps.callerId + package: botbuilder + summary: >- + A string containing a URI identifying the caller of a bot. This field is + not intended to be transmitted over + + the wire, but is instead populated by bots and clients based on + cryptographically verifiable data that asserts + + the identity of the callers (e.g. tokens). + fullName: callerId + remarks: '' + isDeprecated: false + syntax: + content: 'callerId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.callerId](xref:botbuilder.Activity.callerId) + - name: channelData + uid: botbuilder.ActivityTimestamps.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [Activity.channelData](xref:botbuilder.Activity.channelData) + - name: channelId + uid: botbuilder.ActivityTimestamps.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.channelId](xref:botbuilder.Activity.channelId) + - name: code + uid: botbuilder.ActivityTimestamps.code + package: botbuilder + summary: >- + The a code for endOfConversation activities that indicates why the + conversation ended. + + Possible values include: 'unknown', 'completedSuccessfully', + 'userCancelled', 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.code](xref:botbuilder.Activity.code) + - name: conversation + uid: botbuilder.ActivityTimestamps.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.conversation](xref:botbuilder.Activity.conversation) + - name: deliveryMode + uid: botbuilder.ActivityTimestamps.deliveryMode + package: botbuilder + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification', 'expectReplies', 'ephemeral' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.deliveryMode](xref:botbuilder.Activity.deliveryMode) + - name: entities + uid: botbuilder.ActivityTimestamps.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.entities](xref:botbuilder.Activity.entities) + - name: expiration + uid: botbuilder.ActivityTimestamps.expiration + package: botbuilder + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [Activity.expiration](xref:botbuilder.Activity.expiration) + - name: from + uid: botbuilder.ActivityTimestamps.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [Activity.from](xref:botbuilder.Activity.from) + - name: historyDisclosed + uid: botbuilder.ActivityTimestamps.historyDisclosed + package: botbuilder + summary: Indicates whether the prior history of the channel is disclosed. + fullName: historyDisclosed + remarks: '' + isDeprecated: false + syntax: + content: 'historyDisclosed?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [Activity.historyDisclosed](xref:botbuilder.Activity.historyDisclosed) + - name: id + uid: botbuilder.ActivityTimestamps.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.id](xref:botbuilder.Activity.id) + - name: importance + uid: botbuilder.ActivityTimestamps.importance + package: botbuilder + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.importance](xref:botbuilder.Activity.importance) + - name: inputHint + uid: botbuilder.ActivityTimestamps.inputHint + package: botbuilder + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.inputHint](xref:botbuilder.Activity.inputHint) + - name: label + uid: botbuilder.ActivityTimestamps.label + package: botbuilder + summary: A descriptive label for the activity. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.label](xref:botbuilder.Activity.label) + - name: listenFor + uid: botbuilder.ActivityTimestamps.listenFor + package: botbuilder + summary: >- + List of phrases and references that speech and language priming systems + should listen for + fullName: listenFor + remarks: '' + isDeprecated: false + syntax: + content: 'listenFor: string[]' + return: + description: '' + type: string[] + inheritanceDescription: >- + Inherited From + [Activity.listenFor](xref:botbuilder.Activity.listenFor) + - name: locale + uid: botbuilder.ActivityTimestamps.locale + package: botbuilder + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.locale](xref:botbuilder.Activity.locale) + - name: localTimestamp + uid: botbuilder.ActivityTimestamps.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [Activity.localTimestamp](xref:botbuilder.Activity.localTimestamp) + - name: localTimezone + uid: botbuilder.ActivityTimestamps.localTimezone + package: botbuilder + summary: >- + Contains the name of the local timezone of the message, expressed in IANA + Time Zone database format. + + For example, America/Los_Angeles. + fullName: localTimezone + remarks: '' + isDeprecated: false + syntax: + content: 'localTimezone: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.localTimezone](xref:botbuilder.Activity.localTimezone) + - name: membersAdded + uid: botbuilder.ActivityTimestamps.membersAdded + package: botbuilder + summary: The collection of members added to the conversation. + fullName: membersAdded + remarks: '' + isDeprecated: false + syntax: + content: 'membersAdded?: ChannelAccount[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.membersAdded](xref:botbuilder.Activity.membersAdded) + - name: membersRemoved + uid: botbuilder.ActivityTimestamps.membersRemoved + package: botbuilder + summary: The collection of members removed from the conversation. + fullName: membersRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'membersRemoved?: ChannelAccount[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.membersRemoved](xref:botbuilder.Activity.membersRemoved) + - name: name + uid: botbuilder.ActivityTimestamps.name + package: botbuilder + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.name](xref:botbuilder.Activity.name) + - name: reactionsAdded + uid: botbuilder.ActivityTimestamps.reactionsAdded + package: botbuilder + summary: The collection of reactions added to the conversation. + fullName: reactionsAdded + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsAdded?: MessageReaction[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.reactionsAdded](xref:botbuilder.Activity.reactionsAdded) + - name: reactionsRemoved + uid: botbuilder.ActivityTimestamps.reactionsRemoved + package: botbuilder + summary: The collection of reactions removed from the conversation. + fullName: reactionsRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsRemoved?: MessageReaction[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.reactionsRemoved](xref:botbuilder.Activity.reactionsRemoved) + - name: recipient + uid: botbuilder.ActivityTimestamps.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.recipient](xref:botbuilder.Activity.recipient) + - name: relatesTo + uid: botbuilder.ActivityTimestamps.relatesTo + package: botbuilder + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.relatesTo](xref:botbuilder.Activity.relatesTo) + - name: replyToId + uid: botbuilder.ActivityTimestamps.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.replyToId](xref:botbuilder.Activity.replyToId) + - name: semanticAction + uid: botbuilder.ActivityTimestamps.semanticAction + package: botbuilder + summary: An optional programmatic action accompanying this request + fullName: semanticAction + remarks: '' + isDeprecated: false + syntax: + content: 'semanticAction?: SemanticAction' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.semanticAction](xref:botbuilder.Activity.semanticAction) + - name: serviceUrl + uid: botbuilder.ActivityTimestamps.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.serviceUrl](xref:botbuilder.Activity.serviceUrl) + - name: speak + uid: botbuilder.ActivityTimestamps.speak + package: botbuilder + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.speak](xref:botbuilder.Activity.speak) + - name: suggestedActions + uid: botbuilder.ActivityTimestamps.suggestedActions + package: botbuilder + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [Activity.suggestedActions](xref:botbuilder.Activity.suggestedActions) + - name: summary + uid: botbuilder.ActivityTimestamps.summary + package: botbuilder + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.summary](xref:botbuilder.Activity.summary) + - name: text + uid: botbuilder.ActivityTimestamps.text + package: botbuilder + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.text](xref:botbuilder.Activity.text) + - name: textFormat + uid: botbuilder.ActivityTimestamps.textFormat + package: botbuilder + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.textFormat](xref:botbuilder.Activity.textFormat) + - name: textHighlights + uid: botbuilder.ActivityTimestamps.textHighlights + package: botbuilder + summary: >- + The collection of text fragments to highlight when the activity contains a + ReplyToId value. + fullName: textHighlights + remarks: '' + isDeprecated: false + syntax: + content: 'textHighlights?: TextHighlight[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [Activity.textHighlights](xref:botbuilder.Activity.textHighlights) + - name: timestamp + uid: botbuilder.ActivityTimestamps.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [Activity.timestamp](xref:botbuilder.Activity.timestamp) + - name: topicName + uid: botbuilder.ActivityTimestamps.topicName + package: botbuilder + summary: The updated topic name of the conversation. + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.topicName](xref:botbuilder.Activity.topicName) + - name: type + uid: botbuilder.ActivityTimestamps.type + package: botbuilder + summary: >- + Contains the activity type. Possible values include: 'message', + 'contactRelationUpdate', + + 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', + 'deleteUserData', + + 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', + 'suggestion', + + 'trace', 'handoff' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Activity.type](xref:botbuilder.Activity.type) + - name: value + uid: botbuilder.ActivityTimestamps.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + inheritanceDescription: Inherited From [Activity.value](xref:botbuilder.Activity.value) + - name: valueType + uid: botbuilder.ActivityTimestamps.valueType + package: botbuilder + summary: The type of the activity's value object. + fullName: valueType + remarks: '' + isDeprecated: false + syntax: + content: 'valueType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Activity.valueType](xref:botbuilder.Activity.valueType) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTypes.yml new file mode 100644 index 00000000..ebfdd547 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ActivityTypes.yml @@ -0,0 +1,90 @@ +### YamlMime:TSEnum +name: ActivityTypes +uid: botbuilder.ActivityTypes +package: botbuilder +summary: >- + Defines values for ActivityTypes. + + Possible values include: 'message', 'contactRelationUpdate', + 'conversationUpdate', 'typing', + + 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', + 'messageDelete', + + 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' +fullName: ActivityTypes +remarks: '' +isDeprecated: false +fields: + - name: Command + uid: botbuilder.ActivityTypes.Command + package: botbuilder + summary: '' + - name: CommandResult + uid: botbuilder.ActivityTypes.CommandResult + package: botbuilder + summary: '' + - name: ContactRelationUpdate + uid: botbuilder.ActivityTypes.ContactRelationUpdate + package: botbuilder + summary: '' + - name: ConversationUpdate + uid: botbuilder.ActivityTypes.ConversationUpdate + package: botbuilder + summary: '' + - name: DeleteUserData + uid: botbuilder.ActivityTypes.DeleteUserData + package: botbuilder + summary: '' + - name: EndOfConversation + uid: botbuilder.ActivityTypes.EndOfConversation + package: botbuilder + summary: '' + - name: Event + uid: botbuilder.ActivityTypes.Event + package: botbuilder + summary: '' + - name: Handoff + uid: botbuilder.ActivityTypes.Handoff + package: botbuilder + summary: '' + - name: InstallationUpdate + uid: botbuilder.ActivityTypes.InstallationUpdate + package: botbuilder + summary: '' + - name: Invoke + uid: botbuilder.ActivityTypes.Invoke + package: botbuilder + summary: '' + - name: InvokeResponse + uid: botbuilder.ActivityTypes.InvokeResponse + package: botbuilder + summary: '' + - name: Message + uid: botbuilder.ActivityTypes.Message + package: botbuilder + summary: '' + - name: MessageDelete + uid: botbuilder.ActivityTypes.MessageDelete + package: botbuilder + summary: '' + - name: MessageReaction + uid: botbuilder.ActivityTypes.MessageReaction + package: botbuilder + summary: '' + - name: MessageUpdate + uid: botbuilder.ActivityTypes.MessageUpdate + package: botbuilder + summary: '' + - name: Suggestion + uid: botbuilder.ActivityTypes.Suggestion + package: botbuilder + summary: '' + - name: Trace + uid: botbuilder.ActivityTypes.Trace + package: botbuilder + summary: '' + - name: Typing + uid: botbuilder.ActivityTypes.Typing + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardAuthentication.yml new file mode 100644 index 00000000..80877985 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardAuthentication.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: AdaptiveCardAuthentication +uid: botbuilder.AdaptiveCardAuthentication +package: botbuilder +summary: >- + Defines the structure that arrives in the Activity.Value.Authentication for + Invoke + + activity with Name of 'adaptiveCard/action'. +fullName: AdaptiveCardAuthentication +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: connectionName + uid: botbuilder.AdaptiveCardAuthentication.connectionName + package: botbuilder + summary: The connection name. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TokenExchangeInvokeRequest.connectionName](xref:botbuilder.TokenExchangeInvokeRequest.connectionName) + - name: id + uid: botbuilder.AdaptiveCardAuthentication.id + package: botbuilder + summary: The id from the OAuthCard. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TokenExchangeInvokeRequest.id](xref:botbuilder.TokenExchangeInvokeRequest.id) + - name: token + uid: botbuilder.AdaptiveCardAuthentication.token + package: botbuilder + summary: The user token that can be exchanged. + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [TokenExchangeInvokeRequest.token](xref:botbuilder.TokenExchangeInvokeRequest.token) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeAction.yml new file mode 100644 index 00000000..9f2c26ec --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeAction.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: AdaptiveCardInvokeAction +uid: botbuilder.AdaptiveCardInvokeAction +package: botbuilder +summary: |- + Defines the structure that arrives in the Activity.Value.Action for Invoke + activity with Name of 'adaptiveCard/action'. +fullName: AdaptiveCardInvokeAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder.AdaptiveCardInvokeAction.data + package: botbuilder + summary: The Data of this adaptive card action invoke. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: Record' + return: + description: '' + type: Record<string, unknown> + - name: id + uid: botbuilder.AdaptiveCardInvokeAction.id + package: botbuilder + summary: The id of this Adaptive Card Invoke Action. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.AdaptiveCardInvokeAction.type + package: botbuilder + summary: The Type of this Adaptive Card Invoke Action. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: verb + uid: botbuilder.AdaptiveCardInvokeAction.verb + package: botbuilder + summary: The Verb of this adaptive card action invoke. + fullName: verb + remarks: '' + isDeprecated: false + syntax: + content: 'verb: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeResponse.yml new file mode 100644 index 00000000..296f1bed --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeResponse.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: AdaptiveCardInvokeResponse +uid: botbuilder.AdaptiveCardInvokeResponse +package: botbuilder +summary: >- + Defines the structure that is returned as the result of an Invoke activity + with + + Name of 'adaptiveCard/action'. +fullName: AdaptiveCardInvokeResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: statusCode + uid: botbuilder.AdaptiveCardInvokeResponse.statusCode + package: botbuilder + summary: The Card Action response status code. + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: number' + return: + description: '' + type: number + - name: type + uid: botbuilder.AdaptiveCardInvokeResponse.type + package: botbuilder + summary: The type of this response. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.AdaptiveCardInvokeResponse.value + package: botbuilder + summary: The json response object. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: Record' + return: + description: '' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeValue.yml new file mode 100644 index 00000000..9c69476f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AdaptiveCardInvokeValue.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: AdaptiveCardInvokeValue +uid: botbuilder.AdaptiveCardInvokeValue +package: botbuilder +summary: >- + Defines the structure that arrives in the Activity.Value for Invoke activity + with + + Name of 'adaptiveCard/action'. +fullName: AdaptiveCardInvokeValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder.AdaptiveCardInvokeValue.action + package: botbuilder + summary: >- + The + [AdaptiveCardInvokeAction](xref:botframework-schema.AdaptiveCardInvokeAction) + of + + this adaptive card invoke action value. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: AdaptiveCardInvokeAction' + return: + description: '' + type: + - name: authentication + uid: botbuilder.AdaptiveCardInvokeValue.authentication + package: botbuilder + summary: >- + The + [AdaptiveCardAuthentication](xref:botframework-schema.AdaptiveCardAuthentication) + + for this adaptive card invoke action value. + fullName: authentication + remarks: '' + isDeprecated: false + syntax: + content: 'authentication: AdaptiveCardAuthentication' + return: + description: '' + type: + - name: state + uid: botbuilder.AdaptiveCardInvokeValue.state + package: botbuilder + summary: The 'state' or magic code for an OAuth flow. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AnimationCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AnimationCard.yml new file mode 100644 index 00000000..18a98203 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AnimationCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: AnimationCard +uid: botbuilder.AnimationCard +package: botbuilder +summary: 'An animation card (Ex: gif or short video clip)' +fullName: AnimationCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder.AnimationCard.aspect + package: botbuilder + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder.AnimationCard.autoloop + package: botbuilder + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder.AnimationCard.autostart + package: botbuilder + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder.AnimationCard.buttons + package: botbuilder + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder.AnimationCard.duration + package: botbuilder + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder.AnimationCard.image + package: botbuilder + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder.AnimationCard.media + package: botbuilder + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder.AnimationCard.shareable + package: botbuilder + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder.AnimationCard.subtitle + package: botbuilder + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.AnimationCard.text + package: botbuilder + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.AnimationCard.title + package: botbuilder + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.AnimationCard.value + package: botbuilder + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AppBasedLinkQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AppBasedLinkQuery.yml new file mode 100644 index 00000000..1372da97 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AppBasedLinkQuery.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AppBasedLinkQuery +uid: botbuilder.AppBasedLinkQuery +package: botbuilder +summary: '' +fullName: AppBasedLinkQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: state + uid: botbuilder.AppBasedLinkQuery.state + package: botbuilder + summary: State is the magic code for OAuth Flow + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string + - name: url + uid: botbuilder.AppBasedLinkQuery.url + package: botbuilder + summary: Url queried by user + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ApplicationIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ApplicationIdentityType.yml new file mode 100644 index 00000000..c8611978 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ApplicationIdentityType.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: ApplicationIdentityType +uid: botbuilder.ApplicationIdentityType +package: botbuilder +summary: >- + Defines values for ApplicationIdentityType. + + Possible values include: 'aadApplication', 'bot', 'tenantBot', + 'office365Connector', 'webhook' +fullName: ApplicationIdentityType +remarks: '' +isDeprecated: false +syntax: | + type ApplicationIdentityType = + | "aadApplication" + | "bot" + | "tenantBot" + | "office365Connector" + | "webhook" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Attachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Attachment.yml new file mode 100644 index 00000000..eff2f065 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Attachment.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: Attachment +uid: botbuilder.Attachment +package: botbuilder +summary: An attachment within an activity +fullName: Attachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder.Attachment.content + package: botbuilder + summary: Embedded content + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: any' + return: + description: '' + type: any + - name: contentType + uid: botbuilder.Attachment.contentType + package: botbuilder + summary: mimetype/Contenttype for the file + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: string' + return: + description: '' + type: string + - name: contentUrl + uid: botbuilder.Attachment.contentUrl + package: botbuilder + summary: Content Url + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.Attachment.name + package: botbuilder + summary: (OPTIONAL) The name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: thumbnailUrl + uid: botbuilder.Attachment.thumbnailUrl + package: botbuilder + summary: (OPTIONAL) Thumbnail associated with attachment + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentData.yml new file mode 100644 index 00000000..c2c19930 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentData.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: AttachmentData +uid: botbuilder.AttachmentData +package: botbuilder +summary: Attachment data +fullName: AttachmentData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.AttachmentData.name + package: botbuilder + summary: Name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: originalBase64 + uid: botbuilder.AttachmentData.originalBase64 + package: botbuilder + summary: Attachment content + fullName: originalBase64 + remarks: '' + isDeprecated: false + syntax: + content: 'originalBase64: Uint8Array' + return: + description: '' + type: Uint8Array + - name: thumbnailBase64 + uid: botbuilder.AttachmentData.thumbnailBase64 + package: botbuilder + summary: Attachment thumbnail + fullName: thumbnailBase64 + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailBase64: Uint8Array' + return: + description: '' + type: Uint8Array + - name: type + uid: botbuilder.AttachmentData.type + package: botbuilder + summary: Content-Type of the attachment + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentInfo.yml new file mode 100644 index 00000000..59214575 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: AttachmentInfo +uid: botbuilder.AttachmentInfo +package: botbuilder +summary: Metadata for an attachment +fullName: AttachmentInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.AttachmentInfo.name + package: botbuilder + summary: Name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.AttachmentInfo.type + package: botbuilder + summary: ContentType of the attachment + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: views + uid: botbuilder.AttachmentInfo.views + package: botbuilder + summary: attachment views + fullName: views + remarks: '' + isDeprecated: false + syntax: + content: 'views: AttachmentView[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayout.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayout.yml new file mode 100644 index 00000000..0ead40ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayout.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: AttachmentLayout +uid: botbuilder.AttachmentLayout +package: botbuilder +summary: |- + Defines values for AttachmentLayout. + Possible values include: 'list', 'grid' +fullName: AttachmentLayout +remarks: '' +isDeprecated: false +syntax: | + type AttachmentLayout = "list" | "grid" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayoutTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayoutTypes.yml new file mode 100644 index 00000000..4387e40f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentLayoutTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: AttachmentLayoutTypes +uid: botbuilder.AttachmentLayoutTypes +package: botbuilder +summary: |- + Defines values for AttachmentLayoutTypes. + Possible values include: 'list', 'carousel' +fullName: AttachmentLayoutTypes +remarks: '' +isDeprecated: false +fields: + - name: Carousel + uid: botbuilder.AttachmentLayoutTypes.Carousel + package: botbuilder + summary: '' + - name: List + uid: botbuilder.AttachmentLayoutTypes.List + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentView.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentView.yml new file mode 100644 index 00000000..d5a2fc1a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AttachmentView.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AttachmentView +uid: botbuilder.AttachmentView +package: botbuilder +summary: Attachment View name and size +fullName: AttachmentView +remarks: '' +isDeprecated: false +type: interface +properties: + - name: size + uid: botbuilder.AttachmentView.size + package: botbuilder + summary: Size of the attachment + fullName: size + remarks: '' + isDeprecated: false + syntax: + content: 'size: number' + return: + description: '' + type: number + - name: viewId + uid: botbuilder.AttachmentView.viewId + package: botbuilder + summary: Id of the attachment + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AudioCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AudioCard.yml new file mode 100644 index 00000000..68ffea78 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AudioCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: AudioCard +uid: botbuilder.AudioCard +package: botbuilder +summary: Audio card +fullName: AudioCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder.AudioCard.aspect + package: botbuilder + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder.AudioCard.autoloop + package: botbuilder + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder.AudioCard.autostart + package: botbuilder + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder.AudioCard.buttons + package: botbuilder + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder.AudioCard.duration + package: botbuilder + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder.AudioCard.image + package: botbuilder + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder.AudioCard.media + package: botbuilder + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder.AudioCard.shareable + package: botbuilder + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder.AudioCard.subtitle + package: botbuilder + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.AudioCard.text + package: botbuilder + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.AudioCard.title + package: botbuilder + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.AudioCard.value + package: botbuilder + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/AutoSaveStateMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/AutoSaveStateMiddleware.yml new file mode 100644 index 00000000..f3d6e9d3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/AutoSaveStateMiddleware.yml @@ -0,0 +1,123 @@ +### YamlMime:TSType +name: AutoSaveStateMiddleware +uid: botbuilder.AutoSaveStateMiddleware +package: botbuilder +summary: >- + Middleware that will automatically save any state changes at the end of the + turn. +fullName: AutoSaveStateMiddleware +remarks: >- + The `AutoSaveStateMiddleware` class should be added towards the top of your + bot's middleware + + stack, before any other components that use state. Any `BotState` plugins + passed to the + + constructor will have their `BotState.saveChanges()` method called upon + successful completion + + of the turn. + + + This example shows boilerplate code for reading and writing conversation and + user state within + + a bot: + + + ```JavaScript + + const { AutoSaveStateMiddleware, ConversationState, UserState, MemoryStorage } + = require('botbuilder'); + + + const storage = new MemoryStorage(); + + const conversationState = new ConversationState(storage); + + const userState = new UserState(storage); + + adapter.use(new AutoSaveStateMiddleware(conversationState, userState)); + + + server.post('/api/messages', (req, res) => { + adapter.processActivity(req, res, async (turnContext) => { + // Get state + const convo = await conversationState.load(turnContext); + const user = await userState.load(turnContext); + + // ... route activity ... + // ...make changes to state objects... + // ... no need to call userState.saveChanges() or conversationState.saveChanges() anymore! + }); + }); + + ``` +isDeprecated: false +type: class +constructors: + - name: AutoSaveStateMiddleware(BotState[]) + uid: botbuilder.AutoSaveStateMiddleware.constructor + package: botbuilder + summary: Creates a new AutoSaveStateMiddleware instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new AutoSaveStateMiddleware(botStates: BotState[])' + parameters: + - id: botStates + type: [] + description: >- + One or more BotState plugins to automatically save at the end of the + turn. +properties: + - name: botStateSet + uid: botbuilder.AutoSaveStateMiddleware.botStateSet + package: botbuilder + summary: Set of `BotState` plugins being automatically saved. + fullName: botStateSet + remarks: '' + isDeprecated: false + syntax: + content: 'botStateSet: BotStateSet' + return: + description: '' + type: +methods: + - name: add(BotState[]) + uid: botbuilder.AutoSaveStateMiddleware.add + package: botbuilder + summary: Adds additional `BotState` plugins to be saved. + remarks: '' + isDeprecated: false + syntax: + content: 'function add(botStates: BotState[]): AutoSaveStateMiddleware' + parameters: + - id: botStates + type: [] + description: One or more BotState plugins to add. + return: + description: The updated BotStateSet object. + type: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.AutoSaveStateMiddleware.onTurn + package: botbuilder + summary: >- + Called by the adapter (for example, a `BotFrameworkAdapter`) at runtime in + order to process an inbound [Activity](xref:botframework-schema.Activity). + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: The context object for this turn. + - id: next + type: () => Promise<void> + description: '{function} The next delegate function.' + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardComponent.yml new file mode 100644 index 00000000..c1659367 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardComponent.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: BaseCardComponent +uid: botbuilder.BaseCardComponent +package: botbuilder +summary: Base Adaptive Card Extension card view component. +fullName: BaseCardComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder.BaseCardComponent.componentName + package: botbuilder + summary: |- + Unique component name. + For example, "textInput" + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: CardComponentName' + return: + description: '' + type: + - name: id + uid: botbuilder.BaseCardComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardViewParameters.yml new file mode 100644 index 00000000..bef96796 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseCardViewParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: BaseCardViewParameters +uid: botbuilder.BaseCardViewParameters +package: botbuilder +summary: Base parameters for the card view. +fullName: BaseCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardBar + uid: botbuilder.BaseCardViewParameters.cardBar + package: botbuilder + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseHandleActionResponse.yml new file mode 100644 index 00000000..b371e718 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BaseHandleActionResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: BaseHandleActionResponse +uid: botbuilder.BaseHandleActionResponse +package: botbuilder +summary: The base handle action response. +fullName: BaseHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder.BaseHandleActionResponse.renderArguments + package: botbuilder + summary: The render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments?: CardViewResponse | QuickViewResponse' + return: + description: '' + type: >- + | + - name: responseType + uid: botbuilder.BaseHandleActionResponse.responseType + package: botbuilder + summary: The type of the view in the handle action response. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: ViewResponseType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BasicCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BasicCard.yml new file mode 100644 index 00000000..7ccc0323 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BasicCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: BasicCard +uid: botbuilder.BasicCard +package: botbuilder +summary: A basic card +fullName: BasicCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder.BasicCard.buttons + package: botbuilder + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder.BasicCard.images + package: botbuilder + summary: Array of images for the card + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images: CardImage[]' + return: + description: '' + type: [] + - name: subtitle + uid: botbuilder.BasicCard.subtitle + package: botbuilder + summary: Subtitle of the card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder.BasicCard.tap + package: botbuilder + summary: This action will be activated when user taps on the card itself + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder.BasicCard.text + package: botbuilder + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.BasicCard.title + package: botbuilder + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntriesResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntriesResponse.yml new file mode 100644 index 00000000..c7a948cb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntriesResponse.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BatchFailedEntriesResponse +uid: botbuilder.BatchFailedEntriesResponse +package: botbuilder +summary: '' +fullName: BatchFailedEntriesResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder.BatchFailedEntriesResponse.continuationToken + package: botbuilder + summary: The continuation token for paginated results. + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: failedEntryResponses + uid: botbuilder.BatchFailedEntriesResponse.failedEntryResponses + package: botbuilder + summary: The list of failed entries result of a batch operation. + fullName: failedEntryResponses + remarks: '' + isDeprecated: false + syntax: + content: 'failedEntryResponses: BatchFailedEntry[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntry.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntry.yml new file mode 100644 index 00000000..67c912db --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchFailedEntry.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BatchFailedEntry +uid: botbuilder.BatchFailedEntry +package: botbuilder +summary: '' +fullName: BatchFailedEntry +remarks: '' +isDeprecated: false +type: interface +properties: + - name: error + uid: botbuilder.BatchFailedEntry.error + package: botbuilder + summary: The error of the failed entry. + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.BatchFailedEntry.id + package: botbuilder + summary: The id of the failed entry. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationRequest.yml new file mode 100644 index 00000000..dee8c163 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationRequest.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: BatchOperationRequest +uid: botbuilder.BatchOperationRequest +package: botbuilder +summary: '' +fullName: BatchOperationRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: botbuilder.BatchOperationRequest.activity + package: botbuilder + summary: The activity of the request. + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity: Activity' + return: + description: '' + type: + - name: members + uid: botbuilder.BatchOperationRequest.members + package: botbuilder + summary: The list of members. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members?: TeamsMember[]' + return: + description: '' + type: [] + - name: teamId + uid: botbuilder.BatchOperationRequest.teamId + package: botbuilder + summary: The id of the team. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string' + return: + description: '' + type: string + - name: tenantId + uid: botbuilder.BatchOperationRequest.tenantId + package: botbuilder + summary: The id of the Teams tenant. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationResponse.yml new file mode 100644 index 00000000..ddb13d56 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: BatchOperationResponse +uid: botbuilder.BatchOperationResponse +package: botbuilder +summary: '' +fullName: BatchOperationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: operationId + uid: botbuilder.BatchOperationResponse.operationId + package: botbuilder + summary: The id of the operation executed. + fullName: operationId + remarks: '' + isDeprecated: false + syntax: + content: 'operationId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationStateResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationStateResponse.yml new file mode 100644 index 00000000..d06ef832 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BatchOperationStateResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: BatchOperationStateResponse +uid: botbuilder.BatchOperationStateResponse +package: botbuilder +summary: '' +fullName: BatchOperationStateResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: retryAfter + uid: botbuilder.BatchOperationStateResponse.retryAfter + package: botbuilder + summary: The datetime value to retry the operation. + fullName: retryAfter + remarks: '' + isDeprecated: false + syntax: + content: 'retryAfter?: Date' + return: + description: '' + type: Date + - name: state + uid: botbuilder.BatchOperationStateResponse.state + package: botbuilder + summary: The state of the operation. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string + - name: statusMap + uid: botbuilder.BatchOperationStateResponse.statusMap + package: botbuilder + summary: The status map for processed operations. + fullName: statusMap + remarks: '' + isDeprecated: false + syntax: + content: 'statusMap: Record' + return: + description: '' + type: Record<number, number> + - name: totalEntriesCount + uid: botbuilder.BatchOperationStateResponse.totalEntriesCount + package: botbuilder + summary: The number of entries. + fullName: totalEntriesCount + remarks: '' + isDeprecated: false + syntax: + content: 'totalEntriesCount: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotAdapter.yml new file mode 100644 index 00000000..9dbf529d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotAdapter.yml @@ -0,0 +1,413 @@ +### YamlMime:TSType +name: BotAdapter +uid: botbuilder.BotAdapter +package: botbuilder +summary: >- + Defines the core behavior of a bot adapter that can connect a bot to a service + endpoint. +fullName: BotAdapter +remarks: >- + The bot adapter encapsulates authentication processes and sends activities to + and receives + + activities from the Bot Connector Service. When your bot receives an activity, + the adapter + + creates a turn context object, passes it to your bot application logic, and + sends responses + + back to the user's channel. + + + The adapter processes and directs incoming activities in through the bot + middleware pipeline to + + your bot logic and then back out again. As each activity flows in and out of + the bot, each + + piece of middleware can inspect or act upon the activity, both before and + after the bot logic runs. + + Use the [use](xref:botbuilder-core.BotAdapter.use) method to add + [Middleware](xref:botbuilder-core.Middleware) + + objects to your adapter's middleware collection. + + + For more information, see the articles on + + [How bots + work](https://docs.microsoft.com/azure/bot-service/bot-builder-basics) and + + [Middleware](https://docs.microsoft.com/azure/bot-service/bot-builder-concept-middleware). +isDeprecated: false +type: class +properties: + - name: BotIdentityKey + uid: botbuilder.BotAdapter.BotIdentityKey + package: botbuilder + summary: '' + fullName: BotIdentityKey + remarks: '' + isDeprecated: false + syntax: + content: 'BotIdentityKey: symbol' + return: + description: '' + type: symbol + - name: ConnectorClientKey + uid: botbuilder.BotAdapter.ConnectorClientKey + package: botbuilder + summary: '' + fullName: ConnectorClientKey + remarks: '' + isDeprecated: false + syntax: + content: 'ConnectorClientKey: symbol' + return: + description: '' + type: symbol + - name: OAuthScopeKey + uid: botbuilder.BotAdapter.OAuthScopeKey + package: botbuilder + summary: '' + fullName: OAuthScopeKey + remarks: '' + isDeprecated: false + syntax: + content: 'OAuthScopeKey: symbol' + return: + description: '' + type: symbol + - name: onTurnError + uid: botbuilder.BotAdapter.onTurnError + package: botbuilder + summary: >- + Gets or sets an error handler that can catch exceptions in the middleware + or application. + fullName: onTurnError + remarks: '' + isDeprecated: false + syntax: + content: '(context: TurnContext, error: Error) => Promise onTurnError' + return: + description: A promise representing the async operation. + type: '(context: TurnContext, error: Error) => Promise<void>' +methods: + - name: >- + continueConversation(Partial, (revocableContext: + TurnContext) => Promise) + uid: botbuilder.BotAdapter.continueConversation + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: >- + This is often referred to as a _proactive notification_, the bot can + proactively + + send a message to a conversation or user without waiting for an incoming + message. + + For example, a bot can use this method to send notifications or coupons to + a user. + isDeprecated: false + syntax: + content: >- + function continueConversation(reference: Partial, + logic: (revocableContext: TurnContext) => Promise): Promise + parameters: + - id: reference + type: Partial<> + description: A reference to the conversation to continue. + - id: logic + type: '(revocableContext: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: '' + type: Promise<void> + - name: >- + continueConversationAsync(ClaimsIdentity, Partial, + (context: TurnContext) => Promise) + uid: botbuilder.BotAdapter.continueConversationAsync_1 + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversationAsync(claimsIdentity: ClaimsIdentity, + reference: Partial, logic: (context: TurnContext) + => Promise): Promise + parameters: + - id: claimsIdentity + type: ClaimsIdentity + description: >- + A [ClaimsIdentity](xref:botframework-connector) for the + conversation. + - id: reference + type: Partial<> + description: >- + A partial + [ConversationReference](xref:botframework-schema.ConversationReference) + to the conversation to continue. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: a promise representing the async operation + type: Promise<void> + - name: >- + continueConversationAsync(ClaimsIdentity, Partial, + string, (context: TurnContext) => Promise) + uid: botbuilder.BotAdapter.continueConversationAsync_2 + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversationAsync(claimsIdentity: ClaimsIdentity, + reference: Partial, audience: string, logic: + (context: TurnContext) => Promise): Promise + parameters: + - id: claimsIdentity + type: ClaimsIdentity + description: >- + A [ClaimsIdentity](xref:botframework-connector) for the + conversation. + - id: reference + type: Partial<> + description: >- + A partial + [ConversationReference](xref:botframework-schema.ConversationReference) + to the conversation to continue. + - id: audience + type: string + description: A value signifying the recipient of the proactive message. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: a promise representing the async operation + type: Promise<void> + - name: >- + continueConversationAsync(string, Partial, + (context: TurnContext) => Promise) + uid: botbuilder.BotAdapter.continueConversationAsync + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversationAsync(botAppId: string, reference: + Partial, logic: (context: TurnContext) => + Promise): Promise + parameters: + - id: botAppId + type: string + description: >- + The application ID of the bot. This parameter is ignored in single + tenant the Adapters (Console,Test, etc) but is critical to the + BotFrameworkAdapter which is multi-tenant aware. + - id: reference + type: Partial<> + description: >- + A partial + [ConversationReference](xref:botframework-schema.ConversationReference) + to the conversation to continue. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: a promise representing the async operation + type: Promise<void> + - name: >- + createConversationAsync(string, string, string, string, + ConversationParameters, (context: TurnContext) => Promise) + uid: botbuilder.BotAdapter.createConversationAsync + package: botbuilder + summary: Creates a conversation on the specified channel. + remarks: >- + To start a conversation, your bot must know its account information and + the user's account information on that + + channel. Most _channels only support initiating a direct message + (non-group) conversation. + + + The adapter attempts to create a new conversation on the channel, and then + sends a `conversationUpdate` activity + + through its middleware pipeline to the logic method. + + + If the conversation is established with the specified users, the ID of the + activity's converstion will contain + + the ID of the new conversation. + isDeprecated: false + syntax: + content: >- + function createConversationAsync(_botAppId: string, _channelId: string, + _serviceUrl: string, _audience: string, _conversationParameters: + ConversationParameters, _logic: (context: TurnContext) => + Promise): Promise + parameters: + - id: _botAppId + type: string + description: The application ID of the bot. + - id: _channelId + type: string + description: The ID for the channel. + - id: _serviceUrl + type: string + description: The ID for the channel. + - id: _audience + type: string + description: |- + The audience for the connector. + + - id: _conversationParameters + type: + description: The conversation information to use to create the conversation + - id: _logic + type: '(context: TurnContext) => Promise<void>' + description: The method to call for the resulting bot turn. + return: + description: A promise that represents the asynchronous operation + type: Promise<void> + - name: deleteActivity(TurnContext, Partial) + uid: botbuilder.BotAdapter.deleteActivity + package: botbuilder + summary: >- + Asynchronously deletes an existing activity. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + to delete + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. + isDeprecated: false + syntax: + content: >- + function deleteActivity(context: TurnContext, reference: + Partial): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: reference + type: Partial<> + description: Conversation reference information for the activity to delete. + return: + description: '' + type: Promise<void> + - name: sendActivities(TurnContext, Partial[]) + uid: botbuilder.BotAdapter.sendActivities + package: botbuilder + summary: >- + Asynchronously sends a set of outgoing activities to a channel server. + + + This method supports the framework and is not intended to be called + directly for your code. + + Use the turn context's + [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or + + [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) method + from your bot code. + remarks: >- + The activities will be sent one after another in the order in which + they're received. A + + response object will be returned for each sent activity. For `message` + activities this will + + contain the ID of the delivered message. + isDeprecated: false + syntax: + content: >- + function sendActivities(context: TurnContext, activities: + Partial[]): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: activities + type: Partial<>[] + description: The activities to send. + return: + description: An array of [ResourceResponse](xref:botbuilder.Os) + type: Promise<[]> + - name: updateActivity(TurnContext, Partial) + uid: botbuilder.BotAdapter.updateActivity + package: botbuilder + summary: >- + Asynchronously replaces a previous activity with an updated version. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + to update + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. + isDeprecated: false + syntax: + content: >- + function updateActivity(context: TurnContext, activity: + Partial): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: activity + type: Partial<> + description: The updated version of the activity to replace. + return: + description: '' + type: Promise<void | > + - name: use((MiddlewareHandler | Middleware)[]) + uid: botbuilder.BotAdapter.use + package: botbuilder + summary: Adds middleware to the adapter's pipeline. + remarks: >- + Middleware is added to the adapter at initialization time. + + Each turn, the adapter calls its middleware in the order in which you + added it. + isDeprecated: false + syntax: + content: >- + function use(middlewares: (MiddlewareHandler | Middleware)[]): + BotAdapter + parameters: + - id: middlewares + type: >- + ( | )[] + description: The middleware or middleware handlers to add. + return: + description: The updated adapter object. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotComponent.yml new file mode 100644 index 00000000..df3d350b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotComponent.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: BotComponent +uid: botbuilder.BotComponent +package: botbuilder +summary: >- + Definition of a BotComponent that allows registration of services, custom + actions, memory scopes and adapters. + + + To make your components available to the system you derive from BotComponent + and register services to add functionality. + + These components then are consumed in appropriate places by the systems that + need them. When using Composer, configureServices + + gets called automatically on the components by the bot runtime, as long as the + components are registered in the configuration. +fullName: BotComponent +remarks: '' +isDeprecated: false +type: class +properties: + - name: z + uid: botbuilder.BotComponent.z + package: botbuilder + summary: '' + fullName: z + remarks: '' + isDeprecated: false + syntax: + content: 'static z: ZodType' + return: + description: '' + type: >- + ZodType<, ZodTypeDef, > +methods: + - name: configureServices(ServiceCollection, Configuration) + uid: botbuilder.BotComponent.configureServices + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function configureServices(services: ServiceCollection, configuration: + Configuration) + parameters: + - id: services + type: ServiceCollection + description: '' + - id: configuration + type: Configuration + description: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuth.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuth.yml new file mode 100644 index 00000000..d767cf0c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuth.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BotConfigAuth +uid: botbuilder.BotConfigAuth +package: botbuilder +summary: '' +fullName: BotConfigAuth +remarks: '' +isDeprecated: false +type: interface +properties: + - name: suggestedActions + uid: botbuilder.BotConfigAuth.suggestedActions + package: botbuilder + summary: SuggestedActions for the Bot Config Auth + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: type + uid: botbuilder.BotConfigAuth.type + package: botbuilder + summary: Type of the Bot Config Auth + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "auth"' + return: + description: '' + type: '"auth"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuthType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuthType.yml new file mode 100644 index 00000000..498a8e43 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotConfigAuthType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotConfigAuthType +uid: botbuilder.BotConfigAuthType +package: botbuilder +summary: |- + Defines possible values for BotConfigAuth type. + Possible values include: "auth" +fullName: BotConfigAuthType +remarks: '' +isDeprecated: false +syntax: | + type BotConfigAuthType = "auth" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapter.yml index 76751f55..d3d4b346 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapter.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: BotFrameworkAdapter remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Use `CloudAdapter` instead. type: class @@ -39,15 +38,13 @@ constructors: class defines the available adapter settings. - isPreview: false isDeprecated: false syntax: content: 'new BotFrameworkAdapter(settings?: Partial)' parameters: - id: settings type: Partial<> - description: | - Optional. The settings to use for this adapter instance. + description: Optional. The settings to use for this adapter instance. properties: - name: isStreamingConnectionOpen uid: botbuilder.BotFrameworkAdapter.isStreamingConnectionOpen @@ -57,20 +54,32 @@ properties: open for the bot to send activities. fullName: isStreamingConnectionOpen remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean isStreamingConnectionOpen return: - description: 'True if the streaming connection is open, otherwise false.' + description: True if the streaming connection is open, otherwise false. type: boolean + - name: onTurnError + uid: botbuilder.BotFrameworkAdapter.onTurnError + package: botbuilder + summary: >- + Gets or sets an error handler that can catch exceptions in the middleware + or application. + fullName: onTurnError + remarks: '' + isDeprecated: false + syntax: + content: '(context: TurnContext, error: Error) => Promise onTurnError' + return: + description: A promise representing the async operation. + type: '(context: TurnContext, error: Error) => Promise<void>' - name: TokenApiClientCredentialsKey uid: botbuilder.BotFrameworkAdapter.TokenApiClientCredentialsKey package: botbuilder summary: '' fullName: TokenApiClientCredentialsKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'TokenApiClientCredentialsKey: symbol' @@ -84,56 +93,45 @@ inheritedProperties: summary: '' fullName: BotIdentityKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'BotIdentityKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From BotAdapter.BotIdentityKey + inheritanceDescription: >- + Inherited From + [BotAdapter.BotIdentityKey](xref:botbuilder.BotAdapter.BotIdentityKey) - name: ConnectorClientKey uid: botbuilder.BotFrameworkAdapter.ConnectorClientKey package: botbuilder summary: '' fullName: ConnectorClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorClientKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From BotAdapter.ConnectorClientKey + inheritanceDescription: >- + Inherited From + [BotAdapter.ConnectorClientKey](xref:botbuilder.BotAdapter.ConnectorClientKey) - name: OAuthScopeKey uid: botbuilder.BotFrameworkAdapter.OAuthScopeKey package: botbuilder summary: '' fullName: OAuthScopeKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'OAuthScopeKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From BotAdapter.OAuthScopeKey - - name: onTurnError - uid: botbuilder.BotFrameworkAdapter.onTurnError - package: botbuilder - summary: '' - fullName: onTurnError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onTurnError: (context: TurnContext, error: Error) => Promise' - return: - description: '' - type: '(context: TurnContext, error: Error) => Promise<void>' - inheritanceDescription: Inherited From BotAdapter.onTurnError + inheritanceDescription: >- + Inherited From + [BotAdapter.OAuthScopeKey](xref:botbuilder.BotAdapter.OAuthScopeKey) inheritedMethods: - name: >- continueConversationAsync(ClaimsIdentity, Partial, @@ -144,7 +142,6 @@ inheritedMethods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -158,7 +155,7 @@ inheritedMethods: A [ClaimsIdentity](xref:botframework-connector) for the conversation. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -169,7 +166,9 @@ inheritedMethods: return: description: a promise representing the async operation type: Promise<void> - inheritanceDescription: Inherited From BotAdapter.continueConversationAsync + inheritanceDescription: >- + Inherited From + [BotAdapter.continueConversationAsync](xref:botbuilder.BotAdapter.continueConversationAsync) - name: >- continueConversationAsync(ClaimsIdentity, Partial, string, (context: TurnContext) => Promise) @@ -179,7 +178,6 @@ inheritedMethods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -193,7 +191,7 @@ inheritedMethods: A [ClaimsIdentity](xref:botframework-connector) for the conversation. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -207,7 +205,9 @@ inheritedMethods: return: description: a promise representing the async operation type: Promise<void> - inheritanceDescription: Inherited From BotAdapter.continueConversationAsync + inheritanceDescription: >- + Inherited From + [BotAdapter.continueConversationAsync](xref:botbuilder.BotAdapter.continueConversationAsync) - name: >- continueConversationAsync(string, Partial, (context: TurnContext) => Promise) @@ -217,7 +217,6 @@ inheritedMethods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -232,7 +231,7 @@ inheritedMethods: tenant the Adapters (Console,Test, etc) but is critical to the BotFrameworkAdapter which is multi-tenant aware. - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- A partial [ConversationReference](xref:botframework-schema.ConversationReference) @@ -243,7 +242,9 @@ inheritedMethods: return: description: a promise representing the async operation type: Promise<void> - inheritanceDescription: Inherited From BotAdapter.continueConversationAsync + inheritanceDescription: >- + Inherited From + [BotAdapter.continueConversationAsync](xref:botbuilder.BotAdapter.continueConversationAsync) - name: >- createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise) @@ -268,7 +269,6 @@ inheritedMethods: activity's converstion will contain the ID of the new conversation. - isPreview: false isDeprecated: false syntax: content: >- @@ -292,7 +292,7 @@ inheritedMethods: The audience for the connector. - id: _conversationParameters - type: ConversationParameters + type: description: The conversation information to use to create the conversation - id: _logic type: '(context: TurnContext) => Promise<void>' @@ -300,10 +300,10 @@ inheritedMethods: return: description: A promise that represents the asynchronous operation type: Promise<void> - inheritanceDescription: Inherited From BotAdapter.createConversationAsync - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) + inheritanceDescription: >- + Inherited From + [BotAdapter.createConversationAsync](xref:botbuilder.BotAdapter.createConversationAsync) + - name: use((MiddlewareHandler | Middleware)[]) uid: botbuilder.BotFrameworkAdapter.use package: botbuilder summary: Adds middleware to the adapter's pipeline. @@ -312,22 +312,21 @@ inheritedMethods: Each turn, the adapter calls its middleware in the order in which you added it. - isPreview: false isDeprecated: false syntax: content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this + function use(middlewares: (MiddlewareHandler | Middleware)[]): + BotFrameworkAdapter parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | Middleware[] + ( | )[] description: The middleware or middleware handlers to add. return: description: The updated adapter object. - type: this - inheritanceDescription: Inherited From BotAdapter.use + type: + inheritanceDescription: Inherited From [BotAdapter.use](xref:botbuilder.BotAdapter.use) methods: - name: >- continueConversation(Partial, (context: @@ -403,7 +402,6 @@ methods: }); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -411,12 +409,11 @@ methods: logic: (context: TurnContext) => Promise): Promise parameters: - id: reference - type: Partial<ConversationReference> + type: Partial<> description: A reference to the conversation to continue. - id: logic type: '(context: TurnContext) => Promise<void>' - description: | - The asynchronous method to call after the adapter middleware runs. + description: The asynchronous method to call after the adapter middleware runs. return: description: '' type: Promise<void> @@ -429,7 +426,6 @@ methods: Asynchronously resumes a conversation with a user, possibly after some time has gone by. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -438,10 +434,10 @@ methods: Promise parameters: - id: reference - type: Partial<ConversationReference> + type: Partial<> description: >- - (xref:botframework-schema.ConversationReference) of the conversation - to continue. + [ConversationReference](xref:botframework-schema.ConversationReference) + of the conversation to continue. - id: oAuthScope type: string description: >- @@ -449,7 +445,7 @@ methods: call to continue the conversation. - id: logic type: '(context: TurnContext) => Promise<void>' - description: > + description: >- Optional. The asynchronous method to call after the adapter middleware runs. return: @@ -462,7 +458,6 @@ methods: remarks: >- Override this in a derived class to create a mock connector client for unit testing. - isPreview: false isDeprecated: false syntax: content: 'function createConnectorClient(serviceUrl: string): ConnectorClient' @@ -475,7 +470,7 @@ methods: The [ConnectorClient](xref:botbuilder-connector.ConnectorClient) instance. type: ConnectorClient - - name: 'createConnectorClientWithIdentity(string, ClaimsIdentity)' + - name: createConnectorClientWithIdentity(string, ClaimsIdentity) uid: botbuilder.BotFrameworkAdapter.createConnectorClientWithIdentity package: botbuilder summary: Create a ConnectorClient with a ClaimsIdentity. @@ -485,7 +480,6 @@ methods: Derives the correct audience from the ClaimsIdentity, or the instance's credentials property. - isPreview: false isDeprecated: false syntax: content: >- @@ -497,12 +491,11 @@ methods: description: The client's service URL. - id: identity type: ClaimsIdentity - description: | - ClaimsIdentity + description: ClaimsIdentity return: description: '' type: Promise<ConnectorClient> - - name: 'createConnectorClientWithIdentity(string, ClaimsIdentity, string)' + - name: createConnectorClientWithIdentity(string, ClaimsIdentity, string) uid: botbuilder.BotFrameworkAdapter.createConnectorClientWithIdentity_1 package: botbuilder summary: Create a ConnectorClient with a ClaimsIdentity and an explicit audience. @@ -511,7 +504,6 @@ methods: be derived from the ClaimsIdentity or the instance's credentials property. - isPreview: false isDeprecated: false syntax: content: >- @@ -526,7 +518,7 @@ methods: description: ClaimsIdentity - id: audience type: string - description: > + description: >- The recipient of the ConnectorClient's messages. Normally the Bot Framework Channel Service or the AppId of another bot. return: @@ -539,7 +531,6 @@ methods: package: botbuilder summary: Asynchronously creates and starts a conversation with a user on a channel. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -547,7 +538,7 @@ methods: logic: (context: TurnContext) => Promise): Promise parameters: - id: reference - type: Partial<ConversationReference> + type: Partial<> description: A reference for the conversation to create. - id: logic type: '(context: TurnContext) => Promise<void>' @@ -562,7 +553,6 @@ methods: package: botbuilder summary: Asynchronously creates and starts a conversation with a user on a channel. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -571,10 +561,10 @@ methods: TurnContext) => Promise): Promise parameters: - id: reference - type: Partial<ConversationReference> + type: Partial<> description: A reference for the conversation to create. - id: parameters - type: Partial<ConversationParameters> + type: Partial<> description: Parameters used when creating the conversation - id: logic type: '(context: TurnContext) => Promise<void>' @@ -582,12 +572,13 @@ methods: return: description: a promise representing the asynchronous operation type: Promise<void> - - name: 'deleteActivity(TurnContext, Partial)' + - name: deleteActivity(TurnContext, Partial) uid: botbuilder.BotFrameworkAdapter.deleteActivity package: botbuilder - summary: > + summary: >- Asynchronously deletes an existing activity. + This interface supports the framework and is not intended to be called directly for your code. @@ -599,7 +590,6 @@ methods: remarks: >- Not all channels support this operation. For channels that don't, this call may throw an exception. - isPreview: false isDeprecated: false syntax: content: >- @@ -607,16 +597,15 @@ methods: Partial): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: reference - type: Partial<ConversationReference> - description: | - Conversation reference information for the activity to delete. + type: Partial<> + description: Conversation reference information for the activity to delete. return: description: '' type: Promise<void> - - name: 'deleteConversationMember(TurnContext, string)' + - name: deleteConversationMember(TurnContext, string) uid: botbuilder.BotFrameworkAdapter.deleteConversationMember package: botbuilder summary: Asynchronously removes a member from the current conversation. @@ -626,7 +615,6 @@ methods: Not all channels support this operation. For channels that don't, this call may throw an exception. - isPreview: false isDeprecated: false syntax: content: >- @@ -634,39 +622,38 @@ methods: string): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: memberId type: string - description: | - The ID of the member to remove from the conversation. + description: The ID of the member to remove from the conversation. return: description: '' type: Promise<void> - - name: 'emulateOAuthCards(TurnContext | string, boolean)' + - name: emulateOAuthCards(string | TurnContext, boolean) uid: botbuilder.BotFrameworkAdapter.emulateOAuthCards package: botbuilder - summary: > + summary: >- Asynchronously sends an emulated OAuth card for a channel. + This method supports the framework and is not intended to be called directly for your code. remarks: >- When testing a bot in the Bot Framework Emulator, this method can emulate the OAuth card interaction. - isPreview: false isDeprecated: false syntax: content: >- - function emulateOAuthCards(contextOrServiceUrl: TurnContext | string, + function emulateOAuthCards(contextOrServiceUrl: string | TurnContext, emulate: boolean): Promise parameters: - id: contextOrServiceUrl - type: TurnContext | string + type: string | description: The URL of the emulator. - id: emulate type: boolean - description: > + description: >- `true` to send an emulated OAuth card to the emulator; or `false` to not send the card. return: @@ -681,7 +668,6 @@ methods: Asynchronously Performs a token exchange operation such as for single sign-on. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -690,7 +676,7 @@ methods: appCredentials?: CoreAppCredentials): Promise parameters: - id: context - type: TurnContext + type: description: Context for the current turn of conversation with the user. - id: connectionName type: string @@ -699,72 +685,74 @@ methods: type: string description: The user id that will be associated with the token. - id: tokenExchangeRequest - type: TokenExchangeRequest + type: description: >- The exchange request details, either a token to exchange or a uri to exchange. - id: appCredentials - type: CoreAppCredentials - description: | - Optional. The CoreAppCredentials for OAuth. + type: + description: Optional. The CoreAppCredentials for OAuth. return: description: '' - type: Promise<TokenResponse> - - name: 'getAadTokens(TurnContext, string, string[])' + type: Promise<> + - name: getAadTokens(TurnContext, string, string[]) uid: botbuilder.BotFrameworkAdapter.getAadTokens package: botbuilder summary: Asynchronously signs out the user from the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAadTokens(context: TurnContext, connectionName: string, - resourceUrls: string[]): Promise<[key: string]: TokenResponse> + resourceUrls: string[]): Promise<{[propertyName: string]: + TokenResponse}> parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: connectionName type: string description: The name of the auth connection to use. - id: resourceUrls - type: 'string[]' + type: string[] description: The list of resource URLs to retrieve tokens for. return: description: >- A map of the [TokenResponse](xref:botframework-schema.TokenResponse) objects by resource URL. - type: 'Promise<[key: string]: TokenResponse>' - - name: 'getAadTokens(TurnContext, string, string[], CoreAppCredentials)' + type: >- + Promise<{[propertyName: string]: }> + - name: getAadTokens(TurnContext, string, string[], CoreAppCredentials) uid: botbuilder.BotFrameworkAdapter.getAadTokens_1 package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], oAuthAppCredentials?: CoreAppCredentials): - Promise<[key: string]: TokenResponse> + Promise<{[propertyName: string]: TokenResponse}> parameters: - id: context - type: TurnContext + type: description: '' - id: connectionName type: string description: '' - id: resourceUrls - type: 'string[]' + type: string[] description: '' - id: oAuthAppCredentials - type: CoreAppCredentials + type: description: '' return: description: '' - type: 'Promise<[key: string]: TokenResponse>' - - name: 'getActivityMembers(TurnContext, string)' + type: >- + Promise<{[propertyName: string]: }> + - name: getActivityMembers(TurnContext, string) uid: botbuilder.BotFrameworkAdapter.getActivityMembers package: botbuilder summary: Asynchronously lists the members of a given activity. @@ -780,7 +768,6 @@ methods: in that it will return only those users directly involved in the activity, not all members of the conversation. - isPreview: false isDeprecated: false syntax: content: >- @@ -788,11 +775,11 @@ methods: Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: activityId type: string - description: > + description: >- Optional. The ID of the activity to get the members of. If not specified, the current activity ID is used. return: @@ -801,7 +788,7 @@ methods: objects for the users involved in a given activity. - type: 'Promise<ChannelAccount[]>' + type: Promise<[]> - name: getConversationMembers(TurnContext) uid: botbuilder.BotFrameworkAdapter.getConversationMembers package: botbuilder @@ -818,7 +805,6 @@ methods: in that it will return all members of the conversation, not just those directly involved in a specific activity. - isPreview: false isDeprecated: false syntax: content: >- @@ -826,17 +812,16 @@ methods: Promise parameters: - id: context - type: TurnContext - description: | - The context object for the turn. + type: + description: The context object for the turn. return: description: >- An array of [ChannelAccount](xref:botframework-schema.ChannelAccount) objects for all users currently involved in a conversation. - type: 'Promise<ChannelAccount[]>' - - name: 'getConversations(TurnContext | string, string)' + type: Promise<[]> + - name: getConversations(string | TurnContext, string) uid: botbuilder.BotFrameworkAdapter.getConversations package: botbuilder summary: >- @@ -872,15 +857,14 @@ methods: retrieved from `contextOrServiceUrl`.[activity](xref:botbuilder-core.TurnContext.activity).[serviceUrl](xref:botframework-schema.Activity.serviceUrl). - isPreview: false isDeprecated: false syntax: content: >- - function getConversations(contextOrServiceUrl: TurnContext | string, + function getConversations(contextOrServiceUrl: string | TurnContext, continuationToken?: string): Promise parameters: - id: contextOrServiceUrl - type: TurnContext | string + type: string | description: >- The URL of the channel server to query or a @@ -888,7 +872,7 @@ methods: conversation on the channel. - id: continuationToken type: string - description: > + description: >- Optional. The continuation token from the previous page of results. Omit this parameter or use `undefined` to retrieve the first page of @@ -899,8 +883,8 @@ methods: object containing a page of results and a continuation token. - type: Promise<ConversationsResult> - - name: 'getSignInLink(TurnContext, string, AppCredentials, string, string)' + type: Promise<> + - name: getSignInLink(TurnContext, string, AppCredentials, string, string) uid: botbuilder.BotFrameworkAdapter.getSignInLink package: botbuilder summary: >- @@ -909,7 +893,6 @@ methods: of a [SigninCard](xref:botframework-schema.SigninCard). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -918,7 +901,7 @@ methods: string): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: connectionName type: string @@ -931,17 +914,15 @@ methods: description: The user id that will be associated with the token. - id: finalRedirect type: string - description: | - The final URL that the OAuth flow will redirect to. + description: The final URL that the OAuth flow will redirect to. return: description: '' type: Promise<string> - - name: 'getSignInLink(TurnContext, string, CoreAppCredentials, string, string)' + - name: getSignInLink(TurnContext, string, CoreAppCredentials, string, string) uid: botbuilder.BotFrameworkAdapter.getSignInLink_1 package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -950,13 +931,13 @@ methods: finalRedirect?: string): Promise parameters: - id: context - type: TurnContext + type: description: '' - id: connectionName type: string description: '' - id: oAuthAppCredentials - type: CoreAppCredentials + type: description: '' - id: userId type: string @@ -967,14 +948,13 @@ methods: return: description: '' type: Promise<string> - - name: 'getSignInResource(TurnContext, string, string, string, CoreAppCredentials)' + - name: getSignInResource(TurnContext, string, string, string, CoreAppCredentials) uid: botbuilder.BotFrameworkAdapter.getSignInResource package: botbuilder summary: >- Asynchronously Get the raw signin resource to be sent to the user for signin. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -983,7 +963,7 @@ methods: CoreAppCredentials): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: connectionName type: string @@ -995,22 +975,21 @@ methods: type: string description: The final URL that the OAuth flow will redirect to. - id: appCredentials - type: CoreAppCredentials + type: description: Optional. The CoreAppCredentials for OAuth. return: description: >- The [BotSignInGetSignInResourceResponse](xref:botframework-connector.BotSignInGetSignInResourceResponse) object. - type: Promise<SignInUrlResponse> - - name: 'getTokenStatus(TurnContext, string, string)' + type: Promise<> + - name: getTokenStatus(TurnContext, string, string) uid: botbuilder.BotFrameworkAdapter.getTokenStatus package: botbuilder summary: >- Asynchronously retrieves the token status for each configured connection for the given user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1018,7 +997,7 @@ methods: includeFilter?: string): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: userId type: string @@ -1036,13 +1015,12 @@ methods: description: >- The [TokenStatus](xref:botframework-connector.TokenStatus) objects retrieved. - type: 'Promise<TokenStatus[]>' - - name: 'getTokenStatus(TurnContext, string, string, CoreAppCredentials)' + type: Promise<[]> + - name: getTokenStatus(TurnContext, string, string, CoreAppCredentials) uid: botbuilder.BotFrameworkAdapter.getTokenStatus_1 package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1051,7 +1029,7 @@ methods: Promise parameters: - id: context - type: TurnContext + type: description: '' - id: userId type: string @@ -1060,19 +1038,18 @@ methods: type: string description: '' - id: oAuthAppCredentials - type: CoreAppCredentials + type: description: '' return: description: '' - type: 'Promise<TokenStatus[]>' - - name: 'getUserToken(TurnContext, string, string)' + type: Promise<[]> + - name: getUserToken(TurnContext, string, string) uid: botbuilder.BotFrameworkAdapter.getUserToken package: botbuilder summary: >- Asynchronously attempts to retrieve the token for a user that's in a login flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1080,7 +1057,7 @@ methods: magicCode?: string): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: connectionName type: string @@ -1092,13 +1069,12 @@ methods: description: >- A [TokenResponse](xref:botframework-schema.TokenResponse) object that contains the user token. - type: Promise<TokenResponse> - - name: 'getUserToken(TurnContext, string, string, CoreAppCredentials)' + type: Promise<> + - name: getUserToken(TurnContext, string, string, CoreAppCredentials) uid: botbuilder.BotFrameworkAdapter.getUserToken_1 package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1107,7 +1083,7 @@ methods: Promise parameters: - id: context - type: TurnContext + type: description: '' - id: connectionName type: string @@ -1116,13 +1092,14 @@ methods: type: string description: '' - id: oAuthAppCredentials - type: CoreAppCredentials + type: description: '' return: description: '' - type: Promise<TokenResponse> + type: Promise<> - name: >- - process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => + process(Request, Record>, INodeSocket, INodeBuffer, (context: TurnContext) => Promise) uid: botbuilder.BotFrameworkAdapter.process_1 package: botbuilder @@ -1130,16 +1107,18 @@ methods: Handle a web socket connection by applying a logic function to each streaming request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function process(req: Request, socket: INodeSocket, head: INodeBuffer, + function process(req: Request, Record>, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise): Promise parameters: - id: req - type: - description: 'An incoming HTTP [Request](xref:botbuilder.Request)' + type: >- + <Record<string, unknown>, + Record<string, undefined | string | string[]>> + description: An incoming HTTP [Request](xref:botbuilder.Request) - id: socket type: INodeSocket description: >- @@ -1156,24 +1135,28 @@ methods: return: description: a promise representing the asynchronous operation. type: Promise<void> - - name: 'process(Request, Response, (context: TurnContext) => Promise)' + - name: >- + process(Request, Record>, Response, (context: TurnContext) => Promise) uid: botbuilder.BotFrameworkAdapter.process package: botbuilder summary: Process a web request by applying a logic function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function process(req: Request, res: Response, logic: (context: + function process(req: Request, Record>, res: Response, logic: (context: TurnContext) => Promise): Promise parameters: - id: req - type: - description: 'An incoming HTTP [Request](xref:botbuilder.Request)' + type: >- + <Record<string, unknown>, + Record<string, undefined | string | string[]>> + description: An incoming HTTP [Request](xref:botbuilder.Request) - id: res type: - description: 'The corresponding HTTP [Response](xref:botbuilder.Response)' + description: The corresponding HTTP [Response](xref:botbuilder.Response) - id: logic type: '(context: TurnContext) => Promise<void>' description: The logic function to apply @@ -1255,7 +1238,6 @@ methods: }); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -1270,8 +1252,7 @@ methods: description: An Express or Restify style response object. - id: logic type: '(context: TurnContext) => Promise<any>' - description: | - The function to call at the end of the middleware pipeline. + description: The function to call at the end of the middleware pipeline. return: description: '' type: Promise<void> @@ -1281,6 +1262,9 @@ methods: summary: >- Asynchronously creates a turn context and runs the middleware pipeline for an incoming activity. + + + Use [CloudAdapter.processActivityDirect] instead. remarks: >- This is the main way a bot receives incoming messages and defines a turn in the conversation. This method: @@ -1313,7 +1297,6 @@ methods: Use the adapter's [use](xref:botbuilder-core.BotAdapter.use) method to add middleware to the adapter. - isPreview: false isDeprecated: false syntax: content: >- @@ -1321,12 +1304,11 @@ methods: TurnContext) => Promise): Promise parameters: - id: activity - type: Activity + type: description: The activity to process. - id: logic type: '(context: TurnContext) => Promise<any>' - description: | - The function to call at the end of the middleware pipeline. + description: The function to call at the end of the middleware pipeline. return: description: '' type: Promise<void> @@ -1339,7 +1321,6 @@ methods: then generates and returns a response if appropriate. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1354,12 +1335,13 @@ methods: A response created by the BotAdapter to be sent to the client that originated the request. type: Promise<StreamingResponse> - - name: 'sendActivities(TurnContext, Partial[])' + - name: sendActivities(TurnContext, Partial[]) uid: botbuilder.BotFrameworkAdapter.sendActivities package: botbuilder - summary: > + summary: >- Asynchronously sends a set of outgoing activities to a channel server. + This method supports the framework and is not intended to be called directly for your code. @@ -1376,7 +1358,6 @@ methods: activities this will contain the ID of the delivered message. - isPreview: false isDeprecated: false syntax: content: >- @@ -1384,21 +1365,19 @@ methods: Partial[]): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: activities - type: 'Partial<Activity>[]' - description: | - The activities to send. + type: Partial<>[] + description: The activities to send. return: - description: 'An array of [ResourceResponse](xref:botbuilder.Request)' - type: 'Promise<ResourceResponse[]>' - - name: 'signOutUser(TurnContext, string, string)' + description: An array of [ResourceResponse](xref:botbuilder.Os) + type: Promise<[]> + - name: signOutUser(TurnContext, string, string) uid: botbuilder.BotFrameworkAdapter.signOutUser package: botbuilder summary: Asynchronously signs out the user from the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1406,7 +1385,7 @@ methods: userId?: string): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: connectionName type: string @@ -1417,12 +1396,11 @@ methods: return: description: '' type: Promise<void> - - name: 'signOutUser(TurnContext, string, string, CoreAppCredentials)' + - name: signOutUser(TurnContext, string, string, CoreAppCredentials) uid: botbuilder.BotFrameworkAdapter.signOutUser_1 package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1431,7 +1409,7 @@ methods: Promise parameters: - id: context - type: TurnContext + type: description: '' - id: connectionName type: string @@ -1440,17 +1418,18 @@ methods: type: string description: '' - id: oAuthAppCredentials - type: CoreAppCredentials + type: description: '' return: description: '' type: Promise<void> - - name: 'updateActivity(TurnContext, Partial)' + - name: updateActivity(TurnContext, Partial) uid: botbuilder.BotFrameworkAdapter.updateActivity package: botbuilder - summary: > + summary: >- Asynchronously replaces a previous activity with an updated version. + This interface supports the framework and is not intended to be called directly for your code. @@ -1462,25 +1441,24 @@ methods: remarks: >- Not all channels support this operation. For channels that don't, this call may throw an exception. - isPreview: false isDeprecated: false syntax: content: >- function updateActivity(context: TurnContext, activity: - Partial): Promise + Partial): Promise parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: activity - type: Partial<Activity> + type: Partial<> description: The updated version of the activity to replace. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse | void> + type: Promise<void | > - name: >- useNamedPipe((context: TurnContext) => Promise, string, number, () => void) @@ -1490,7 +1468,6 @@ methods: Connects the handler to a Named Pipe server and begins listening for incoming requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1509,7 +1486,7 @@ methods: description: Number of times to attempt to bind incoming and outgoing pipe - id: onListen type: () => void - description: > + description: >- Optional callback that fires once when server is listening on both incoming and outgoing pipe return: @@ -1524,7 +1501,6 @@ methods: Process the initial request to establish a long lived connection via a streaming server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1545,10 +1521,10 @@ methods: description: The first packet of the upgraded stream. - id: logic type: '(context: TurnContext) => Promise<any>' - description: > + description: >- The logic that handles incoming streaming requests for the lifetime of the WebSocket connection. return: description: '' type: Promise<void> -extends: BotAdapter +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapterSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapterSettings.yml index 6f253321..77cbf798 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapterSettings.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkAdapterSettings.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: BotFrameworkAdapterSettings remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: >- Use `CloudAdapter` with `ConfigurationBotFrameworkAuthentication` instead to @@ -23,7 +22,6 @@ properties: Portal](https://dev.botframework.com/). fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -38,7 +36,6 @@ properties: Portal](https://dev.botframework.com/). fullName: appPassword remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appPassword: string' @@ -53,7 +50,6 @@ properties: Recommended for Skills. fullName: authConfig remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authConfig?: AuthenticationConfiguration' @@ -66,7 +62,6 @@ properties: summary: Optional. Certificate key to authenticate the appId against AAD. fullName: certificatePrivateKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'certificatePrivateKey?: string' @@ -79,7 +74,6 @@ properties: summary: Optional. Certificate thumbprint to authenticate the appId against AAD. fullName: certificateThumbprint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'certificateThumbprint?: string' @@ -92,7 +86,6 @@ properties: summary: Optional. The tenant to acquire the bot-to-channel token from. fullName: channelAuthTenant remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelAuthTenant?: string' @@ -107,7 +100,6 @@ properties: from Azure or other channel locations. fullName: channelService remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelService?: string' @@ -120,7 +112,6 @@ properties: summary: Optional. Used when creating new ConnectorClients. fullName: clientOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientOptions?: ConnectorClientOptions' @@ -133,7 +124,6 @@ properties: summary: Optional. The OAuth API endpoint for your bot to use. fullName: oAuthEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'oAuthEndpoint?: string' @@ -146,7 +136,6 @@ properties: summary: Optional. The OpenID Metadata endpoint for your bot to use. fullName: openIdMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'openIdMetadata?: string' @@ -159,7 +148,6 @@ properties: summary: Optional. Used to pass in a NodeWebSocketFactoryBase instance. fullName: webSocketFactory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'webSocketFactory?: NodeWebSocketFactoryBase' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkClient.yml new file mode 100644 index 00000000..694d1b0b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkClient.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: BotFrameworkClient +uid: botbuilder.BotFrameworkClient +package: botbuilder +summary: '' +fullName: BotFrameworkClient +remarks: '' +isDeprecated: false +type: interface +properties: + - name: postActivity + uid: botbuilder.BotFrameworkClient.postActivity + package: botbuilder + summary: Forwards an activity to a another bot. + fullName: postActivity + remarks: '' + isDeprecated: false + syntax: + content: >- + postActivity: (fromBotId: string, toBotId: string, toUrl: string, + serviceUrl: string, conversationId: string, activity: Activity) => + Promise> + return: + description: '' + type: >- + (fromBotId: string, toBotId: string, toUrl: string, serviceUrl: + string, conversationId: string, activity: Activity) => + Promise<InvokeResponse<T>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpAdapter.yml index 60c715c3..fd95d9c7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpAdapter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpAdapter.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: BotFrameworkHttpAdapter remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: |- Use `CloudAdapter` instead. @@ -14,7 +13,8 @@ customDeprecatedMessage: |- type: interface methods: - name: >- - process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => + process(Request, Record>, INodeSocket, INodeBuffer, (context: TurnContext) => Promise) uid: botbuilder.BotFrameworkHttpAdapter.process_1 package: botbuilder @@ -22,15 +22,17 @@ methods: Handle a web socket connection by applying a logic callback function to each streaming request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function process(req: Request, socket: INodeSocket, head: INodeBuffer, + function process(req: Request, Record>, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise): Promise parameters: - id: req - type: Request + type: >- + <Record<string, unknown>, + Record<string, undefined | string | string[]>> description: '' - id: socket type: INodeSocket @@ -44,23 +46,27 @@ methods: return: description: '' type: Promise<void> - - name: 'process(Request, Response, (context: TurnContext) => Promise)' + - name: >- + process(Request, Record>, Response, (context: TurnContext) => Promise) uid: botbuilder.BotFrameworkHttpAdapter.process package: botbuilder summary: Process a web request by applying a logic callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function process(req: Request, res: Response, logic: (context: + function process(req: Request, Record>, res: Response, logic: (context: TurnContext) => Promise): Promise parameters: - id: req - type: Request + type: >- + <Record<string, unknown>, + Record<string, undefined | string | string[]>> description: '' - id: res - type: Response + type: description: '' - id: logic type: '(context: TurnContext) => Promise<void>' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpClient.yml index 053f6f25..875fd026 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkHttpClient.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: BotFrameworkHttpClient remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: >- Use `BotFrameworkAuthentication.createBotFrameworkClient()` to obtain a client @@ -15,14 +14,13 @@ customDeprecatedMessage: >- HttpClient for calling skills from a Node.js BotBuilder V4 SDK bot. type: class constructors: - - name: 'BotFrameworkHttpClient(ICredentialProvider, string)' + - name: BotFrameworkHttpClient(ICredentialProvider, string) uid: botbuilder.BotFrameworkHttpClient.constructor package: botbuilder summary: >- Creates a new instance of the [BotFrameworkHttpClient](xref:botbuilder.BotFrameworkHttpClient) class remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,15 +34,13 @@ constructors: [ICredentialProvider](xref:botframework-connector.ICredentialProvider). - id: channelService type: string - description: | - Optional. The channel service. + description: Optional. The channel service. methods: - - name: 'postActivity(string, string, string, string, string, Activity)' + - name: postActivity(string, string, string, string, string, Activity) uid: botbuilder.BotFrameworkHttpClient.postActivity package: botbuilder summary: Forwards an activity to another bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -68,8 +64,8 @@ methods: type: string description: A conversation ID to use for the conversation with the skill. - id: activity - type: Activity + type: description: Activity to forward. return: description: A promise representing the asynchronous operation. - type: Promise<InvokeResponse<T>> + type: Promise<<T>> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkSkill.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkSkill.yml new file mode 100644 index 00000000..9a398c54 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotFrameworkSkill.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: BotFrameworkSkill +uid: botbuilder.BotFrameworkSkill +package: botbuilder +summary: Registration for a BotFrameworkHttpProtocol based Skill endpoint. +fullName: BotFrameworkSkill +remarks: '' +isDeprecated: false +type: interface +properties: + - name: appId + uid: botbuilder.BotFrameworkSkill.appId + package: botbuilder + summary: AppId of the skill. + fullName: appId + remarks: '' + isDeprecated: false + syntax: + content: 'appId: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.BotFrameworkSkill.id + package: botbuilder + summary: Id of the skill. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: skillEndpoint + uid: botbuilder.BotFrameworkSkill.skillEndpoint + package: botbuilder + summary: Endpoint for the skill + fullName: skillEndpoint + remarks: '' + isDeprecated: false + syntax: + content: 'skillEndpoint: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotHandler.yml new file mode 100644 index 00000000..3cbf3e71 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotHandler.yml @@ -0,0 +1,43 @@ +### YamlMime:TSTypeAlias +name: BotHandler +uid: botbuilder.BotHandler +package: botbuilder +summary: >- + Describes a bot activity event handler, for use with an + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. +fullName: BotHandler +remarks: >- + **Parameters** + + + | Name | Type | Description | + + | :--- | :--- | :--- | + + | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The context + object for the turn. | + + | `next` | () => Promise | A continuation function for handling the + activity. | + + + **Returns** + + + `any` + + + The incoming activity is contained in the `context` object's + [activity](xref:botbuilder-core.TurnContext.activity) property. + + Call the `next` function to continue the processing of activity events. Not + doing so will stop propagation of events for this activity. + + + A bot activity handler can return a value, to support _invoke_ activities. +isDeprecated: false +syntax: | + type BotHandler = ( + context: TurnContext, + next: () => Promise + ) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewActionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewActionType.yml new file mode 100644 index 00000000..fee554db --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewActionType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotMessagePreviewActionType +uid: botbuilder.BotMessagePreviewActionType +package: botbuilder +summary: |- + Defines values for BotMessagePreviewActionType. + Possible values include: 'edit', 'send' +fullName: BotMessagePreviewActionType +remarks: '' +isDeprecated: false +syntax: | + type BotMessagePreviewActionType = "edit" | "send" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewType.yml new file mode 100644 index 00000000..ed1a4719 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotMessagePreviewType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotMessagePreviewType +uid: botbuilder.BotMessagePreviewType +package: botbuilder +summary: |- + Defines values for BotMessagePreviewType. + Possible values include: 'message', 'continue' +fullName: BotMessagePreviewType +remarks: '' +isDeprecated: false +syntax: | + type BotMessagePreviewType = "message" | "continue" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotPageViewTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotPageViewTelemetryClient.yml new file mode 100644 index 00000000..b2ec7e6d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotPageViewTelemetryClient.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: BotPageViewTelemetryClient +uid: botbuilder.BotPageViewTelemetryClient +package: botbuilder +summary: '' +fullName: BotPageViewTelemetryClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: trackPageView(TelemetryPageView) + uid: botbuilder.BotPageViewTelemetryClient.trackPageView + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function trackPageView(telemetry: TelemetryPageView): any' + parameters: + - id: telemetry + type: + description: '' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotState.yml new file mode 100644 index 00000000..ee133709 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotState.yml @@ -0,0 +1,211 @@ +### YamlMime:TSType +name: BotState +uid: botbuilder.BotState +package: botbuilder +summary: Base class for the frameworks state persistance scopes. +fullName: BotState +remarks: >- + This class will read and write state, to a provided storage provider, for each + turn of + + conversation with a user. Derived classes, like `ConversationState` and + `UserState`, provide a + + `StorageKeyFactory` which is used to determine the key used to persist a given + storage object. + + + The state object thats loaded will be automatically cached on the context + object for the + + lifetime of the turn and will only be written to storage if it has been + modified. +isDeprecated: false +type: class +constructors: + - name: BotState(Storage, StorageKeyFactory) + uid: botbuilder.BotState.constructor + package: botbuilder + summary: Creates a new BotState instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new BotState(storage: Storage, storageKey: StorageKeyFactory)' + parameters: + - id: storage + type: + description: Storage provider to persist the state object to. + - id: storageKey + type: + description: >- + Function called anytime the storage key for a given turn needs to be + calculated. +methods: + - name: clear(TurnContext) + uid: botbuilder.BotState.clear + package: botbuilder + summary: Clears the current state object for a turn. + remarks: >- + The cleared state object will not be persisted until + [saveChanges()](#savechanges) has + + been called. + + + ```JavaScript + + await botState.clear(context); + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: 'function clear(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: createProperty(string) + uid: botbuilder.BotState.createProperty + package: botbuilder + summary: >- + Creates a new property accessor for reading and writing an individual + property to the bot + + states storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createProperty(name: string): StatePropertyAccessor' + parameters: + - id: name + type: string + description: Name of the property to add. + return: + description: An accessor for the property. + type: <T> + - name: delete(TurnContext) + uid: botbuilder.BotState.delete + package: botbuilder + summary: Delete the backing state object for the current turn. + remarks: >- + The state object will be removed from storage if it exists. If the state + object has been + + read in and cached, the cache will be cleared. + + + ```JavaScript + + await botState.delete(context); + + ``` + isDeprecated: false + syntax: + content: 'function delete(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: get(TurnContext) + uid: botbuilder.BotState.get + package: botbuilder + summary: Returns a cached state object or undefined if not cached. + remarks: >- + This example shows how to synchronously get an already loaded and cached + state object: + + + ```JavaScript + + const state = botState.get(context); + + ``` + isDeprecated: false + syntax: + content: 'function get(context: TurnContext): any' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A cached state object or undefined if not cached. + type: any + - name: load(TurnContext, boolean) + uid: botbuilder.BotState.load + package: botbuilder + summary: Reads in and caches the backing state object for a turn. + remarks: >- + Subsequent reads will return the cached object unless the `force` flag is + passed in which + + will force the state object to be re-read. + + + This method is automatically called on first access of any of created + property accessors. + + + ```JavaScript + + const state = await botState.load(context); + + ``` + isDeprecated: false + syntax: + content: 'function load(context: TurnContext, force?: boolean): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) If `true` the cache will be bypassed and the state will + always be read in directly from storage. Defaults to `false`. + return: + description: The cached state. + type: Promise<any> + - name: saveChanges(TurnContext, boolean) + uid: botbuilder.BotState.saveChanges + package: botbuilder + summary: Saves the cached state object if it's been changed. + remarks: >- + If the `force` flag is passed in the cached state object will be saved + regardless of + + whether its been changed or not and if no object has been cached, an empty + object will be + + created and then saved. + + + ```JavaScript + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: >- + function saveChanges(context: TurnContext, force?: boolean): + Promise + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) if `true` the state will always be written out regardless + of its change state. Defaults to `false`. + return: + description: A promise representing the async operation. + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotStatePropertyAccessor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotStatePropertyAccessor.yml new file mode 100644 index 00000000..4b2a6a3f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotStatePropertyAccessor.yml @@ -0,0 +1,122 @@ +### YamlMime:TSType +name: BotStatePropertyAccessor +uid: botbuilder.BotStatePropertyAccessor +package: botbuilder +summary: A `BotState` specific implementation of the `StatePropertyAccessor` interface. +fullName: BotStatePropertyAccessor +remarks: >- + Properties can be defined for a given `BotState` instance using + `createProperty()`. + + + ```JavaScript + + const dialogStateProperty = ConversationState.createProperty('dialogState'); + + const dialogs = new DialogSet(dialogStateProperty); + + ``` +isDeprecated: false +type: class +constructors: + - name: BotStatePropertyAccessor(BotState, string) + uid: botbuilder.BotStatePropertyAccessor.constructor + package: botbuilder + summary: Creates a new BotStatePropertyAccessor instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new BotStatePropertyAccessor(state: BotState, name: string)' + parameters: + - id: state + type: + description: Parent BotState instance. + - id: name + type: string + description: Unique name of the property for the parent BotState. +properties: + - name: name + uid: botbuilder.BotStatePropertyAccessor.name + package: botbuilder + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string +methods: + - name: delete(TurnContext) + uid: botbuilder.BotStatePropertyAccessor.delete + package: botbuilder + summary: Deletes the persisted property from its backing storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(context: TurnContext): Promise' + parameters: + - id: context + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. + return: + description: '' + type: Promise<void> + - name: get(TurnContext) + uid: botbuilder.BotStatePropertyAccessor.get + package: botbuilder + summary: Reads a persisted property from its backing storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function get(context: TurnContext): Promise' + parameters: + - id: context + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. + return: + description: A JSON representation of the cached state. + type: Promise<undefined | T> + - name: get(TurnContext, T) + uid: botbuilder.BotStatePropertyAccessor.get_1 + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function get(context: TurnContext, defaultValue: T): Promise' + parameters: + - id: context + type: + description: '' + - id: defaultValue + type: T + description: '' + return: + description: '' + type: Promise<T> + - name: set(TurnContext, T) + uid: botbuilder.BotStatePropertyAccessor.set + package: botbuilder + summary: Assigns a new value to the properties backing storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function set(context: TurnContext, value: T): Promise' + parameters: + - id: context + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. + - id: value + type: T + description: Value to set on the property. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotStateSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotStateSet.yml new file mode 100644 index 00000000..ac26171d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotStateSet.yml @@ -0,0 +1,107 @@ +### YamlMime:TSType +name: BotStateSet +uid: botbuilder.BotStateSet +package: botbuilder +summary: >- + A collection of `BotState` plugins that should be loaded or saved in parallel + as a single unit. + + See `AutoSaveStateMiddleware` for an implementation of this class. +fullName: BotStateSet +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BotStateSet(BotState[]) + uid: botbuilder.BotStateSet.constructor + package: botbuilder + summary: Creates a new BotStateSet instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new BotStateSet(botStates: BotState[])' + parameters: + - id: botStates + type: [] + description: One or more BotState plugins to register. +properties: + - name: botStates + uid: botbuilder.BotStateSet.botStates + package: botbuilder + summary: Array of the sets `BotState` plugins. + fullName: botStates + remarks: '' + isDeprecated: false + syntax: + content: 'botStates: BotState[]' + return: + description: '' + type: [] +methods: + - name: add(BotState[]) + uid: botbuilder.BotStateSet.add + package: botbuilder + summary: Registers one or more `BotState` plugins with the set. + remarks: '' + isDeprecated: false + syntax: + content: 'function add(botStates: BotState[]): BotStateSet' + parameters: + - id: botStates + type: [] + description: One or more BotState plugins to register. + return: + description: The updated BotStateSet. + type: + - name: loadAll(TurnContext, boolean) + uid: botbuilder.BotStateSet.loadAll + package: botbuilder + summary: Calls `BotState.load()` on all of the BotState plugins in the set. + remarks: |- + This will trigger all of the plugins to read in their state in parallel. + + ```JavaScript + await stateSet.readAll(context); + ``` + isDeprecated: false + syntax: + content: 'function loadAll(context: TurnContext, force?: boolean): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) If `true` the cache will be bypassed and the state will + always be read in directly from storage. Defaults to `false`. + return: + description: '' + type: Promise<void> + - name: saveAllChanges(TurnContext, boolean) + uid: botbuilder.BotStateSet.saveAllChanges + package: botbuilder + summary: Calls `BotState.saveChanges()` on all of the BotState plugins in the set. + remarks: |- + This will trigger all of the plugins to write out their state in parallel. + + ```JavaScript + await stateSet.saveAllChanges(context); + ``` + isDeprecated: false + syntax: + content: >- + function saveAllChanges(context: TurnContext, force?: boolean): + Promise + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) if `true` the state will always be written out regardless + of its change state. Defaults to `false`. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BotTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotTelemetryClient.yml new file mode 100644 index 00000000..150a8dc9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BotTelemetryClient.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: BotTelemetryClient +uid: botbuilder.BotTelemetryClient +package: botbuilder +summary: '' +fullName: BotTelemetryClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: flush() + uid: botbuilder.BotTelemetryClient.flush + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function flush(): any' + return: + description: '' + type: any + - name: trackDependency(TelemetryDependency) + uid: botbuilder.BotTelemetryClient.trackDependency + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function trackDependency(telemetry: TelemetryDependency): any' + parameters: + - id: telemetry + type: + description: '' + return: + description: '' + type: any + - name: trackEvent(TelemetryEvent) + uid: botbuilder.BotTelemetryClient.trackEvent + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function trackEvent(telemetry: TelemetryEvent): any' + parameters: + - id: telemetry + type: + description: '' + return: + description: '' + type: any + - name: trackException(TelemetryException) + uid: botbuilder.BotTelemetryClient.trackException + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function trackException(telemetry: TelemetryException): any' + parameters: + - id: telemetry + type: + description: '' + return: + description: '' + type: any + - name: trackTrace(TelemetryTrace) + uid: botbuilder.BotTelemetryClient.trackTrace + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function trackTrace(telemetry: TelemetryTrace): any' + parameters: + - id: telemetry + type: + description: '' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserLocalStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserLocalStorage.yml new file mode 100644 index 00000000..7a4bee5f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserLocalStorage.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: BrowserLocalStorage +uid: botbuilder.BrowserLocalStorage +package: botbuilder +summary: Storage provider that uses browser local storage. +fullName: BrowserLocalStorage +remarks: >- + Anything written to the store will remain persisted until the user manually + flushes their + + browsers cookies and other site data. + + + ```JavaScript + + const { BrowserLocalStorage, UserState } = require('botbuilder'); + + + const userState = new UserState(new BrowserLocalStorage()); + + ``` +isDeprecated: false +type: class +constructors: + - name: BrowserLocalStorage() + uid: botbuilder.BrowserLocalStorage.constructor + package: botbuilder + summary: >- + Creates a new + [BrowserLocalStorage](xref:botbuilder-core.BrowserLocalStorage) instance. + remarks: '' + isDeprecated: false + syntax: + content: new BrowserLocalStorage() +inheritedMethods: + - name: delete(string[]) + uid: botbuilder.BrowserLocalStorage.delete + package: botbuilder + summary: Deletes storage items from storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: >- + Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to + delete. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [MemoryStorage.delete](xref:botbuilder.MemoryStorage.delete) + - name: read(string[]) + uid: botbuilder.BrowserLocalStorage.read + package: botbuilder + summary: Reads storage items from storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function read(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: >- + Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to + read. + return: + description: The read items. + type: Promise<> + inheritanceDescription: >- + Inherited From + [MemoryStorage.read](xref:botbuilder.MemoryStorage.read) + - name: write(StoreItems) + uid: botbuilder.BrowserLocalStorage.write + package: botbuilder + summary: Writes storage items to storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function write(changes: StoreItems): Promise' + parameters: + - id: changes + type: + description: >- + The [StoreItems](xref:botbuilder-core.StoreItems) to write, indexed + by key. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [MemoryStorage.write](xref:botbuilder.MemoryStorage.write) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserSessionStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserSessionStorage.yml new file mode 100644 index 00000000..8b046012 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/BrowserSessionStorage.yml @@ -0,0 +1,103 @@ +### YamlMime:TSType +name: BrowserSessionStorage +uid: botbuilder.BrowserSessionStorage +package: botbuilder +summary: Storage provider that uses browser session storage. +fullName: BrowserSessionStorage +remarks: >- + Anything written to the store will only be persisted for the lifetime of a + single page within a + + browser tab. The storage will survive page reloads but closing the tab will + delete anything + + persisted by the store and opening a new browser tab will create a new + persistance store for the + + page. + + + ```JavaScript + + const { BrowserSessionStorage, ConversationState } = require('botbuilder'); + + + const conversationState = new ConversationState(new BrowserSessionStorage()); + + ``` +isDeprecated: false +type: class +constructors: + - name: BrowserSessionStorage() + uid: botbuilder.BrowserSessionStorage.constructor + package: botbuilder + summary: >- + Creates a new + [BrowserSessionStorage](xref:botbuilder-core.BrowserSessionStorage) + instance. + remarks: '' + isDeprecated: false + syntax: + content: new BrowserSessionStorage() +inheritedMethods: + - name: delete(string[]) + uid: botbuilder.BrowserSessionStorage.delete + package: botbuilder + summary: Deletes storage items from storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: >- + Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to + delete. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [MemoryStorage.delete](xref:botbuilder.MemoryStorage.delete) + - name: read(string[]) + uid: botbuilder.BrowserSessionStorage.read + package: botbuilder + summary: Reads storage items from storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function read(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: >- + Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to + read. + return: + description: The read items. + type: Promise<> + inheritanceDescription: >- + Inherited From + [MemoryStorage.read](xref:botbuilder.MemoryStorage.read) + - name: write(StoreItems) + uid: botbuilder.BrowserSessionStorage.write + package: botbuilder + summary: Writes storage items to storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function write(changes: StoreItems): Promise' + parameters: + - id: changes + type: + description: >- + The [StoreItems](xref:botbuilder-core.StoreItems) to write, indexed + by key. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [MemoryStorage.write](xref:botbuilder.MemoryStorage.write) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CacheInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CacheInfo.yml new file mode 100644 index 00000000..1a3ff5ab --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CacheInfo.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: CacheInfo +uid: botbuilder.CacheInfo +package: botbuilder +summary: '' +fullName: CacheInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheDuration + uid: botbuilder.CacheInfo.cacheDuration + package: botbuilder + summary: The time in seconds for which the cached object should remain in the cache + fullName: cacheDuration + remarks: '' + isDeprecated: false + syntax: + content: 'cacheDuration?: number' + return: + description: '' + type: number + - name: cacheType + uid: botbuilder.CacheInfo.cacheType + package: botbuilder + summary: The type of cache for this object. + fullName: cacheType + remarks: '' + isDeprecated: false + syntax: + content: 'cacheType?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CachedBotState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CachedBotState.yml new file mode 100644 index 00000000..c15f88ff --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CachedBotState.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: CachedBotState +uid: botbuilder.CachedBotState +package: botbuilder +summary: State information cached off the context object by a `BotState` instance. +fullName: CachedBotState +remarks: '' +isDeprecated: false +type: interface +properties: + - name: hash + uid: botbuilder.CachedBotState.hash + package: botbuilder + summary: >- + Hash of the last known state values. This is used to perform change + detection. + fullName: hash + remarks: '' + isDeprecated: false + syntax: + content: 'hash: string' + return: + description: '' + type: string + - name: state + uid: botbuilder.CachedBotState.state + package: botbuilder + summary: Dictionary of state values. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: {[id: string]: any}' + return: + description: '' + type: '{[id: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CallerIdConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CallerIdConstants.yml new file mode 100644 index 00000000..42c4e4a6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CallerIdConstants.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: CallerIdConstants +uid: botbuilder.CallerIdConstants +package: botbuilder +summary: Constants used to populate the Activity.callerId property. +fullName: CallerIdConstants +remarks: '' +isDeprecated: false +type: class +properties: + - name: BotToBotPrefix + uid: botbuilder.CallerIdConstants.BotToBotPrefix + package: botbuilder + summary: The caller ID prefix when a bot initiates a request to another bot. + fullName: BotToBotPrefix + remarks: >- + This prefix will be followed by the Azure Active Directory App ID of the + bot that initiated the call. + isDeprecated: false + syntax: + content: 'static BotToBotPrefix: string' + return: + description: '' + type: string + - name: PublicAzureChannel + uid: botbuilder.CallerIdConstants.PublicAzureChannel + package: botbuilder + summary: The caller ID for any Bot Framework channel. + fullName: PublicAzureChannel + remarks: '' + isDeprecated: false + syntax: + content: 'static PublicAzureChannel: string' + return: + description: '' + type: string + - name: USGovChannel + uid: botbuilder.CallerIdConstants.USGovChannel + package: botbuilder + summary: The caller ID for any Bot Framework US Government cloud channel. + fullName: USGovChannel + remarks: '' + isDeprecated: false + syntax: + content: 'static USGovChannel: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardAction.yml new file mode 100644 index 00000000..5f4ce035 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardAction.yml @@ -0,0 +1,115 @@ +### YamlMime:TSType +name: CardAction +uid: botbuilder.CardAction +package: botbuilder +summary: A clickable action +fullName: CardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botbuilder.CardAction.channelData + package: botbuilder + summary: Channel-specific data associated with this action + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + - name: displayText + uid: botbuilder.CardAction.displayText + package: botbuilder + summary: (Optional) text to display in the chat feed if the button is clicked + fullName: displayText + remarks: '' + isDeprecated: false + syntax: + content: 'displayText?: string' + return: + description: '' + type: string + - name: image + uid: botbuilder.CardAction.image + package: botbuilder + summary: Image URL which will appear on the button, next to text label + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: string' + return: + description: '' + type: string + - name: imageAltText + uid: botbuilder.CardAction.imageAltText + package: botbuilder + summary: Alternate image text to be used in place of the `image` field + fullName: imageAltText + remarks: '' + isDeprecated: false + syntax: + content: 'imageAltText?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.CardAction.text + package: botbuilder + summary: Text for this action + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.CardAction.title + package: botbuilder + summary: Text description which appears on the button + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.CardAction.type + package: botbuilder + summary: >- + The type of action implemented by this button. Possible values include: + 'openUrl', 'imBack', + + 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', + 'signin', 'call', + + messageBack', 'openApp' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.CardAction.value + package: botbuilder + summary: >- + Supplementary parameter for action. Content of this property depends on + the ActionType + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardBarComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardBarComponent.yml new file mode 100644 index 00000000..499d8b4c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardBarComponent.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: CardBarComponent +uid: botbuilder.CardBarComponent +package: botbuilder +summary: Adaptive Card Extension Card view title area (card bar) component +fullName: CardBarComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder.CardBarComponent.componentName + package: botbuilder + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "cardBar"' + return: + description: '' + type: '"cardBar"' + - name: icon + uid: botbuilder.CardBarComponent.icon + package: botbuilder + summary: The icon to display. + fullName: icon + remarks: '' + isDeprecated: false + syntax: + content: 'icon?: CardImage' + return: + description: '' + type: CardImage + - name: title + uid: botbuilder.CardBarComponent.title + package: botbuilder + summary: The title to display. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.CardBarComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonBase.yml new file mode 100644 index 00000000..a94e1208 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonBase.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: CardButtonBase +uid: botbuilder.CardButtonBase +package: botbuilder +summary: >- + Base properties for the buttons used in different Adaptive Card Extension card + view components, such as Text Input, Search Box and Card Button. +fullName: CardButtonBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder.CardButtonBase.action + package: botbuilder + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + - name: id + uid: botbuilder.CardButtonBase.id + package: botbuilder + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonComponent.yml new file mode 100644 index 00000000..546c614e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardButtonComponent.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: CardButtonComponent +uid: botbuilder.CardButtonComponent +package: botbuilder +summary: Adaptive Card Extension Card button component. +fullName: CardButtonComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder.CardButtonComponent.componentName + package: botbuilder + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "cardButton"' + return: + description: '' + type: '"cardButton"' + - name: style + uid: botbuilder.CardButtonComponent.style + package: botbuilder + summary: Controls the style of the button. + fullName: style + remarks: '' + isDeprecated: false + syntax: + content: 'style?: "default" | "positive"' + return: + description: '' + type: '"default" | "positive"' + - name: title + uid: botbuilder.CardButtonComponent.title + package: botbuilder + summary: Text displayed on the button. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botbuilder.CardButtonComponent.action + package: botbuilder + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder.CardButtonBase.action) + - name: id + uid: botbuilder.CardButtonComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder.CardButtonBase.id) +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardComponentName.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardComponentName.yml new file mode 100644 index 00000000..ef14621f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardComponentName.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: CardComponentName +uid: botbuilder.CardComponentName +package: botbuilder +summary: Names of the components allowed in a card view. +fullName: CardComponentName +remarks: '' +isDeprecated: false +syntax: | + type CardComponentName = + | "text" + | "cardButton" + | "cardBar" + | "textInput" + | "searchBox" + | "searchFooter" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardFactory.yml new file mode 100644 index 00000000..ad15473b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardFactory.yml @@ -0,0 +1,555 @@ +### YamlMime:TSType +name: CardFactory +uid: botbuilder.CardFactory +package: botbuilder +summary: Provides methods for formatting the various card types a bot can return. +fullName: CardFactory +remarks: >- + All of these functions return an + [Attachment](xref:botframework-schema.Attachment) object, + + which can be added to an existing activity's + [attachments](xref:botframework-schema.Activity.attachments) collection + directly or + + passed as input to one of the + [MessageFactory](xref:botbuilder-core.MessageFactory) methods to generate a + new activity. + + + This example sends a message that contains a single hero card. + + + ```javascript + + const { MessageFactory, CardFactory } = require('botbuilder'); + + + const card = CardFactory.heroCard( + 'White T-Shirt', + ['https://example.com/whiteShirt.jpg'], + ['buy'] + ); + + const message = MessageFactory.attachment(card); + + await context.sendActivity(message); + + ``` +isDeprecated: false +type: class +properties: + - name: contentTypes + uid: botbuilder.CardFactory.contentTypes + package: botbuilder + summary: Lists the content type schema for each card style. + fullName: contentTypes + remarks: '' + isDeprecated: false + syntax: + content: 'static contentTypes: any' + return: + description: '' + type: any +methods: + - name: actions(undefined | (string | CardAction)[]) + uid: botbuilder.CardFactory.actions + package: botbuilder + summary: Returns a properly formatted array of actions. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function actions(actions: undefined | (string | CardAction)[]): + CardAction[] + parameters: + - id: actions + type: undefined | (string | )[] + description: >- + The array of action to include on the card. Each `string` in the + array + is converted to an `imBack` button with a title and value set to the value of the string. + return: + description: A properly formatted array of actions. + type: [] + - name: adaptiveCard(any) + uid: botbuilder.CardFactory.adaptiveCard + package: botbuilder + summary: Returns an attachment for an Adaptive Card. + remarks: >- + Adaptive Cards are an open card exchange format enabling developers to + exchange UI content in a common and consistent way. + + For channels that don't yet support Adaptive Cards natively, the Bot + Framework will + + down-render the card to an image that's been styled to look good on the + target channel. For + + channels that support [hero cards](#herocards) you can continue to include + Adaptive Card + + actions and they will be sent as buttons along with the rendered version + of the card. + + + For more information about Adaptive Cards and to download the latest SDK, + visit + + [adaptivecards.io](http://adaptivecards.io/). + + + For example: + + ```JavaScript + + const card = CardFactory.adaptiveCard({ + "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", + "type": "AdaptiveCard", + "version": "1.0", + "body": [ + { + "type": "TextBlock", + "text": "Default text input" + } + ], + "actions": [ + { + "type": "Action.Submit", + "title": "OK" + } + ] + }); + + ``` + isDeprecated: false + syntax: + content: 'static function adaptiveCard(card: any): Attachment' + parameters: + - id: card + type: any + description: A description of the Adaptive Card to return. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + animationCard(string, (string | MediaUrl)[], (string | CardAction)[], + Partial) + uid: botbuilder.CardFactory.animationCard + package: botbuilder + summary: Returns an attachment for an animation card. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function animationCard(title: string, media: (string | + MediaUrl)[], buttons?: (string | CardAction)[], other?: + Partial): Attachment + parameters: + - id: title + type: string + description: The card title. + - id: media + type: (string | )[] + description: The media URLs for the card. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + audioCard(string, (string | MediaUrl)[], (string | CardAction)[], + Partial) + uid: botbuilder.CardFactory.audioCard + package: botbuilder + summary: Returns an attachment for an audio card. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function audioCard(title: string, media: (string | MediaUrl)[], + buttons?: (string | CardAction)[], other?: Partial): + Attachment + parameters: + - id: title + type: string + description: The card title. + - id: media + type: (string | )[] + description: The media URL for the card. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + heroCard(string, (string | CardImage)[], (string | CardAction)[], + Partial) + uid: botbuilder.CardFactory.heroCard + package: botbuilder + summary: Returns an attachment for a hero card. + remarks: |- + Hero cards tend to have one dominant, full-width image. + Channels typically render the card's text and buttons below the image. + + For example: + ```javascript + const card = CardFactory.heroCard( + 'White T-Shirt', + ['https://example.com/whiteShirt.jpg'], + ['buy'] + ); + ``` + isDeprecated: false + syntax: + content: >- + static function heroCard(title: string, images?: (string | CardImage)[], + buttons?: (string | CardAction)[], other?: Partial): + Attachment + parameters: + - id: title + type: string + description: The card title. + - id: images + type: (string | )[] + description: >- + Optional. The array of images to include on the card. Each element + can be a + [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + heroCard(string, string, (string | CardImage)[], (string | CardAction)[], + Partial) + uid: botbuilder.CardFactory.heroCard_1 + package: botbuilder + summary: Returns an attachment for a hero card. + remarks: |- + Hero cards tend to have one dominant, full-width image. + Channels typically render the card's text and buttons below the image. + For example: + ```javascript + const card = CardFactory.heroCard( + 'White T-Shirt', + ['https://example.com/whiteShirt.jpg'], + ['buy'] + ); + ``` + isDeprecated: false + syntax: + content: >- + static function heroCard(title: string, text: string, images?: (string | + CardImage)[], buttons?: (string | CardAction)[], other?: + Partial): Attachment + parameters: + - id: title + type: string + description: The card title. + - id: text + type: string + description: The card text. + - id: images + type: (string | )[] + description: >- + Optional. The array of images to include on the card. Each element + can be a + [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: images(undefined | (string | CardImage)[]) + uid: botbuilder.CardFactory.images + package: botbuilder + summary: Returns a properly formatted array of card images. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function images(images: undefined | (string | CardImage)[]): + CardImage[] + parameters: + - id: images + type: undefined | (string | )[] + description: |- + The array of images to include on the card. Each element can be a + [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. + return: + description: A properly formatted array of card images. + type: [] + - name: media(undefined | (string | MediaUrl)[]) + uid: botbuilder.CardFactory.media + package: botbuilder + summary: Returns a properly formatted array of media URL objects. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function media(links: undefined | (string | MediaUrl)[]): + MediaUrl[] + parameters: + - id: links + type: undefined | (string | )[] + description: The media URLs. Each `string` is converted to a media URL object. + return: + description: A properly formatted array of media URL objects. + type: [] + - name: o365ConnectorCard(O365ConnectorCard) + uid: botbuilder.CardFactory.o365ConnectorCard + package: botbuilder + summary: Returns an attachment for an Office 365 connector card. + remarks: |- + For example: + ```JavaScript + const card = CardFactory.o365ConnectorCard({ + "title": "card title", + "text": "card text", + "summary": "O365 card summary", + "themeColor": "#E67A9E", + "sections": [ + { + "title": "**section title**", + "text": "section text", + "activityTitle": "activity title", + } + ] + }); + ``` + isDeprecated: false + syntax: + content: 'static function o365ConnectorCard(card: O365ConnectorCard): Attachment' + parameters: + - id: card + type: + description: a description of the Office 365 connector card to return. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + oauthCard(string, string, string, string, TokenExchangeResource, + TokenPostResource) + uid: botbuilder.CardFactory.oauthCard + package: botbuilder + summary: Returns an attachment for an OAuth card. + remarks: OAuth cards support the Bot Framework's single sign on (SSO) service. + isDeprecated: false + syntax: + content: >- + static function oauthCard(connectionName: string, title: string, text?: + string, link?: string, tokenExchangeResource?: TokenExchangeResource, + tokenPostResource?: TokenPostResource): Attachment + parameters: + - id: connectionName + type: string + description: The name of the OAuth connection to use. + - id: title + type: string + description: The title for the card's sign-in button. + - id: text + type: string + description: Optional. Additional text to include on the card. + - id: link + type: string + description: Optional. The sign-in link to use. + - id: tokenExchangeResource + type: + description: optional. The resource to try to perform token exchange with. + - id: tokenPostResource + type: + description: optional. The resource for directly post a token to token service. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: receiptCard(ReceiptCard) + uid: botbuilder.CardFactory.receiptCard + package: botbuilder + summary: Returns an attachment for a receipt card. + remarks: '' + isDeprecated: false + syntax: + content: 'static function receiptCard(card: ReceiptCard): Attachment' + parameters: + - id: card + type: + description: A description of the receipt card to return. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: signinCard(string, string, string) + uid: botbuilder.CardFactory.signinCard + package: botbuilder + summary: Returns an attachment for a sign-in card. + remarks: >- + For channels that don't natively support sign-in cards, an alternative + message is rendered. + isDeprecated: false + syntax: + content: >- + static function signinCard(title: string, url: string, text?: string): + Attachment + parameters: + - id: title + type: string + description: The title for the card's sign-in button. + - id: url + type: string + description: The URL of the sign-in page to use. + - id: text + type: string + description: Optional. Additional text to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + thumbnailCard(string, (string | CardImage)[], (string | CardAction)[], + Partial) + uid: botbuilder.CardFactory.thumbnailCard + package: botbuilder + summary: Returns an attachment for a thumbnail card. + remarks: >- + Thumbnail cards are similar to hero cards but instead of a full width + image, + + they're typically rendered with a smaller thumbnail version of the image. + + Channels typically render the card's text to one side of the image, + + with any buttons displayed below the card. + isDeprecated: false + syntax: + content: >- + static function thumbnailCard(title: string, images?: (string | + CardImage)[], buttons?: (string | CardAction)[], other?: + Partial): Attachment + parameters: + - id: title + type: string + description: The card title. + - id: images + type: (string | )[] + description: >- + Optional. The array of images to include on the card. Each element + can be a + [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + thumbnailCard(string, string, (string | CardImage)[], (string | + CardAction)[], Partial) + uid: botbuilder.CardFactory.thumbnailCard_1 + package: botbuilder + summary: Returns an attachment for a thumbnail card. + remarks: >- + Thumbnail cards are similar to hero cards but instead of a full width + image, + + they're typically rendered with a smaller thumbnail version of the image. + + Channels typically render the card's text to one side of the image, + + with any buttons displayed below the card. + isDeprecated: false + syntax: + content: >- + static function thumbnailCard(title: string, text: string, images?: + (string | CardImage)[], buttons?: (string | CardAction)[], other?: + Partial): Attachment + parameters: + - id: title + type: string + description: The card title. + - id: text + type: string + description: The card text. + - id: images + type: (string | )[] + description: >- + Optional. The array of images to include on the card. Each element + can be a + [CardImage](ref:botframework-schema.CardImage) or the URL of the image to include. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: + - name: >- + videoCard(string, (string | MediaUrl)[], (string | CardAction)[], + Partial) + uid: botbuilder.CardFactory.videoCard + package: botbuilder + summary: Returns an attachment for a video card. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function videoCard(title: string, media: (string | MediaUrl)[], + buttons?: (string | CardAction)[], other?: Partial): + Attachment + parameters: + - id: title + type: string + description: The card title. + - id: media + type: (string | )[] + description: The media URLs for the card. + - id: buttons + type: (string | )[] + description: >- + Optional. The array of buttons to include on the card. Each `string` + in the array + is converted to an `imBack` button with a title and value set to the value of the string. + - id: other + type: Partial<> + description: Optional. Any additional properties to include on the card. + return: + description: An [Attachment](xref:botframework-schema.Attachment). + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardImage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardImage.yml new file mode 100644 index 00000000..a57f2c11 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardImage.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: CardImage +uid: botbuilder.CardImage +package: botbuilder +summary: An image on a card +fullName: CardImage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alt + uid: botbuilder.CardImage.alt + package: botbuilder + summary: Image description intended for screen readers + fullName: alt + remarks: '' + isDeprecated: false + syntax: + content: 'alt?: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder.CardImage.tap + package: botbuilder + summary: Action assigned to specific Attachment + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap?: CardAction' + return: + description: '' + type: + - name: url + uid: botbuilder.CardImage.url + package: botbuilder + summary: URL thumbnail image for major content property + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchBoxComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchBoxComponent.yml new file mode 100644 index 00000000..b78ad768 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchBoxComponent.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: CardSearchBoxComponent +uid: botbuilder.CardSearchBoxComponent +package: botbuilder +summary: >- + Adaptive Card Extension Search box component. Represents a search box rendered + in the card view. +fullName: CardSearchBoxComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: button + uid: botbuilder.CardSearchBoxComponent.button + package: botbuilder + summary: Button displayed on the search box. + fullName: button + remarks: '' + isDeprecated: false + syntax: + content: 'button: ICardSearchBoxButton' + return: + description: '' + type: + - name: componentName + uid: botbuilder.CardSearchBoxComponent.componentName + package: botbuilder + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "searchBox"' + return: + description: '' + type: '"searchBox"' + - name: defaultValue + uid: botbuilder.CardSearchBoxComponent.defaultValue + package: botbuilder + summary: Default value to display. + fullName: defaultValue + remarks: '' + isDeprecated: false + syntax: + content: 'defaultValue?: string' + return: + description: '' + type: string + - name: placeholder + uid: botbuilder.CardSearchBoxComponent.placeholder + package: botbuilder + summary: Placeholder text to display. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.CardSearchBoxComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchFooterComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchFooterComponent.yml new file mode 100644 index 00000000..75be7dbd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardSearchFooterComponent.yml @@ -0,0 +1,105 @@ +### YamlMime:TSType +name: CardSearchFooterComponent +uid: botbuilder.CardSearchFooterComponent +package: botbuilder +summary: >- + Adaptive Card Extension Search footer component. Represents a container with + an image (in the shape of a circle) and text. +fullName: CardSearchFooterComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder.CardSearchFooterComponent.componentName + package: botbuilder + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "searchFooter"' + return: + description: '' + type: '"searchFooter"' + - name: imageInitials + uid: botbuilder.CardSearchFooterComponent.imageInitials + package: botbuilder + summary: The initials to display in the image area when there is no image. + fullName: imageInitials + remarks: '' + isDeprecated: false + syntax: + content: 'imageInitials?: string' + return: + description: '' + type: string + - name: imageUrl + uid: botbuilder.CardSearchFooterComponent.imageUrl + package: botbuilder + summary: >- + Url to the image to use, should be a square aspect ratio and big enough to + fit in the image area. + fullName: imageUrl + remarks: '' + isDeprecated: false + syntax: + content: 'imageUrl?: string' + return: + description: '' + type: string + - name: onSelection + uid: botbuilder.CardSearchFooterComponent.onSelection + package: botbuilder + summary: Action to invoke when the footer is selected. + fullName: onSelection + remarks: '' + isDeprecated: false + syntax: + content: 'onSelection?: CardAction' + return: + description: '' + type: CardAction + - name: text + uid: botbuilder.CardSearchFooterComponent.text + package: botbuilder + summary: >- + Primary text to display. For example, name of the person for people + search. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.CardSearchFooterComponent.title + package: botbuilder + summary: Title text to display. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.CardSearchFooterComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextComponent.yml new file mode 100644 index 00000000..5d978b4d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextComponent.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: CardTextComponent +uid: botbuilder.CardTextComponent +package: botbuilder +summary: >- + Adaptive Card Extension Text component. Represents a text block rendered in + the card view. +fullName: CardTextComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botbuilder.CardTextComponent.componentName + package: botbuilder + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "text"' + return: + description: '' + type: '"text"' + - name: text + uid: botbuilder.CardTextComponent.text + package: botbuilder + summary: Text to display. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.CardTextComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextInputComponent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextInputComponent.yml new file mode 100644 index 00000000..9f8d00fb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardTextInputComponent.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: CardTextInputComponent +uid: botbuilder.CardTextInputComponent +package: botbuilder +summary: Adaptive Card Extension Text input component. +fullName: CardTextInputComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.CardTextInputComponent.ariaLabel + package: botbuilder + summary: Aria label for the text field. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: button + uid: botbuilder.CardTextInputComponent.button + package: botbuilder + summary: Optional button to display. + fullName: button + remarks: '' + isDeprecated: false + syntax: + content: 'button?: ICardTextInputIconButton | ICardTextInputTitleButton' + return: + description: '' + type: >- + | + - name: componentName + uid: botbuilder.CardTextInputComponent.componentName + package: botbuilder + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "textInput"' + return: + description: '' + type: '"textInput"' + - name: defaultValue + uid: botbuilder.CardTextInputComponent.defaultValue + package: botbuilder + summary: Default value to display. + fullName: defaultValue + remarks: '' + isDeprecated: false + syntax: + content: 'defaultValue?: string' + return: + description: '' + type: string + - name: iconAfter + uid: botbuilder.CardTextInputComponent.iconAfter + package: botbuilder + summary: >- + Properties for an optional icon, displayed in the right end of the text + input. + fullName: iconAfter + remarks: '' + isDeprecated: false + syntax: + content: 'iconAfter?: CardImage' + return: + description: '' + type: CardImage + - name: iconBefore + uid: botbuilder.CardTextInputComponent.iconBefore + package: botbuilder + summary: >- + Properties for an optional icon, displayed in the left end of the text + input. + fullName: iconBefore + remarks: '' + isDeprecated: false + syntax: + content: 'iconBefore?: CardImage' + return: + description: '' + type: CardImage + - name: placeholder + uid: botbuilder.CardTextInputComponent.placeholder + package: botbuilder + summary: Placeholder text to display. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.CardTextInputComponent.id + package: botbuilder + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botbuilder.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewActionsFooterParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewActionsFooterParameters.yml new file mode 100644 index 00000000..69f4588c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewActionsFooterParameters.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: CardViewActionsFooterParameters +uid: botbuilder.CardViewActionsFooterParameters +package: botbuilder +summary: The actions-only footer parameters for the card view. +fullName: CardViewActionsFooterParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewActionsFooterParameters = + | [CardButtonComponent] + | [CardButtonComponent, CardButtonComponent] + | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewFooterParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewFooterParameters.yml new file mode 100644 index 00000000..8d8eae16 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewFooterParameters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: CardViewFooterParameters +uid: botbuilder.CardViewFooterParameters +package: botbuilder +summary: >- + The footer parameters for the card view. Can contain either 0 to 2 buttons or + a single text input. +fullName: CardViewFooterParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewFooterParameters = + | CardViewActionsFooterParameters + | [CardTextInputComponent] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewHandleActionResponse.yml new file mode 100644 index 00000000..2f39ff13 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: CardViewHandleActionResponse +uid: botbuilder.CardViewHandleActionResponse +package: botbuilder +summary: The handle action response for card view. +fullName: CardViewHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder.CardViewHandleActionResponse.renderArguments + package: botbuilder + summary: Card view render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments: CardViewResponse' + return: + description: '' + type: + - name: responseType + uid: botbuilder.CardViewHandleActionResponse.responseType + package: botbuilder + summary: Card view. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "Card"' + return: + description: '' + type: '"Card"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewParameters.yml new file mode 100644 index 00000000..a3255806 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewParameters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: CardViewParameters +uid: botbuilder.CardViewParameters +package: botbuilder +summary: Card View Parameters. +fullName: CardViewParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewParameters = + | TextCardViewParameters + | TextInputCardViewParameters + | SearchCardViewParameters + | SignInCardViewParameters diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewResponse.yml new file mode 100644 index 00000000..b7e9c5f2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CardViewResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: CardViewResponse +uid: botbuilder.CardViewResponse +package: botbuilder +summary: SharePoint ACE Card view response payload. +fullName: CardViewResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aceData + uid: botbuilder.CardViewResponse.aceData + package: botbuilder + summary: The ACE data. + fullName: aceData + remarks: '' + isDeprecated: false + syntax: + content: 'aceData: AceData' + return: + description: '' + type: + - name: cardViewParameters + uid: botbuilder.CardViewResponse.cardViewParameters + package: botbuilder + summary: The card view parameters. + fullName: cardViewParameters + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewParameters: CardViewParameters' + return: + description: '' + type: + - name: onCardSelection + uid: botbuilder.CardViewResponse.onCardSelection + package: botbuilder + summary: The on card selection action. + fullName: onCardSelection + remarks: '' + isDeprecated: false + syntax: + content: 'onCardSelection?: OnCardSelectionAction' + return: + description: '' + type: + - name: viewId + uid: botbuilder.CardViewResponse.viewId + package: botbuilder + summary: The view id. + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelAccount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelAccount.yml new file mode 100644 index 00000000..418cfd79 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelAccount.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: ChannelAccount +uid: botbuilder.ChannelAccount +package: botbuilder +summary: Channel account information needed to route a message +fullName: ChannelAccount +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadObjectId + uid: botbuilder.ChannelAccount.aadObjectId + package: botbuilder + summary: This account's object ID within Azure Active Directory (AAD) + fullName: aadObjectId + remarks: '' + isDeprecated: false + syntax: + content: 'aadObjectId?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.ChannelAccount.id + package: botbuilder + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.ChannelAccount.name + package: botbuilder + summary: Display friendly name + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.ChannelAccount.properties + package: botbuilder + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + - name: role + uid: botbuilder.ChannelAccount.role + package: botbuilder + summary: >- + Role of the entity behind the account (Example: User, Bot, etc.). Possible + values include: + + 'user', 'bot', 'skill' + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelInfo.yml new file mode 100644 index 00000000..c1d302fb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ChannelInfo +uid: botbuilder.ChannelInfo +package: botbuilder +summary: '' +fullName: ChannelInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.ChannelInfo.id + package: botbuilder + summary: Unique identifier representing a channel + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.ChannelInfo.name + package: botbuilder + summary: Name of the channel + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.ChannelInfo.type + package: botbuilder + summary: The type of the channel. Valid values are standard, shared and private. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandler.yml index 35ee9b23..72edd1b0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandler.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: ChannelServiceHandler remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: |- Use `CloudChannelServiceHandler` instead. @@ -22,7 +21,6 @@ constructors: Initializes a new instance of the ChannelServiceHandler class, using a credential provider. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,15 +35,13 @@ constructors: description: The authentication configuration. - id: channelService type: string - description: | - A string representing the channel provider. + description: A string representing the channel provider. inheritedMethods: - - name: 'handleCreateConversation(string, ConversationParameters)' + - name: handleCreateConversation(string, ConversationParameters) uid: botbuilder.ChannelServiceHandler.handleCreateConversation package: botbuilder summary: Creates a new Conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -56,22 +52,21 @@ inheritedMethods: type: string description: The authentication header. - id: parameters - type: ConversationParameters + type: description: >- - (xref:botbuilder-core.ConversationParameters) to create the - conversation from. + [ConversationParameters](xref:botbuilder-core.ConversationParameters) + to create the conversation from. return: description: A `Promise` representation for the operation. - type: Promise<ConversationResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleCreateConversation](xref:botbuilder.ChannelServiceHandlerBase.handleCreateConversation) - - name: 'handleDeleteActivity(string, string, string)' + - name: handleDeleteActivity(string, string, string) uid: botbuilder.ChannelServiceHandler.handleDeleteActivity package: botbuilder - summary: 'Deletes an existing [Activity](xref:botframework-schema.Activity).' + summary: Deletes an existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -86,20 +81,18 @@ inheritedMethods: description: The conversation Id. - id: activityId type: string - description: | - The activity Id to delete. + description: The activity Id to delete. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleDeleteActivity](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteActivity) - - name: 'handleDeleteConversationMember(string, string, string)' + - name: handleDeleteConversationMember(string, string, string) uid: botbuilder.ChannelServiceHandler.handleDeleteConversationMember package: botbuilder summary: Deletes a member from a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,22 +107,20 @@ inheritedMethods: description: The conversation Id. - id: memberId type: string - description: | - Id of the member to delete from this conversation. + description: Id of the member to delete from this conversation. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleDeleteConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteConversationMember) - - name: 'handleGetActivityMembers(string, string, string)' + - name: handleGetActivityMembers(string, string, string) uid: botbuilder.ChannelServiceHandler.handleGetActivityMembers package: botbuilder summary: >- Enumerates the members of an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -149,16 +140,15 @@ inheritedMethods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' + type: Promise<[]> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleGetActivityMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetActivityMembers) - - name: 'handleGetConversationMember(string, string, string)' + - name: handleGetConversationMember(string, string, string) uid: botbuilder.ChannelServiceHandler.handleGetConversationMember package: botbuilder summary: Gets the account of a single conversation member. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -178,16 +168,15 @@ inheritedMethods: description: >- The [ChannelAccount](xref:botframework-schema.ChannelAccount) for the provided user id. - type: Promise<ChannelAccount> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleGetConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMember) - - name: 'handleGetConversationMembers(string, string)' + - name: handleGetConversationMembers(string, string) uid: botbuilder.ChannelServiceHandler.handleGetConversationMembers package: botbuilder summary: Enumerates the members of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -204,16 +193,15 @@ inheritedMethods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' + type: Promise<[]> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleGetConversationMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMembers) - - name: 'handleGetConversationPagedMembers(string, string, number, string)' + - name: handleGetConversationPagedMembers(string, string, number, string) uid: botbuilder.ChannelServiceHandler.handleGetConversationPagedMembers package: botbuilder summary: Enumerates the members of a conversation one page at a time. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -238,16 +226,15 @@ inheritedMethods: A `Promise` representing the [PagedMembersResult](xref:botframework-schema.PagedMembersResult) for the operation. - type: Promise<PagedMembersResult> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleGetConversationPagedMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationPagedMembers) - - name: 'handleGetConversations(string, string, string)' + - name: handleGetConversations(string, string, string) uid: botbuilder.ChannelServiceHandler.handleGetConversations package: botbuilder summary: Lists the Conversations in which the bot has participated. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -265,16 +252,15 @@ inheritedMethods: description: A skip or continuation token. return: description: A `Promise` representation for the operation. - type: Promise<ConversationsResult> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleGetConversations](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversations) - - name: 'handleReplyToActivity(string, string, string, Activity)' + - name: handleReplyToActivity(string, string, string, Activity) uid: botbuilder.ChannelServiceHandler.handleReplyToActivity package: botbuilder - summary: 'Sends a reply to an [Activity](xref:botframework-schema.Activity).' + summary: Sends a reply to an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -292,23 +278,22 @@ inheritedMethods: type: string description: The activity Id the reply is to. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleReplyToActivity](xref:botbuilder.ChannelServiceHandlerBase.handleReplyToActivity) - - name: 'handleSendConversationHistory(string, string, Transcript)' + - name: handleSendConversationHistory(string, string, Transcript) uid: botbuilder.ChannelServiceHandler.handleSendConversationHistory package: botbuilder summary: Uploads the historic activities of the conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -323,25 +308,24 @@ inheritedMethods: type: string description: The conversation Id. - id: transcript - type: Transcript - description: '(xref:botframework-schema.Transcript) of activities.' + type: + description: '[Transcript](xref:botframework-schema.Transcript) of activities.' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleSendConversationHistory](xref:botbuilder.ChannelServiceHandlerBase.handleSendConversationHistory) - - name: 'handleSendToConversation(string, string, Activity)' + - name: handleSendToConversation(string, string, Activity) uid: botbuilder.ChannelServiceHandler.handleSendToConversation package: botbuilder summary: >- Sends an [Activity](xref:botframework-schema.Activity) to the end of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -355,25 +339,24 @@ inheritedMethods: type: string description: The conversation Id. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleSendToConversation](xref:botbuilder.ChannelServiceHandlerBase.handleSendToConversation) - - name: 'handleUpdateActivity(string, string, string, Activity)' + - name: handleUpdateActivity(string, string, string, Activity) uid: botbuilder.ChannelServiceHandler.handleUpdateActivity package: botbuilder summary: >- Edits a previously sent existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -391,23 +374,22 @@ inheritedMethods: type: string description: The activity Id to update. - id: activity - type: Activity - description: 'The replacement [Activity](xref:botframework-schema.Activity).' + type: + description: The replacement [Activity](xref:botframework-schema.Activity). return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleUpdateActivity](xref:botbuilder.ChannelServiceHandlerBase.handleUpdateActivity) - - name: 'handleUploadAttachment(string, string, AttachmentData)' + - name: handleUploadAttachment(string, string, AttachmentData) uid: botbuilder.ChannelServiceHandler.handleUploadAttachment package: botbuilder summary: Stores data in a compliant store when dealing with enterprises. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -421,14 +403,14 @@ inheritedMethods: type: string description: The conversation Id. - id: attachmentUpload - type: AttachmentData - description: '(xref:botframework-schema.AttachmentData).' + type: + description: '[AttachmentData](xref:botframework-schema.AttachmentData).' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From [ChannelServiceHandlerBase.handleUploadAttachment](xref:botbuilder.ChannelServiceHandlerBase.handleUploadAttachment) diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandlerBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandlerBase.yml index 6b6d04fc..9feeece2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandlerBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceHandlerBase.yml @@ -9,16 +9,14 @@ summary: >- implements routing ChannelAPI calls from the Skill up through the bot/adapter. fullName: ChannelServiceHandlerBase remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'handleCreateConversation(string, ConversationParameters)' + - name: handleCreateConversation(string, ConversationParameters) uid: botbuilder.ChannelServiceHandlerBase.handleCreateConversation package: botbuilder summary: Creates a new Conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,19 +27,18 @@ methods: type: string description: The authentication header. - id: parameters - type: ConversationParameters + type: description: >- - (xref:botbuilder-core.ConversationParameters) to create the - conversation from. + [ConversationParameters](xref:botbuilder-core.ConversationParameters) + to create the conversation from. return: description: A `Promise` representation for the operation. - type: Promise<ConversationResourceResponse> - - name: 'handleDeleteActivity(string, string, string)' + type: Promise<> + - name: handleDeleteActivity(string, string, string) uid: botbuilder.ChannelServiceHandlerBase.handleDeleteActivity package: botbuilder - summary: 'Deletes an existing [Activity](xref:botframework-schema.Activity).' + summary: Deletes an existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -56,17 +53,15 @@ methods: description: The conversation Id. - id: activityId type: string - description: | - The activity Id to delete. + description: The activity Id to delete. return: description: '' type: Promise<void> - - name: 'handleDeleteConversationMember(string, string, string)' + - name: handleDeleteConversationMember(string, string, string) uid: botbuilder.ChannelServiceHandlerBase.handleDeleteConversationMember package: botbuilder summary: Deletes a member from a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -81,19 +76,17 @@ methods: description: The conversation Id. - id: memberId type: string - description: | - Id of the member to delete from this conversation. + description: Id of the member to delete from this conversation. return: description: '' type: Promise<void> - - name: 'handleGetActivityMembers(string, string, string)' + - name: handleGetActivityMembers(string, string, string) uid: botbuilder.ChannelServiceHandlerBase.handleGetActivityMembers package: botbuilder summary: >- Enumerates the members of an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -113,13 +106,12 @@ methods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' - - name: 'handleGetConversationMember(string, string, string)' + type: Promise<[]> + - name: handleGetConversationMember(string, string, string) uid: botbuilder.ChannelServiceHandlerBase.handleGetConversationMember package: botbuilder summary: Gets the account of a single conversation member. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -139,13 +131,12 @@ methods: description: >- The [ChannelAccount](xref:botframework-schema.ChannelAccount) for the provided user id. - type: Promise<ChannelAccount> - - name: 'handleGetConversationMembers(string, string)' + type: Promise<> + - name: handleGetConversationMembers(string, string) uid: botbuilder.ChannelServiceHandlerBase.handleGetConversationMembers package: botbuilder summary: Enumerates the members of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -162,13 +153,12 @@ methods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' - - name: 'handleGetConversationPagedMembers(string, string, number, string)' + type: Promise<[]> + - name: handleGetConversationPagedMembers(string, string, number, string) uid: botbuilder.ChannelServiceHandlerBase.handleGetConversationPagedMembers package: botbuilder summary: Enumerates the members of a conversation one page at a time. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -193,13 +183,12 @@ methods: A `Promise` representing the [PagedMembersResult](xref:botframework-schema.PagedMembersResult) for the operation. - type: Promise<PagedMembersResult> - - name: 'handleGetConversations(string, string, string)' + type: Promise<> + - name: handleGetConversations(string, string, string) uid: botbuilder.ChannelServiceHandlerBase.handleGetConversations package: botbuilder summary: Lists the Conversations in which the bot has participated. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -217,13 +206,12 @@ methods: description: A skip or continuation token. return: description: A `Promise` representation for the operation. - type: Promise<ConversationsResult> - - name: 'handleReplyToActivity(string, string, string, Activity)' + type: Promise<> + - name: handleReplyToActivity(string, string, string, Activity) uid: botbuilder.ChannelServiceHandlerBase.handleReplyToActivity package: botbuilder - summary: 'Sends a reply to an [Activity](xref:botframework-schema.Activity).' + summary: Sends a reply to an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,20 +229,19 @@ methods: type: string description: The activity Id the reply is to. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - - name: 'handleSendConversationHistory(string, string, Transcript)' + type: Promise<> + - name: handleSendConversationHistory(string, string, Transcript) uid: botbuilder.ChannelServiceHandlerBase.handleSendConversationHistory package: botbuilder summary: Uploads the historic activities of the conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -269,22 +256,21 @@ methods: type: string description: The conversation Id. - id: transcript - type: Transcript - description: '(xref:botframework-schema.Transcript) of activities.' + type: + description: '[Transcript](xref:botframework-schema.Transcript) of activities.' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - - name: 'handleSendToConversation(string, string, Activity)' + type: Promise<> + - name: handleSendToConversation(string, string, Activity) uid: botbuilder.ChannelServiceHandlerBase.handleSendToConversation package: botbuilder summary: >- Sends an [Activity](xref:botframework-schema.Activity) to the end of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -298,22 +284,21 @@ methods: type: string description: The conversation Id. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - - name: 'handleUpdateActivity(string, string, string, Activity)' + type: Promise<> + - name: handleUpdateActivity(string, string, string, Activity) uid: botbuilder.ChannelServiceHandlerBase.handleUpdateActivity package: botbuilder summary: >- Edits a previously sent existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -331,20 +316,19 @@ methods: type: string description: The activity Id to update. - id: activity - type: Activity - description: 'The replacement [Activity](xref:botframework-schema.Activity).' + type: + description: The replacement [Activity](xref:botframework-schema.Activity). return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - - name: 'handleUploadAttachment(string, string, AttachmentData)' + type: Promise<> + - name: handleUploadAttachment(string, string, AttachmentData) uid: botbuilder.ChannelServiceHandlerBase.handleUploadAttachment package: botbuilder summary: Stores data in a compliant store when dealing with enterprises. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -358,11 +342,11 @@ methods: type: string description: The conversation Id. - id: attachmentUpload - type: AttachmentData - description: '(xref:botframework-schema.AttachmentData).' + type: + description: '[AttachmentData](xref:botframework-schema.AttachmentData).' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceRoutes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceRoutes.yml index c422e654..37b7fbe4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceRoutes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ChannelServiceRoutes.yml @@ -5,7 +5,6 @@ package: botbuilder summary: Routes the API calls with the ChannelServiceHandler methods. fullName: ChannelServiceRoutes remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -23,15 +21,13 @@ constructors: parameters: - id: channelServiceHandler type: - description: | - The channel service handler. + description: The channel service handler. methods: - - name: 'register(WebServer, string)' + - name: register(WebServer, string) uid: botbuilder.ChannelServiceRoutes.register package: botbuilder summary: Registers all Channel Service paths on the provided WebServer. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function register(server: WebServer, basePath?: string)' @@ -41,6 +37,6 @@ methods: description: WebServer - id: basePath type: string - description: > + description: >- Optional basePath which is appended before the service's REST API is configured on the WebServer. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Channels.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Channels.yml new file mode 100644 index 00000000..0d2e21ec --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Channels.yml @@ -0,0 +1,106 @@ +### YamlMime:TSEnum +name: Channels +uid: botbuilder.Channels +package: botbuilder +summary: >- + Defines values for ChannelIds for Channels. + + Possible values include: 'alexa', 'console', 'cortana', 'directline', + 'directlinespeech', 'email', + + 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', + 'outlook', 'skype', 'skypeforbusiness', + + 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' +fullName: Channels +remarks: '' +isDeprecated: false +fields: + - name: Alexa + uid: botbuilder.Channels.Alexa + package: botbuilder + summary: '' + - name: Console + uid: botbuilder.Channels.Console + package: botbuilder + summary: '' + - name: Directline + uid: botbuilder.Channels.Directline + package: botbuilder + summary: '' + - name: DirectlineSpeech + uid: botbuilder.Channels.DirectlineSpeech + package: botbuilder + summary: '' + - name: Email + uid: botbuilder.Channels.Email + package: botbuilder + summary: '' + - name: Emulator + uid: botbuilder.Channels.Emulator + package: botbuilder + summary: '' + - name: Facebook + uid: botbuilder.Channels.Facebook + package: botbuilder + summary: '' + - name: Groupme + uid: botbuilder.Channels.Groupme + package: botbuilder + summary: '' + - name: Kik + uid: botbuilder.Channels.Kik + package: botbuilder + summary: '' + - name: Line + uid: botbuilder.Channels.Line + package: botbuilder + summary: '' + - name: Msteams + uid: botbuilder.Channels.Msteams + package: botbuilder + summary: '' + - name: Omni + uid: botbuilder.Channels.Omni + package: botbuilder + summary: '' + - name: Outlook + uid: botbuilder.Channels.Outlook + package: botbuilder + summary: '' + - name: Skype + uid: botbuilder.Channels.Skype + package: botbuilder + summary: '' + - name: Skypeforbusiness + uid: botbuilder.Channels.Skypeforbusiness + package: botbuilder + summary: '' + - name: Slack + uid: botbuilder.Channels.Slack + package: botbuilder + summary: '' + - name: Sms + uid: botbuilder.Channels.Sms + package: botbuilder + summary: '' + - name: Telegram + uid: botbuilder.Channels.Telegram + package: botbuilder + summary: '' + - name: Telephony + uid: botbuilder.Channels.Telephony + package: botbuilder + summary: '' + - name: Test + uid: botbuilder.Channels.Test + package: botbuilder + summary: '' + - name: Twilio + uid: botbuilder.Channels.Twilio + package: botbuilder + summary: '' + - name: Webchat + uid: botbuilder.Channels.Webchat + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapter.yml index 4ca180e3..898e4e2a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapter.yml @@ -7,7 +7,6 @@ summary: >- different cloud environmens both public and private. fullName: CloudAdapter remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: Initializes a new instance of the [CloudAdapter](xref:botbuilder:CloudAdapter) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,10 +25,25 @@ constructors: parameters: - id: botFrameworkAuthentication type: BotFrameworkAuthentication - description: > + description: >- Optional [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) instance +properties: + - name: onTurnError + uid: botbuilder.CloudAdapter.onTurnError + package: botbuilder + summary: >- + Gets or sets an error handler that can catch exceptions in the middleware + or application. + fullName: onTurnError + remarks: '' + isDeprecated: false + syntax: + content: '(context: TurnContext, error: Error) => Promise onTurnError' + return: + description: A promise representing the async operation. + type: '(context: TurnContext, error: Error) => Promise<void>' inheritedProperties: - name: BotIdentityKey uid: botbuilder.CloudAdapter.BotIdentityKey @@ -38,95 +51,94 @@ inheritedProperties: summary: '' fullName: BotIdentityKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'BotIdentityKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From BotAdapter.BotIdentityKey + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.BotIdentityKey](xref:botbuilder.CloudAdapterBase.BotIdentityKey) - name: ConnectorClientKey uid: botbuilder.CloudAdapter.ConnectorClientKey package: botbuilder summary: '' fullName: ConnectorClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorClientKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From BotAdapter.ConnectorClientKey + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.ConnectorClientKey](xref:botbuilder.CloudAdapterBase.ConnectorClientKey) - name: ConnectorFactoryKey uid: botbuilder.CloudAdapter.ConnectorFactoryKey package: botbuilder summary: '' fullName: ConnectorFactoryKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ConnectorFactoryKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From CloudAdapterBase.ConnectorFactoryKey + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.ConnectorFactoryKey](xref:botbuilder.CloudAdapterBase.ConnectorFactoryKey) - name: OAuthScopeKey uid: botbuilder.CloudAdapter.OAuthScopeKey package: botbuilder summary: '' fullName: OAuthScopeKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'OAuthScopeKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From BotAdapter.OAuthScopeKey - - name: onTurnError - uid: botbuilder.CloudAdapter.onTurnError - package: botbuilder - summary: '' - fullName: onTurnError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onTurnError: (context: TurnContext, error: Error) => Promise' - return: - description: '' - type: '(context: TurnContext, error: Error) => Promise<void>' - inheritanceDescription: Inherited From BotAdapter.onTurnError + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.OAuthScopeKey](xref:botbuilder.CloudAdapterBase.OAuthScopeKey) - name: UserTokenClientKey uid: botbuilder.CloudAdapter.UserTokenClientKey package: botbuilder summary: '' fullName: UserTokenClientKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'UserTokenClientKey: symbol' return: description: '' type: symbol - inheritanceDescription: Inherited From CloudAdapterBase.UserTokenClientKey + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.UserTokenClientKey](xref:botbuilder.CloudAdapterBase.UserTokenClientKey) inheritedMethods: - name: >- continueConversation(Partial, (context: TurnContext) => Promise) uid: botbuilder.CloudAdapter.continueConversation package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: '' + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: >- + This is often referred to as a _proactive notification_, the bot can + proactively + + send a message to a conversation or user without waiting for an incoming + message. + + For example, a bot can use this method to send notifications or coupons to + a user. + isDeprecated: false syntax: content: >- function continueConversation(_reference: @@ -134,56 +146,41 @@ inheritedMethods: Promise): Promise parameters: - id: _reference - type: Partial<ConversationReference> - description: '' + type: Partial<> + description: A reference to the conversation to continue. - id: _logic type: '(context: TurnContext) => Promise<void>' - description: '' + description: The asynchronous method to call after the adapter middleware runs. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.continueConversation - - name: >- - continueConversationAsync(string | ClaimsIdentity, - Partial, (context: TurnContext) => Promise | - string, (context: TurnContext) => Promise) - uid: botbuilder.CloudAdapter.continueConversationAsync - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function continueConversationAsync(botAppIdOrClaimsIdentity: string | - ClaimsIdentity, reference: Partial, - logicOrAudience: (context: TurnContext) => Promise | string, - maybeLogic?: (context: TurnContext) => Promise): Promise - parameters: - - id: botAppIdOrClaimsIdentity - type: string | ClaimsIdentity - description: '' - - id: reference - type: Partial<ConversationReference> - description: '' - - id: logicOrAudience - type: '(context: TurnContext) => Promise<void> | string' - description: '' - - id: maybeLogic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.continueConversationAsync + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.continueConversation](xref:botbuilder.CloudAdapterBase.continueConversation) - name: >- createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise) uid: botbuilder.CloudAdapter.createConversationAsync package: botbuilder - summary: '' - remarks: '' - isPreview: false + summary: Creates a conversation on the specified channel. + remarks: >- + To start a conversation, your bot must know its account information and + the user's account information on that + + channel. Most _channels only support initiating a direct message + (non-group) conversation. + + + The adapter attempts to create a new conversation on the channel, and then + sends a `conversationUpdate` activity + + through its middleware pipeline to the logic method. + + + If the conversation is established with the specified users, the ID of the + activity's converstion will contain + + the ID of the new conversation. isDeprecated: false syntax: content: >- @@ -194,32 +191,48 @@ inheritedMethods: parameters: - id: botAppId type: string - description: '' + description: The application ID of the bot. - id: channelId type: string - description: '' + description: The ID for the channel. - id: serviceUrl type: string - description: '' + description: The ID for the channel. - id: audience type: string - description: '' + description: |- + The audience for the connector. + - id: conversationParameters - type: ConversationParameters - description: '' + type: + description: The conversation information to use to create the conversation - id: logic type: '(context: TurnContext) => Promise<void>' - description: '' + description: The method to call for the resulting bot turn. return: - description: '' + description: A promise that represents the asynchronous operation type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.createConversationAsync - - name: 'deleteActivity(TurnContext, Partial)' + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.createConversationAsync](xref:botbuilder.CloudAdapterBase.createConversationAsync) + - name: deleteActivity(TurnContext, Partial) uid: botbuilder.CloudAdapter.deleteActivity package: botbuilder - summary: '' - remarks: '' - isPreview: false + summary: >- + Asynchronously deletes an existing activity. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + to delete + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. isDeprecated: false syntax: content: >- @@ -227,21 +240,40 @@ inheritedMethods: Partial): Promise parameters: - id: context - type: TurnContext - description: '' + type: + description: The context object for the turn. - id: reference - type: Partial<ConversationReference> - description: '' + type: Partial<> + description: Conversation reference information for the activity to delete. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From CloudAdapterBase.deleteActivity - - name: 'sendActivities(TurnContext, Partial[])' + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.deleteActivity](xref:botbuilder.CloudAdapterBase.deleteActivity) + - name: sendActivities(TurnContext, Partial[]) uid: botbuilder.CloudAdapter.sendActivities package: botbuilder - summary: '' - remarks: '' - isPreview: false + summary: >- + Asynchronously sends a set of outgoing activities to a channel server. + + + This method supports the framework and is not intended to be called + directly for your code. + + Use the turn context's + [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or + + [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) method + from your bot code. + remarks: >- + The activities will be sent one after another in the order in which + they're received. A + + response object will be returned for each sent activity. For `message` + activities this will + + contain the ID of the delivered message. isDeprecated: false syntax: content: >- @@ -249,40 +281,54 @@ inheritedMethods: Partial[]): Promise parameters: - id: context - type: TurnContext - description: '' + type: + description: The context object for the turn. - id: activities - type: 'Partial<Activity>[]' - description: '' + type: Partial<>[] + description: The activities to send. return: - description: '' - type: 'Promise<ResourceResponse[]>' - inheritanceDescription: Inherited From CloudAdapterBase.sendActivities - - name: 'updateActivity(TurnContext, Partial)' + description: An array of [ResourceResponse](xref:botbuilder.Os) + type: Promise<[]> + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.sendActivities](xref:botbuilder.CloudAdapterBase.sendActivities) + - name: updateActivity(TurnContext, Partial) uid: botbuilder.CloudAdapter.updateActivity package: botbuilder - summary: '' - remarks: '' - isPreview: false + summary: >- + Asynchronously replaces a previous activity with an updated version. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + to update + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. isDeprecated: false syntax: content: >- function updateActivity(context: TurnContext, activity: - Partial): Promise + Partial): Promise parameters: - id: context - type: TurnContext - description: '' + type: + description: The context object for the turn. - id: activity - type: Partial<Activity> - description: '' + type: Partial<> + description: The updated version of the activity to replace. return: description: '' - type: Promise<ResourceResponse | void> - inheritanceDescription: Inherited From CloudAdapterBase.updateActivity - - name: >- - use((context: TurnContext, next: () => Promise) => Promise | - Middleware[]) + type: Promise<void | > + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.updateActivity](xref:botbuilder.CloudAdapterBase.updateActivity) + - name: use((MiddlewareHandler | Middleware)[]) uid: botbuilder.CloudAdapter.use package: botbuilder summary: Adds middleware to the adapter's pipeline. @@ -291,22 +337,23 @@ inheritedMethods: Each turn, the adapter calls its middleware in the order in which you added it. - isPreview: false isDeprecated: false syntax: content: >- - function use(middlewares: (context: TurnContext, next: () => - Promise) => Promise | Middleware[]): this + function use(middlewares: (MiddlewareHandler | Middleware)[]): + CloudAdapter parameters: - id: middlewares type: >- - (context: TurnContext, next: () => Promise<void>) => - Promise<void> | Middleware[] + ( | )[] description: The middleware or middleware handlers to add. return: description: The updated adapter object. - type: this - inheritanceDescription: Inherited From BotAdapter.use + type: + inheritanceDescription: >- + Inherited From + [CloudAdapterBase.use](xref:botbuilder.CloudAdapterBase.use) methods: - name: >- connectNamedPipe(string, (context: TurnContext) => Promise, string, @@ -315,7 +362,6 @@ methods: package: botbuilder summary: Used to connect the adapter to a named pipe. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -341,17 +387,18 @@ methods: cloud environment. - id: callerId type: string - description: 'Optional, the caller ID' + description: Optional, the caller ID - id: retryCount type: number - description: > + description: >- Optional, the number of times to retry a failed connection (defaults to 7) return: description: '' type: Promise<void> - name: >- - process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => + process(Request, Record>, INodeSocket, INodeBuffer, (context: TurnContext) => Promise) uid: botbuilder.CloudAdapter.process_1 package: botbuilder @@ -359,16 +406,18 @@ methods: Handle a web socket connection by applying a logic function to each streaming request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function process(req: Request, socket: INodeSocket, head: INodeBuffer, + function process(req: Request, Record>, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise): Promise parameters: - id: req - type: - description: 'An incoming HTTP [Request](xref:botbuilder.Request)' + type: >- + <Record<string, unknown>, + Record<string, undefined | string | string[]>> + description: An incoming HTTP [Request](xref:botbuilder.Request) - id: socket type: INodeSocket description: >- @@ -385,21 +434,25 @@ methods: return: description: a promise representing the asynchronous operation. type: Promise<void> - - name: 'process(Request, Response, (context: TurnContext) => Promise)' + - name: >- + process(Request, Record>, Response, (context: TurnContext) => Promise) uid: botbuilder.CloudAdapter.process package: botbuilder summary: Process a web request by applying a logic function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function process(req: Request, res: Response, logic: (context: + function process(req: Request, Record>, res: Response, logic: (context: TurnContext) => Promise): Promise parameters: - id: req - type: - description: 'The corresponding HTTP [Response](xref:botbuilder.Response)' + type: >- + <Record<string, unknown>, + Record<string, undefined | string | string[]>> + description: An incoming HTTP [Request](xref:botbuilder.Request) - id: res type: description: '' @@ -409,4 +462,32 @@ methods: return: description: a promise representing the asynchronous operation. type: Promise<void> -extends: CloudAdapterBase + - name: >- + processActivityDirect(string | AuthenticateRequestResult, Activity, + (context: TurnContext) => Promise) + uid: botbuilder.CloudAdapter.processActivityDirect + package: botbuilder + summary: Asynchronously process an activity running the provided logic function. + remarks: '' + isDeprecated: false + syntax: + content: >- + function processActivityDirect(authorization: string | + AuthenticateRequestResult, activity: Activity, logic: (context: + TurnContext) => Promise): Promise + parameters: + - id: authorization + type: string | AuthenticateRequestResult + description: >- + The authorization header in the format: "Bearer [longString]" or the + AuthenticateRequestResult for this turn. + - id: activity + type: + description: The activity to process. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The logic function to apply. + return: + description: a promise representing the asynchronous operation. + type: Promise<void> +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapterBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapterBase.yml new file mode 100644 index 00000000..ccbf151b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudAdapterBase.yml @@ -0,0 +1,335 @@ +### YamlMime:TSType +name: CloudAdapterBase +uid: botbuilder.CloudAdapterBase +package: botbuilder +summary: >- + An adapter that implements the Bot Framework Protocol and can be hosted in + different cloud environments both public and private. +fullName: CloudAdapterBase +remarks: '' +isDeprecated: false +type: class +constructors: + - name: CloudAdapterBase(BotFrameworkAuthentication) + uid: botbuilder.CloudAdapterBase.constructor + package: botbuilder + summary: >- + Create a new [CloudAdapterBase](xref:botbuilder.CloudAdapterBase) + instance. + remarks: '' + isDeprecated: false + syntax: + content: >- + new CloudAdapterBase(botFrameworkAuthentication: + BotFrameworkAuthentication) + parameters: + - id: botFrameworkAuthentication + type: BotFrameworkAuthentication + description: >- + A + [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) + used for validating and creating tokens. +properties: + - name: ConnectorFactoryKey + uid: botbuilder.CloudAdapterBase.ConnectorFactoryKey + package: botbuilder + summary: '' + fullName: ConnectorFactoryKey + remarks: '' + isDeprecated: false + syntax: + content: 'ConnectorFactoryKey: symbol' + return: + description: '' + type: symbol + - name: onTurnError + uid: botbuilder.CloudAdapterBase.onTurnError + package: botbuilder + summary: >- + Gets or sets an error handler that can catch exceptions in the middleware + or application. + fullName: onTurnError + remarks: '' + isDeprecated: false + syntax: + content: '(context: TurnContext, error: Error) => Promise onTurnError' + return: + description: A promise representing the async operation. + type: '(context: TurnContext, error: Error) => Promise<void>' + - name: UserTokenClientKey + uid: botbuilder.CloudAdapterBase.UserTokenClientKey + package: botbuilder + summary: '' + fullName: UserTokenClientKey + remarks: '' + isDeprecated: false + syntax: + content: 'UserTokenClientKey: symbol' + return: + description: '' + type: symbol +inheritedProperties: + - name: BotIdentityKey + uid: botbuilder.CloudAdapterBase.BotIdentityKey + package: botbuilder + summary: '' + fullName: BotIdentityKey + remarks: '' + isDeprecated: false + syntax: + content: 'BotIdentityKey: symbol' + return: + description: '' + type: symbol + inheritanceDescription: >- + Inherited From + [BotAdapter.BotIdentityKey](xref:botbuilder.BotAdapter.BotIdentityKey) + - name: ConnectorClientKey + uid: botbuilder.CloudAdapterBase.ConnectorClientKey + package: botbuilder + summary: '' + fullName: ConnectorClientKey + remarks: '' + isDeprecated: false + syntax: + content: 'ConnectorClientKey: symbol' + return: + description: '' + type: symbol + inheritanceDescription: >- + Inherited From + [BotAdapter.ConnectorClientKey](xref:botbuilder.BotAdapter.ConnectorClientKey) + - name: OAuthScopeKey + uid: botbuilder.CloudAdapterBase.OAuthScopeKey + package: botbuilder + summary: '' + fullName: OAuthScopeKey + remarks: '' + isDeprecated: false + syntax: + content: 'OAuthScopeKey: symbol' + return: + description: '' + type: symbol + inheritanceDescription: >- + Inherited From + [BotAdapter.OAuthScopeKey](xref:botbuilder.BotAdapter.OAuthScopeKey) +inheritedMethods: + - name: use((MiddlewareHandler | Middleware)[]) + uid: botbuilder.CloudAdapterBase.use + package: botbuilder + summary: Adds middleware to the adapter's pipeline. + remarks: >- + Middleware is added to the adapter at initialization time. + + Each turn, the adapter calls its middleware in the order in which you + added it. + isDeprecated: false + syntax: + content: >- + function use(middlewares: (MiddlewareHandler | Middleware)[]): + CloudAdapterBase + parameters: + - id: middlewares + type: >- + ( | )[] + description: The middleware or middleware handlers to add. + return: + description: The updated adapter object. + type: + inheritanceDescription: Inherited From [BotAdapter.use](xref:botbuilder.BotAdapter.use) +methods: + - name: >- + continueConversation(Partial, (context: + TurnContext) => Promise) + uid: botbuilder.CloudAdapterBase.continueConversation + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: >- + This is often referred to as a _proactive notification_, the bot can + proactively + + send a message to a conversation or user without waiting for an incoming + message. + + For example, a bot can use this method to send notifications or coupons to + a user. + isDeprecated: false + syntax: + content: >- + function continueConversation(_reference: + Partial, _logic: (context: TurnContext) => + Promise): Promise + parameters: + - id: _reference + type: Partial<> + description: A reference to the conversation to continue. + - id: _logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: '' + type: Promise<void> + - name: >- + createConversationAsync(string, string, string, string, + ConversationParameters, (context: TurnContext) => Promise) + uid: botbuilder.CloudAdapterBase.createConversationAsync + package: botbuilder + summary: Creates a conversation on the specified channel. + remarks: >- + To start a conversation, your bot must know its account information and + the user's account information on that + + channel. Most _channels only support initiating a direct message + (non-group) conversation. + + + The adapter attempts to create a new conversation on the channel, and then + sends a `conversationUpdate` activity + + through its middleware pipeline to the logic method. + + + If the conversation is established with the specified users, the ID of the + activity's converstion will contain + + the ID of the new conversation. + isDeprecated: false + syntax: + content: >- + function createConversationAsync(botAppId: string, channelId: string, + serviceUrl: string, audience: string, conversationParameters: + ConversationParameters, logic: (context: TurnContext) => Promise): + Promise + parameters: + - id: botAppId + type: string + description: The application ID of the bot. + - id: channelId + type: string + description: The ID for the channel. + - id: serviceUrl + type: string + description: The ID for the channel. + - id: audience + type: string + description: |- + The audience for the connector. + + - id: conversationParameters + type: + description: The conversation information to use to create the conversation + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The method to call for the resulting bot turn. + return: + description: A promise that represents the asynchronous operation + type: Promise<void> + - name: deleteActivity(TurnContext, Partial) + uid: botbuilder.CloudAdapterBase.deleteActivity + package: botbuilder + summary: >- + Asynchronously deletes an existing activity. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + to delete + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. + isDeprecated: false + syntax: + content: >- + function deleteActivity(context: TurnContext, reference: + Partial): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: reference + type: Partial<> + description: Conversation reference information for the activity to delete. + return: + description: '' + type: Promise<void> + - name: sendActivities(TurnContext, Partial[]) + uid: botbuilder.CloudAdapterBase.sendActivities + package: botbuilder + summary: >- + Asynchronously sends a set of outgoing activities to a channel server. + + + This method supports the framework and is not intended to be called + directly for your code. + + Use the turn context's + [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or + + [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) method + from your bot code. + remarks: >- + The activities will be sent one after another in the order in which + they're received. A + + response object will be returned for each sent activity. For `message` + activities this will + + contain the ID of the delivered message. + isDeprecated: false + syntax: + content: >- + function sendActivities(context: TurnContext, activities: + Partial[]): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: activities + type: Partial<>[] + description: The activities to send. + return: + description: An array of [ResourceResponse](xref:botbuilder.Os) + type: Promise<[]> + - name: updateActivity(TurnContext, Partial) + uid: botbuilder.CloudAdapterBase.updateActivity + package: botbuilder + summary: >- + Asynchronously replaces a previous activity with an updated version. + + + This interface supports the framework and is not intended to be called + directly for your code. + + Use + [TurnContext.updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + to update + + an activity from your bot code. + remarks: >- + Not all channels support this operation. For channels that don't, this + call may throw an exception. + isDeprecated: false + syntax: + content: >- + function updateActivity(context: TurnContext, activity: + Partial): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: activity + type: Partial<> + description: The updated version of the activity to replace. + return: + description: '' + type: Promise<void | > +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudChannelServiceHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudChannelServiceHandler.yml deleted file mode 100644 index 91dc9ace..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudChannelServiceHandler.yml +++ /dev/null @@ -1,421 +0,0 @@ -### YamlMime:TSType -name: CloudChannelServiceHandler -uid: botbuilder.CloudChannelServiceHandler -package: botbuilder -summary: >- - A class to help with the implementation of the Bot Framework protocol using - [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication). -fullName: CloudChannelServiceHandler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: CloudChannelServiceHandler(BotFrameworkAuthentication) - uid: botbuilder.CloudChannelServiceHandler.constructor - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new CloudChannelServiceHandler(auth: BotFrameworkAuthentication)' - parameters: - - id: auth - type: BotFrameworkAuthentication - description: | - Bot framework authentication -inheritedMethods: - - name: 'handleCreateConversation(string, ConversationParameters)' - uid: botbuilder.CloudChannelServiceHandler.handleCreateConversation - package: botbuilder - summary: Creates a new Conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleCreateConversation(authHeader: string, parameters: - ConversationParameters): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: parameters - type: ConversationParameters - description: >- - (xref:botbuilder-core.ConversationParameters) to create the - conversation from. - return: - description: A `Promise` representation for the operation. - type: Promise<ConversationResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleCreateConversation](xref:botbuilder.ChannelServiceHandlerBase.handleCreateConversation) - - name: 'handleDeleteActivity(string, string, string)' - uid: botbuilder.CloudChannelServiceHandler.handleDeleteActivity - package: botbuilder - summary: 'Deletes an existing [Activity](xref:botframework-schema.Activity).' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleDeleteActivity(authHeader: string, conversationId: - string, activityId: string): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: activityId - type: string - description: | - The activity Id to delete. - return: - description: '' - type: Promise<void> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleDeleteActivity](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteActivity) - - name: 'handleDeleteConversationMember(string, string, string)' - uid: botbuilder.CloudChannelServiceHandler.handleDeleteConversationMember - package: botbuilder - summary: Deletes a member from a conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleDeleteConversationMember(authHeader: string, - conversationId: string, memberId: string): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: memberId - type: string - description: | - Id of the member to delete from this conversation. - return: - description: '' - type: Promise<void> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleDeleteConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteConversationMember) - - name: 'handleGetActivityMembers(string, string, string)' - uid: botbuilder.CloudChannelServiceHandler.handleGetActivityMembers - package: botbuilder - summary: >- - Enumerates the members of an - [Activity](xref:botframework-schema.Activity). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleGetActivityMembers(authHeader: string, conversationId: - string, activityId: string): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: activityId - type: string - description: The activity Id. - return: - description: >- - The enumerated - [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetActivityMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetActivityMembers) - - name: 'handleGetConversationMember(string, string, string)' - uid: botbuilder.CloudChannelServiceHandler.handleGetConversationMember - package: botbuilder - summary: Gets the account of a single conversation member. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleGetConversationMember(authHeader: string, userId: string, - conversationId: string): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: userId - type: string - description: The user Id. - - id: conversationId - type: string - description: The conversation Id. - return: - description: >- - The [ChannelAccount](xref:botframework-schema.ChannelAccount) for the - provided user id. - type: Promise<ChannelAccount> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMember) - - name: 'handleGetConversationMembers(string, string)' - uid: botbuilder.CloudChannelServiceHandler.handleGetConversationMembers - package: botbuilder - summary: Enumerates the members of a conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleGetConversationMembers(authHeader: string, - conversationId: string): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - return: - description: >- - The enumerated - [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetConversationMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMembers) - - name: 'handleGetConversationPagedMembers(string, string, number, string)' - uid: botbuilder.CloudChannelServiceHandler.handleGetConversationPagedMembers - package: botbuilder - summary: Enumerates the members of a conversation one page at a time. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleGetConversationPagedMembers(authHeader: string, - conversationId: string, pageSize?: number, continuationToken?: string): - Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: pageSize - type: number - description: Suggested page size. - - id: continuationToken - type: string - description: A continuation token. - return: - description: >- - A `Promise` representing the - [PagedMembersResult](xref:botframework-schema.PagedMembersResult) for - the operation. - type: Promise<PagedMembersResult> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetConversationPagedMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationPagedMembers) - - name: 'handleGetConversations(string, string, string)' - uid: botbuilder.CloudChannelServiceHandler.handleGetConversations - package: botbuilder - summary: Lists the Conversations in which the bot has participated. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleGetConversations(authHeader: string, conversationId: - string, continuationToken?: string): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: continuationToken - type: string - description: A skip or continuation token. - return: - description: A `Promise` representation for the operation. - type: Promise<ConversationsResult> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetConversations](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversations) - - name: 'handleReplyToActivity(string, string, string, Activity)' - uid: botbuilder.CloudChannelServiceHandler.handleReplyToActivity - package: botbuilder - summary: 'Sends a reply to an [Activity](xref:botframework-schema.Activity).' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleReplyToActivity(authHeader: string, conversationId: - string, activityId: string, activity: Activity): - Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: activityId - type: string - description: The activity Id the reply is to. - - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' - return: - description: >- - A `Promise` representing the - [ResourceResponse](xref:botframework-schema.ResourceResponse) for the - operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleReplyToActivity](xref:botbuilder.ChannelServiceHandlerBase.handleReplyToActivity) - - name: 'handleSendConversationHistory(string, string, Transcript)' - uid: botbuilder.CloudChannelServiceHandler.handleSendConversationHistory - package: botbuilder - summary: Uploads the historic activities of the conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleSendConversationHistory(authHeader: string, - conversationId: string, transcript: Transcript): - Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: transcript - type: Transcript - description: '(xref:botframework-schema.Transcript) of activities.' - return: - description: >- - A `Promise` representing the - [ResourceResponse](xref:botframework-schema.ResourceResponse) for the - operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleSendConversationHistory](xref:botbuilder.ChannelServiceHandlerBase.handleSendConversationHistory) - - name: 'handleSendToConversation(string, string, Activity)' - uid: botbuilder.CloudChannelServiceHandler.handleSendToConversation - package: botbuilder - summary: >- - Sends an [Activity](xref:botframework-schema.Activity) to the end of a - conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleSendToConversation(authHeader: string, conversationId: - string, activity: Activity): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' - return: - description: >- - A `Promise` representing the - [ResourceResponse](xref:botframework-schema.ResourceResponse) for the - operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleSendToConversation](xref:botbuilder.ChannelServiceHandlerBase.handleSendToConversation) - - name: 'handleUpdateActivity(string, string, string, Activity)' - uid: botbuilder.CloudChannelServiceHandler.handleUpdateActivity - package: botbuilder - summary: >- - Edits a previously sent existing - [Activity](xref:botframework-schema.Activity). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleUpdateActivity(authHeader: string, conversationId: - string, activityId: string, activity: Activity): - Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: activityId - type: string - description: The activity Id to update. - - id: activity - type: Activity - description: 'The replacement [Activity](xref:botframework-schema.Activity).' - return: - description: >- - A `Promise` representing the - [ResourceResponse](xref:botframework-schema.ResourceResponse) for the - operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleUpdateActivity](xref:botbuilder.ChannelServiceHandlerBase.handleUpdateActivity) - - name: 'handleUploadAttachment(string, string, AttachmentData)' - uid: botbuilder.CloudChannelServiceHandler.handleUploadAttachment - package: botbuilder - summary: Stores data in a compliant store when dealing with enterprises. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleUploadAttachment(authHeader: string, conversationId: - string, attachmentUpload: AttachmentData): Promise - parameters: - - id: authHeader - type: string - description: The authentication header. - - id: conversationId - type: string - description: The conversation Id. - - id: attachmentUpload - type: AttachmentData - description: '(xref:botframework-schema.AttachmentData).' - return: - description: >- - A `Promise` representing the - [ResourceResponse](xref:botframework-schema.ResourceResponse) for the - operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleUploadAttachment](xref:botbuilder.ChannelServiceHandlerBase.handleUploadAttachment) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudSkillHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudSkillHandler.yml index d4e74e2a..14e475c6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudSkillHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CloudSkillHandler.yml @@ -5,7 +5,6 @@ package: botbuilder summary: A Bot Framework Handler for skills. fullName: CloudSkillHandler remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: botbuilder summary: Initializes a new instance of the CloudSkillHandler class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -25,20 +23,19 @@ constructors: auth: BotFrameworkAuthentication) parameters: - id: adapter - type: BotAdapter + type: description: An instance of the BotAdapter that will handle the request. - id: logic type: '(context: TurnContext) => Promise<void>' description: The Bot logic function - id: conversationIdFactory - type: SkillConversationIdFactoryBase + type: description: >- A SkillConversationIdFactoryBase to unpack the conversation ID and map it to the calling bot. - id: auth type: BotFrameworkAuthentication - description: | - Bot Framework Authentication to use + description: Bot Framework Authentication to use properties: - name: SkillConversationReferenceKey uid: botbuilder.CloudSkillHandler.SkillConversationReferenceKey @@ -48,7 +45,6 @@ properties: Parent. fullName: SkillConversationReferenceKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'SkillConversationReferenceKey: symbol' @@ -56,12 +52,11 @@ properties: description: '' type: symbol inheritedMethods: - - name: 'handleCreateConversation(string, ConversationParameters)' + - name: handleCreateConversation(string, ConversationParameters) uid: botbuilder.CloudSkillHandler.handleCreateConversation package: botbuilder summary: Creates a new Conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -72,22 +67,19 @@ inheritedMethods: type: string description: The authentication header. - id: parameters - type: ConversationParameters + type: description: >- - (xref:botbuilder-core.ConversationParameters) to create the - conversation from. + [ConversationParameters](xref:botbuilder-core.ConversationParameters) + to create the conversation from. return: description: A `Promise` representation for the operation. - type: Promise<ConversationResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleCreateConversation](xref:botbuilder.ChannelServiceHandlerBase.handleCreateConversation) - - name: 'handleDeleteActivity(string, string, string)' + type: Promise<> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleCreateConversation + - name: handleDeleteActivity(string, string, string) uid: botbuilder.CloudSkillHandler.handleDeleteActivity package: botbuilder - summary: 'Deletes an existing [Activity](xref:botframework-schema.Activity).' + summary: Deletes an existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -102,20 +94,16 @@ inheritedMethods: description: The conversation Id. - id: activityId type: string - description: | - The activity Id to delete. + description: The activity Id to delete. return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleDeleteActivity](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteActivity) - - name: 'handleDeleteConversationMember(string, string, string)' + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleDeleteActivity + - name: handleDeleteConversationMember(string, string, string) uid: botbuilder.CloudSkillHandler.handleDeleteConversationMember package: botbuilder summary: Deletes a member from a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,22 +118,20 @@ inheritedMethods: description: The conversation Id. - id: memberId type: string - description: | - Id of the member to delete from this conversation. + description: Id of the member to delete from this conversation. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleDeleteConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteConversationMember) - - name: 'handleGetActivityMembers(string, string, string)' + CloudChannelServiceHandler.handleDeleteConversationMember + - name: handleGetActivityMembers(string, string, string) uid: botbuilder.CloudSkillHandler.handleGetActivityMembers package: botbuilder summary: >- Enumerates the members of an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -165,16 +151,13 @@ inheritedMethods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetActivityMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetActivityMembers) - - name: 'handleGetConversationMember(string, string, string)' + type: Promise<[]> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleGetActivityMembers + - name: handleGetConversationMember(string, string, string) uid: botbuilder.CloudSkillHandler.handleGetConversationMember package: botbuilder summary: Gets the account of a single conversation member. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -194,16 +177,15 @@ inheritedMethods: description: >- The [ChannelAccount](xref:botframework-schema.ChannelAccount) for the provided user id. - type: Promise<ChannelAccount> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMember) - - name: 'handleGetConversationMembers(string, string)' + CloudChannelServiceHandler.handleGetConversationMember + - name: handleGetConversationMembers(string, string) uid: botbuilder.CloudSkillHandler.handleGetConversationMembers package: botbuilder summary: Enumerates the members of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -220,16 +202,15 @@ inheritedMethods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' + type: Promise<[]> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversationMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMembers) - - name: 'handleGetConversationPagedMembers(string, string, number, string)' + CloudChannelServiceHandler.handleGetConversationMembers + - name: handleGetConversationPagedMembers(string, string, number, string) uid: botbuilder.CloudSkillHandler.handleGetConversationPagedMembers package: botbuilder summary: Enumerates the members of a conversation one page at a time. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -254,16 +235,15 @@ inheritedMethods: A `Promise` representing the [PagedMembersResult](xref:botframework-schema.PagedMembersResult) for the operation. - type: Promise<PagedMembersResult> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversationPagedMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationPagedMembers) - - name: 'handleGetConversations(string, string, string)' + CloudChannelServiceHandler.handleGetConversationPagedMembers + - name: handleGetConversations(string, string, string) uid: botbuilder.CloudSkillHandler.handleGetConversations package: botbuilder summary: Lists the Conversations in which the bot has participated. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -281,16 +261,13 @@ inheritedMethods: description: A skip or continuation token. return: description: A `Promise` representation for the operation. - type: Promise<ConversationsResult> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleGetConversations](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversations) - - name: 'handleReplyToActivity(string, string, string, Activity)' + type: Promise<> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleGetConversations + - name: handleReplyToActivity(string, string, string, Activity) uid: botbuilder.CloudSkillHandler.handleReplyToActivity package: botbuilder - summary: 'Sends a reply to an [Activity](xref:botframework-schema.Activity).' + summary: Sends a reply to an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -308,23 +285,20 @@ inheritedMethods: type: string description: The activity Id the reply is to. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleReplyToActivity](xref:botbuilder.ChannelServiceHandlerBase.handleReplyToActivity) - - name: 'handleSendConversationHistory(string, string, Transcript)' + type: Promise<> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleReplyToActivity + - name: handleSendConversationHistory(string, string, Transcript) uid: botbuilder.CloudSkillHandler.handleSendConversationHistory package: botbuilder summary: Uploads the historic activities of the conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -339,25 +313,24 @@ inheritedMethods: type: string description: The conversation Id. - id: transcript - type: Transcript - description: '(xref:botframework-schema.Transcript) of activities.' + type: + description: '[Transcript](xref:botframework-schema.Transcript) of activities.' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleSendConversationHistory](xref:botbuilder.ChannelServiceHandlerBase.handleSendConversationHistory) - - name: 'handleSendToConversation(string, string, Activity)' + CloudChannelServiceHandler.handleSendConversationHistory + - name: handleSendToConversation(string, string, Activity) uid: botbuilder.CloudSkillHandler.handleSendToConversation package: botbuilder summary: >- Sends an [Activity](xref:botframework-schema.Activity) to the end of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -371,25 +344,22 @@ inheritedMethods: type: string description: The conversation Id. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleSendToConversation](xref:botbuilder.ChannelServiceHandlerBase.handleSendToConversation) - - name: 'handleUpdateActivity(string, string, string, Activity)' + type: Promise<> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleSendToConversation + - name: handleUpdateActivity(string, string, string, Activity) uid: botbuilder.CloudSkillHandler.handleUpdateActivity package: botbuilder summary: >- Edits a previously sent existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -407,23 +377,20 @@ inheritedMethods: type: string description: The activity Id to update. - id: activity - type: Activity - description: 'The replacement [Activity](xref:botframework-schema.Activity).' + type: + description: The replacement [Activity](xref:botframework-schema.Activity). return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleUpdateActivity](xref:botbuilder.ChannelServiceHandlerBase.handleUpdateActivity) - - name: 'handleUploadAttachment(string, string, AttachmentData)' + type: Promise<> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleUpdateActivity + - name: handleUploadAttachment(string, string, AttachmentData) uid: botbuilder.CloudSkillHandler.handleUploadAttachment package: botbuilder summary: Stores data in a compliant store when dealing with enterprises. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -437,15 +404,13 @@ inheritedMethods: type: string description: The conversation Id. - id: attachmentUpload - type: AttachmentData - description: '(xref:botframework-schema.AttachmentData).' + type: + description: '[AttachmentData](xref:botframework-schema.AttachmentData).' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> - inheritanceDescription: >- - Inherited From - [ChannelServiceHandlerBase.handleUploadAttachment](xref:botbuilder.ChannelServiceHandlerBase.handleUploadAttachment) -extends: + type: Promise<> + inheritanceDescription: Inherited From CloudChannelServiceHandler.handleUploadAttachment +extends: CloudChannelServiceHandler diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandContext.yml new file mode 100644 index 00000000..214b475a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandContext.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: CommandContext +uid: botbuilder.CommandContext +package: botbuilder +summary: |- + Defines values for CommandContext. + Possible values include: 'message', 'compose', 'commandbox' +fullName: CommandContext +remarks: '' +isDeprecated: false +syntax: | + type CommandContext = "message" | "compose" | "commandbox" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandResultValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandResultValue.yml new file mode 100644 index 00000000..d04f0ec4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandResultValue.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: CommandResultValue +uid: botbuilder.CommandResultValue +package: botbuilder +summary: >- + The value field of a ICommandResultActivity contains metadata related to a + command result. + + An optional extensible data payload may be included if defined by the command + activity name. + + The presence of an error field indicates that the original command failed to + complete. +fullName: CommandResultValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: commandId + uid: botbuilder.CommandResultValue.commandId + package: botbuilder + summary: ID of the command. + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId: string' + return: + description: '' + type: string + - name: data + uid: botbuilder.CommandResultValue.data + package: botbuilder + summary: >- + The data field containing optional parameters specific to this command + activity, + + as defined by the name. The value of the data field is a complex type. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: T' + return: + description: '' + type: T + - name: error + uid: botbuilder.CommandResultValue.error + package: botbuilder + summary: The optional error, if the command result indicates a failure. + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error?: Error' + return: + description: '' + type: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandValue.yml new file mode 100644 index 00000000..21999f87 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CommandValue.yml @@ -0,0 +1,42 @@ +### YamlMime:TSType +name: CommandValue +uid: botbuilder.CommandValue +package: botbuilder +summary: >- + The value field of a ICommandActivity contains metadata related to a command. + + An optional extensible data payload may be included if defined by the command + activity name. +fullName: CommandValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: commandId + uid: botbuilder.CommandValue.commandId + package: botbuilder + summary: ID of the command. + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId: string' + return: + description: '' + type: string + - name: data + uid: botbuilder.CommandValue.data + package: botbuilder + summary: >- + The data field containing optional parameters specific to this command + activity, + + as defined by the name. The value of the data field is a complex type. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: T' + return: + description: '' + type: T diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ComponentRegistration.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ComponentRegistration.yml new file mode 100644 index 00000000..7ff8bcac --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ComponentRegistration.yml @@ -0,0 +1,37 @@ +### YamlMime:TSType +name: ComponentRegistration +uid: botbuilder.ComponentRegistration +package: botbuilder +summary: >- + ComponentRegistration is a signature class for discovering assets from + components. +fullName: ComponentRegistration +remarks: '' +isDeprecated: false +type: class +properties: + - name: components + uid: botbuilder.ComponentRegistration.components + package: botbuilder + summary: Gets list of all ComponentRegistration objects registered. + fullName: components + remarks: '' + isDeprecated: false + syntax: + content: static ComponentRegistration[] components + return: + description: A list of ComponentRegistration objects. + type: [] +methods: + - name: add(ComponentRegistration) + uid: botbuilder.ComponentRegistration.add + package: botbuilder + summary: Add a component, only one instance per type is allowed for components. + remarks: '' + isDeprecated: false + syntax: + content: 'static function add(componentRegistration: ComponentRegistration)' + parameters: + - id: componentRegistration + type: + description: The component to be registered. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponse.yml new file mode 100644 index 00000000..5a2862c7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: ConfigResponse +uid: botbuilder.ConfigResponse +package: botbuilder +summary: '' +fullName: ConfigResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder.ConfigResponse.cacheInfo + package: botbuilder + summary: >- + The data of the ConfigResponse cache, including cache type and cache + duration. + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: config + uid: botbuilder.ConfigResponse.config + package: botbuilder + summary: The ConfigResponse config of BotConfigAuth or TaskModuleResponse + fullName: config + remarks: '' + isDeprecated: false + syntax: + content: 'config: ConfigResponseConfig' + return: + description: '' + type: + - name: responseType + uid: botbuilder.ConfigResponse.responseType + package: botbuilder + summary: The type of response 'config'. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "config"' + return: + description: '' + type: '"config"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponseConfig.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponseConfig.yml new file mode 100644 index 00000000..dbb0a751 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigResponseConfig.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ConfigResponseConfig +uid: botbuilder.ConfigResponseConfig +package: botbuilder +summary: '' +fullName: ConfigResponseConfig +remarks: '' +isDeprecated: false +syntax: | + type ConfigResponseConfig = BotConfigAuth | TaskModuleResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthentication.yml new file mode 100644 index 00000000..9247662e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthentication.yml @@ -0,0 +1,219 @@ +### YamlMime:TSType +name: ConfigurationBotFrameworkAuthentication +uid: botbuilder.ConfigurationBotFrameworkAuthentication +package: botbuilder +summary: >- + Creates a + [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) + instance from an object with the authentication values or a + [Configuration](xref:botbuilder-dialogs-adaptive-runtime-core.Configuration) + instance. +fullName: ConfigurationBotFrameworkAuthentication +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + ConfigurationBotFrameworkAuthentication({ BotOpenIdMetadata?: string, + CallerId?: string, CertificatePrivateKey?: string, CertificateThumbprint?: + string, ChannelService?: string, MicrosoftAppId?: string, + MicrosoftAppTenantId?: string, OAuthApiEndpoint?: string, OAuthUrl?: + string, ToBotFromChannelOpenIdMetadataUrl?: string, + ToBotFromChannelTokenIssuer?: string, ToBotFromEmulatorOpenIdMetadataUrl?: + string, ToChannelFromBotLoginUrl?: string, ToChannelFromBotOAuthScope?: + string, ValidateAuthority?: string | boolean }, + ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: + RequestInfo, init?: RequestInit) => Promise, + ConnectorClientOptions) + uid: botbuilder.ConfigurationBotFrameworkAuthentication.constructor + package: botbuilder + summary: >- + Initializes a new instance of the + [ConfigurationBotFrameworkAuthentication](xref:botbuilder-core.ConfigurationBotFrameworkAuthentication) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: { + BotOpenIdMetadata?: string, CallerId?: string, CertificatePrivateKey?: + string, CertificateThumbprint?: string, ChannelService?: string, + MicrosoftAppId?: string, MicrosoftAppTenantId?: string, + OAuthApiEndpoint?: string, OAuthUrl?: string, + ToBotFromChannelOpenIdMetadataUrl?: string, + ToBotFromChannelTokenIssuer?: string, + ToBotFromEmulatorOpenIdMetadataUrl?: string, ToChannelFromBotLoginUrl?: + string, ToChannelFromBotOAuthScope?: string, ValidateAuthority?: string + | boolean }, credentialsFactory?: ServiceClientCredentialsFactory, + authConfiguration?: AuthenticationConfiguration, + botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => + Promise, connectorClientOptions?: ConnectorClientOptions) + parameters: + - id: botFrameworkAuthConfig + type: >- + { BotOpenIdMetadata?: string, CallerId?: string, + CertificatePrivateKey?: string, CertificateThumbprint?: string, + ChannelService?: string, MicrosoftAppId?: string, + MicrosoftAppTenantId?: string, OAuthApiEndpoint?: string, OAuthUrl?: + string, ToBotFromChannelOpenIdMetadataUrl?: string, + ToBotFromChannelTokenIssuer?: string, + ToBotFromEmulatorOpenIdMetadataUrl?: string, + ToChannelFromBotLoginUrl?: string, ToChannelFromBotOAuthScope?: + string, ValidateAuthority?: string | boolean } + description: >- + A + [ConfigurationBotFrameworkAuthenticationOptions](xref:botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions) + object. + - id: credentialsFactory + type: ServiceClientCredentialsFactory + description: >- + A + [ServiceClientCredentialsFactory](xref:botframework-connector.ServiceClientCredentialsFactory) + instance. + - id: authConfiguration + type: AuthenticationConfiguration + description: >- + A + [Configuration](xref:botframework-connector.AuthenticationConfiguration) + object. + - id: botFrameworkClientFetch + type: >- + (input: RequestInfo, init?: RequestInit) => + Promise<Response> + description: >- + A custom Fetch implementation to be used in the + [BotFrameworkClient](xref:botframework-connector.BotFrameworkClient). + - id: connectorClientOptions + type: ConnectorClientOptions + description: >- + A + [ConnectorClientOptions](xref:botframework-connector.ConnectorClientOptions) + object. +inheritedMethods: + - name: getOriginatingAudience() + uid: botbuilder.ConfigurationBotFrameworkAuthentication.getOriginatingAudience + package: botbuilder + summary: Gets the originating audience from Bot OAuth scope. + remarks: '' + isDeprecated: false + syntax: + content: 'function getOriginatingAudience(): string' + return: + description: The originating audience. + type: string + inheritanceDescription: Inherited From BotFrameworkAuthentication.getOriginatingAudience +methods: + - name: authenticateChannelRequest(string) + uid: >- + botbuilder.ConfigurationBotFrameworkAuthentication.authenticateChannelRequest + package: botbuilder + summary: Authenticate Bot Framework Protocol requests to Skills. + remarks: '' + isDeprecated: false + syntax: + content: >- + function authenticateChannelRequest(authHeader: string): + Promise + parameters: + - id: authHeader + type: string + description: The http auth header received in the skill request. + return: + description: A [ClaimsIdentity](xref:botframework-connector.ClaimsIdentity). + type: Promise<ClaimsIdentity> + - name: authenticateRequest(Activity, string) + uid: botbuilder.ConfigurationBotFrameworkAuthentication.authenticateRequest + package: botbuilder + summary: Validate Bot Framework Protocol requests. + remarks: '' + isDeprecated: false + syntax: + content: >- + function authenticateRequest(activity: Activity, authHeader: string): + Promise + parameters: + - id: activity + type: + description: The inbound Activity. + - id: authHeader + type: string + description: The HTTP auth header. + return: + description: >- + An + [AuthenticateRequestResult](xref:botframework-connector.AuthenticateRequestResult). + type: Promise<AuthenticateRequestResult> + - name: authenticateStreamingRequest(string, string) + uid: >- + botbuilder.ConfigurationBotFrameworkAuthentication.authenticateStreamingRequest + package: botbuilder + summary: Validate Bot Framework Protocol requests. + remarks: '' + isDeprecated: false + syntax: + content: >- + function authenticateStreamingRequest(authHeader: string, + channelIdHeader: string): Promise + parameters: + - id: authHeader + type: string + description: The HTTP auth header. + - id: channelIdHeader + type: string + description: The channel ID HTTP header. + return: + description: >- + An + [AuthenticateRequestResult](xref:botframework-connector.AuthenticateRequestResult). + type: Promise<AuthenticateRequestResult> + - name: createBotFrameworkClient() + uid: >- + botbuilder.ConfigurationBotFrameworkAuthentication.createBotFrameworkClient + package: botbuilder + summary: Creates a BotFrameworkClient for calling Skills. + remarks: '' + isDeprecated: false + syntax: + content: 'function createBotFrameworkClient(): BotFrameworkClient' + return: + description: >- + A + [BotFrameworkClient](xref:botframework-connector.BotFrameworkClient). + type: + - name: createConnectorFactory(ClaimsIdentity) + uid: botbuilder.ConfigurationBotFrameworkAuthentication.createConnectorFactory + package: botbuilder + summary: >- + Creates a ConnectorFactory that can be used to create ConnectorClients + that can use credentials from this particular Cloud Environment. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createConnectorFactory(claimsIdentity: ClaimsIdentity): + ConnectorFactory + parameters: + - id: claimsIdentity + type: ClaimsIdentity + description: The inbound Activity's ClaimsIdentity. + return: + description: A [ConnectorFactory](xref:botframework-connector.ConnectorFactory). + type: ConnectorFactory + - name: createUserTokenClient(ClaimsIdentity) + uid: botbuilder.ConfigurationBotFrameworkAuthentication.createUserTokenClient + package: botbuilder + summary: Creates the appropriate UserTokenClient instance. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createUserTokenClient(claimsIdentity: ClaimsIdentity): + Promise + parameters: + - id: claimsIdentity + type: ClaimsIdentity + description: The inbound Activity's ClaimsIdentity. + return: + description: An [UserTokenClient](xref:botframework-connector.UserTokenClient). + type: Promise<UserTokenClient> +extends: BotFrameworkAuthentication diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthenticationOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthenticationOptions.yml new file mode 100644 index 00000000..b4f9cf85 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationBotFrameworkAuthenticationOptions.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: ConfigurationBotFrameworkAuthenticationOptions +uid: botbuilder.ConfigurationBotFrameworkAuthenticationOptions +package: botbuilder +summary: >- + Contains settings used to configure a + [ConfigurationBotFrameworkAuthentication](xref:botbuilder-core.ConfigurationBotFrameworkAuthentication) + instance. +fullName: ConfigurationBotFrameworkAuthenticationOptions +remarks: '' +isDeprecated: false +syntax: | + type ConfigurationBotFrameworkAuthenticationOptions = z.infer< + typeof TypedOptions + > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactory.yml new file mode 100644 index 00000000..206e531c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactory.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: ConfigurationServiceClientCredentialFactory +uid: botbuilder.ConfigurationServiceClientCredentialFactory +package: botbuilder +summary: >- + ServiceClientCredentialsFactory that uses a + [ConfigurationServiceClientCredentialFactoryOptions](xref:botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions) + or a + [Configuration](xref:botbuilder-dialogs-adaptive-runtime-core.Configuration) + instance to build ServiceClientCredentials with an AppId and App Password. +fullName: ConfigurationServiceClientCredentialFactory +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + ConfigurationServiceClientCredentialFactory({ CertificatePrivateKey?: + string, CertificateThumbprint?: string, MicrosoftAppId?: string, + MicrosoftAppPassword?: string, MicrosoftAppTenantId?: string, + MicrosoftAppType?: string }) + uid: botbuilder.ConfigurationServiceClientCredentialFactory.constructor + package: botbuilder + summary: >- + Initializes a new instance of the + [ConfigurationServiceClientCredentialFactory](xref:botbuilder-core.ConfigurationServiceClientCredentialFactory) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new ConfigurationServiceClientCredentialFactory(factoryOptions?: { + CertificatePrivateKey?: string, CertificateThumbprint?: string, + MicrosoftAppId?: string, MicrosoftAppPassword?: string, + MicrosoftAppTenantId?: string, MicrosoftAppType?: string }) + parameters: + - id: factoryOptions + type: >- + { CertificatePrivateKey?: string, CertificateThumbprint?: string, + MicrosoftAppId?: string, MicrosoftAppPassword?: string, + MicrosoftAppTenantId?: string, MicrosoftAppType?: string } + description: >- + A + [ConfigurationServiceClientCredentialFactoryOptions](xref:botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions) + object. +inheritedProperties: + - name: appId + uid: botbuilder.ConfigurationServiceClientCredentialFactory.appId + package: botbuilder + summary: The app ID for this credential. + fullName: appId + remarks: '' + isDeprecated: false + syntax: + content: 'appId: null | string' + return: + description: '' + type: null | string + inheritanceDescription: Inherited From PasswordServiceClientCredentialFactory.appId + - name: password + uid: botbuilder.ConfigurationServiceClientCredentialFactory.password + package: botbuilder + summary: The app password for this credential. + fullName: password + remarks: '' + isDeprecated: false + syntax: + content: 'password: null | string' + return: + description: '' + type: null | string + inheritanceDescription: Inherited From PasswordServiceClientCredentialFactory.password + - name: tenantId + uid: botbuilder.ConfigurationServiceClientCredentialFactory.tenantId + package: botbuilder + summary: The tenant ID of the Azure AD tenant where the bot is created. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId: null | string' + return: + description: '' + type: null | string + inheritanceDescription: Inherited From PasswordServiceClientCredentialFactory.tenantId +methods: + - name: createCredentials(string, string, string, boolean) + uid: botbuilder.ConfigurationServiceClientCredentialFactory.createCredentials + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createCredentials(microsoftAppId: string, audience: string, + loginEndpoint: string, validateAuthority: boolean): + Promise + parameters: + - id: microsoftAppId + type: string + description: '' + - id: audience + type: string + description: '' + - id: loginEndpoint + type: string + description: '' + - id: validateAuthority + type: boolean + description: '' + return: + description: '' + type: >- + Promise<> + - name: isAuthenticationDisabled() + uid: >- + botbuilder.ConfigurationServiceClientCredentialFactory.isAuthenticationDisabled + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function isAuthenticationDisabled(): Promise' + return: + description: '' + type: Promise<boolean> + - name: isValidAppId(string) + uid: botbuilder.ConfigurationServiceClientCredentialFactory.isValidAppId + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function isValidAppId(microsoftAppId: string): Promise' + parameters: + - id: microsoftAppId + type: string + description: '' + return: + description: '' + type: Promise<boolean> +extends: PasswordServiceClientCredentialFactory diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactoryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactoryOptions.yml new file mode 100644 index 00000000..935eaf4e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfigurationServiceClientCredentialFactoryOptions.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: ConfigurationServiceClientCredentialFactoryOptions +uid: botbuilder.ConfigurationServiceClientCredentialFactoryOptions +package: botbuilder +summary: >- + Contains settings used to configure a + [ConfigurationServiceClientCredentialFactory](xref:botbuilder-core.ConfigurationServiceClientCredentialFactory) + instance. +fullName: ConfigurationServiceClientCredentialFactoryOptions +remarks: '' +isDeprecated: false +syntax: | + type ConfigurationServiceClientCredentialFactoryOptions = z.infer< + typeof TypedConfig + > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfirmationDialog.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfirmationDialog.yml new file mode 100644 index 00000000..ac5f1e26 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConfirmationDialog.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: ConfirmationDialog +uid: botbuilder.ConfirmationDialog +package: botbuilder +summary: >- + SharePoint Confirmation Dialog option that is passed through `Submit` Action + is executed. +fullName: ConfirmationDialog +remarks: '' +isDeprecated: false +type: interface +properties: + - name: message + uid: botbuilder.ConfirmationDialog.message + package: botbuilder + summary: Dialog message. + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.ConfirmationDialog.title + package: botbuilder + summary: Dialog title. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConnectorClientBuilder.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConnectorClientBuilder.yml deleted file mode 100644 index ae3d2e71..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConnectorClientBuilder.yml +++ /dev/null @@ -1,28 +0,0 @@ -### YamlMime:TSType -name: ConnectorClientBuilder -uid: botbuilder.ConnectorClientBuilder -package: botbuilder -summary: Abstraction to build connector clients. -fullName: ConnectorClientBuilder -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: createConnectorClientWithIdentity - uid: botbuilder.ConnectorClientBuilder.createConnectorClientWithIdentity - package: botbuilder - summary: Creates the connector client asynchronous. - fullName: createConnectorClientWithIdentity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - createConnectorClientWithIdentity: (serviceUrl: string, claimsIdentity: - ClaimsIdentity, audience: string) => Promise - return: - description: '' - type: >- - (serviceUrl: string, claimsIdentity: ClaimsIdentity, audience: string) - => Promise<ConnectorClient> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConsoleTranscriptLogger.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConsoleTranscriptLogger.yml new file mode 100644 index 00000000..fcc89132 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConsoleTranscriptLogger.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: ConsoleTranscriptLogger +uid: botbuilder.ConsoleTranscriptLogger +package: botbuilder +summary: ConsoleTranscriptLogger , writes activities to Console output. +fullName: ConsoleTranscriptLogger +remarks: '' +isDeprecated: false +type: class +methods: + - name: logActivity(Activity) + uid: botbuilder.ConsoleTranscriptLogger.logActivity + package: botbuilder + summary: Log an activity to the transcript. + remarks: '' + isDeprecated: false + syntax: + content: 'function logActivity(activity: Activity): void | Promise' + parameters: + - id: activity + type: + description: Activity being logged. + return: + description: '' + type: void | Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ContactRelationUpdateActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ContactRelationUpdateActionTypes.yml new file mode 100644 index 00000000..56100cfd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ContactRelationUpdateActionTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: ContactRelationUpdateActionTypes +uid: botbuilder.ContactRelationUpdateActionTypes +package: botbuilder +summary: |- + Defines values for ContactRelationUpdateActionTypes. + Possible values include: 'add', 'remove' +fullName: ContactRelationUpdateActionTypes +remarks: '' +isDeprecated: false +fields: + - name: Add + uid: botbuilder.ContactRelationUpdateActionTypes.Add + package: botbuilder + summary: '' + - name: Remove + uid: botbuilder.ContactRelationUpdateActionTypes.Remove + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ContentType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ContentType.yml new file mode 100644 index 00000000..10ad4bb3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ContentType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ContentType +uid: botbuilder.ContentType +package: botbuilder +summary: |- + Defines values for ContentType. + Possible values include: 'html', 'text' +fullName: ContentType +remarks: '' +isDeprecated: false +syntax: | + type ContentType = "html" | "text" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationAccount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationAccount.yml new file mode 100644 index 00000000..f78287d8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationAccount.yml @@ -0,0 +1,116 @@ +### YamlMime:TSType +name: ConversationAccount +uid: botbuilder.ConversationAccount +package: botbuilder +summary: Channel account information for a conversation +fullName: ConversationAccount +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadObjectId + uid: botbuilder.ConversationAccount.aadObjectId + package: botbuilder + summary: This account's object ID within Azure Active Directory (AAD) + fullName: aadObjectId + remarks: '' + isDeprecated: false + syntax: + content: 'aadObjectId?: string' + return: + description: '' + type: string + - name: conversationType + uid: botbuilder.ConversationAccount.conversationType + package: botbuilder + summary: >- + Indicates the type of the conversation in channels that distinguish + between conversation types + fullName: conversationType + remarks: '' + isDeprecated: false + syntax: + content: 'conversationType: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.ConversationAccount.id + package: botbuilder + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: isGroup + uid: botbuilder.ConversationAccount.isGroup + package: botbuilder + summary: >- + Indicates whether the conversation contains more than two participants at + the time the + + activity was generated + fullName: isGroup + remarks: '' + isDeprecated: false + syntax: + content: 'isGroup: boolean' + return: + description: '' + type: boolean + - name: name + uid: botbuilder.ConversationAccount.name + package: botbuilder + summary: Display friendly name + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.ConversationAccount.properties + package: botbuilder + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + - name: role + uid: botbuilder.ConversationAccount.role + package: botbuilder + summary: >- + Role of the entity behind the account (Example: User, Bot, etc.). Possible + values include: + + 'user', 'bot' + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: RoleTypes' + return: + description: '' + type: + - name: tenantId + uid: botbuilder.ConversationAccount.tenantId + package: botbuilder + summary: This conversation's tenant ID + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationIdentityType.yml new file mode 100644 index 00000000..26b2163e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationIdentityType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ConversationIdentityType +uid: botbuilder.ConversationIdentityType +package: botbuilder +summary: |- + Defines values for ConversationIdentityType. + Possible values include: 'team', 'channel' +fullName: ConversationIdentityType +remarks: '' +isDeprecated: false +syntax: | + type ConversationIdentityType = "team" | "channel" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationList.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationList.yml new file mode 100644 index 00000000..08ff76bb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationList.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ConversationList +uid: botbuilder.ConversationList +package: botbuilder +summary: '' +fullName: ConversationList +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversations + uid: botbuilder.ConversationList.conversations + package: botbuilder + summary: '' + fullName: conversations + remarks: '' + isDeprecated: false + syntax: + content: 'conversations?: ChannelInfo[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationMembers.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationMembers.yml new file mode 100644 index 00000000..e896878c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationMembers.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ConversationMembers +uid: botbuilder.ConversationMembers +package: botbuilder +summary: Conversation and its members +fullName: ConversationMembers +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.ConversationMembers.id + package: botbuilder + summary: Conversation ID + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: members + uid: botbuilder.ConversationMembers.members + package: botbuilder + summary: List of members in this conversation + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: ChannelAccount[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationParameters.yml new file mode 100644 index 00000000..18d15695 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationParameters.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: ConversationParameters +uid: botbuilder.ConversationParameters +package: botbuilder +summary: Parameters for creating a new conversation +fullName: ConversationParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: botbuilder.ConversationParameters.activity + package: botbuilder + summary: >- + (Optional) When creating a new conversation, use this activity as the + initial message to the + + conversation + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity: Activity' + return: + description: '' + type: + - name: bot + uid: botbuilder.ConversationParameters.bot + package: botbuilder + summary: The bot address for this conversation + fullName: bot + remarks: '' + isDeprecated: false + syntax: + content: 'bot: ChannelAccount' + return: + description: '' + type: + - name: channelData + uid: botbuilder.ConversationParameters.channelData + package: botbuilder + summary: Channel specific payload for creating the conversation + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData: any' + return: + description: '' + type: any + - name: isGroup + uid: botbuilder.ConversationParameters.isGroup + package: botbuilder + summary: IsGroup + fullName: isGroup + remarks: '' + isDeprecated: false + syntax: + content: 'isGroup: boolean' + return: + description: '' + type: boolean + - name: members + uid: botbuilder.ConversationParameters.members + package: botbuilder + summary: Members to add to the conversation + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members?: ChannelAccount[]' + return: + description: '' + type: [] + - name: tenantId + uid: botbuilder.ConversationParameters.tenantId + package: botbuilder + summary: (Optional) The tenant ID in which the conversation should be created + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string + - name: topicName + uid: botbuilder.ConversationParameters.topicName + package: botbuilder + summary: (Optional) Topic of the conversation (if supported by the channel) + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationReference.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationReference.yml new file mode 100644 index 00000000..b184a119 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationReference.yml @@ -0,0 +1,101 @@ +### YamlMime:TSType +name: ConversationReference +uid: botbuilder.ConversationReference +package: botbuilder +summary: An object relating to a particular point in a conversation +fullName: ConversationReference +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityId + uid: botbuilder.ConversationReference.activityId + package: botbuilder + summary: (Optional) ID of the activity to refer to + fullName: activityId + remarks: '' + isDeprecated: false + syntax: + content: 'activityId?: string' + return: + description: '' + type: string + - name: bot + uid: botbuilder.ConversationReference.bot + package: botbuilder + summary: Bot participating in this conversation + fullName: bot + remarks: '' + isDeprecated: false + syntax: + content: 'bot: ChannelAccount' + return: + description: '' + type: + - name: channelId + uid: botbuilder.ConversationReference.channelId + package: botbuilder + summary: Channel ID + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: conversation + uid: botbuilder.ConversationReference.conversation + package: botbuilder + summary: Conversation reference + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: locale + uid: botbuilder.ConversationReference.locale + package: botbuilder + summary: |- + A locale name for the contents of the text field. + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated with a language and an ISO 3166 two-letter + subculture code associated with a country or region. + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: serviceUrl + uid: botbuilder.ConversationReference.serviceUrl + package: botbuilder + summary: >- + Service endpoint where operations concerning the referenced conversation + may be performed + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + - name: user + uid: botbuilder.ConversationReference.user + package: botbuilder + summary: (Optional) User participating in this conversation + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: ChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationResourceResponse.yml new file mode 100644 index 00000000..ebc81d67 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationResourceResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: ConversationResourceResponse +uid: botbuilder.ConversationResourceResponse +package: botbuilder +summary: A response containing a resource +fullName: ConversationResourceResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityId + uid: botbuilder.ConversationResourceResponse.activityId + package: botbuilder + summary: ID of the Activity (if sent) + fullName: activityId + remarks: '' + isDeprecated: false + syntax: + content: 'activityId: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.ConversationResourceResponse.id + package: botbuilder + summary: Id of the resource + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: serviceUrl + uid: botbuilder.ConversationResourceResponse.serviceUrl + package: botbuilder + summary: >- + Service endpoint where operations concerning the conversation may be + performed + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationState.yml new file mode 100644 index 00000000..ea24eb30 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationState.yml @@ -0,0 +1,240 @@ +### YamlMime:TSType +name: ConversationState +uid: botbuilder.ConversationState +package: botbuilder +summary: Reads and writes conversation state for your bot to storage. +fullName: ConversationState +remarks: >- + Each conversation your bot has with a user or group will have its own isolated + storage object + + that can be used to persist conversation tracking information between turns of + the conversation. + + This state information can be reset at any point by calling [clear()](#clear). + + + ```JavaScript + + const { ConversationState, MemoryStorage } = require('botbuilder'); + + + const conversationState = new ConversationState(new MemoryStorage()); + + ``` +isDeprecated: false +type: class +constructors: + - name: ConversationState(Storage, string) + uid: botbuilder.ConversationState.constructor + package: botbuilder + summary: Creates a new ConversationState instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new ConversationState(storage: Storage, namespace?: string)' + parameters: + - id: storage + type: + description: Storage provider to persist conversation state to. + - id: namespace + type: string + description: >- + (Optional) namespace to append to storage keys. Defaults to an empty + string. +inheritedMethods: + - name: clear(TurnContext) + uid: botbuilder.ConversationState.clear + package: botbuilder + summary: Clears the current state object for a turn. + remarks: >- + The cleared state object will not be persisted until + [saveChanges()](#savechanges) has + + been called. + + + ```JavaScript + + await botState.clear(context); + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: 'function clear(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: Inherited From [BotState.clear](xref:botbuilder.BotState.clear) + - name: createProperty(string) + uid: botbuilder.ConversationState.createProperty + package: botbuilder + summary: >- + Creates a new property accessor for reading and writing an individual + property to the bot + + states storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createProperty(name: string): StatePropertyAccessor' + parameters: + - id: name + type: string + description: Name of the property to add. + return: + description: An accessor for the property. + type: <T> + inheritanceDescription: >- + Inherited From + [BotState.createProperty](xref:botbuilder.BotState.createProperty) + - name: delete(TurnContext) + uid: botbuilder.ConversationState.delete + package: botbuilder + summary: Delete the backing state object for the current turn. + remarks: >- + The state object will be removed from storage if it exists. If the state + object has been + + read in and cached, the cache will be cleared. + + + ```JavaScript + + await botState.delete(context); + + ``` + isDeprecated: false + syntax: + content: 'function delete(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: Inherited From [BotState.delete](xref:botbuilder.BotState.delete) + - name: get(TurnContext) + uid: botbuilder.ConversationState.get + package: botbuilder + summary: Returns a cached state object or undefined if not cached. + remarks: >- + This example shows how to synchronously get an already loaded and cached + state object: + + + ```JavaScript + + const state = botState.get(context); + + ``` + isDeprecated: false + syntax: + content: 'function get(context: TurnContext): any' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A cached state object or undefined if not cached. + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder.BotState.get) + - name: load(TurnContext, boolean) + uid: botbuilder.ConversationState.load + package: botbuilder + summary: Reads in and caches the backing state object for a turn. + remarks: >- + Subsequent reads will return the cached object unless the `force` flag is + passed in which + + will force the state object to be re-read. + + + This method is automatically called on first access of any of created + property accessors. + + + ```JavaScript + + const state = await botState.load(context); + + ``` + isDeprecated: false + syntax: + content: 'function load(context: TurnContext, force?: boolean): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) If `true` the cache will be bypassed and the state will + always be read in directly from storage. Defaults to `false`. + return: + description: The cached state. + type: Promise<any> + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder.BotState.load) + - name: saveChanges(TurnContext, boolean) + uid: botbuilder.ConversationState.saveChanges + package: botbuilder + summary: Saves the cached state object if it's been changed. + remarks: >- + If the `force` flag is passed in the cached state object will be saved + regardless of + + whether its been changed or not and if no object has been cached, an empty + object will be + + created and then saved. + + + ```JavaScript + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: >- + function saveChanges(context: TurnContext, force?: boolean): + Promise + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) if `true` the state will always be written out regardless + of its change state. Defaults to `false`. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotState.saveChanges](xref:botbuilder.BotState.saveChanges) +methods: + - name: getStorageKey(TurnContext) + uid: botbuilder.ConversationState.getStorageKey + package: botbuilder + summary: Returns the storage key for the current conversation state. + remarks: '' + isDeprecated: false + syntax: + content: 'function getStorageKey(context: TurnContext): undefined | string' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: The storage key for the current conversation state. + type: undefined | string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationsResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationsResult.yml new file mode 100644 index 00000000..ecf42624 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ConversationsResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ConversationsResult +uid: botbuilder.ConversationsResult +package: botbuilder +summary: Conversations result +fullName: ConversationsResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder.ConversationsResult.continuationToken + package: botbuilder + summary: Paging token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: conversations + uid: botbuilder.ConversationsResult.conversations + package: botbuilder + summary: List of conversations + fullName: conversations + remarks: '' + isDeprecated: false + syntax: + content: 'conversations: ConversationMembers[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/CoreAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/CoreAppCredentials.yml new file mode 100644 index 00000000..8f3bc0f7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/CoreAppCredentials.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: CoreAppCredentials +uid: botbuilder.CoreAppCredentials +package: botbuilder +summary: CoreAppCredentials +fullName: CoreAppCredentials +remarks: >- + Runtime-agnostic interface representing "ServiceClientCredentials" from + @azure/ms-rest-js +isDeprecated: false +type: interface +methods: + - name: signRequest(CoreWebResource) + uid: botbuilder.CoreAppCredentials.signRequest + package: botbuilder + summary: Signs a request with the Authentication header. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signRequest(webResource: CoreWebResource): + Promise + parameters: + - id: webResource + type: CoreWebResource + description: The CoreWebResource/request to be signed. + return: + description: The signed request object; + type: Promise<CoreWebResource> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/DeleteActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/DeleteActivityHandler.yml new file mode 100644 index 00000000..656e3929 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/DeleteActivityHandler.yml @@ -0,0 +1,59 @@ +### YamlMime:TSTypeAlias +name: DeleteActivityHandler +uid: botbuilder.DeleteActivityHandler +package: botbuilder +summary: A handler that can participate in delete activity events for the current turn. +fullName: DeleteActivityHandler +remarks: >- + **Parameters** + + + | Name | Type | Description | + + | :--- | :--- | :--- | + + | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The context + object for the turn. | + + | `reference` | + Partial\<[ConversationReference](xref:botframework-schema.ConversationReference)> + | The conversation containing the activity to delete. | + + | `next` | () => Promise\ | The function to call to continue event + processing. | + + + A handler calls the `next` function to pass control to the next registered + handler. + + If a handler doesn’t call the `next` function, the adapter does not call any + of the + + subsequent handlers and does not attempt to delete the activity. + + + The `reference` parameter's + [activityId](xref:botframework-schema.ConversationReference.activityId) + property indicates which activity + + in the conversation to delete. + + + **See also** + + + - [BotAdapter](xref:botbuilder-core.BotAdapter) + + - [SendActivitiesHandler](xref:botbuilder-core.SendActivitiesHandler) + + - [UpdateActivityHandler](xref:botbuilder-core.UpdateActivityHandler) + + - + [TurnContext.onDeleteActivity](xref:botbuilder-core.TurnContext.onDeleteActivity) +isDeprecated: false +syntax: | + type DeleteActivityHandler = ( + context: TurnContext, + reference: Partial, + next: () => Promise + ) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/DeliveryModes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/DeliveryModes.yml new file mode 100644 index 00000000..2a147825 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/DeliveryModes.yml @@ -0,0 +1,29 @@ +### YamlMime:TSEnum +name: DeliveryModes +uid: botbuilder.DeliveryModes +package: botbuilder +summary: >- + Defines values for DeliveryModes. + + Possible values include: 'normal', 'notification', 'expectReplies', + 'ephemeral' +fullName: DeliveryModes +remarks: '' +isDeprecated: false +fields: + - name: Ephemeral + uid: botbuilder.DeliveryModes.Ephemeral + package: botbuilder + summary: '' + - name: ExpectReplies + uid: botbuilder.DeliveryModes.ExpectReplies + package: botbuilder + summary: '' + - name: Normal + uid: botbuilder.DeliveryModes.Normal + package: botbuilder + summary: '' + - name: Notification + uid: botbuilder.DeliveryModes.Notification + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/DropDownOptionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/DropDownOptionType.yml new file mode 100644 index 00000000..ce5f3068 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/DropDownOptionType.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: DropDownOptionType +uid: botbuilder.DropDownOptionType +package: botbuilder +summary: SharePoint property pane drop down option type. +fullName: DropDownOptionType +remarks: '' +isDeprecated: false +fields: + - name: Normal + uid: botbuilder.DropDownOptionType.Normal + package: botbuilder + summary: Render a normal option. + numericValue: 0 + - name: Divider + uid: botbuilder.DropDownOptionType.Divider + package: botbuilder + summary: Render a divider. + numericValue: 1 + - name: Header + uid: botbuilder.DropDownOptionType.Header + package: botbuilder + summary: Render a header. + numericValue: 2 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/EndOfConversationCodes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/EndOfConversationCodes.yml new file mode 100644 index 00000000..a0fde477 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/EndOfConversationCodes.yml @@ -0,0 +1,39 @@ +### YamlMime:TSEnum +name: EndOfConversationCodes +uid: botbuilder.EndOfConversationCodes +package: botbuilder +summary: >- + Defines values for EndOfConversationCodes. + + Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', + 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' +fullName: EndOfConversationCodes +remarks: '' +isDeprecated: false +fields: + - name: BotIssuedInvalidMessage + uid: botbuilder.EndOfConversationCodes.BotIssuedInvalidMessage + package: botbuilder + summary: '' + - name: BotTimedOut + uid: botbuilder.EndOfConversationCodes.BotTimedOut + package: botbuilder + summary: '' + - name: ChannelFailed + uid: botbuilder.EndOfConversationCodes.ChannelFailed + package: botbuilder + summary: '' + - name: CompletedSuccessfully + uid: botbuilder.EndOfConversationCodes.CompletedSuccessfully + package: botbuilder + summary: '' + - name: Unknown + uid: botbuilder.EndOfConversationCodes.Unknown + package: botbuilder + summary: '' + - name: UserCancelled + uid: botbuilder.EndOfConversationCodes.UserCancelled + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Entity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Entity.yml new file mode 100644 index 00000000..bd683aba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Entity.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: Entity +uid: botbuilder.Entity +package: botbuilder +summary: Metadata object pertaining to an activity +fullName: Entity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder.Entity.type + package: botbuilder + summary: Type of this entity (RFC 3987 IRI) + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorModel.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorModel.yml new file mode 100644 index 00000000..d860f299 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorModel.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ErrorModel +uid: botbuilder.ErrorModel +package: botbuilder +summary: Object representing error information +fullName: ErrorModel +remarks: '' +isDeprecated: false +type: interface +properties: + - name: code + uid: botbuilder.ErrorModel.code + package: botbuilder + summary: Error code + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code: string' + return: + description: '' + type: string + - name: innerHttpError + uid: botbuilder.ErrorModel.innerHttpError + package: botbuilder + summary: Error from inner http call + fullName: innerHttpError + remarks: '' + isDeprecated: false + syntax: + content: 'innerHttpError: InnerHttpError' + return: + description: '' + type: + - name: message + uid: botbuilder.ErrorModel.message + package: botbuilder + summary: Error message + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorResponse.yml new file mode 100644 index 00000000..9b7b061c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ErrorResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ErrorResponse +uid: botbuilder.ErrorResponse +package: botbuilder +summary: An HTTP API response +fullName: ErrorResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: error + uid: botbuilder.ErrorResponse.error + package: botbuilder + summary: Error message + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: ErrorModel' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/EventFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/EventFactory.yml index e66ca4b2..e86d046d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/EventFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/EventFactory.yml @@ -5,16 +5,14 @@ package: botbuilder summary: Contains utility methods for creating various event types. fullName: EventFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'createHandoffInitiation(TurnContext, T, Transcript)' + - name: createHandoffInitiation(TurnContext, T, Transcript) uid: botbuilder.EventFactory.createHandoffInitiation package: botbuilder summary: Create handoff initiation event. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -22,23 +20,22 @@ methods: handoffContext: T, transcript?: Transcript): Activity parameters: - id: context - type: TurnContext + type: description: The context object for the turn. - id: handoffContext type: T description: Agent hub-specific context. - id: transcript - type: Transcript + type: description: Transcript of the conversation. return: description: The handoff event activity. - type: Activity - - name: 'createHandoffStatus(ConversationAccount, string, string)' + type: + - name: createHandoffStatus(ConversationAccount, string, string) uid: botbuilder.EventFactory.createHandoffStatus package: botbuilder summary: Create handoff status event. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -46,7 +43,7 @@ methods: state: string, message?: string): Activity parameters: - id: conversation - type: ConversationAccount + type: description: Conversation being handed over. - id: state type: string @@ -56,4 +53,4 @@ methods: description: Additional message for failed handoff. return: description: The handoff event activity. - type: Activity + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardAction.yml new file mode 100644 index 00000000..64717dcd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ExecuteCardAction +uid: botbuilder.ExecuteCardAction +package: botbuilder +summary: SharePoint `Action.Execute` event. +fullName: ExecuteCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder.ExecuteCardAction.parameters + package: botbuilder + summary: Parameters passed to the Execute event handler + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: ExecuteCardParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.ExecuteCardAction.type + package: botbuilder + summary: Indicates this is an Execute button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "Execute"' + return: + description: '' + type: '"Execute"' + - name: verb + uid: botbuilder.ExecuteCardAction.verb + package: botbuilder + summary: Verb associated with this action + fullName: verb + remarks: '' + isDeprecated: false + syntax: + content: 'verb?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardParameters.yml new file mode 100644 index 00000000..d35ed9fe --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExecuteCardParameters.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: ExecuteCardParameters +uid: botbuilder.ExecuteCardParameters +package: botbuilder +summary: Parameters for SharePoint Action.Execute card action. +fullName: ExecuteCardParameters +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ExpectedReplies.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExpectedReplies.yml new file mode 100644 index 00000000..b86e0b13 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExpectedReplies.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ExpectedReplies +uid: botbuilder.ExpectedReplies +package: botbuilder +summary: Expected Replies in response to DeliveryModes.ExpectReplies +fullName: ExpectedReplies +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activities + uid: botbuilder.ExpectedReplies.activities + package: botbuilder + summary: A collection of Activities that conforms to the ExpectedReplies schema. + fullName: activities + remarks: '' + isDeprecated: false + syntax: + content: 'activities: Activity[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ExtendedUserTokenProvider.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExtendedUserTokenProvider.yml new file mode 100644 index 00000000..20e1ea32 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExtendedUserTokenProvider.yml @@ -0,0 +1,300 @@ +### YamlMime:TSType +name: ExtendedUserTokenProvider +uid: botbuilder.ExtendedUserTokenProvider +package: botbuilder +summary: >- + Interface for User Token OAuth Single Sign On and Token Exchange APIs for + BotAdapters +fullName: ExtendedUserTokenProvider +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use `UserTokenClient` instead. +type: interface +inheritedMethods: + - name: getTokenStatus(TurnContext, string, string, any) + uid: botbuilder.ExtendedUserTokenProvider.getTokenStatus + package: botbuilder + summary: >- + Retrieves the token status for each configured connection for the given + user, using the bot's AppCredentials. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTokenStatus(context: TurnContext, userId: string, + includeFilter?: string, oAuthAppCredentials?: any): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: userId + type: string + description: The user Id for which token status is retrieved. + - id: includeFilter + type: string + description: >- + Comma separated list of connection's to include. Blank will return + token status for all configured connections. + - id: oAuthAppCredentials + type: any + description: The app credentials for OAuth. + return: + description: '' + type: Promise<any[]> + inheritanceDescription: >- + Inherited From + [IUserTokenProvider.getTokenStatus](xref:botbuilder.IUserTokenProvider.getTokenStatus) +methods: + - name: exchangeToken(TurnContext, string, string, TokenExchangeRequest) + uid: botbuilder.ExtendedUserTokenProvider.exchangeToken + package: botbuilder + summary: Performs a token exchange operation such as for single sign-on. + remarks: '' + isDeprecated: false + syntax: + content: >- + function exchangeToken(context: TurnContext, connectionName: string, + userId: string, tokenExchangeRequest: TokenExchangeRequest): + Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: The user id that will be associated with the token. + - id: tokenExchangeRequest + type: + description: >- + The exchange request details, either a token to exchange or a uri to + exchange. + return: + description: '' + type: Promise<> + - name: >- + exchangeToken(TurnContext, string, string, TokenExchangeRequest, + CoreAppCredentials) + uid: botbuilder.ExtendedUserTokenProvider.exchangeToken_1 + package: botbuilder + summary: Performs a token exchange operation such as for single sign-on. + remarks: '' + isDeprecated: false + syntax: + content: >- + function exchangeToken(context: TurnContext, connectionName: string, + userId: string, tokenExchangeRequest: TokenExchangeRequest, + appCredentials: CoreAppCredentials): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: The user id that will be associated with the token. + - id: tokenExchangeRequest + type: + description: >- + The exchange request details, either a token to exchange or a uri to + exchange. + - id: appCredentials + type: + description: '' + return: + description: '' + type: Promise<> + - name: getAadTokens(TurnContext, string, string[], CoreAppCredentials) + uid: botbuilder.ExtendedUserTokenProvider.getAadTokens + package: botbuilder + summary: Signs the user out with the token server. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAadTokens(context: TurnContext, connectionName: string, + resourceUrls: string[], appCredentials?: CoreAppCredentials): + Promise<{[propertyName: string]: TokenResponse}> + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: resourceUrls + type: string[] + description: '' + - id: appCredentials + type: + description: '' + return: + description: '' + type: >- + Promise<{[propertyName: string]: }> + - name: getSignInLink(TurnContext, string, CoreAppCredentials) + uid: botbuilder.ExtendedUserTokenProvider.getSignInLink + package: botbuilder + summary: >- + Gets a signin link from the token server that can be sent as part of a + SigninCard. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInLink(context: TurnContext, connectionName: string, + appCredentials?: CoreAppCredentials): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: appCredentials + type: + description: '' + return: + description: '' + type: Promise<string> + - name: getSignInResource(TurnContext, string) + uid: botbuilder.ExtendedUserTokenProvider.getSignInResource + package: botbuilder + summary: >- + Get the raw signin resource to be sent to the user for signin for a + connection name. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInResource(context: TurnContext, connectionName: + string): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + return: + description: '' + type: Promise<> + - name: getSignInResource(TurnContext, string, string, string) + uid: botbuilder.ExtendedUserTokenProvider.getSignInResource_1 + package: botbuilder + summary: >- + Get the raw signin resource to be sent to the user for signin for a + connection name. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInResource(context: TurnContext, connectionName: string, + userId: string, finalRedirect?: string): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: The user id that will be associated with the token. + - id: finalRedirect + type: string + description: The final URL that the OAuth flow will redirect to. + return: + description: '' + type: Promise<> + - name: getSignInResource(TurnContext, string, string, string, CoreAppCredentials) + uid: botbuilder.ExtendedUserTokenProvider.getSignInResource_2 + package: botbuilder + summary: >- + Get the raw signin resource to be sent to the user for signin for a + connection name. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInResource(context: TurnContext, connectionName: string, + userId: string, finalRedirect?: string, appCredentials?: + CoreAppCredentials): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: The user id that will be associated with the token. + - id: finalRedirect + type: string + description: The final URL that the OAuth flow will redirect to. + - id: appCredentials + type: + description: '' + return: + description: '' + type: Promise<> + - name: getUserToken(TurnContext, string, string, CoreAppCredentials) + uid: botbuilder.ExtendedUserTokenProvider.getUserToken + package: botbuilder + summary: Retrieves the OAuth token for a user that is in a sign-in flow. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getUserToken(context: TurnContext, connectionName: string, + magicCode?: string, appCredentials?: CoreAppCredentials): + Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: magicCode + type: string + description: (Optional) Optional user entered code to validate. + - id: appCredentials + type: + description: '' + return: + description: '' + type: Promise<> + - name: signOutUser(TurnContext, string, string, CoreAppCredentials) + uid: botbuilder.ExtendedUserTokenProvider.signOutUser + package: botbuilder + summary: Signs the user out with the token server. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signOutUser(context: TurnContext, connectionName: string, + userId?: string, appCredentials?: CoreAppCredentials): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: User id of user to sign out. + - id: appCredentials + type: + description: '' + return: + description: '' + type: Promise<void> +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkActionParameters.yml new file mode 100644 index 00000000..99a410d9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkActionParameters.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ExternalLinkActionParameters +uid: botbuilder.ExternalLinkActionParameters +package: botbuilder +summary: Parameters for opening an external link. +fullName: ExternalLinkActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isTeamsDeepLink + uid: botbuilder.ExternalLinkActionParameters.isTeamsDeepLink + package: botbuilder + summary: Indicates whether this is a Teams Deep Link. + fullName: isTeamsDeepLink + remarks: '' + isDeprecated: false + syntax: + content: 'isTeamsDeepLink?: boolean' + return: + description: '' + type: boolean + - name: target + uid: botbuilder.ExternalLinkActionParameters.target + package: botbuilder + summary: The URL of the link. + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkCardAction.yml new file mode 100644 index 00000000..2ede1952 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ExternalLinkCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ExternalLinkCardAction +uid: botbuilder.ExternalLinkCardAction +package: botbuilder +summary: SharePoint ExternalLink action. +fullName: ExternalLinkCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder.ExternalLinkCardAction.parameters + package: botbuilder + summary: Parameters for the external link. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: ExternalLinkActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.ExternalLinkCardAction.type + package: botbuilder + summary: Indicates this is an external link button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "ExternalLink"' + return: + description: '' + type: '"ExternalLink"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Fact.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Fact.yml new file mode 100644 index 00000000..543e0f8c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Fact.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: Fact +uid: botbuilder.Fact +package: botbuilder +summary: >- + Set of key-value pairs. Advantage of this section is that key and value + properties will be + + rendered with default style information with some delimiter between them. So + there is no need + + for developer to specify style information. +fullName: Fact +remarks: '' +isDeprecated: false +type: interface +properties: + - name: key + uid: botbuilder.Fact.key + package: botbuilder + summary: The key for this Fact + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.Fact.value + package: botbuilder + summary: The value for this Fact + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FieldType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FieldType.yml new file mode 100644 index 00000000..50b1585d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FieldType.yml @@ -0,0 +1,54 @@ +### YamlMime:TSEnum +name: FieldType +uid: botbuilder.FieldType +package: botbuilder +summary: SharePoint property pane group field type. +fullName: FieldType +remarks: '' +isDeprecated: false +fields: + - name: CheckBox + uid: botbuilder.FieldType.CheckBox + package: botbuilder + summary: Checkbox field. + numericValue: 2 + - name: TextField + uid: botbuilder.FieldType.TextField + package: botbuilder + summary: Text field. + numericValue: 3 + - name: Toggle + uid: botbuilder.FieldType.Toggle + package: botbuilder + summary: Toggle field. + numericValue: 5 + - name: Dropdown + uid: botbuilder.FieldType.Dropdown + package: botbuilder + summary: Dropdown field. + numericValue: 6 + - name: Label + uid: botbuilder.FieldType.Label + package: botbuilder + summary: Label field. + numericValue: 7 + - name: Slider + uid: botbuilder.FieldType.Slider + package: botbuilder + summary: Slider field. + numericValue: 8 + - name: ChoiceGroup + uid: botbuilder.FieldType.ChoiceGroup + package: botbuilder + summary: Choice Group field. + numericValue: 10 + - name: HorizontalRule + uid: botbuilder.FieldType.HorizontalRule + package: botbuilder + summary: Horizontal Rule field. + numericValue: 12 + - name: Link + uid: botbuilder.FieldType.Link + package: botbuilder + summary: Link field. + numericValue: 13 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCard.yml new file mode 100644 index 00000000..db9453fb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCard.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: FileConsentCard +uid: botbuilder.FileConsentCard +package: botbuilder +summary: '' +fullName: FileConsentCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: acceptContext + uid: botbuilder.FileConsentCard.acceptContext + package: botbuilder + summary: Context sent back to the Bot if user + fullName: acceptContext + remarks: '' + isDeprecated: false + syntax: + content: 'acceptContext?: any' + return: + description: '' + type: any + - name: declineContext + uid: botbuilder.FileConsentCard.declineContext + package: botbuilder + summary: Context sent back to the Bot if user + fullName: declineContext + remarks: '' + isDeprecated: false + syntax: + content: 'declineContext?: any' + return: + description: '' + type: any + - name: description + uid: botbuilder.FileConsentCard.description + package: botbuilder + summary: File description. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description?: string' + return: + description: '' + type: string + - name: sizeInBytes + uid: botbuilder.FileConsentCard.sizeInBytes + package: botbuilder + summary: Size of the file to be uploaded in Bytes. + fullName: sizeInBytes + remarks: '' + isDeprecated: false + syntax: + content: 'sizeInBytes?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCardResponse.yml new file mode 100644 index 00000000..75612b36 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileConsentCardResponse.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: FileConsentCardResponse +uid: botbuilder.FileConsentCardResponse +package: botbuilder +summary: '' +fullName: FileConsentCardResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder.FileConsentCardResponse.action + package: botbuilder + summary: The action the user took. Possible values + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: Action' + return: + description: '' + type: + - name: context + uid: botbuilder.FileConsentCardResponse.context + package: botbuilder + summary: The context associated with the action. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: any' + return: + description: '' + type: any + - name: uploadInfo + uid: botbuilder.FileConsentCardResponse.uploadInfo + package: botbuilder + summary: If the user accepted the file, + fullName: uploadInfo + remarks: '' + isDeprecated: false + syntax: + content: 'uploadInfo?: FileUploadInfo' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfo.yml new file mode 100644 index 00000000..6835eb0f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfo.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: FileDownloadInfo +uid: botbuilder.FileDownloadInfo +package: botbuilder +summary: '' +fullName: FileDownloadInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: downloadUrl + uid: botbuilder.FileDownloadInfo.downloadUrl + package: botbuilder + summary: File download url. + fullName: downloadUrl + remarks: '' + isDeprecated: false + syntax: + content: 'downloadUrl?: string' + return: + description: '' + type: string + - name: etag + uid: botbuilder.FileDownloadInfo.etag + package: botbuilder + summary: ETag for the file. + fullName: etag + remarks: '' + isDeprecated: false + syntax: + content: 'etag?: any' + return: + description: '' + type: any + - name: fileType + uid: botbuilder.FileDownloadInfo.fileType + package: botbuilder + summary: Type of file. + fullName: fileType + remarks: '' + isDeprecated: false + syntax: + content: 'fileType?: string' + return: + description: '' + type: string + - name: uniqueId + uid: botbuilder.FileDownloadInfo.uniqueId + package: botbuilder + summary: Unique Id for the file. + fullName: uniqueId + remarks: '' + isDeprecated: false + syntax: + content: 'uniqueId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfoAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfoAttachment.yml new file mode 100644 index 00000000..763953a6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileDownloadInfoAttachment.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: FileDownloadInfoAttachment +uid: botbuilder.FileDownloadInfoAttachment +package: botbuilder +summary: '' +fullName: FileDownloadInfoAttachment +remarks: '' +isDeprecated: false +syntax: | + type FileDownloadInfoAttachment = TeamsAttachment diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileInfoCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileInfoCard.yml new file mode 100644 index 00000000..898d2255 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileInfoCard.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: FileInfoCard +uid: botbuilder.FileInfoCard +package: botbuilder +summary: '' +fullName: FileInfoCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: etag + uid: botbuilder.FileInfoCard.etag + package: botbuilder + summary: ETag for the file. + fullName: etag + remarks: '' + isDeprecated: false + syntax: + content: 'etag?: any' + return: + description: '' + type: any + - name: fileType + uid: botbuilder.FileInfoCard.fileType + package: botbuilder + summary: Type of file. + fullName: fileType + remarks: '' + isDeprecated: false + syntax: + content: 'fileType?: string' + return: + description: '' + type: string + - name: uniqueId + uid: botbuilder.FileInfoCard.uniqueId + package: botbuilder + summary: Unique Id for the file. + fullName: uniqueId + remarks: '' + isDeprecated: false + syntax: + content: 'uniqueId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileTranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileTranscriptStore.yml index ddd6ecae..8cf36708 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileTranscriptStore.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileTranscriptStore.yml @@ -28,7 +28,6 @@ remarks: >- '/transcripts/'))); ``` -isPreview: false isDeprecated: false type: class constructors: @@ -37,22 +36,19 @@ constructors: package: botbuilder summary: Creates an instance of FileTranscriptStore. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new FileTranscriptStore(folder: string)' parameters: - id: folder type: string - description: | - Root folder where transcript will be stored. + description: Root folder where transcript will be stored. methods: - - name: 'deleteTranscript(string, string)' + - name: deleteTranscript(string, string) uid: botbuilder.FileTranscriptStore.deleteTranscript package: botbuilder summary: Delete a conversation and all of it's activities. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -68,14 +64,13 @@ methods: return: description: A promise representing the asynchronous operation. type: Promise<void> - - name: 'getTranscriptActivities(string, string, string, Date)' + - name: getTranscriptActivities(string, string, string, Date) uid: botbuilder.FileTranscriptStore.getTranscriptActivities package: botbuilder summary: >- Get all activities associated with a conversation id (aka get the transcript). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -97,13 +92,14 @@ methods: description: (Optional) Earliest time to include. return: description: PagedResult of activities. - type: Promise<PagedResult<Activity>> - - name: 'listTranscripts(string, string)' + type: >- + Promise<<>> + - name: listTranscripts(string, string) uid: botbuilder.FileTranscriptStore.listTranscripts package: botbuilder summary: List all the logged conversations for a given channelId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,19 +114,20 @@ methods: description: (Optional) Continuation token to page through results. return: description: PagedResult of transcripts. - type: Promise<PagedResult<TranscriptInfo>> + type: >- + Promise<<>> - name: logActivity(Activity) uid: botbuilder.FileTranscriptStore.logActivity package: botbuilder summary: Log an activity to the transcript. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logActivity(activity: Activity): Promise' parameters: - id: activity - type: Activity + type: description: Activity being logged. return: description: a promise representing the asynchronous operation. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FileUploadInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileUploadInfo.yml new file mode 100644 index 00000000..58d0c96a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FileUploadInfo.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: FileUploadInfo +uid: botbuilder.FileUploadInfo +package: botbuilder +summary: '' +fullName: FileUploadInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: contentUrl + uid: botbuilder.FileUploadInfo.contentUrl + package: botbuilder + summary: URL to file. + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + - name: fileType + uid: botbuilder.FileUploadInfo.fileType + package: botbuilder + summary: Type of the file. + fullName: fileType + remarks: '' + isDeprecated: false + syntax: + content: 'fileType?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.FileUploadInfo.name + package: botbuilder + summary: Name of the file. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: uniqueId + uid: botbuilder.FileUploadInfo.uniqueId + package: botbuilder + summary: ID that uniquely identifies the file. + fullName: uniqueId + remarks: '' + isDeprecated: false + syntax: + content: 'uniqueId?: string' + return: + description: '' + type: string + - name: uploadUrl + uid: botbuilder.FileUploadInfo.uploadUrl + package: botbuilder + summary: URL to an upload session that the bot can use + fullName: uploadUrl + remarks: '' + isDeprecated: false + syntax: + content: 'uploadUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/FocusParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/FocusParameters.yml new file mode 100644 index 00000000..2c630e3d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/FocusParameters.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: FocusParameters +uid: botbuilder.FocusParameters +package: botbuilder +summary: >- + Interface to give third party developers the capability to determine which + element should recieve focus, when, and how often content should be read. +fullName: FocusParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLive + uid: botbuilder.FocusParameters.ariaLive + package: botbuilder + summary: >- + Sets the accessibility reading of the contents within the focus target. + + Polite - Content in the target's subtree is read when the user is idle. + + Assertive - Disrupts any announcement in favor of the changed contents + within the target's subtree. + + Off - The screen reader will not read contents within the target's + subtree. + fullName: ariaLive + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLive?: "polite" | "assertive" | "off"' + return: + description: '' + type: '"polite" | "assertive" | "off"' + - name: focusTarget + uid: botbuilder.FocusParameters.focusTarget + package: botbuilder + summary: >- + Sets the default focus on the DOM. Developers pass in the id of a unique + element that is to attain focus within a quick view. + + If the `focusTarget` is not defined then the root element is selected. + fullName: focusTarget + remarks: '' + isDeprecated: false + syntax: + content: 'focusTarget?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/GeoCoordinates.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/GeoCoordinates.yml new file mode 100644 index 00000000..988ef845 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/GeoCoordinates.yml @@ -0,0 +1,76 @@ +### YamlMime:TSType +name: GeoCoordinates +uid: botbuilder.GeoCoordinates +package: botbuilder +summary: 'GeoCoordinates (entity type: "https://schema.org/GeoCoordinates")' +fullName: GeoCoordinates +remarks: '' +isDeprecated: false +type: interface +properties: + - name: elevation + uid: botbuilder.GeoCoordinates.elevation + package: botbuilder + summary: >- + Elevation of the location [WGS + 84](https://en.wikipedia.org/wiki/World_Geodetic_System) + fullName: elevation + remarks: '' + isDeprecated: false + syntax: + content: 'elevation: number' + return: + description: '' + type: number + - name: latitude + uid: botbuilder.GeoCoordinates.latitude + package: botbuilder + summary: >- + Latitude of the location [WGS + 84](https://en.wikipedia.org/wiki/World_Geodetic_System) + fullName: latitude + remarks: '' + isDeprecated: false + syntax: + content: 'latitude: number' + return: + description: '' + type: number + - name: longitude + uid: botbuilder.GeoCoordinates.longitude + package: botbuilder + summary: >- + Longitude of the location [WGS + 84](https://en.wikipedia.org/wiki/World_Geodetic_System) + fullName: longitude + remarks: '' + isDeprecated: false + syntax: + content: 'longitude: number' + return: + description: '' + type: number + - name: name + uid: botbuilder.GeoCoordinates.name + package: botbuilder + summary: The name of the thing + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.GeoCoordinates.type + package: botbuilder + summary: The type of the thing + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationActionParameters.yml new file mode 100644 index 00000000..7eabf08b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationActionParameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: GetLocationActionParameters +uid: botbuilder.GetLocationActionParameters +package: botbuilder +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.GetLocation + action. +fullName: GetLocationActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: chooseLocationOnMap + uid: botbuilder.GetLocationActionParameters.chooseLocationOnMap + package: botbuilder + summary: |- + If true, allow the user to choose a location by opening a map. + Otherwise, get the current location. + fullName: chooseLocationOnMap + remarks: '' + isDeprecated: false + syntax: + content: 'chooseLocationOnMap?: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationCardAction.yml new file mode 100644 index 00000000..da9732f4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/GetLocationCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: GetLocationCardAction +uid: botbuilder.GetLocationCardAction +package: botbuilder +summary: SharePoint `VivaAction.GetLocation` event. +fullName: GetLocationCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder.GetLocationCardAction.parameters + package: botbuilder + summary: Parameters that can be supplied with the Viva Get Location Action. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: GetLocationActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.GetLocationCardAction.type + package: botbuilder + summary: Indicates this is a Viva Select Location button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.GetLocation"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/GetPropertyPaneConfigurationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/GetPropertyPaneConfigurationResponse.yml new file mode 100644 index 00000000..45ddee2c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/GetPropertyPaneConfigurationResponse.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: GetPropertyPaneConfigurationResponse +uid: botbuilder.GetPropertyPaneConfigurationResponse +package: botbuilder +summary: SharePoint ACE get property pane configuration response. +fullName: GetPropertyPaneConfigurationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: currentPage + uid: botbuilder.GetPropertyPaneConfigurationResponse.currentPage + package: botbuilder + summary: Current page number. + fullName: currentPage + remarks: '' + isDeprecated: false + syntax: + content: 'currentPage: number' + return: + description: '' + type: number + - name: loadingIndicatorDelayTime + uid: botbuilder.GetPropertyPaneConfigurationResponse.loadingIndicatorDelayTime + package: botbuilder + summary: Loading indicator delay time. + fullName: loadingIndicatorDelayTime + remarks: '' + isDeprecated: false + syntax: + content: 'loadingIndicatorDelayTime: number' + return: + description: '' + type: number + - name: pages + uid: botbuilder.GetPropertyPaneConfigurationResponse.pages + package: botbuilder + summary: Property pane pages. + fullName: pages + remarks: '' + isDeprecated: false + syntax: + content: 'pages: PropertyPanePage[]' + return: + description: '' + type: [] + - name: showLoadingIndicator + uid: botbuilder.GetPropertyPaneConfigurationResponse.showLoadingIndicator + package: botbuilder + summary: >- + Value indicating whether to show loading indicator on top of the property + pane. + fullName: showLoadingIndicator + remarks: '' + isDeprecated: false + syntax: + content: 'showLoadingIndicator: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/HandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/HandleActionResponse.yml new file mode 100644 index 00000000..d7ee29fa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/HandleActionResponse.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: HandleActionResponse +uid: botbuilder.HandleActionResponse +package: botbuilder +summary: The handle action response. +fullName: HandleActionResponse +remarks: '' +isDeprecated: false +syntax: | + type HandleActionResponse = + | CardViewHandleActionResponse + | QuickViewHandleActionResponse + | NoOpHandleActionResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/HandoffEventNames.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/HandoffEventNames.yml index 8c5b6b57..3be05609 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/HandoffEventNames.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/HandoffEventNames.yml @@ -5,7 +5,6 @@ package: botbuilder summary: Defines values for handoff event names. fullName: HandoffEventNames remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: HandoffStatus remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static HandoffStatus: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: InitiateHandoff remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static InitiateHandoff: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/HeroCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/HeroCard.yml new file mode 100644 index 00000000..6904f614 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/HeroCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: HeroCard +uid: botbuilder.HeroCard +package: botbuilder +summary: A Hero card (card with a single, large image) +fullName: HeroCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder.HeroCard.buttons + package: botbuilder + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder.HeroCard.images + package: botbuilder + summary: Array of images for the card + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images: CardImage[]' + return: + description: '' + type: [] + - name: subtitle + uid: botbuilder.HeroCard.subtitle + package: botbuilder + summary: Subtitle of the card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder.HeroCard.tap + package: botbuilder + summary: This action will be activated when user taps on the card itself + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder.HeroCard.text + package: botbuilder + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.HeroCard.title + package: botbuilder + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IActivity.yml new file mode 100644 index 00000000..f3938446 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IActivity.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: IActivity +uid: botbuilder.IActivity +package: botbuilder +summary: '' +fullName: IActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botbuilder.IActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + - name: channelId + uid: botbuilder.IActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: conversation + uid: botbuilder.IActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: entities + uid: botbuilder.IActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + - name: from + uid: botbuilder.IActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + - name: id + uid: botbuilder.IActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: localTimestamp + uid: botbuilder.IActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + - name: recipient + uid: botbuilder.IActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + - name: replyToId + uid: botbuilder.IActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + - name: serviceUrl + uid: botbuilder.IActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + - name: timestamp + uid: botbuilder.IActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + - name: type + uid: botbuilder.IActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardSearchBoxButton.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardSearchBoxButton.yml new file mode 100644 index 00000000..c226d3d1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardSearchBoxButton.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: ICardSearchBoxButton +uid: botbuilder.ICardSearchBoxButton +package: botbuilder +summary: Search box button properties. +fullName: ICardSearchBoxButton +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: action + uid: botbuilder.ICardSearchBoxButton.action + package: botbuilder + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder.CardButtonBase.action) + - name: id + uid: botbuilder.ICardSearchBoxButton.id + package: botbuilder + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputIconButton.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputIconButton.yml new file mode 100644 index 00000000..652f7169 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputIconButton.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: ICardTextInputIconButton +uid: botbuilder.ICardTextInputIconButton +package: botbuilder +summary: Text input icon button. +fullName: ICardTextInputIconButton +remarks: '' +isDeprecated: false +type: interface +properties: + - name: icon + uid: botbuilder.ICardTextInputIconButton.icon + package: botbuilder + summary: Properties for the icon displayed on the button. + fullName: icon + remarks: '' + isDeprecated: false + syntax: + content: 'icon: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: action + uid: botbuilder.ICardTextInputIconButton.action + package: botbuilder + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder.CardButtonBase.action) + - name: id + uid: botbuilder.ICardTextInputIconButton.id + package: botbuilder + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputTitleButton.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputTitleButton.yml new file mode 100644 index 00000000..665616f3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICardTextInputTitleButton.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: ICardTextInputTitleButton +uid: botbuilder.ICardTextInputTitleButton +package: botbuilder +summary: Text input title button. +fullName: ICardTextInputTitleButton +remarks: '' +isDeprecated: false +type: interface +properties: + - name: title + uid: botbuilder.ICardTextInputTitleButton.title + package: botbuilder + summary: Text displayed on the button. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botbuilder.ICardTextInputTitleButton.action + package: botbuilder + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botbuilder.CardButtonBase.action) + - name: id + uid: botbuilder.ICardTextInputTitleButton.id + package: botbuilder + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botbuilder.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandActivity.yml new file mode 100644 index 00000000..90adb93d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandActivity.yml @@ -0,0 +1,219 @@ +### YamlMime:TSType +name: ICommandActivity +uid: botbuilder.ICommandActivity +package: botbuilder +summary: Asynchronous external command. +fullName: ICommandActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.ICommandActivity.name + package: botbuilder + summary: The name of the event. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.ICommandActivity.value + package: botbuilder + summary: The value for this command. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: CommandValue' + return: + description: '' + type: <T> +inheritedProperties: + - name: channelData + uid: botbuilder.ICommandActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.ICommandActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.ICommandActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.ICommandActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.ICommandActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.ICommandActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.ICommandActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.ICommandActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.ICommandActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.ICommandActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.ICommandActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.ICommandActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandResultActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandResultActivity.yml new file mode 100644 index 00000000..94e8f408 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ICommandResultActivity.yml @@ -0,0 +1,219 @@ +### YamlMime:TSType +name: ICommandResultActivity +uid: botbuilder.ICommandResultActivity +package: botbuilder +summary: Asynchronous external command result. +fullName: ICommandResultActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.ICommandResultActivity.name + package: botbuilder + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.ICommandResultActivity.value + package: botbuilder + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: CommandResultValue' + return: + description: '' + type: <T> +inheritedProperties: + - name: channelData + uid: botbuilder.ICommandResultActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.ICommandResultActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.ICommandResultActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.ICommandResultActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.ICommandResultActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.ICommandResultActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.ICommandResultActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.ICommandResultActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.ICommandResultActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.ICommandResultActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.ICommandResultActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.ICommandResultActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IContactRelationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IContactRelationUpdateActivity.yml new file mode 100644 index 00000000..22ceb942 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IContactRelationUpdateActivity.yml @@ -0,0 +1,211 @@ +### YamlMime:TSType +name: IContactRelationUpdateActivity +uid: botbuilder.IContactRelationUpdateActivity +package: botbuilder +summary: '' +fullName: IContactRelationUpdateActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder.IContactRelationUpdateActivity.action + package: botbuilder + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder.IContactRelationUpdateActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IContactRelationUpdateActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IContactRelationUpdateActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IContactRelationUpdateActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IContactRelationUpdateActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IContactRelationUpdateActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IContactRelationUpdateActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IContactRelationUpdateActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IContactRelationUpdateActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IContactRelationUpdateActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IContactRelationUpdateActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IContactRelationUpdateActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IConversationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IConversationUpdateActivity.yml new file mode 100644 index 00000000..ef7d0cff --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IConversationUpdateActivity.yml @@ -0,0 +1,243 @@ +### YamlMime:TSType +name: IConversationUpdateActivity +uid: botbuilder.IConversationUpdateActivity +package: botbuilder +summary: '' +fullName: IConversationUpdateActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: historyDisclosed + uid: botbuilder.IConversationUpdateActivity.historyDisclosed + package: botbuilder + summary: Indicates whether the prior history of the channel is disclosed. + fullName: historyDisclosed + remarks: '' + isDeprecated: false + syntax: + content: 'historyDisclosed?: boolean' + return: + description: '' + type: boolean + - name: membersAdded + uid: botbuilder.IConversationUpdateActivity.membersAdded + package: botbuilder + summary: The collection of members added to the conversation. + fullName: membersAdded + remarks: '' + isDeprecated: false + syntax: + content: 'membersAdded?: ChannelAccount[]' + return: + description: '' + type: [] + - name: membersRemoved + uid: botbuilder.IConversationUpdateActivity.membersRemoved + package: botbuilder + summary: The collection of members removed from the conversation. + fullName: membersRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'membersRemoved?: ChannelAccount[]' + return: + description: '' + type: [] + - name: topicName + uid: botbuilder.IConversationUpdateActivity.topicName + package: botbuilder + summary: The updated topic name of the conversation. + fullName: topicName + remarks: '' + isDeprecated: false + syntax: + content: 'topicName?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder.IConversationUpdateActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IConversationUpdateActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IConversationUpdateActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IConversationUpdateActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IConversationUpdateActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IConversationUpdateActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IConversationUpdateActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IConversationUpdateActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IConversationUpdateActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IConversationUpdateActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IConversationUpdateActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IConversationUpdateActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IEndOfConversationActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IEndOfConversationActivity.yml new file mode 100644 index 00000000..78c41ba1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IEndOfConversationActivity.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: IEndOfConversationActivity +uid: botbuilder.IEndOfConversationActivity +package: botbuilder +summary: '' +fullName: IEndOfConversationActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: code + uid: botbuilder.IEndOfConversationActivity.code + package: botbuilder + summary: >- + The a code for endOfConversation activities that indicates why the + conversation ended. + + Possible values include: 'unknown', 'completedSuccessfully', + 'userCancelled', 'botTimedOut', + + 'botIssuedInvalidMessage', 'channelFailed' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.IEndOfConversationActivity.text + package: botbuilder + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder.IEndOfConversationActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IEndOfConversationActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IEndOfConversationActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IEndOfConversationActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IEndOfConversationActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IEndOfConversationActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IEndOfConversationActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IEndOfConversationActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IEndOfConversationActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IEndOfConversationActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IEndOfConversationActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IEndOfConversationActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IEventActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IEventActivity.yml new file mode 100644 index 00000000..2d208e8b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IEventActivity.yml @@ -0,0 +1,231 @@ +### YamlMime:TSType +name: IEventActivity +uid: botbuilder.IEventActivity +package: botbuilder +summary: '' +fullName: IEventActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.IEventActivity.name + package: botbuilder + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: relatesTo + uid: botbuilder.IEventActivity.relatesTo + package: botbuilder + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: value + uid: botbuilder.IEventActivity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any +inheritedProperties: + - name: channelData + uid: botbuilder.IEventActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IEventActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IEventActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IEventActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IEventActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IEventActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IEventActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IEventActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IEventActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IEventActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IEventActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IEventActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IHandoffActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IHandoffActivity.yml new file mode 100644 index 00000000..ecaec0a3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IHandoffActivity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: IHandoffActivity +uid: botbuilder.IHandoffActivity +package: botbuilder +summary: '' +fullName: IHandoffActivity +remarks: '' +isDeprecated: false +syntax: | + type IHandoffActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IInstallationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IInstallationUpdateActivity.yml new file mode 100644 index 00000000..28299a80 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IInstallationUpdateActivity.yml @@ -0,0 +1,211 @@ +### YamlMime:TSType +name: IInstallationUpdateActivity +uid: botbuilder.IInstallationUpdateActivity +package: botbuilder +summary: '' +fullName: IInstallationUpdateActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botbuilder.IInstallationUpdateActivity.action + package: botbuilder + summary: >- + Indicates whether the recipient of a contactRelationUpdate was added or + removed from the + + sender's contact list. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action?: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder.IInstallationUpdateActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IInstallationUpdateActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IInstallationUpdateActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IInstallationUpdateActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IInstallationUpdateActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IInstallationUpdateActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IInstallationUpdateActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IInstallationUpdateActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IInstallationUpdateActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IInstallationUpdateActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IInstallationUpdateActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IInstallationUpdateActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IInvokeActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IInvokeActivity.yml new file mode 100644 index 00000000..7b7ac8e0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IInvokeActivity.yml @@ -0,0 +1,231 @@ +### YamlMime:TSType +name: IInvokeActivity +uid: botbuilder.IInvokeActivity +package: botbuilder +summary: '' +fullName: IInvokeActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.IInvokeActivity.name + package: botbuilder + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: relatesTo + uid: botbuilder.IInvokeActivity.relatesTo + package: botbuilder + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: value + uid: botbuilder.IInvokeActivity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any +inheritedProperties: + - name: channelData + uid: botbuilder.IInvokeActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IInvokeActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IInvokeActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IInvokeActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IInvokeActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IInvokeActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IInvokeActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IInvokeActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IInvokeActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IInvokeActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IInvokeActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IInvokeActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageActivity.yml new file mode 100644 index 00000000..7c434b9d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageActivity.yml @@ -0,0 +1,385 @@ +### YamlMime:TSType +name: IMessageActivity +uid: botbuilder.IMessageActivity +package: botbuilder +summary: '' +fullName: IMessageActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: attachmentLayout + uid: botbuilder.IMessageActivity.attachmentLayout + package: botbuilder + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + - name: attachments + uid: botbuilder.IMessageActivity.attachments + package: botbuilder + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + - name: deliveryMode + uid: botbuilder.IMessageActivity.deliveryMode + package: botbuilder + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + - name: expiration + uid: botbuilder.IMessageActivity.expiration + package: botbuilder + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + - name: importance + uid: botbuilder.IMessageActivity.importance + package: botbuilder + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + - name: inputHint + uid: botbuilder.IMessageActivity.inputHint + package: botbuilder + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + - name: locale + uid: botbuilder.IMessageActivity.locale + package: botbuilder + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: speak + uid: botbuilder.IMessageActivity.speak + package: botbuilder + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + - name: suggestedActions + uid: botbuilder.IMessageActivity.suggestedActions + package: botbuilder + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: summary + uid: botbuilder.IMessageActivity.summary + package: botbuilder + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.IMessageActivity.text + package: botbuilder + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: textFormat + uid: botbuilder.IMessageActivity.textFormat + package: botbuilder + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.IMessageActivity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any +inheritedProperties: + - name: channelData + uid: botbuilder.IMessageActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IMessageActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IMessageActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IMessageActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IMessageActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IMessageActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IMessageActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IMessageActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IMessageActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IMessageActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IMessageActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IMessageActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageDeleteActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageDeleteActivity.yml new file mode 100644 index 00000000..4ca26f05 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageDeleteActivity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: IMessageDeleteActivity +uid: botbuilder.IMessageDeleteActivity +package: botbuilder +summary: '' +fullName: IMessageDeleteActivity +remarks: '' +isDeprecated: false +syntax: | + type IMessageDeleteActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageReactionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageReactionActivity.yml new file mode 100644 index 00000000..24883c73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageReactionActivity.yml @@ -0,0 +1,219 @@ +### YamlMime:TSType +name: IMessageReactionActivity +uid: botbuilder.IMessageReactionActivity +package: botbuilder +summary: '' +fullName: IMessageReactionActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: reactionsAdded + uid: botbuilder.IMessageReactionActivity.reactionsAdded + package: botbuilder + summary: The collection of reactions added to the conversation. + fullName: reactionsAdded + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsAdded?: MessageReaction[]' + return: + description: '' + type: [] + - name: reactionsRemoved + uid: botbuilder.IMessageReactionActivity.reactionsRemoved + package: botbuilder + summary: The collection of reactions removed from the conversation. + fullName: reactionsRemoved + remarks: '' + isDeprecated: false + syntax: + content: 'reactionsRemoved?: MessageReaction[]' + return: + description: '' + type: [] +inheritedProperties: + - name: channelData + uid: botbuilder.IMessageReactionActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IMessageReactionActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IMessageReactionActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.IMessageReactionActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.IMessageReactionActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IMessageReactionActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.IMessageReactionActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IMessageReactionActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IMessageReactionActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IMessageReactionActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.IMessageReactionActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IMessageReactionActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageUpdateActivity.yml new file mode 100644 index 00000000..738930e9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IMessageUpdateActivity.yml @@ -0,0 +1,423 @@ +### YamlMime:TSType +name: IMessageUpdateActivity +uid: botbuilder.IMessageUpdateActivity +package: botbuilder +summary: '' +fullName: IMessageUpdateActivity +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: attachmentLayout + uid: botbuilder.IMessageUpdateActivity.attachmentLayout + package: botbuilder + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachmentLayout](xref:botbuilder.IMessageActivity.attachmentLayout) + - name: attachments + uid: botbuilder.IMessageUpdateActivity.attachments + package: botbuilder + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachments](xref:botbuilder.IMessageActivity.attachments) + - name: channelData + uid: botbuilder.IMessageUpdateActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.IMessageUpdateActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.IMessageUpdateActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: deliveryMode + uid: botbuilder.IMessageUpdateActivity.deliveryMode + package: botbuilder + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.deliveryMode](xref:botbuilder.IMessageActivity.deliveryMode) + - name: entities + uid: botbuilder.IMessageUpdateActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: expiration + uid: botbuilder.IMessageUpdateActivity.expiration + package: botbuilder + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IMessageActivity.expiration](xref:botbuilder.IMessageActivity.expiration) + - name: from + uid: botbuilder.IMessageUpdateActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.IMessageUpdateActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: importance + uid: botbuilder.IMessageUpdateActivity.importance + package: botbuilder + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.importance](xref:botbuilder.IMessageActivity.importance) + - name: inputHint + uid: botbuilder.IMessageUpdateActivity.inputHint + package: botbuilder + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.inputHint](xref:botbuilder.IMessageActivity.inputHint) + - name: locale + uid: botbuilder.IMessageUpdateActivity.locale + package: botbuilder + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.locale](xref:botbuilder.IMessageActivity.locale) + - name: localTimestamp + uid: botbuilder.IMessageUpdateActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.IMessageUpdateActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.IMessageUpdateActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.IMessageUpdateActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: speak + uid: botbuilder.IMessageUpdateActivity.speak + package: botbuilder + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.speak](xref:botbuilder.IMessageActivity.speak) + - name: suggestedActions + uid: botbuilder.IMessageUpdateActivity.suggestedActions + package: botbuilder + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IMessageActivity.suggestedActions](xref:botbuilder.IMessageActivity.suggestedActions) + - name: summary + uid: botbuilder.IMessageUpdateActivity.summary + package: botbuilder + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.summary](xref:botbuilder.IMessageActivity.summary) + - name: text + uid: botbuilder.IMessageUpdateActivity.text + package: botbuilder + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.text](xref:botbuilder.IMessageActivity.text) + - name: textFormat + uid: botbuilder.IMessageUpdateActivity.textFormat + package: botbuilder + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.textFormat](xref:botbuilder.IMessageActivity.textFormat) + - name: timestamp + uid: botbuilder.IMessageUpdateActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.IMessageUpdateActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) + - name: value + uid: botbuilder.IMessageUpdateActivity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IMessageActivity.value](xref:botbuilder.IMessageActivity.value) +extends: , diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IStatusCodeError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IStatusCodeError.yml new file mode 100644 index 00000000..2a32119a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IStatusCodeError.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: IStatusCodeError +uid: botbuilder.IStatusCodeError +package: botbuilder +summary: '' +fullName: IStatusCodeError +remarks: '' +isDeprecated: false +type: interface +properties: + - name: message + uid: botbuilder.IStatusCodeError.message + package: botbuilder + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: string' + return: + description: '' + type: string + - name: statusCode + uid: botbuilder.IStatusCodeError.statusCode + package: botbuilder + summary: '' + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: StatusCodes' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ISuggestionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ISuggestionActivity.yml new file mode 100644 index 00000000..b7801336 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ISuggestionActivity.yml @@ -0,0 +1,438 @@ +### YamlMime:TSType +name: ISuggestionActivity +uid: botbuilder.ISuggestionActivity +package: botbuilder +summary: '' +fullName: ISuggestionActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: textHighlights + uid: botbuilder.ISuggestionActivity.textHighlights + package: botbuilder + summary: >- + The collection of text fragments to highlight when the activity contains a + ReplyToId value. + fullName: textHighlights + remarks: '' + isDeprecated: false + syntax: + content: 'textHighlights?: TextHighlight[]' + return: + description: '' + type: [] +inheritedProperties: + - name: attachmentLayout + uid: botbuilder.ISuggestionActivity.attachmentLayout + package: botbuilder + summary: >- + The layout hint for multiple attachments. Default: list. Possible values + include: 'list', + + 'carousel' + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachmentLayout](xref:botbuilder.IMessageActivity.attachmentLayout) + - name: attachments + uid: botbuilder.ISuggestionActivity.attachments + package: botbuilder + summary: Attachments + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: Attachment[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IMessageActivity.attachments](xref:botbuilder.IMessageActivity.attachments) + - name: channelData + uid: botbuilder.ISuggestionActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.ISuggestionActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.ISuggestionActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: deliveryMode + uid: botbuilder.ISuggestionActivity.deliveryMode + package: botbuilder + summary: >- + A delivery hint to signal to the recipient alternate delivery paths for + the activity. + + The default delivery mode is "default". Possible values include: 'normal', + 'notification' + fullName: deliveryMode + remarks: '' + isDeprecated: false + syntax: + content: 'deliveryMode?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.deliveryMode](xref:botbuilder.IMessageActivity.deliveryMode) + - name: entities + uid: botbuilder.ISuggestionActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: expiration + uid: botbuilder.ISuggestionActivity.expiration + package: botbuilder + summary: >- + The time at which the activity should be considered to be "expired" and + should not be + + presented to the recipient. + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IMessageActivity.expiration](xref:botbuilder.IMessageActivity.expiration) + - name: from + uid: botbuilder.ISuggestionActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.ISuggestionActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: importance + uid: botbuilder.ISuggestionActivity.importance + package: botbuilder + summary: >- + The importance of the activity. Possible values include: 'low', 'normal', + 'high' + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.importance](xref:botbuilder.IMessageActivity.importance) + - name: inputHint + uid: botbuilder.ISuggestionActivity.inputHint + package: botbuilder + summary: >- + Indicates whether your bot is accepting, + + expecting, or ignoring user input after the message is delivered to the + client. Possible + + values include: 'acceptingInput', 'ignoringInput', 'expectingInput' + fullName: inputHint + remarks: '' + isDeprecated: false + syntax: + content: 'inputHint?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.inputHint](xref:botbuilder.IMessageActivity.inputHint) + - name: locale + uid: botbuilder.ISuggestionActivity.locale + package: botbuilder + summary: >- + A locale name for the contents of the text field. + + The locale name is a combination of an ISO 639 two- or three-letter + culture code associated + + with a language + + and an ISO 3166 two-letter subculture code associated with a country or + region. + + The locale name can also correspond to a valid BCP-47 language tag. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.locale](xref:botbuilder.IMessageActivity.locale) + - name: localTimestamp + uid: botbuilder.ISuggestionActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.ISuggestionActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.ISuggestionActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.ISuggestionActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: speak + uid: botbuilder.ISuggestionActivity.speak + package: botbuilder + summary: The text to speak. + fullName: speak + remarks: '' + isDeprecated: false + syntax: + content: 'speak?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.speak](xref:botbuilder.IMessageActivity.speak) + - name: suggestedActions + uid: botbuilder.ISuggestionActivity.suggestedActions + package: botbuilder + summary: The suggested actions for the activity. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IMessageActivity.suggestedActions](xref:botbuilder.IMessageActivity.suggestedActions) + - name: summary + uid: botbuilder.ISuggestionActivity.summary + package: botbuilder + summary: The text to display if the channel cannot render cards. + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.summary](xref:botbuilder.IMessageActivity.summary) + - name: text + uid: botbuilder.ISuggestionActivity.text + package: botbuilder + summary: The text content of the message. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.text](xref:botbuilder.IMessageActivity.text) + - name: textFormat + uid: botbuilder.ISuggestionActivity.textFormat + package: botbuilder + summary: >- + Format of text fields Default:markdown. Possible values include: + 'markdown', 'plain', 'xml' + fullName: textFormat + remarks: '' + isDeprecated: false + syntax: + content: 'textFormat?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IMessageActivity.textFormat](xref:botbuilder.IMessageActivity.textFormat) + - name: timestamp + uid: botbuilder.ISuggestionActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.ISuggestionActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) + - name: value + uid: botbuilder.ISuggestionActivity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IMessageActivity.value](xref:botbuilder.IMessageActivity.value) +extends: , diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ITraceActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ITraceActivity.yml new file mode 100644 index 00000000..f29970ab --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ITraceActivity.yml @@ -0,0 +1,255 @@ +### YamlMime:TSType +name: ITraceActivity +uid: botbuilder.ITraceActivity +package: botbuilder +summary: '' +fullName: ITraceActivity +remarks: '' +isDeprecated: false +type: interface +properties: + - name: label + uid: botbuilder.ITraceActivity.label + package: botbuilder + summary: A descriptive label for the activity. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.ITraceActivity.name + package: botbuilder + summary: The name of the operation associated with an invoke or event activity. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: relatesTo + uid: botbuilder.ITraceActivity.relatesTo + package: botbuilder + summary: A reference to another conversation or activity. + fullName: relatesTo + remarks: '' + isDeprecated: false + syntax: + content: 'relatesTo?: ConversationReference' + return: + description: '' + type: + - name: value + uid: botbuilder.ITraceActivity.value + package: botbuilder + summary: A value that is associated with the activity. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any + - name: valueType + uid: botbuilder.ITraceActivity.valueType + package: botbuilder + summary: The type of the activity's value object. + fullName: valueType + remarks: '' + isDeprecated: false + syntax: + content: 'valueType: string' + return: + description: '' + type: string +inheritedProperties: + - name: channelData + uid: botbuilder.ITraceActivity.channelData + package: botbuilder + summary: Contains channel-specific content. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [IActivity.channelData](xref:botbuilder.IActivity.channelData) + - name: channelId + uid: botbuilder.ITraceActivity.channelId + package: botbuilder + summary: Contains an ID that uniquely identifies the channel. Set by the channel. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.channelId](xref:botbuilder.IActivity.channelId) + - name: conversation + uid: botbuilder.ITraceActivity.conversation + package: botbuilder + summary: Identifies the conversation to which the activity belongs. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.conversation](xref:botbuilder.IActivity.conversation) + - name: entities + uid: botbuilder.ITraceActivity.entities + package: botbuilder + summary: Represents the entities that were mentioned in the message. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: Entity[]' + return: + description: '' + type: [] + inheritanceDescription: >- + Inherited From + [IActivity.entities](xref:botbuilder.IActivity.entities) + - name: from + uid: botbuilder.ITraceActivity.from + package: botbuilder + summary: Identifies the sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: Inherited From [IActivity.from](xref:botbuilder.IActivity.from) + - name: id + uid: botbuilder.ITraceActivity.id + package: botbuilder + summary: Contains an ID that uniquely identifies the activity on the channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.id](xref:botbuilder.IActivity.id) + - name: localTimestamp + uid: botbuilder.ITraceActivity.localTimestamp + package: botbuilder + summary: >- + Contains the local date and time of the message, expressed in ISO-8601 + format. + + + For example, 2016-09-23T13:07:49.4714686-07:00. + fullName: localTimestamp + remarks: '' + isDeprecated: false + syntax: + content: 'localTimestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.localTimestamp](xref:botbuilder.IActivity.localTimestamp) + - name: recipient + uid: botbuilder.ITraceActivity.recipient + package: botbuilder + summary: Identifies the recipient of the message. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: ChannelAccount' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [IActivity.recipient](xref:botbuilder.IActivity.recipient) + - name: replyToId + uid: botbuilder.ITraceActivity.replyToId + package: botbuilder + summary: Contains the ID of the message to which this message is a reply. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.replyToId](xref:botbuilder.IActivity.replyToId) + - name: serviceUrl + uid: botbuilder.ITraceActivity.serviceUrl + package: botbuilder + summary: >- + Contains the URL that specifies the channel's service endpoint. Set by the + channel. + fullName: serviceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'serviceUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [IActivity.serviceUrl](xref:botbuilder.IActivity.serviceUrl) + - name: timestamp + uid: botbuilder.ITraceActivity.timestamp + package: botbuilder + summary: >- + Contains the date and time that the message was sent, in UTC, expressed in + ISO-8601 format. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: Date' + return: + description: '' + type: Date + inheritanceDescription: >- + Inherited From + [IActivity.timestamp](xref:botbuilder.IActivity.timestamp) + - name: type + uid: botbuilder.ITraceActivity.type + package: botbuilder + summary: Contains the activity type 'iActivity' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [IActivity.type](xref:botbuilder.IActivity.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ITypingActivity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ITypingActivity.yml new file mode 100644 index 00000000..2f2b2b69 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ITypingActivity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ITypingActivity +uid: botbuilder.ITypingActivity +package: botbuilder +summary: '' +fullName: ITypingActivity +remarks: '' +isDeprecated: false +syntax: | + type ITypingActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IUserTokenProvider.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IUserTokenProvider.yml new file mode 100644 index 00000000..673020c4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IUserTokenProvider.yml @@ -0,0 +1,135 @@ +### YamlMime:TSType +name: IUserTokenProvider +uid: botbuilder.IUserTokenProvider +package: botbuilder +summary: Interface for User Token OAuth APIs for BotAdapters +fullName: IUserTokenProvider +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use `UserTokenClient` instead. +type: interface +methods: + - name: getAadTokens(TurnContext, string, string[]) + uid: botbuilder.IUserTokenProvider.getAadTokens + package: botbuilder + summary: Signs the user out with the token server. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAadTokens(context: TurnContext, connectionName: string, + resourceUrls: string[]): Promise<{[propertyName: string]: + TokenResponse}> + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: resourceUrls + type: string[] + description: '' + return: + description: '' + type: >- + Promise<{[propertyName: string]: }> + - name: getSignInLink(TurnContext, string) + uid: botbuilder.IUserTokenProvider.getSignInLink + package: botbuilder + summary: >- + Gets a signin link from the token server that can be sent as part of a + SigninCard. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInLink(context: TurnContext, connectionName: string): + Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + return: + description: '' + type: Promise<string> + - name: getTokenStatus(TurnContext, string, string, any) + uid: botbuilder.IUserTokenProvider.getTokenStatus + package: botbuilder + summary: >- + Retrieves the token status for each configured connection for the given + user, using the bot's AppCredentials. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTokenStatus(context: TurnContext, userId: string, + includeFilter?: string, oAuthAppCredentials?: any): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: userId + type: string + description: The user Id for which token status is retrieved. + - id: includeFilter + type: string + description: >- + Comma separated list of connection's to include. Blank will return + token status for all configured connections. + - id: oAuthAppCredentials + type: any + description: The app credentials for OAuth. + return: + description: '' + type: Promise<any[]> + - name: getUserToken(TurnContext, string, string) + uid: botbuilder.IUserTokenProvider.getUserToken + package: botbuilder + summary: Retrieves the OAuth token for a user that is in a sign-in flow. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getUserToken(context: TurnContext, connectionName: string, + magicCode?: string): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: magicCode + type: string + description: (Optional) Optional user entered code to validate. + return: + description: '' + type: Promise<> + - name: signOutUser(TurnContext, string, string) + uid: botbuilder.IUserTokenProvider.signOutUser + package: botbuilder + summary: Signs the user out with the token server. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signOutUser(context: TurnContext, connectionName: string, + userId?: string): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: User id of user to sign out. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Importance.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Importance.yml new file mode 100644 index 00000000..f06f71bf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Importance.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Importance +uid: botbuilder.Importance +package: botbuilder +summary: |- + Defines values for Importance. + Possible values include: 'normal', 'high', 'urgent' +fullName: Importance +remarks: '' +isDeprecated: false +syntax: | + type Importance = "normal" | "high" | "urgent" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InnerHttpError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InnerHttpError.yml new file mode 100644 index 00000000..32670a06 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InnerHttpError.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: InnerHttpError +uid: botbuilder.InnerHttpError +package: botbuilder +summary: Object representing inner http error +fullName: InnerHttpError +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.InnerHttpError.body + package: botbuilder + summary: Body from failed request + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: any' + return: + description: '' + type: any + - name: statusCode + uid: botbuilder.InnerHttpError.statusCode + package: botbuilder + summary: HttpStatusCode from failed request + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InputHints.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InputHints.yml new file mode 100644 index 00000000..414836ef --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InputHints.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: InputHints +uid: botbuilder.InputHints +package: botbuilder +summary: |- + Defines values for InputHints. + Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput' +fullName: InputHints +remarks: '' +isDeprecated: false +fields: + - name: AcceptingInput + uid: botbuilder.InputHints.AcceptingInput + package: botbuilder + summary: '' + - name: ExpectingInput + uid: botbuilder.InputHints.ExpectingInput + package: botbuilder + summary: '' + - name: IgnoringInput + uid: botbuilder.InputHints.IgnoringInput + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionMiddleware.yml index 7c45c990..683d662c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionMiddleware.yml @@ -9,7 +9,6 @@ fullName: InspectionMiddleware remarks: >- InspectionMiddleware for emulator inspection of runtime Activities and BotState. -isPreview: false isDeprecated: true customDeprecatedMessage: This class will be removed in a future version of the framework. type: class @@ -23,7 +22,6 @@ constructors: Create the Inspection middleware for sending trace activities out to an emulator session remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -35,22 +33,20 @@ constructors: type: description: A state management object for inspection state. - id: userState - type: UserState + type: description: A state management object for user state. - id: conversationState - type: ConversationState + type: description: A state management object for conversation state. - id: credentials type: Partial<MicrosoftAppCredentials> - description: | - The authentication credentials. + description: The authentication credentials. inheritedMethods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder.InspectionMiddleware.onTurn package: botbuilder summary: Implement middleware signature remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -58,33 +54,29 @@ inheritedMethods: Promise parameters: - id: turnContext - type: TurnContext - description: An incoming TurnContext object. + type: + description: '{TurnContext} An incoming TurnContext object.' - id: next type: () => Promise<void> - description: | - The next delegate function. + description: '{function} The next delegate function.' return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [InterceptionMiddleware.onTurn](xref:InterceptionMiddleware.onTurn) + inheritanceDescription: Inherited From InterceptionMiddleware.onTurn methods: - name: processCommand(TurnContext) uid: botbuilder.InspectionMiddleware.processCommand package: botbuilder summary: Indentifies open and attach commands and calls the appropriate method. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function processCommand(turnContext: TurnContext): Promise' parameters: - id: turnContext - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. return: - description: 'True if the command is open or attached, otherwise false.' + description: True if the command is open or attached, otherwise false. type: Promise<any> extends: InterceptionMiddleware diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionState.yml index d45b0a29..332b7a1e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InspectionState.yml @@ -9,7 +9,6 @@ fullName: InspectionState remarks: >- InspectionState for use by the InspectionMiddleware for emulator inspection of runtime Activities and BotState. -isPreview: false isDeprecated: true customDeprecatedMessage: This class will be removed in a future version of the framework. type: class @@ -21,14 +20,13 @@ constructors: Creates a new instance of the [InspectionState](xref:botbuilder.InspectionState) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new InspectionState(storage: Storage)' parameters: - id: storage - type: Storage - description: > + type: + description: >- The [Storage](xref:botbuilder-core.Storage) layer this state management object will use to store and retrieve state. inheritedMethods: @@ -50,18 +48,17 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function clear(context: TurnContext): Promise' parameters: - id: context - type: TurnContext + type: description: Context for current turn of conversation with the user. return: description: A promise representing the async operation. type: Promise<void> - inheritanceDescription: Inherited From BotState.clear + inheritanceDescription: Inherited From [BotState.clear](xref:botbuilder.BotState.clear) - name: createProperty(string) uid: botbuilder.InspectionState.createProperty package: botbuilder @@ -71,7 +68,6 @@ inheritedMethods: states storage object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createProperty(name: string): StatePropertyAccessor' @@ -81,8 +77,10 @@ inheritedMethods: description: Name of the property to add. return: description: An accessor for the property. - type: StatePropertyAccessor<T> - inheritanceDescription: Inherited From BotState.createProperty + type: <T> + inheritanceDescription: >- + Inherited From + [BotState.createProperty](xref:botbuilder.BotState.createProperty) - name: delete(TurnContext) uid: botbuilder.InspectionState.delete package: botbuilder @@ -99,18 +97,17 @@ inheritedMethods: await botState.delete(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function delete(context: TurnContext): Promise' parameters: - id: context - type: TurnContext + type: description: Context for current turn of conversation with the user. return: description: A promise representing the async operation. type: Promise<void> - inheritanceDescription: Inherited From BotState.delete + inheritanceDescription: Inherited From [BotState.delete](xref:botbuilder.BotState.delete) - name: get(TurnContext) uid: botbuilder.InspectionState.get package: botbuilder @@ -125,19 +122,18 @@ inheritedMethods: const state = botState.get(context); ``` - isPreview: false isDeprecated: false syntax: - content: 'function get(context: TurnContext): any | undefined' + content: 'function get(context: TurnContext): any' parameters: - id: context - type: TurnContext + type: description: Context for current turn of conversation with the user. return: description: A cached state object or undefined if not cached. - type: any | undefined - inheritanceDescription: Inherited From BotState.get - - name: 'load(TurnContext, boolean)' + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder.BotState.get) + - name: load(TurnContext, boolean) uid: botbuilder.InspectionState.load package: botbuilder summary: Reads in and caches the backing state object for a turn. @@ -157,13 +153,12 @@ inheritedMethods: const state = await botState.load(context); ``` - isPreview: false isDeprecated: false syntax: content: 'function load(context: TurnContext, force?: boolean): Promise' parameters: - id: context - type: TurnContext + type: description: Context for current turn of conversation with the user. - id: force type: boolean @@ -173,8 +168,8 @@ inheritedMethods: return: description: The cached state. type: Promise<any> - inheritanceDescription: Inherited From BotState.load - - name: 'saveChanges(TurnContext, boolean)' + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder.BotState.load) + - name: saveChanges(TurnContext, boolean) uid: botbuilder.InspectionState.saveChanges package: botbuilder summary: Saves the cached state object if it's been changed. @@ -193,7 +188,6 @@ inheritedMethods: await botState.saveChanges(context); ``` - isPreview: false isDeprecated: false syntax: content: >- @@ -201,7 +195,7 @@ inheritedMethods: Promise parameters: - id: context - type: TurnContext + type: description: Context for current turn of conversation with the user. - id: force type: boolean @@ -211,5 +205,7 @@ inheritedMethods: return: description: A promise representing the async operation. type: Promise<void> - inheritanceDescription: Inherited From BotState.saveChanges -extends: BotState + inheritanceDescription: >- + Inherited From + [BotState.saveChanges](xref:botbuilder.BotState.saveChanges) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InstallationUpdateActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InstallationUpdateActionTypes.yml new file mode 100644 index 00000000..bfc22ca5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InstallationUpdateActionTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: InstallationUpdateActionTypes +uid: botbuilder.InstallationUpdateActionTypes +package: botbuilder +summary: |- + Defines values for InstallationUpdateActionTypes. + Possible values include: 'add', 'remove' +fullName: InstallationUpdateActionTypes +remarks: '' +isDeprecated: false +fields: + - name: Add + uid: botbuilder.InstallationUpdateActionTypes.Add + package: botbuilder + summary: '' + - name: Remove + uid: botbuilder.InstallationUpdateActionTypes.Remove + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/IntentScore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/IntentScore.yml new file mode 100644 index 00000000..30a848a0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/IntentScore.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: IntentScore +uid: botbuilder.IntentScore +package: botbuilder +summary: Score plus any extra information about an intent. +fullName: IntentScore +remarks: '' +isDeprecated: false +type: interface +properties: + - name: score + uid: botbuilder.IntentScore.score + package: botbuilder + summary: Gets or sets confidence in an intent. + fullName: score + remarks: '' + isDeprecated: false + syntax: + content: 'score?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeException.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeException.yml new file mode 100644 index 00000000..57b5cb68 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeException.yml @@ -0,0 +1,129 @@ +### YamlMime:TSType +name: InvokeException +uid: botbuilder.InvokeException +package: botbuilder +summary: A custom exception for invoke response errors. +fullName: InvokeException +remarks: '' +isDeprecated: false +type: class +constructors: + - name: InvokeException(StatusCodes, T) + uid: botbuilder.InvokeException.constructor + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new InvokeException(status: StatusCodes, response?: T)' + parameters: + - id: status + type: + description: The Http status code of the error. + - id: response + type: T + description: optional. The body of the exception. Default is null. +inheritedProperties: + - name: message + uid: botbuilder.InvokeException.message + package: botbuilder + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.message + - name: name + uid: botbuilder.InvokeException.name + package: botbuilder + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: botbuilder.InvokeException.prepareStackTrace + package: botbuilder + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace + - name: stack + uid: botbuilder.InvokeException.stack + package: botbuilder + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: botbuilder.InvokeException.stackTraceLimit + package: botbuilder + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: botbuilder.InvokeException.captureStackTrace + package: botbuilder + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace +methods: + - name: createInvokeResponse() + uid: botbuilder.InvokeException.createInvokeResponse + package: botbuilder + summary: >- + A factory method that creates a new + [InvokeResponse](xref:botbuilder-core.InvokeResponse) object with the + status code and body of the current object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createInvokeResponse(): InvokeResponse' + return: + description: A new [InvokeResponse](xref:botbuilder-core.InvokeResponse) object. + type: <any> +extends: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeResponse.yml new file mode 100644 index 00000000..61803d4e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/InvokeResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: InvokeResponse +uid: botbuilder.InvokeResponse +package: botbuilder +summary: >- + Represents a response returned by a bot when it receives an `invoke` activity. + + + This interface supports the framework and is not intended to be called + directly for your code. +fullName: InvokeResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.InvokeResponse.body + package: botbuilder + summary: Optional. The body of the response. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: T' + return: + description: '' + type: T + - name: status + uid: botbuilder.InvokeResponse.status + package: botbuilder + summary: The HTTP status code of the response. + fullName: status + remarks: '' + isDeprecated: false + syntax: + content: 'status: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Location.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Location.yml new file mode 100644 index 00000000..1fbc883c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Location.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: Location +uid: botbuilder.Location +package: botbuilder +summary: Interface for location coordinates +fullName: Location +remarks: '' +isDeprecated: false +type: interface +properties: + - name: accuracy + uid: botbuilder.Location.accuracy + package: botbuilder + summary: Accuracy of the location. + fullName: accuracy + remarks: '' + isDeprecated: false + syntax: + content: 'accuracy?: number' + return: + description: '' + type: number + - name: latitude + uid: botbuilder.Location.latitude + package: botbuilder + summary: Latitude of the location. + fullName: latitude + remarks: '' + isDeprecated: false + syntax: + content: 'latitude: number' + return: + description: '' + type: number + - name: longitude + uid: botbuilder.Location.longitude + package: botbuilder + summary: Longitude of the location. + fullName: longitude + remarks: '' + isDeprecated: false + syntax: + content: 'longitude: number' + return: + description: '' + type: number + - name: timestamp + uid: botbuilder.Location.timestamp + package: botbuilder + summary: Timestamp in ISO milliseconds since epoch. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaCard.yml new file mode 100644 index 00000000..6f3e2f23 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: MediaCard +uid: botbuilder.MediaCard +package: botbuilder +summary: Media card +fullName: MediaCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder.MediaCard.aspect + package: botbuilder + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder.MediaCard.autoloop + package: botbuilder + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder.MediaCard.autostart + package: botbuilder + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder.MediaCard.buttons + package: botbuilder + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder.MediaCard.duration + package: botbuilder + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder.MediaCard.image + package: botbuilder + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder.MediaCard.media + package: botbuilder + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder.MediaCard.shareable + package: botbuilder + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder.MediaCard.subtitle + package: botbuilder + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.MediaCard.text + package: botbuilder + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.MediaCard.title + package: botbuilder + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.MediaCard.value + package: botbuilder + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaEventValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaEventValue.yml new file mode 100644 index 00000000..f42a083d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaEventValue.yml @@ -0,0 +1,24 @@ +### YamlMime:TSType +name: MediaEventValue +uid: botbuilder.MediaEventValue +package: botbuilder +summary: Supplementary parameter for media events +fullName: MediaEventValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardValue + uid: botbuilder.MediaEventValue.cardValue + package: botbuilder + summary: >- + Callback parameter specified in the Value field of the MediaCard that + originated this event + fullName: cardValue + remarks: '' + isDeprecated: false + syntax: + content: 'cardValue: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaType.yml new file mode 100644 index 00000000..c84e1338 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaType.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: MediaType +uid: botbuilder.MediaType +package: botbuilder +summary: Enum value to specify the type of media for VivaAction.SelectMedia action. +fullName: MediaType +remarks: '' +isDeprecated: false +fields: + - name: Image + uid: botbuilder.MediaType.Image + package: botbuilder + summary: '' + numericValue: 1 + - name: Audio + uid: botbuilder.MediaType.Audio + package: botbuilder + summary: '' + numericValue: 4 + - name: Document + uid: botbuilder.MediaType.Document + package: botbuilder + summary: '' + numericValue: 8 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaUrl.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaUrl.yml new file mode 100644 index 00000000..bb3b00b2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MediaUrl.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: MediaUrl +uid: botbuilder.MediaUrl +package: botbuilder +summary: Media URL +fullName: MediaUrl +remarks: '' +isDeprecated: false +type: interface +properties: + - name: profile + uid: botbuilder.MediaUrl.profile + package: botbuilder + summary: >- + Optional profile hint to the client to differentiate multiple MediaUrl + objects from each other + fullName: profile + remarks: '' + isDeprecated: false + syntax: + content: 'profile?: string' + return: + description: '' + type: string + - name: url + uid: botbuilder.MediaUrl.url + package: botbuilder + summary: Url for the media + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Meeting.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Meeting.yml new file mode 100644 index 00000000..31bf51d7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Meeting.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: Meeting +uid: botbuilder.Meeting +package: botbuilder +summary: '' +fullName: Meeting +remarks: '' +isDeprecated: false +type: interface +properties: + - name: inMeeting + uid: botbuilder.Meeting.inMeeting + package: botbuilder + summary: Indicates if the participant is in the meeting. + fullName: inMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'inMeeting?: boolean' + return: + description: '' + type: boolean + - name: role + uid: botbuilder.Meeting.role + package: botbuilder + summary: Meeting role of the user. + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingDetails.yml new file mode 100644 index 00000000..690374cd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingDetails.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: MeetingDetails +uid: botbuilder.MeetingDetails +package: botbuilder +summary: '' +fullName: MeetingDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: msGraphResourceId + uid: botbuilder.MeetingDetails.msGraphResourceId + package: botbuilder + summary: The MsGraphResourceId, used specifically for MS Graph API calls. + fullName: msGraphResourceId + remarks: '' + isDeprecated: false + syntax: + content: 'msGraphResourceId: string' + return: + description: '' + type: string + - name: scheduledEndTime + uid: botbuilder.MeetingDetails.scheduledEndTime + package: botbuilder + summary: The meeting's scheduled end time, in UTC. + fullName: scheduledEndTime + remarks: '' + isDeprecated: false + syntax: + content: 'scheduledEndTime?: Date' + return: + description: '' + type: Date + - name: scheduledStartTime + uid: botbuilder.MeetingDetails.scheduledStartTime + package: botbuilder + summary: The meeting's scheduled start time, in UTC. + fullName: scheduledStartTime + remarks: '' + isDeprecated: false + syntax: + content: 'scheduledStartTime?: Date' + return: + description: '' + type: Date + - name: type + uid: botbuilder.MeetingDetails.type + package: botbuilder + summary: The meeting's type. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.MeetingDetails.id + package: botbuilder + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.id + - name: joinUrl + uid: botbuilder.MeetingDetails.joinUrl + package: botbuilder + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.joinUrl + - name: title + uid: botbuilder.MeetingDetails.title + package: botbuilder + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.title +extends: MeetingDetailsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEndEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEndEventDetails.yml new file mode 100644 index 00000000..1cd560fd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEndEventDetails.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: MeetingEndEventDetails +uid: botbuilder.MeetingEndEventDetails +package: botbuilder +summary: '' +fullName: MeetingEndEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: endTime + uid: botbuilder.MeetingEndEventDetails.endTime + package: botbuilder + summary: Timestamp for meeting end, in UTC. + fullName: endTime + remarks: '' + isDeprecated: false + syntax: + content: 'endTime: Date' + return: + description: '' + type: Date +inheritedProperties: + - name: id + uid: botbuilder.MeetingEndEventDetails.id + package: botbuilder + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.id](xref:botbuilder.MeetingEventDetails.id) + - name: joinUrl + uid: botbuilder.MeetingEndEventDetails.joinUrl + package: botbuilder + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.joinUrl](xref:botbuilder.MeetingEventDetails.joinUrl) + - name: meetingType + uid: botbuilder.MeetingEndEventDetails.meetingType + package: botbuilder + summary: The meeting's type. + fullName: meetingType + remarks: '' + isDeprecated: false + syntax: + content: 'meetingType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.meetingType](xref:botbuilder.MeetingEventDetails.meetingType) + - name: title + uid: botbuilder.MeetingEndEventDetails.title + package: botbuilder + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.title](xref:botbuilder.MeetingEventDetails.title) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEventDetails.yml new file mode 100644 index 00000000..77c33a53 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingEventDetails.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: MeetingEventDetails +uid: botbuilder.MeetingEventDetails +package: botbuilder +summary: '' +fullName: MeetingEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: meetingType + uid: botbuilder.MeetingEventDetails.meetingType + package: botbuilder + summary: The meeting's type. + fullName: meetingType + remarks: '' + isDeprecated: false + syntax: + content: 'meetingType: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botbuilder.MeetingEventDetails.id + package: botbuilder + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.id + - name: joinUrl + uid: botbuilder.MeetingEventDetails.joinUrl + package: botbuilder + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.joinUrl + - name: title + uid: botbuilder.MeetingEventDetails.title + package: botbuilder + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From MeetingDetailsBase.title +extends: MeetingDetailsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingInfo.yml new file mode 100644 index 00000000..79ca7c54 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MeetingInfo +uid: botbuilder.MeetingInfo +package: botbuilder +summary: '' +fullName: MeetingInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversation + uid: botbuilder.MeetingInfo.conversation + package: botbuilder + summary: The Conversation Account for the meeting. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationAccount' + return: + description: '' + type: + - name: details + uid: botbuilder.MeetingInfo.details + package: botbuilder + summary: The specific details of a Teams meeting. + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: MeetingDetails' + return: + description: '' + type: + - name: organizer + uid: botbuilder.MeetingInfo.organizer + package: botbuilder + summary: The organizer's user information. + fullName: organizer + remarks: '' + isDeprecated: false + syntax: + content: 'organizer: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotification.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotification.yml new file mode 100644 index 00000000..08a1bb8c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotification.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MeetingNotification +uid: botbuilder.MeetingNotification +package: botbuilder +summary: '' +fullName: MeetingNotification +remarks: '' +isDeprecated: false +syntax: | + type MeetingNotification = TargetedMeetingNotification diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationBase.yml new file mode 100644 index 00000000..e3fdeee0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationBase.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MeetingNotificationBase +uid: botbuilder.MeetingNotificationBase +package: botbuilder +summary: '' +fullName: MeetingNotificationBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder.MeetingNotificationBase.type + package: botbuilder + summary: The type of meeting notification. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.MeetingNotificationBase.value + package: botbuilder + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T' + return: + description: '' + type: T diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationChannelData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationChannelData.yml new file mode 100644 index 00000000..01021c7d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationChannelData.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MeetingNotificationChannelData +uid: botbuilder.MeetingNotificationChannelData +package: botbuilder +summary: '' +fullName: MeetingNotificationChannelData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: onBehalfOf + uid: botbuilder.MeetingNotificationChannelData.onBehalfOf + package: botbuilder + summary: The user that the bot is sending the notification on behalfOf, if any. + fullName: onBehalfOf + remarks: '' + isDeprecated: false + syntax: + content: 'onBehalfOf?: OnBehalfOf[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationRecipientFailureInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationRecipientFailureInfo.yml new file mode 100644 index 00000000..506b3f9a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationRecipientFailureInfo.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: MeetingNotificationRecipientFailureInfo +uid: botbuilder.MeetingNotificationRecipientFailureInfo +package: botbuilder +summary: '' +fullName: MeetingNotificationRecipientFailureInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: errorCode + uid: botbuilder.MeetingNotificationRecipientFailureInfo.errorCode + package: botbuilder + summary: The error code. + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: failureReason + uid: botbuilder.MeetingNotificationRecipientFailureInfo.failureReason + package: botbuilder + summary: >- + The reason for which the meetings notification could not be sent to the + recipient. + fullName: failureReason + remarks: '' + isDeprecated: false + syntax: + content: 'failureReason: string' + return: + description: '' + type: string + - name: recipientMri + uid: botbuilder.MeetingNotificationRecipientFailureInfo.recipientMri + package: botbuilder + summary: The targeted recipient's MRI. + fullName: recipientMri + remarks: '' + isDeprecated: false + syntax: + content: 'recipientMri: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationResponse.yml new file mode 100644 index 00000000..b3e3d0b8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingNotificationResponse.yml @@ -0,0 +1,24 @@ +### YamlMime:TSType +name: MeetingNotificationResponse +uid: botbuilder.MeetingNotificationResponse +package: botbuilder +summary: '' +fullName: MeetingNotificationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: recipientsFailureInfo + uid: botbuilder.MeetingNotificationResponse.recipientsFailureInfo + package: botbuilder + summary: >- + The list of recipients that failed to recieve the sent meetings + notification. + fullName: recipientsFailureInfo + remarks: '' + isDeprecated: false + syntax: + content: 'recipientsFailureInfo?: MeetingNotificationRecipientFailureInfo[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingParticipantsEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingParticipantsEventDetails.yml new file mode 100644 index 00000000..d0edcc6d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingParticipantsEventDetails.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MeetingParticipantsEventDetails +uid: botbuilder.MeetingParticipantsEventDetails +package: botbuilder +summary: '' +fullName: MeetingParticipantsEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: members + uid: botbuilder.MeetingParticipantsEventDetails.members + package: botbuilder + summary: The participants info. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: TeamsMeetingMember[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStageSurface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStageSurface.yml new file mode 100644 index 00000000..4c6c908f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStageSurface.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MeetingStageSurface +uid: botbuilder.MeetingStageSurface +package: botbuilder +summary: '' +fullName: MeetingStageSurface +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder.MeetingStageSurface.content + package: botbuilder + summary: The content to display in the meeting notification. + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content: T' + return: + description: '' + type: T + - name: contentType + uid: botbuilder.MeetingStageSurface.contentType + package: botbuilder + summary: The content type. + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: "task"' + return: + description: '' + type: '"task"' + - name: surface + uid: botbuilder.MeetingStageSurface.surface + package: botbuilder + summary: The surface type. + fullName: surface + remarks: '' + isDeprecated: false + syntax: + content: 'surface: "meetingStage"' + return: + description: '' + type: '"meetingStage"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStartEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStartEventDetails.yml new file mode 100644 index 00000000..05f7ec60 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingStartEventDetails.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: MeetingStartEventDetails +uid: botbuilder.MeetingStartEventDetails +package: botbuilder +summary: '' +fullName: MeetingStartEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: startTime + uid: botbuilder.MeetingStartEventDetails.startTime + package: botbuilder + summary: Timestamp for meeting start, in UTC. + fullName: startTime + remarks: '' + isDeprecated: false + syntax: + content: 'startTime: Date' + return: + description: '' + type: Date +inheritedProperties: + - name: id + uid: botbuilder.MeetingStartEventDetails.id + package: botbuilder + summary: The meeting's Id, encoded as a BASE64 string. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.id](xref:botbuilder.MeetingEventDetails.id) + - name: joinUrl + uid: botbuilder.MeetingStartEventDetails.joinUrl + package: botbuilder + summary: The URL used to join the meeting. + fullName: joinUrl + remarks: '' + isDeprecated: false + syntax: + content: 'joinUrl: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.joinUrl](xref:botbuilder.MeetingEventDetails.joinUrl) + - name: meetingType + uid: botbuilder.MeetingStartEventDetails.meetingType + package: botbuilder + summary: The meeting's type. + fullName: meetingType + remarks: '' + isDeprecated: false + syntax: + content: 'meetingType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.meetingType](xref:botbuilder.MeetingEventDetails.meetingType) + - name: title + uid: botbuilder.MeetingStartEventDetails.title + package: botbuilder + summary: The title of the meeting. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MeetingEventDetails.title](xref:botbuilder.MeetingEventDetails.title) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingSurface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingSurface.yml new file mode 100644 index 00000000..7476798e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingSurface.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MeetingSurface +uid: botbuilder.MeetingSurface +package: botbuilder +summary: '' +fullName: MeetingSurface +remarks: '' +isDeprecated: false +syntax: | + type MeetingSurface = MeetingStageSurface | MeetingTabIconSurface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingTabIconSurface.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingTabIconSurface.yml new file mode 100644 index 00000000..94638ace --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MeetingTabIconSurface.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MeetingTabIconSurface +uid: botbuilder.MeetingTabIconSurface +package: botbuilder +summary: '' +fullName: MeetingTabIconSurface +remarks: '' +isDeprecated: false +type: interface +properties: + - name: surface + uid: botbuilder.MeetingTabIconSurface.surface + package: botbuilder + summary: The surface type. + fullName: surface + remarks: '' + isDeprecated: false + syntax: + content: 'surface: "meetingTabIcon"' + return: + description: '' + type: '"meetingTabIcon"' + - name: tabEntityId + uid: botbuilder.MeetingTabIconSurface.tabEntityId + package: botbuilder + summary: The tab entity ID. + fullName: tabEntityId + remarks: '' + isDeprecated: false + syntax: + content: 'tabEntityId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryStorage.yml new file mode 100644 index 00000000..22ce94eb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryStorage.yml @@ -0,0 +1,101 @@ +### YamlMime:TSType +name: MemoryStorage +uid: botbuilder.MemoryStorage +package: botbuilder +summary: Memory based storage provider for a bot. +fullName: MemoryStorage +remarks: >- + This provider is most useful for simulating production storage when running + locally against the + + emulator or as part of a unit test. It has the following characteristics: + + + - Starts off completely empty when the bot is run. + + - Anything written to the store will be forgotten when the process exits. + + - Objects that are read and written to the store are cloned to properly + simulate network based + storage providers. + - Cloned objects are serialized using `JSON.stringify()` to catch any possible + serialization + related issues that might occur when using a network based storage provider. + + ```JavaScript + + const { MemoryStorage } = require('botbuilder'); + + + const storage = new MemoryStorage(); + + ``` +isDeprecated: false +type: class +constructors: + - name: 'MemoryStorage({[k: string]: string})' + uid: botbuilder.MemoryStorage.constructor + package: botbuilder + summary: Creates a new MemoryStorage instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new MemoryStorage(memory?: {[k: string]: string})' + parameters: + - id: memory + type: '{[k: string]: string}' + description: >- + (Optional) memory to use for storing items. By default it will + create an empty JSON object `{}`. +methods: + - name: delete(string[]) + uid: botbuilder.MemoryStorage.delete + package: botbuilder + summary: Deletes storage items from storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: >- + Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to + delete. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: read(string[]) + uid: botbuilder.MemoryStorage.read + package: botbuilder + summary: Reads storage items from storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function read(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: >- + Keys of the [StoreItems](xref:botbuilder-core.StoreItems) objects to + read. + return: + description: The read items. + type: Promise<> + - name: write(StoreItems) + uid: botbuilder.MemoryStorage.write + package: botbuilder + summary: Writes storage items to storage. + remarks: '' + isDeprecated: false + syntax: + content: 'function write(changes: StoreItems): Promise' + parameters: + - id: changes + type: + description: >- + The [StoreItems](xref:botbuilder-core.StoreItems) to write, indexed + by key. + return: + description: A promise representing the async operation. + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryTranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryTranscriptStore.yml new file mode 100644 index 00000000..c7467193 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MemoryTranscriptStore.yml @@ -0,0 +1,100 @@ +### YamlMime:TSType +name: MemoryTranscriptStore +uid: botbuilder.MemoryTranscriptStore +package: botbuilder +summary: The memory transcript store stores transcripts in volatile memory in a Map. +fullName: MemoryTranscriptStore +remarks: >- + Because this uses an unbounded volatile dictionary this should only be used + for unit tests or + + non-production environments. +isDeprecated: false +type: class +methods: + - name: deleteTranscript(string, string) + uid: botbuilder.MemoryTranscriptStore.deleteTranscript + package: botbuilder + summary: Delete a specific conversation and all of it's activities. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteTranscript(channelId: string, conversationId: string): + Promise + parameters: + - id: channelId + type: string + description: Channel Id where conversation took place. + - id: conversationId + type: string + description: Id of the conversation to delete. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: getTranscriptActivities(string, string, string, Date) + uid: botbuilder.MemoryTranscriptStore.getTranscriptActivities + package: botbuilder + summary: Get activities from the memory transcript store. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTranscriptActivities(channelId: string, conversationId: + string, continuationToken?: string, startDate?: Date): + Promise> + parameters: + - id: channelId + type: string + description: Channel Id. + - id: conversationId + type: string + description: Conversation Id. + - id: continuationToken + type: string + description: Continuation token to page through results. + - id: startDate + type: Date + description: Earliest time to include. + return: + description: A page of matching activities. + type: >- + Promise<<>> + - name: listTranscripts(string, string) + uid: botbuilder.MemoryTranscriptStore.listTranscripts + package: botbuilder + summary: List conversations in the channelId. + remarks: '' + isDeprecated: false + syntax: + content: >- + function listTranscripts(channelId: string, continuationToken?: string): + Promise> + parameters: + - id: channelId + type: string + description: Channel Id. + - id: continuationToken + type: string + description: Continuation token to page through results. + return: + description: A page of conversations for a channel from the store. + type: >- + Promise<<>> + - name: logActivity(Activity) + uid: botbuilder.MemoryTranscriptStore.logActivity + package: botbuilder + summary: Log an activity to the transcript. + remarks: '' + isDeprecated: false + syntax: + content: 'function logActivity(activity: Activity): void | Promise' + parameters: + - id: activity + type: + description: Activity to log. + return: + description: A promise representing the async operation. + type: void | Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Mention.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Mention.yml new file mode 100644 index 00000000..6c6f4f39 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Mention.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Mention +uid: botbuilder.Mention +package: botbuilder +summary: 'Mention information (entity type: "mention")' +fullName: Mention +remarks: '' +isDeprecated: false +type: interface +properties: + - name: mentioned + uid: botbuilder.Mention.mentioned + package: botbuilder + summary: The mentioned user + fullName: mentioned + remarks: '' + isDeprecated: false + syntax: + content: 'mentioned: ChannelAccount' + return: + description: '' + type: + - name: text + uid: botbuilder.Mention.text + package: botbuilder + summary: Sub Text which represents the mention (can be null or empty) + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.Mention.type + package: botbuilder + summary: Type of this entity (RFC 3987 IRI) + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayload.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayload.yml new file mode 100644 index 00000000..13f34480 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayload.yml @@ -0,0 +1,214 @@ +### YamlMime:TSType +name: MessageActionsPayload +uid: botbuilder.MessageActionsPayload +package: botbuilder +summary: '' +fullName: MessageActionsPayload +remarks: '' +isDeprecated: false +type: interface +properties: + - name: attachmentLayout + uid: botbuilder.MessageActionsPayload.attachmentLayout + package: botbuilder + summary: How the attachment(s) are displayed in + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: string' + return: + description: '' + type: string + - name: attachments + uid: botbuilder.MessageActionsPayload.attachments + package: botbuilder + summary: Attachments in + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: MessageActionsPayloadAttachment[]' + return: + description: '' + type: [] + - name: body + uid: botbuilder.MessageActionsPayload.body + package: botbuilder + summary: Plaintext/HTML representation + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: MessageActionsPayloadBody' + return: + description: '' + type: + - name: createdDateTime + uid: botbuilder.MessageActionsPayload.createdDateTime + package: botbuilder + summary: Timestamp of when the message was + fullName: createdDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'createdDateTime?: string' + return: + description: '' + type: string + - name: deleted + uid: botbuilder.MessageActionsPayload.deleted + package: botbuilder + summary: Indicates whether a message has been soft + fullName: deleted + remarks: '' + isDeprecated: false + syntax: + content: 'deleted?: boolean' + return: + description: '' + type: boolean + - name: from + uid: botbuilder.MessageActionsPayload.from + package: botbuilder + summary: Sender of the message. + fullName: from + remarks: '' + isDeprecated: false + syntax: + content: 'from?: MessageActionsPayloadFrom' + return: + description: '' + type: + - name: id + uid: botbuilder.MessageActionsPayload.id + package: botbuilder + summary: Unique id of the message. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: importance + uid: botbuilder.MessageActionsPayload.importance + package: botbuilder + summary: The importance of the message. Possible + fullName: importance + remarks: '' + isDeprecated: false + syntax: + content: 'importance?: Importance' + return: + description: '' + type: + - name: lastModifiedDateTime + uid: botbuilder.MessageActionsPayload.lastModifiedDateTime + package: botbuilder + summary: Timestamp of when the message was + fullName: lastModifiedDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'lastModifiedDateTime?: string' + return: + description: '' + type: string + - name: linkToMessage + uid: botbuilder.MessageActionsPayload.linkToMessage + package: botbuilder + summary: Link back to the message. + fullName: linkToMessage + remarks: '' + isDeprecated: false + syntax: + content: 'linkToMessage?: string' + return: + description: '' + type: string + - name: locale + uid: botbuilder.MessageActionsPayload.locale + package: botbuilder + summary: Locale of the message set by the client. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale?: string' + return: + description: '' + type: string + - name: mentions + uid: botbuilder.MessageActionsPayload.mentions + package: botbuilder + summary: List of entities + fullName: mentions + remarks: '' + isDeprecated: false + syntax: + content: 'mentions?: MessageActionsPayloadMention[]' + return: + description: '' + type: [] + - name: messageType + uid: botbuilder.MessageActionsPayload.messageType + package: botbuilder + summary: Type of message - automatically set to + fullName: messageType + remarks: '' + isDeprecated: false + syntax: + content: 'messageType?: "message"' + return: + description: '' + type: '"message"' + - name: reactions + uid: botbuilder.MessageActionsPayload.reactions + package: botbuilder + summary: Reactions for the + fullName: reactions + remarks: '' + isDeprecated: false + syntax: + content: 'reactions?: MessageActionsPayloadReaction[]' + return: + description: '' + type: [] + - name: replyToId + uid: botbuilder.MessageActionsPayload.replyToId + package: botbuilder + summary: Id of the parent/root message of the thread. + fullName: replyToId + remarks: '' + isDeprecated: false + syntax: + content: 'replyToId?: string' + return: + description: '' + type: string + - name: subject + uid: botbuilder.MessageActionsPayload.subject + package: botbuilder + summary: Subject line of the message. + fullName: subject + remarks: '' + isDeprecated: false + syntax: + content: 'subject?: string' + return: + description: '' + type: string + - name: summary + uid: botbuilder.MessageActionsPayload.summary + package: botbuilder + summary: Summary text of the message that could be used + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadApp.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadApp.yml new file mode 100644 index 00000000..df98122a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadApp.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadApp +uid: botbuilder.MessageActionsPayloadApp +package: botbuilder +summary: '' +fullName: MessageActionsPayloadApp +remarks: '' +isDeprecated: false +type: interface +properties: + - name: applicationIdentityType + uid: botbuilder.MessageActionsPayloadApp.applicationIdentityType + package: botbuilder + summary: The type of + fullName: applicationIdentityType + remarks: '' + isDeprecated: false + syntax: + content: 'applicationIdentityType?: ApplicationIdentityType' + return: + description: '' + type: + - name: displayName + uid: botbuilder.MessageActionsPayloadApp.displayName + package: botbuilder + summary: The plaintext display name of the + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.MessageActionsPayloadApp.id + package: botbuilder + summary: The id of the application. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadAttachment.yml new file mode 100644 index 00000000..f58758e9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadAttachment.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: MessageActionsPayloadAttachment +uid: botbuilder.MessageActionsPayloadAttachment +package: botbuilder +summary: '' +fullName: MessageActionsPayloadAttachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder.MessageActionsPayloadAttachment.content + package: botbuilder + summary: The content of the attachment, in case of a code + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: any' + return: + description: '' + type: any + - name: contentType + uid: botbuilder.MessageActionsPayloadAttachment.contentType + package: botbuilder + summary: The type of the attachment. + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType?: string' + return: + description: '' + type: string + - name: contentUrl + uid: botbuilder.MessageActionsPayloadAttachment.contentUrl + package: botbuilder + summary: The url of the attachment, in case of a + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.MessageActionsPayloadAttachment.id + package: botbuilder + summary: The id of the attachment. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.MessageActionsPayloadAttachment.name + package: botbuilder + summary: The plaintext display name of the attachment. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: thumbnailUrl + uid: botbuilder.MessageActionsPayloadAttachment.thumbnailUrl + package: botbuilder + summary: The url of a thumbnail image that might be + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadBody.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadBody.yml new file mode 100644 index 00000000..8e1c4254 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadBody.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadBody +uid: botbuilder.MessageActionsPayloadBody +package: botbuilder +summary: '' +fullName: MessageActionsPayloadBody +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder.MessageActionsPayloadBody.content + package: botbuilder + summary: The content of the body. + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: string' + return: + description: '' + type: string + - name: contentType + uid: botbuilder.MessageActionsPayloadBody.contentType + package: botbuilder + summary: Type of the content. Possible values + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType?: ContentType' + return: + description: '' + type: + - name: textContent + uid: botbuilder.MessageActionsPayloadBody.textContent + package: botbuilder + summary: The text content of the body after + fullName: textContent + remarks: '' + isDeprecated: false + syntax: + content: 'textContent?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadConversation.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadConversation.yml new file mode 100644 index 00000000..7e205f61 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadConversation.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadConversation +uid: botbuilder.MessageActionsPayloadConversation +package: botbuilder +summary: '' +fullName: MessageActionsPayloadConversation +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversationIdentityType + uid: botbuilder.MessageActionsPayloadConversation.conversationIdentityType + package: botbuilder + summary: The type of + fullName: conversationIdentityType + remarks: '' + isDeprecated: false + syntax: + content: 'conversationIdentityType?: ConversationIdentityType' + return: + description: '' + type: + - name: displayName + uid: botbuilder.MessageActionsPayloadConversation.displayName + package: botbuilder + summary: The plaintext display name of the team or + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.MessageActionsPayloadConversation.id + package: botbuilder + summary: The id of the team or channel. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadFrom.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadFrom.yml new file mode 100644 index 00000000..8590489f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadFrom.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadFrom +uid: botbuilder.MessageActionsPayloadFrom +package: botbuilder +summary: '' +fullName: MessageActionsPayloadFrom +remarks: '' +isDeprecated: false +type: interface +properties: + - name: application + uid: botbuilder.MessageActionsPayloadFrom.application + package: botbuilder + summary: Represents details of the + fullName: application + remarks: '' + isDeprecated: false + syntax: + content: 'application?: MessageActionsPayloadApp' + return: + description: '' + type: + - name: conversation + uid: botbuilder.MessageActionsPayloadFrom.conversation + package: botbuilder + summary: Represents + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation?: MessageActionsPayloadConversation' + return: + description: '' + type: + - name: user + uid: botbuilder.MessageActionsPayloadFrom.user + package: botbuilder + summary: Represents details of the user. + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: MessageActionsPayloadUser' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadMention.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadMention.yml new file mode 100644 index 00000000..86551bcc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadMention.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadMention +uid: botbuilder.MessageActionsPayloadMention +package: botbuilder +summary: '' +fullName: MessageActionsPayloadMention +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.MessageActionsPayloadMention.id + package: botbuilder + summary: The id of the mentioned entity. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: number' + return: + description: '' + type: number + - name: mentioned + uid: botbuilder.MessageActionsPayloadMention.mentioned + package: botbuilder + summary: Provides more details on + fullName: mentioned + remarks: '' + isDeprecated: false + syntax: + content: 'mentioned?: MessageActionsPayloadFrom' + return: + description: '' + type: + - name: mentionText + uid: botbuilder.MessageActionsPayloadMention.mentionText + package: botbuilder + summary: The plaintext display name of the mentioned + fullName: mentionText + remarks: '' + isDeprecated: false + syntax: + content: 'mentionText?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadReaction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadReaction.yml new file mode 100644 index 00000000..a3b2835b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadReaction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadReaction +uid: botbuilder.MessageActionsPayloadReaction +package: botbuilder +summary: '' +fullName: MessageActionsPayloadReaction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: createdDateTime + uid: botbuilder.MessageActionsPayloadReaction.createdDateTime + package: botbuilder + summary: Timestamp of when the user reacted to + fullName: createdDateTime + remarks: '' + isDeprecated: false + syntax: + content: 'createdDateTime?: string' + return: + description: '' + type: string + - name: reactionType + uid: botbuilder.MessageActionsPayloadReaction.reactionType + package: botbuilder + summary: The type of reaction given to the + fullName: reactionType + remarks: '' + isDeprecated: false + syntax: + content: 'reactionType?: ReactionType' + return: + description: '' + type: + - name: user + uid: botbuilder.MessageActionsPayloadReaction.user + package: botbuilder + summary: The user with which the + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: MessageActionsPayloadFrom' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadUser.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadUser.yml new file mode 100644 index 00000000..eca7fa1d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageActionsPayloadUser.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MessageActionsPayloadUser +uid: botbuilder.MessageActionsPayloadUser +package: botbuilder +summary: '' +fullName: MessageActionsPayloadUser +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayName + uid: botbuilder.MessageActionsPayloadUser.displayName + package: botbuilder + summary: The plaintext display name of the user. + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.MessageActionsPayloadUser.id + package: botbuilder + summary: The id of the user. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: userIdentityType + uid: botbuilder.MessageActionsPayloadUser.userIdentityType + package: botbuilder + summary: The identity type of the + fullName: userIdentityType + remarks: '' + isDeprecated: false + syntax: + content: 'userIdentityType?: UserIdentityType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageFactory.yml new file mode 100644 index 00000000..fce71c7f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageFactory.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: MessageFactory +uid: botbuilder.MessageFactory +package: botbuilder +summary: >- + A set of utility functions to assist with the formatting of the various + message types a bot can + + return. +fullName: MessageFactory +remarks: |- + The following example shows sending a message containing a single hero card: + + ```javascript + const { MessageFactory, CardFactory } = require('botbuilder'); + + const card = CardFactory.heroCard( + 'White T-Shirt', + ['https://example.com/whiteShirt.jpg'], + ['buy'] + ); + const message = MessageFactory.attachment(card); + await context.sendActivity(message); + ``` +isDeprecated: false +type: class +methods: + - name: attachment(Attachment, string, string, string) + uid: botbuilder.MessageFactory.attachment + package: botbuilder + summary: Returns a single message activity containing an attachment. + remarks: |- + This example shows creating a message with a hero card attachment: + + ```JavaScript + const message = MessageFactory.attachment( + CardFactory.heroCard( + 'White T-Shirt', + ['https://example.com/whiteShirt.jpg'], + ['buy'] + ) + ); + ``` + isDeprecated: false + syntax: + content: >- + static function attachment(attachment: Attachment, text?: string, + speak?: string, inputHint?: string): Partial + parameters: + - id: attachment + type: + description: Adaptive card to include in the message. + - id: text + type: string + description: (Optional) text of the message. + - id: speak + type: string + description: (Optional) SSML to include with the message. + - id: inputHint + type: string + description: (Optional) input hint for the message. Defaults to `acceptingInput`. + return: + description: A message activity containing the attachment. + type: Partial<> + - name: carousel(Attachment[], string, string, string) + uid: botbuilder.MessageFactory.carousel + package: botbuilder + summary: >- + Returns a message that will display a set of attachments using a carousel + layout. + remarks: |- + This example shows creating a message with a carousel of hero cards: + + ```JavaScript + const message = MessageFactory.carousel([ + CardFactory.heroCard('title1', ['imageUrl1'], ['button1']), + CardFactory.heroCard('title2', ['imageUrl2'], ['button2']), + CardFactory.heroCard('title3', ['imageUrl3'], ['button3']) + ]); + ``` + isDeprecated: false + syntax: + content: >- + static function carousel(attachments: Attachment[], text?: string, + speak?: string, inputHint?: string): Partial + parameters: + - id: attachments + type: [] + description: Array of attachments to include in the message. + - id: text + type: string + description: (Optional) text of the message. + - id: speak + type: string + description: (Optional) SSML to include with the message. + - id: inputHint + type: string + description: (Optional) input hint for the message. + return: + description: >- + A message activity that will display a set of attachments using a + carousel layout. + type: Partial<> + - name: contentUrl(string, string, string, string, string, string) + uid: botbuilder.MessageFactory.contentUrl + package: botbuilder + summary: Returns a message that will display a single image or video to a user. + remarks: >- + This example shows sending an image to the user: + + + ```JavaScript + + const message = + MessageFactory.contentUrl('https://example.com/hawaii.jpg', 'image/jpeg', + 'Hawaii Trip', 'A photo from our family vacation.'); + + ``` + isDeprecated: false + syntax: + content: >- + static function contentUrl(url: string, contentType: string, name?: + string, text?: string, speak?: string, inputHint?: string): + Partial + parameters: + - id: url + type: string + description: Url of the image/video to send. + - id: contentType + type: string + description: The MIME type of the image/video. + - id: name + type: string + description: (Optional) Name of the image/video file. + - id: text + type: string + description: (Optional) text of the message. + - id: speak + type: string + description: (Optional) SSML to include with the message. + - id: inputHint + type: string + description: (Optional) input hint for the message. + return: + description: >- + A message activity that will display a single image or video to a + user. + type: Partial<> + - name: list(Attachment[], string, string, string) + uid: botbuilder.MessageFactory.list + package: botbuilder + summary: Returns a message that will display a set of attachments in list form. + remarks: |- + This example shows creating a message with a list of hero cards: + + ```JavaScript + const message = MessageFactory.list([ + CardFactory.heroCard('title1', ['imageUrl1'], ['button1']), + CardFactory.heroCard('title2', ['imageUrl2'], ['button2']), + CardFactory.heroCard('title3', ['imageUrl3'], ['button3']) + ]); + ``` + isDeprecated: false + syntax: + content: >- + static function list(attachments: Attachment[], text?: string, speak?: + string, inputHint?: string): Partial + parameters: + - id: attachments + type: [] + description: Array of attachments to include in the message. + - id: text + type: string + description: (Optional) text of the message. + - id: speak + type: string + description: (Optional) SSML to include with the message. + - id: inputHint + type: string + description: (Optional) input hint for the message. + return: + description: >- + A message activity that will display a set of attachments in list + form. + type: Partial<> + - name: suggestedActions((string | CardAction)[], string, string, string) + uid: botbuilder.MessageFactory.suggestedActions + package: botbuilder + summary: >- + Returns a message that includes a set of suggested actions and optional + text. + remarks: >- + This example shows creating a message with suggested actions: + + + ```JavaScript + + const message = MessageFactory.suggestedActions(['red', 'green', 'blue'], + `Choose a color`); + + ``` + isDeprecated: false + syntax: + content: >- + static function suggestedActions(actions: (string | CardAction)[], + text?: string, speak?: string, inputHint?: string): Partial + parameters: + - id: actions + type: (string | )[] + description: >- + Array of card actions or strings to include. Strings will be + converted to `messageBack` actions. + - id: text + type: string + description: (Optional) text of the message. + - id: speak + type: string + description: (Optional) SSML to include with the message. + - id: inputHint + type: string + description: (Optional) input hint for the message. Defaults to `acceptingInput`. + return: + description: A message activity that contains the suggested actions. + type: Partial<> + - name: text(string, string, string) + uid: botbuilder.MessageFactory.text + package: botbuilder + summary: Returns a simple text message. + remarks: |- + This example shows sending a simple text message: + + ```JavaScript + const message = MessageFactory.text('Greetings from example message'); + ``` + isDeprecated: false + syntax: + content: >- + static function text(text: string, speak?: string, inputHint?: string): + Partial + parameters: + - id: text + type: string + description: Text to include in the message. + - id: speak + type: string + description: (Optional) SSML to include in the message. + - id: inputHint + type: string + description: (Optional) input hint for the message. Defaults to `acceptingInput`. + return: + description: A message activity containing the text. + type: Partial<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReaction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReaction.yml new file mode 100644 index 00000000..734aaeb6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReaction.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MessageReaction +uid: botbuilder.MessageReaction +package: botbuilder +summary: Message reaction object +fullName: MessageReaction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder.MessageReaction.type + package: botbuilder + summary: 'Message reaction type. Possible values include: ''like'', ''plusOne''' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReactionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReactionTypes.yml new file mode 100644 index 00000000..74d37744 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageReactionTypes.yml @@ -0,0 +1,19 @@ +### YamlMime:TSEnum +name: MessageReactionTypes +uid: botbuilder.MessageReactionTypes +package: botbuilder +summary: |- + Defines values for MessageReactionTypes. + Possible values include: 'like', 'plusOne' +fullName: MessageReactionTypes +remarks: '' +isDeprecated: false +fields: + - name: Like + uid: botbuilder.MessageReactionTypes.Like + package: botbuilder + summary: '' + - name: PlusOne + uid: botbuilder.MessageReactionTypes.PlusOne + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageType.yml new file mode 100644 index 00000000..77bac8f3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessageType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: MessageType +uid: botbuilder.MessageType +package: botbuilder +summary: |- + Defines values for MessageType. + Possible values include: 'message' +fullName: MessageType +remarks: '' +isDeprecated: false +syntax: | + type MessageType = "message" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAction.yml new file mode 100644 index 00000000..242b36cd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAction.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: MessagingExtensionAction +uid: botbuilder.MessagingExtensionAction +package: botbuilder +summary: '' +fullName: MessagingExtensionAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: botActivityPreview + uid: botbuilder.MessagingExtensionAction.botActivityPreview + package: botbuilder + summary: '' + fullName: botActivityPreview + remarks: '' + isDeprecated: false + syntax: + content: 'botActivityPreview?: Activity[]' + return: + description: '' + type: [] + - name: botMessagePreviewAction + uid: botbuilder.MessagingExtensionAction.botMessagePreviewAction + package: botbuilder + summary: Bot message + fullName: botMessagePreviewAction + remarks: '' + isDeprecated: false + syntax: + content: 'botMessagePreviewAction?: BotMessagePreviewActionType' + return: + description: '' + type: + - name: commandContext + uid: botbuilder.MessagingExtensionAction.commandContext + package: botbuilder + summary: The context from which the + fullName: commandContext + remarks: '' + isDeprecated: false + syntax: + content: 'commandContext?: CommandContext' + return: + description: '' + type: + - name: commandId + uid: botbuilder.MessagingExtensionAction.commandId + package: botbuilder + summary: Id of the command assigned by Bot + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId?: string' + return: + description: '' + type: string + - name: messagePayload + uid: botbuilder.MessagingExtensionAction.messagePayload + package: botbuilder + summary: Message content sent as + fullName: messagePayload + remarks: '' + isDeprecated: false + syntax: + content: 'messagePayload?: MessageActionsPayload' + return: + description: '' + type: +inheritedProperties: + - name: context + uid: botbuilder.MessagingExtensionAction.context + package: botbuilder + summary: Current user context, i.e., + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TaskModuleRequestContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleRequest.context](xref:botbuilder.TaskModuleRequest.context) + - name: data + uid: botbuilder.MessagingExtensionAction.data + package: botbuilder + summary: User input data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [TaskModuleRequest.data](xref:botbuilder.TaskModuleRequest.data) + - name: tabContext + uid: botbuilder.MessagingExtensionAction.tabContext + package: botbuilder + summary: Tab request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleRequest.tabContext](xref:botbuilder.TaskModuleRequest.tabContext) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionActionResponse.yml new file mode 100644 index 00000000..3fd60ab3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionActionResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: MessagingExtensionActionResponse +uid: botbuilder.MessagingExtensionActionResponse +package: botbuilder +summary: '' +fullName: MessagingExtensionActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder.MessagingExtensionActionResponse.cacheInfo + package: botbuilder + summary: The cache info for this response + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: composeExtension + uid: botbuilder.MessagingExtensionActionResponse.composeExtension + package: botbuilder + summary: '' + fullName: composeExtension + remarks: '' + isDeprecated: false + syntax: + content: 'composeExtension?: MessagingExtensionResult' + return: + description: '' + type: + - name: task + uid: botbuilder.MessagingExtensionActionResponse.task + package: botbuilder + summary: The JSON for the response to + fullName: task + remarks: '' + isDeprecated: false + syntax: + content: 'task?: TaskModuleContinueResponse | TaskModuleMessageResponse' + return: + description: '' + type: >- + | diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAttachment.yml new file mode 100644 index 00000000..5a667371 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionAttachment.yml @@ -0,0 +1,97 @@ +### YamlMime:TSType +name: MessagingExtensionAttachment +uid: botbuilder.MessagingExtensionAttachment +package: botbuilder +summary: '' +fullName: MessagingExtensionAttachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: preview + uid: botbuilder.MessagingExtensionAttachment.preview + package: botbuilder + summary: '' + fullName: preview + remarks: '' + isDeprecated: false + syntax: + content: 'preview?: Attachment' + return: + description: '' + type: +inheritedProperties: + - name: content + uid: botbuilder.MessagingExtensionAttachment.content + package: botbuilder + summary: Embedded content + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [Attachment.content](xref:botbuilder.Attachment.content) + - name: contentType + uid: botbuilder.MessagingExtensionAttachment.contentType + package: botbuilder + summary: mimetype/Contenttype for the file + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentType](xref:botbuilder.Attachment.contentType) + - name: contentUrl + uid: botbuilder.MessagingExtensionAttachment.contentUrl + package: botbuilder + summary: Content Url + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentUrl](xref:botbuilder.Attachment.contentUrl) + - name: name + uid: botbuilder.MessagingExtensionAttachment.name + package: botbuilder + summary: (OPTIONAL) The name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Attachment.name](xref:botbuilder.Attachment.name) + - name: thumbnailUrl + uid: botbuilder.MessagingExtensionAttachment.thumbnailUrl + package: botbuilder + summary: (OPTIONAL) Thumbnail associated with attachment + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.thumbnailUrl](xref:botbuilder.Attachment.thumbnailUrl) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionParameter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionParameter.yml new file mode 100644 index 00000000..20a7cde2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionParameter.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MessagingExtensionParameter +uid: botbuilder.MessagingExtensionParameter +package: botbuilder +summary: '' +fullName: MessagingExtensionParameter +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.MessagingExtensionParameter.name + package: botbuilder + summary: Name of the parameter + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.MessagingExtensionParameter.value + package: botbuilder + summary: Value of the parameter + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQuery.yml new file mode 100644 index 00000000..aa8791a7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQuery.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: MessagingExtensionQuery +uid: botbuilder.MessagingExtensionQuery +package: botbuilder +summary: '' +fullName: MessagingExtensionQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: commandId + uid: botbuilder.MessagingExtensionQuery.commandId + package: botbuilder + summary: Id of the command assigned by Bot + fullName: commandId + remarks: '' + isDeprecated: false + syntax: + content: 'commandId?: string' + return: + description: '' + type: string + - name: parameters + uid: botbuilder.MessagingExtensionQuery.parameters + package: botbuilder + summary: Parameters for the + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: MessagingExtensionParameter[]' + return: + description: '' + type: [] + - name: queryOptions + uid: botbuilder.MessagingExtensionQuery.queryOptions + package: botbuilder + summary: '' + fullName: queryOptions + remarks: '' + isDeprecated: false + syntax: + content: 'queryOptions?: MessagingExtensionQueryOptions' + return: + description: '' + type: + - name: state + uid: botbuilder.MessagingExtensionQuery.state + package: botbuilder + summary: State parameter passed back to the bot after + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQueryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQueryOptions.yml new file mode 100644 index 00000000..596e5525 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionQueryOptions.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MessagingExtensionQueryOptions +uid: botbuilder.MessagingExtensionQueryOptions +package: botbuilder +summary: '' +fullName: MessagingExtensionQueryOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: count + uid: botbuilder.MessagingExtensionQueryOptions.count + package: botbuilder + summary: Number of entities to fetch + fullName: count + remarks: '' + isDeprecated: false + syntax: + content: 'count?: number' + return: + description: '' + type: number + - name: skip + uid: botbuilder.MessagingExtensionQueryOptions.skip + package: botbuilder + summary: Number of entities to skip + fullName: skip + remarks: '' + isDeprecated: false + syntax: + content: 'skip?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResponse.yml new file mode 100644 index 00000000..3b905e94 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResponse.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MessagingExtensionResponse +uid: botbuilder.MessagingExtensionResponse +package: botbuilder +summary: '' +fullName: MessagingExtensionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder.MessagingExtensionResponse.cacheInfo + package: botbuilder + summary: The cache info for this response + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: composeExtension + uid: botbuilder.MessagingExtensionResponse.composeExtension + package: botbuilder + summary: '' + fullName: composeExtension + remarks: '' + isDeprecated: false + syntax: + content: 'composeExtension?: MessagingExtensionResult' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResult.yml new file mode 100644 index 00000000..d05e7fb7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResult.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: MessagingExtensionResult +uid: botbuilder.MessagingExtensionResult +package: botbuilder +summary: '' +fullName: MessagingExtensionResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityPreview + uid: botbuilder.MessagingExtensionResult.activityPreview + package: botbuilder + summary: (Only when type is botMessagePreview) + fullName: activityPreview + remarks: '' + isDeprecated: false + syntax: + content: 'activityPreview?: Activity' + return: + description: '' + type: + - name: attachmentLayout + uid: botbuilder.MessagingExtensionResult.attachmentLayout + package: botbuilder + summary: Hint for how to deal with + fullName: attachmentLayout + remarks: '' + isDeprecated: false + syntax: + content: 'attachmentLayout?: AttachmentLayout' + return: + description: '' + type: + - name: attachments + uid: botbuilder.MessagingExtensionResult.attachments + package: botbuilder + summary: (Only when type is + fullName: attachments + remarks: '' + isDeprecated: false + syntax: + content: 'attachments?: MessagingExtensionAttachment[]' + return: + description: '' + type: [] + - name: suggestedActions + uid: botbuilder.MessagingExtensionResult.suggestedActions + package: botbuilder + summary: '' + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: MessagingExtensionSuggestedAction' + return: + description: '' + type: + - name: text + uid: botbuilder.MessagingExtensionResult.text + package: botbuilder + summary: (Only when type is message) Text + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.MessagingExtensionResult.type + package: botbuilder + summary: 'The type of the result. Possible values include:' + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: MessagingExtensionResultType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResultType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResultType.yml new file mode 100644 index 00000000..94b00b45 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionResultType.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: MessagingExtensionResultType +uid: botbuilder.MessagingExtensionResultType +package: botbuilder +summary: >- + Defines values for MessagingExtensionResultType. + + Possible values include: 'result', 'auth', 'config', 'message', + 'botMessagePreview', 'silentAuth'. +fullName: MessagingExtensionResultType +remarks: '' +isDeprecated: false +syntax: | + type MessagingExtensionResultType = + | "result" + | "auth" + | "config" + | "message" + | "botMessagePreview" + | "silentAuth" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionSuggestedAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionSuggestedAction.yml new file mode 100644 index 00000000..9be7a57d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MessagingExtensionSuggestedAction.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MessagingExtensionSuggestedAction +uid: botbuilder.MessagingExtensionSuggestedAction +package: botbuilder +summary: '' +fullName: MessagingExtensionSuggestedAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder.MessagingExtensionSuggestedAction.actions + package: botbuilder + summary: Actions + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions?: CardAction[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MicrosoftPayMethodData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MicrosoftPayMethodData.yml new file mode 100644 index 00000000..113a2fc7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MicrosoftPayMethodData.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: MicrosoftPayMethodData +uid: botbuilder.MicrosoftPayMethodData +package: botbuilder +summary: W3C Payment Method Data for Microsoft Pay +fullName: MicrosoftPayMethodData +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: merchantId + uid: botbuilder.MicrosoftPayMethodData.merchantId + package: botbuilder + summary: Microsoft Pay Merchant ID + fullName: merchantId + remarks: '' + isDeprecated: false + syntax: + content: 'merchantId: string' + return: + description: '' + type: string + - name: supportedNetworks + uid: botbuilder.MicrosoftPayMethodData.supportedNetworks + package: botbuilder + summary: Supported payment networks (e.g., "visa" and "mastercard") + fullName: supportedNetworks + remarks: '' + isDeprecated: false + syntax: + content: 'supportedNetworks: string[]' + return: + description: '' + type: string[] + - name: supportedTypes + uid: botbuilder.MicrosoftPayMethodData.supportedTypes + package: botbuilder + summary: Supported payment types (e.g., "credit") + fullName: supportedTypes + remarks: '' + isDeprecated: false + syntax: + content: 'supportedTypes: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Middleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Middleware.yml new file mode 100644 index 00000000..73190fb7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Middleware.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Middleware +uid: botbuilder.Middleware +package: botbuilder +summary: Interface implemented by object based middleware. +fullName: Middleware +remarks: '' +isDeprecated: false +type: interface +methods: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.Middleware.onTurn + package: botbuilder + summary: Called each time the bot receives a new request. + remarks: >- + Calling `await next();` will cause execution to continue to either the + next piece of + + middleware in the chain or the bots main logic if you are the last piece + of middleware. + + + Your middleware should perform its business logic before and/or after the + call to `next()`. + + You can short-circuit further execution of the turn by omitting the call + to `next()`. + + + The following example shows a simple piece of logging middleware: + + + ```JavaScript + + class MyLogger { + async onTurn(context, next) { + console.log(`Leading Edge`); + await next(); + console.log(`Trailing Edge`); + } + } + + ``` + isDeprecated: false + syntax: + content: >- + function onTurn(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: next + type: () => Promise<void> + description: >- + Function to call to continue execution to the next step in the + middleware chain. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareHandler.yml new file mode 100644 index 00000000..e5f79e96 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareHandler.yml @@ -0,0 +1,22 @@ +### YamlMime:TSTypeAlias +name: MiddlewareHandler +uid: botbuilder.MiddlewareHandler +package: botbuilder +summary: >- + Signature implemented by function based middleware. + + + ```TypeScript + + type MiddlewareHandler = (context: TurnContext, next: () => Promise) => + Promise; + + ``` +fullName: MiddlewareHandler +remarks: '' +isDeprecated: false +syntax: | + type MiddlewareHandler = ( + context: TurnContext, + next: () => Promise + ) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareSet.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareSet.yml new file mode 100644 index 00000000..891a6151 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/MiddlewareSet.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: MiddlewareSet +uid: botbuilder.MiddlewareSet +package: botbuilder +summary: A set of `Middleware` plugins. +fullName: MiddlewareSet +remarks: >- + The set itself is middleware so you can easily package up a set of middleware + that can be composed + + into an adapter with a single `adapter.use(mySet)` call or even into another + middleware set using + + `set.use(mySet)`. + + + ```JavaScript + + const { MiddlewareSet } = require('botbuilder'); + + + const set = new MiddlewareSet(); + + set.use(async (context, next) => { + console.log(`Leading Edge`); + await next(); + console.log(`Trailing Edge`); + }); + + ``` +isDeprecated: false +type: class +constructors: + - name: MiddlewareSet((MiddlewareHandler | Middleware)[]) + uid: botbuilder.MiddlewareSet.constructor + package: botbuilder + summary: Creates a new MiddlewareSet instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new MiddlewareSet(middlewares: (MiddlewareHandler | Middleware)[])' + parameters: + - id: middlewares + type: >- + ( | )[] + description: One or more middleware handlers(s) to register. +methods: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.MiddlewareSet.onTurn + package: botbuilder + summary: Processes an incoming activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) object for this + turn. + - id: next + type: () => Promise<void> + description: Delegate to call to continue the bot middleware pipeline. + return: + description: A Promise representing the async operation. + type: Promise<void> + - name: run(TurnContext, () => Promise) + uid: botbuilder.MiddlewareSet.run + package: botbuilder + summary: Executes a set of middleware in series. + remarks: '' + isDeprecated: false + syntax: + content: >- + function run(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: next + type: () => Promise<void> + description: Function to invoke at the end of the middleware chain. + return: + description: A promise that resolves after the handler chain is complete. + type: Promise<void> + - name: use((MiddlewareHandler | Middleware)[]) + uid: botbuilder.MiddlewareSet.use + package: botbuilder + summary: Registers middleware handlers(s) with the set. + remarks: |- + This example adds a new piece of middleware to a set: + ```JavaScript + set.use(async (context, next) => { + console.log(`Leading Edge`); + await next(); + console.log(`Trailing Edge`); + }); + ``` + isDeprecated: false + syntax: + content: >- + function use(middlewares: (MiddlewareHandler | Middleware)[]): + MiddlewareSet + parameters: + - id: middlewares + type: >- + ( | )[] + description: One or more middleware handlers(s) to register. + return: + description: The updated middleware set. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/NoOpHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/NoOpHandleActionResponse.yml new file mode 100644 index 00000000..057df8e6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/NoOpHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: NoOpHandleActionResponse +uid: botbuilder.NoOpHandleActionResponse +package: botbuilder +summary: The handle action response for no op. +fullName: NoOpHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder.NoOpHandleActionResponse.renderArguments + package: botbuilder + summary: No op doesn't have render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments?: undefined' + return: + description: '' + type: undefined + - name: responseType + uid: botbuilder.NoOpHandleActionResponse.responseType + package: botbuilder + summary: No op. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "NoOp"' + return: + description: '' + type: '"NoOp"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/NotificationInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/NotificationInfo.yml new file mode 100644 index 00000000..37bc9157 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/NotificationInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: NotificationInfo +uid: botbuilder.NotificationInfo +package: botbuilder +summary: '' +fullName: NotificationInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alert + uid: botbuilder.NotificationInfo.alert + package: botbuilder + summary: true if notification is to be sent to the user, + fullName: alert + remarks: '' + isDeprecated: false + syntax: + content: 'alert?: boolean' + return: + description: '' + type: boolean + - name: alertInMeeting + uid: botbuilder.NotificationInfo.alertInMeeting + package: botbuilder + summary: true if a notification is to be shown to the user while in a meeting, + fullName: alertInMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'alertInMeeting?: boolean' + return: + description: '' + type: boolean + - name: externalResourceUrl + uid: botbuilder.NotificationInfo.externalResourceUrl + package: botbuilder + summary: the value of the notification's external resource url + fullName: externalResourceUrl + remarks: '' + isDeprecated: false + syntax: + content: 'externalResourceUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/NullTelemetryClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/NullTelemetryClient.yml new file mode 100644 index 00000000..9ac7788d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/NullTelemetryClient.yml @@ -0,0 +1,107 @@ +### YamlMime:TSType +name: NullTelemetryClient +uid: botbuilder.NullTelemetryClient +package: botbuilder +summary: >- + A null bot telemetry client that implements + [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient). +fullName: NullTelemetryClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: NullTelemetryClient(any) + uid: botbuilder.NullTelemetryClient.constructor + package: botbuilder + summary: >- + Creates a new instance of the + [NullTelemetryClient](xref:botbuilder-core.NullTelemetryClient) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new NullTelemetryClient(_settings?: any)' + parameters: + - id: _settings + type: any + description: Optional. Settings for the telemetry client. +methods: + - name: flush() + uid: botbuilder.NullTelemetryClient.flush + package: botbuilder + summary: Flushes the in-memory buffer and any metrics being pre-aggregated. + remarks: '' + isDeprecated: false + syntax: + content: function flush() + - name: trackDependency(TelemetryDependency) + uid: botbuilder.NullTelemetryClient.trackDependency + package: botbuilder + summary: >- + Sends information about an external dependency (outgoing call) in the + application. + remarks: '' + isDeprecated: false + syntax: + content: 'function trackDependency(_telemetry: TelemetryDependency)' + parameters: + - id: _telemetry + type: + description: >- + An object implementing + [TelemetryDependency](xref:botbuilder-core.TelemetryDependency). + - name: trackEvent(TelemetryEvent) + uid: botbuilder.NullTelemetryClient.trackEvent + package: botbuilder + summary: Logs custom events with extensible named fields. + remarks: '' + isDeprecated: false + syntax: + content: 'function trackEvent(_telemetry: TelemetryEvent)' + parameters: + - id: _telemetry + type: + description: >- + An object implementing + [TelemetryEvent](xref:botbuilder-core.TelemetryEvent). + - name: trackException(TelemetryException) + uid: botbuilder.NullTelemetryClient.trackException + package: botbuilder + summary: Logs a system exception. + remarks: '' + isDeprecated: false + syntax: + content: 'function trackException(_telemetry: TelemetryException)' + parameters: + - id: _telemetry + type: + description: >- + An object implementing + [TelemetryException](xref:botbuilder-core.TelemetryException). + - name: trackPageView(TelemetryPageView) + uid: botbuilder.NullTelemetryClient.trackPageView + package: botbuilder + summary: Logs an Application Insights page view. + remarks: '' + isDeprecated: false + syntax: + content: 'function trackPageView(_telemetry: TelemetryPageView)' + parameters: + - id: _telemetry + type: + description: >- + An object implementing + [TelemetryPageView](xref:botbuilder-core.TelemetryPageView). + - name: trackTrace(TelemetryTrace) + uid: botbuilder.NullTelemetryClient.trackTrace + package: botbuilder + summary: Sends a trace message. + remarks: '' + isDeprecated: false + syntax: + content: 'function trackTrace(_telemetry: TelemetryTrace)' + parameters: + - id: _telemetry + type: + description: >- + An object implementing + [TelemetryTrace](xref:botbuilder-core.TelemetryTrace). diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCard.yml new file mode 100644 index 00000000..c3b68a3c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: O365ConnectorCard +uid: botbuilder.O365ConnectorCard +package: botbuilder +summary: '' +fullName: O365ConnectorCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: potentialAction + uid: botbuilder.O365ConnectorCard.potentialAction + package: botbuilder + summary: Set of actions + fullName: potentialAction + remarks: '' + isDeprecated: false + syntax: + content: 'potentialAction?: O365ConnectorCardActionBase[]' + return: + description: '' + type: [] + - name: sections + uid: botbuilder.O365ConnectorCard.sections + package: botbuilder + summary: Set of sections for the + fullName: sections + remarks: '' + isDeprecated: false + syntax: + content: 'sections?: O365ConnectorCardSection[]' + return: + description: '' + type: [] + - name: summary + uid: botbuilder.O365ConnectorCard.summary + package: botbuilder + summary: Summary for the card + fullName: summary + remarks: '' + isDeprecated: false + syntax: + content: 'summary?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.O365ConnectorCard.text + package: botbuilder + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: themeColor + uid: botbuilder.O365ConnectorCard.themeColor + package: botbuilder + summary: Theme color for the card + fullName: themeColor + remarks: '' + isDeprecated: false + syntax: + content: 'themeColor?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.O365ConnectorCard.title + package: botbuilder + summary: Title of the item + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionBase.yml new file mode 100644 index 00000000..8261bbdd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionBase.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: O365ConnectorCardActionBase +uid: botbuilder.O365ConnectorCardActionBase +package: botbuilder +summary: '' +fullName: O365ConnectorCardActionBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: '@id' + uid: botbuilder.O365ConnectorCardActionBase.@id + package: botbuilder + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + - name: '@type' + uid: botbuilder.O365ConnectorCardActionBase.@type + package: botbuilder + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + - name: name + uid: botbuilder.O365ConnectorCardActionBase.name + package: botbuilder + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionCard.yml new file mode 100644 index 00000000..ec380e36 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionCard.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: O365ConnectorCardActionCard +uid: botbuilder.O365ConnectorCardActionCard +package: botbuilder +summary: '' +fullName: O365ConnectorCardActionCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder.O365ConnectorCardActionCard.actions + package: botbuilder + summary: Set of actions contained + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions?: O365ConnectorCardActionBase[]' + return: + description: '' + type: [] + - name: inputs + uid: botbuilder.O365ConnectorCardActionCard.inputs + package: botbuilder + summary: Set of inputs contained in + fullName: inputs + remarks: '' + isDeprecated: false + syntax: + content: 'inputs?: O365ConnectorCardInputBase[]' + return: + description: '' + type: [] +inheritedProperties: + - name: '@id' + uid: botbuilder.O365ConnectorCardActionCard.@id + package: botbuilder + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder.O365ConnectorCardActionCard.@type + package: botbuilder + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder.O365ConnectorCardActionCard.name + package: botbuilder + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionQuery.yml new file mode 100644 index 00000000..c7c041a1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionQuery.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardActionQuery +uid: botbuilder.O365ConnectorCardActionQuery +package: botbuilder +summary: '' +fullName: O365ConnectorCardActionQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actionId + uid: botbuilder.O365ConnectorCardActionQuery.actionId + package: botbuilder + summary: Action Id associated with the HttpPOST action + fullName: actionId + remarks: '' + isDeprecated: false + syntax: + content: 'actionId?: string' + return: + description: '' + type: string + - name: body + uid: botbuilder.O365ConnectorCardActionQuery.body + package: botbuilder + summary: The results of body string defined in + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionType.yml new file mode 100644 index 00000000..aa125c80 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardActionType.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: O365ConnectorCardActionType +uid: botbuilder.O365ConnectorCardActionType +package: botbuilder +summary: |- + Defines values for Type. + Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' +fullName: O365ConnectorCardActionType +remarks: '' +isDeprecated: false +syntax: | + type O365ConnectorCardActionType = + | "ViewAction" + | "OpenUri" + | "HttpPOST" + | "ActionCard" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardDateInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardDateInput.yml new file mode 100644 index 00000000..06786c7e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardDateInput.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: O365ConnectorCardDateInput +uid: botbuilder.O365ConnectorCardDateInput +package: botbuilder +summary: '' +fullName: O365ConnectorCardDateInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: includeTime + uid: botbuilder.O365ConnectorCardDateInput.includeTime + package: botbuilder + summary: Include time input field. Default value + fullName: includeTime + remarks: '' + isDeprecated: false + syntax: + content: 'includeTime?: boolean' + return: + description: '' + type: boolean +inheritedProperties: + - name: '@type' + uid: botbuilder.O365ConnectorCardDateInput.@type + package: botbuilder + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.@type](xref:botbuilder.O365ConnectorCardInputBase.@type) + - name: id + uid: botbuilder.O365ConnectorCardDateInput.id + package: botbuilder + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.id](xref:botbuilder.O365ConnectorCardInputBase.id) + - name: isRequired + uid: botbuilder.O365ConnectorCardDateInput.isRequired + package: botbuilder + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.isRequired](xref:botbuilder.O365ConnectorCardInputBase.isRequired) + - name: title + uid: botbuilder.O365ConnectorCardDateInput.title + package: botbuilder + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.title](xref:botbuilder.O365ConnectorCardInputBase.title) + - name: value + uid: botbuilder.O365ConnectorCardDateInput.value + package: botbuilder + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.value](xref:botbuilder.O365ConnectorCardInputBase.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardFact.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardFact.yml new file mode 100644 index 00000000..886f65a1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardFact.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardFact +uid: botbuilder.O365ConnectorCardFact +package: botbuilder +summary: '' +fullName: O365ConnectorCardFact +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.O365ConnectorCardFact.name + package: botbuilder + summary: Display name of the fact + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.O365ConnectorCardFact.value + package: botbuilder + summary: Display value for the fact + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardHttpPOST.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardHttpPOST.yml new file mode 100644 index 00000000..8b12ede0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardHttpPOST.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: O365ConnectorCardHttpPOST +uid: botbuilder.O365ConnectorCardHttpPOST +package: botbuilder +summary: '' +fullName: O365ConnectorCardHttpPOST +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.O365ConnectorCardHttpPOST.body + package: botbuilder + summary: Content to be posted back to bots via invoke + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: string' + return: + description: '' + type: string +inheritedProperties: + - name: '@id' + uid: botbuilder.O365ConnectorCardHttpPOST.@id + package: botbuilder + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder.O365ConnectorCardHttpPOST.@type + package: botbuilder + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder.O365ConnectorCardHttpPOST.name + package: botbuilder + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardImage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardImage.yml new file mode 100644 index 00000000..7d58b17c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardImage.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardImage +uid: botbuilder.O365ConnectorCardImage +package: botbuilder +summary: '' +fullName: O365ConnectorCardImage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: image + uid: botbuilder.O365ConnectorCardImage.image + package: botbuilder + summary: URL for the image + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.O365ConnectorCardImage.title + package: botbuilder + summary: Alternative text for the image + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBase.yml new file mode 100644 index 00000000..3876f32b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBase.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: O365ConnectorCardInputBase +uid: botbuilder.O365ConnectorCardInputBase +package: botbuilder +summary: '' +fullName: O365ConnectorCardInputBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: '@type' + uid: botbuilder.O365ConnectorCardInputBase.@type + package: botbuilder + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + - name: id + uid: botbuilder.O365ConnectorCardInputBase.id + package: botbuilder + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: isRequired + uid: botbuilder.O365ConnectorCardInputBase.isRequired + package: botbuilder + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + - name: title + uid: botbuilder.O365ConnectorCardInputBase.title + package: botbuilder + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.O365ConnectorCardInputBase.value + package: botbuilder + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBaseType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBaseType.yml new file mode 100644 index 00000000..cfe350cb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputBaseType.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: O365ConnectorCardInputBaseType +uid: botbuilder.O365ConnectorCardInputBaseType +package: botbuilder +summary: |- + Defines values for O365ConnectorCardInputBaseType. + Possible values include: 'textInput', 'dateInput', 'multichoiceInput' +fullName: O365ConnectorCardInputBaseType +remarks: '' +isDeprecated: false +syntax: | + type O365ConnectorCardInputBaseType = + | "textInput" + | "dateInput" + | "multichoiceInput" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputType.yml new file mode 100644 index 00000000..0d5d562b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardInputType.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: O365ConnectorCardInputType +uid: botbuilder.O365ConnectorCardInputType +package: botbuilder +summary: |- + Defines values for O365ConnectorCardInputType. + Possible values include: 'textInput', 'dateInput', 'multichoiceInput' +fullName: O365ConnectorCardInputType +remarks: '' +isDeprecated: false +syntax: > + type O365ConnectorCardInputType = "textInput" | "dateInput" | + "multichoiceInput" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInput.yml new file mode 100644 index 00000000..c0d0b90a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInput.yml @@ -0,0 +1,123 @@ +### YamlMime:TSType +name: O365ConnectorCardMultichoiceInput +uid: botbuilder.O365ConnectorCardMultichoiceInput +package: botbuilder +summary: '' +fullName: O365ConnectorCardMultichoiceInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: choices + uid: botbuilder.O365ConnectorCardMultichoiceInput.choices + package: botbuilder + summary: Set of + fullName: choices + remarks: '' + isDeprecated: false + syntax: + content: 'choices?: O365ConnectorCardMultichoiceInputChoice[]' + return: + description: '' + type: [] + - name: isMultiSelect + uid: botbuilder.O365ConnectorCardMultichoiceInput.isMultiSelect + package: botbuilder + summary: Define if this input field allows + fullName: isMultiSelect + remarks: '' + isDeprecated: false + syntax: + content: 'isMultiSelect?: boolean' + return: + description: '' + type: boolean + - name: style + uid: botbuilder.O365ConnectorCardMultichoiceInput.style + package: botbuilder + summary: Choice item rendering style. Default valud is + fullName: style + remarks: '' + isDeprecated: false + syntax: + content: 'style?: Style' + return: + description: '' + type: +inheritedProperties: + - name: '@type' + uid: botbuilder.O365ConnectorCardMultichoiceInput.@type + package: botbuilder + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.@type](xref:botbuilder.O365ConnectorCardInputBase.@type) + - name: id + uid: botbuilder.O365ConnectorCardMultichoiceInput.id + package: botbuilder + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.id](xref:botbuilder.O365ConnectorCardInputBase.id) + - name: isRequired + uid: botbuilder.O365ConnectorCardMultichoiceInput.isRequired + package: botbuilder + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.isRequired](xref:botbuilder.O365ConnectorCardInputBase.isRequired) + - name: title + uid: botbuilder.O365ConnectorCardMultichoiceInput.title + package: botbuilder + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.title](xref:botbuilder.O365ConnectorCardInputBase.title) + - name: value + uid: botbuilder.O365ConnectorCardMultichoiceInput.value + package: botbuilder + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.value](xref:botbuilder.O365ConnectorCardInputBase.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInputChoice.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInputChoice.yml new file mode 100644 index 00000000..f4fe715a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardMultichoiceInputChoice.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardMultichoiceInputChoice +uid: botbuilder.O365ConnectorCardMultichoiceInputChoice +package: botbuilder +summary: '' +fullName: O365ConnectorCardMultichoiceInputChoice +remarks: '' +isDeprecated: false +type: interface +properties: + - name: display + uid: botbuilder.O365ConnectorCardMultichoiceInputChoice.display + package: botbuilder + summary: The text rednered on ActionCard. + fullName: display + remarks: '' + isDeprecated: false + syntax: + content: 'display?: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.O365ConnectorCardMultichoiceInputChoice.value + package: botbuilder + summary: The value received as results. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUri.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUri.yml new file mode 100644 index 00000000..664efc82 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUri.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: O365ConnectorCardOpenUri +uid: botbuilder.O365ConnectorCardOpenUri +package: botbuilder +summary: '' +fullName: O365ConnectorCardOpenUri +remarks: '' +isDeprecated: false +type: interface +properties: + - name: targets + uid: botbuilder.O365ConnectorCardOpenUri.targets + package: botbuilder + summary: Target os / urls + fullName: targets + remarks: '' + isDeprecated: false + syntax: + content: 'targets?: O365ConnectorCardOpenUriTarget[]' + return: + description: '' + type: [] +inheritedProperties: + - name: '@id' + uid: botbuilder.O365ConnectorCardOpenUri.@id + package: botbuilder + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder.O365ConnectorCardOpenUri.@type + package: botbuilder + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder.O365ConnectorCardOpenUri.name + package: botbuilder + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUriTarget.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUriTarget.yml new file mode 100644 index 00000000..ea7d6ff0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardOpenUriTarget.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: O365ConnectorCardOpenUriTarget +uid: botbuilder.O365ConnectorCardOpenUriTarget +package: botbuilder +summary: '' +fullName: O365ConnectorCardOpenUriTarget +remarks: '' +isDeprecated: false +type: interface +properties: + - name: os + uid: botbuilder.O365ConnectorCardOpenUriTarget.os + package: botbuilder + summary: 'Target operating system. Possible values include:' + fullName: os + remarks: '' + isDeprecated: false + syntax: + content: 'os?: Os' + return: + description: '' + type: + - name: uri + uid: botbuilder.O365ConnectorCardOpenUriTarget.uri + package: botbuilder + summary: Target url + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardSection.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardSection.yml new file mode 100644 index 00000000..48d87673 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardSection.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: O365ConnectorCardSection +uid: botbuilder.O365ConnectorCardSection +package: botbuilder +summary: '' +fullName: O365ConnectorCardSection +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activityImage + uid: botbuilder.O365ConnectorCardSection.activityImage + package: botbuilder + summary: Activity image + fullName: activityImage + remarks: '' + isDeprecated: false + syntax: + content: 'activityImage?: string' + return: + description: '' + type: string + - name: activityImageType + uid: botbuilder.O365ConnectorCardSection.activityImageType + package: botbuilder + summary: Describes how Activity + fullName: activityImageType + remarks: '' + isDeprecated: false + syntax: + content: 'activityImageType?: ActivityImageType' + return: + description: '' + type: + - name: activitySubtitle + uid: botbuilder.O365ConnectorCardSection.activitySubtitle + package: botbuilder + summary: Activity subtitle + fullName: activitySubtitle + remarks: '' + isDeprecated: false + syntax: + content: 'activitySubtitle?: string' + return: + description: '' + type: string + - name: activityText + uid: botbuilder.O365ConnectorCardSection.activityText + package: botbuilder + summary: Activity text + fullName: activityText + remarks: '' + isDeprecated: false + syntax: + content: 'activityText?: string' + return: + description: '' + type: string + - name: activityTitle + uid: botbuilder.O365ConnectorCardSection.activityTitle + package: botbuilder + summary: Activity title + fullName: activityTitle + remarks: '' + isDeprecated: false + syntax: + content: 'activityTitle?: string' + return: + description: '' + type: string + - name: facts + uid: botbuilder.O365ConnectorCardSection.facts + package: botbuilder + summary: Set of facts for the current + fullName: facts + remarks: '' + isDeprecated: false + syntax: + content: 'facts?: O365ConnectorCardFact[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder.O365ConnectorCardSection.images + package: botbuilder + summary: Set of images for the current + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images?: O365ConnectorCardImage[]' + return: + description: '' + type: [] + - name: markdown + uid: botbuilder.O365ConnectorCardSection.markdown + package: botbuilder + summary: Use markdown for all text contents. Default + fullName: markdown + remarks: '' + isDeprecated: false + syntax: + content: 'markdown?: boolean' + return: + description: '' + type: boolean + - name: potentialAction + uid: botbuilder.O365ConnectorCardSection.potentialAction + package: botbuilder + summary: Set of actions + fullName: potentialAction + remarks: '' + isDeprecated: false + syntax: + content: 'potentialAction?: O365ConnectorCardActionBase[]' + return: + description: '' + type: [] + - name: text + uid: botbuilder.O365ConnectorCardSection.text + package: botbuilder + summary: Text for the section + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.O365ConnectorCardSection.title + package: botbuilder + summary: Title of the section + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardTextInput.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardTextInput.yml new file mode 100644 index 00000000..9ee47632 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardTextInput.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: O365ConnectorCardTextInput +uid: botbuilder.O365ConnectorCardTextInput +package: botbuilder +summary: '' +fullName: O365ConnectorCardTextInput +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isMultiline + uid: botbuilder.O365ConnectorCardTextInput.isMultiline + package: botbuilder + summary: Define if text input is allowed for + fullName: isMultiline + remarks: '' + isDeprecated: false + syntax: + content: 'isMultiline?: boolean' + return: + description: '' + type: boolean + - name: maxLength + uid: botbuilder.O365ConnectorCardTextInput.maxLength + package: botbuilder + summary: Maximum length of text input. Default value + fullName: maxLength + remarks: '' + isDeprecated: false + syntax: + content: 'maxLength?: number' + return: + description: '' + type: number +inheritedProperties: + - name: '@type' + uid: botbuilder.O365ConnectorCardTextInput.@type + package: botbuilder + summary: 'Input type name. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardInputType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.@type](xref:botbuilder.O365ConnectorCardInputBase.@type) + - name: id + uid: botbuilder.O365ConnectorCardTextInput.id + package: botbuilder + summary: Input Id. It must be unique per entire O365 + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.id](xref:botbuilder.O365ConnectorCardInputBase.id) + - name: isRequired + uid: botbuilder.O365ConnectorCardTextInput.isRequired + package: botbuilder + summary: Define if this input is a required field. + fullName: isRequired + remarks: '' + isDeprecated: false + syntax: + content: 'isRequired?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.isRequired](xref:botbuilder.O365ConnectorCardInputBase.isRequired) + - name: title + uid: botbuilder.O365ConnectorCardTextInput.title + package: botbuilder + summary: Input title that will be shown as the placeholder + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.title](xref:botbuilder.O365ConnectorCardInputBase.title) + - name: value + uid: botbuilder.O365ConnectorCardTextInput.value + package: botbuilder + summary: Default value for this input field + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardInputBase.value](xref:botbuilder.O365ConnectorCardInputBase.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardViewAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardViewAction.yml new file mode 100644 index 00000000..fc65f96b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/O365ConnectorCardViewAction.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: O365ConnectorCardViewAction +uid: botbuilder.O365ConnectorCardViewAction +package: botbuilder +summary: '' +fullName: O365ConnectorCardViewAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: target + uid: botbuilder.O365ConnectorCardViewAction.target + package: botbuilder + summary: Target urls, only the first url effective for + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target?: string[]' + return: + description: '' + type: string[] +inheritedProperties: + - name: '@id' + uid: botbuilder.O365ConnectorCardViewAction.@id + package: botbuilder + summary: Action Id + fullName: '@id' + remarks: '' + isDeprecated: false + syntax: + content: '@id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@id](xref:botbuilder.O365ConnectorCardActionBase.@id) + - name: '@type' + uid: botbuilder.O365ConnectorCardViewAction.@type + package: botbuilder + summary: 'Type of the action. Possible values include:' + fullName: '@type' + remarks: '' + isDeprecated: false + syntax: + content: '@type?: O365ConnectorCardActionType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.@type](xref:botbuilder.O365ConnectorCardActionBase.@type) + - name: name + uid: botbuilder.O365ConnectorCardViewAction.name + package: botbuilder + summary: Name of the action that will be used as button + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [O365ConnectorCardActionBase.name](xref:botbuilder.O365ConnectorCardActionBase.name) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/OAuthCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/OAuthCard.yml new file mode 100644 index 00000000..c5411264 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/OAuthCard.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: OAuthCard +uid: botbuilder.OAuthCard +package: botbuilder +summary: A card representing a request to perform a sign in via OAuth +fullName: OAuthCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder.OAuthCard.buttons + package: botbuilder + summary: Action to use to perform signin + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: connectionName + uid: botbuilder.OAuthCard.connectionName + package: botbuilder + summary: The name of the registered connection + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.OAuthCard.text + package: botbuilder + summary: Text for signin request + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: tokenExchangeResource + uid: botbuilder.OAuthCard.tokenExchangeResource + package: botbuilder + summary: The token exchange resource for single sign on + fullName: tokenExchangeResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenExchangeResource: TokenExchangeResource' + return: + description: '' + type: + - name: tokenPostResource + uid: botbuilder.OAuthCard.tokenPostResource + package: botbuilder + summary: The token for directly post a token to token service + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource: TokenPostResource' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/OnBehalfOf.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/OnBehalfOf.yml new file mode 100644 index 00000000..8ef30b94 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/OnBehalfOf.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: OnBehalfOf +uid: botbuilder.OnBehalfOf +package: botbuilder +summary: '' +fullName: OnBehalfOf +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayName + uid: botbuilder.OnBehalfOf.displayName + package: botbuilder + summary: The of the person. + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: itemid + uid: botbuilder.OnBehalfOf.itemid + package: botbuilder + summary: The id of the item. + fullName: itemid + remarks: '' + isDeprecated: false + syntax: + content: 'itemid: number' + return: + description: '' + type: number + - name: mentionType + uid: botbuilder.OnBehalfOf.mentionType + package: botbuilder + summary: The mention type of a "person". + fullName: mentionType + remarks: '' + isDeprecated: false + syntax: + content: 'mentionType: string' + return: + description: '' + type: string + - name: mri + uid: botbuilder.OnBehalfOf.mri + package: botbuilder + summary: Ther user MRI of the sender. + fullName: mri + remarks: '' + isDeprecated: false + syntax: + content: 'mri: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/OnCardSelectionAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/OnCardSelectionAction.yml new file mode 100644 index 00000000..4b27a695 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/OnCardSelectionAction.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: OnCardSelectionAction +uid: botbuilder.OnCardSelectionAction +package: botbuilder +summary: Type of handler for when a card is selected. +fullName: OnCardSelectionAction +remarks: '' +isDeprecated: false +syntax: | + type OnCardSelectionAction = + | QuickViewCardAction + | ExternalLinkCardAction + | SelectMediaCardAction + | GetLocationCardAction + | ShowLocationCardAction + | ExecuteCardAction + | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Os.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Os.yml new file mode 100644 index 00000000..4cc0e56e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Os.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Os +uid: botbuilder.Os +package: botbuilder +summary: |- + Defines values for Os. + Possible values include: 'default', 'iOS', 'android', 'windows' +fullName: Os +remarks: '' +isDeprecated: false +syntax: | + type Os = "default" | "iOS" | "android" | "windows" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PagedMembersResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PagedMembersResult.yml new file mode 100644 index 00000000..ab69935c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PagedMembersResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PagedMembersResult +uid: botbuilder.PagedMembersResult +package: botbuilder +summary: Page of members. +fullName: PagedMembersResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder.PagedMembersResult.continuationToken + package: botbuilder + summary: Paging token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: members + uid: botbuilder.PagedMembersResult.members + package: botbuilder + summary: The Channel Accounts. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: ChannelAccount[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PagedResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PagedResult.yml new file mode 100644 index 00000000..998328e5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PagedResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PagedResult +uid: botbuilder.PagedResult +package: botbuilder +summary: Page of results. +fullName: PagedResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder.PagedResult.continuationToken + package: botbuilder + summary: Token used to page through multiple pages. + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: items + uid: botbuilder.PagedResult.items + package: botbuilder + summary: Page of items. + fullName: items + remarks: '' + isDeprecated: false + syntax: + content: 'items: T[]' + return: + description: '' + type: T[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentAddress.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentAddress.yml new file mode 100644 index 00000000..e6763d3d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentAddress.yml @@ -0,0 +1,164 @@ +### YamlMime:TSType +name: PaymentAddress +uid: botbuilder.PaymentAddress +package: botbuilder +summary: Address within a Payment Request +fullName: PaymentAddress +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: addressLine + uid: botbuilder.PaymentAddress.addressLine + package: botbuilder + summary: >- + This is the most specific part of the address. It can include, for + example, a street name, a + + house number, apartment number, a rural delivery route, descriptive + instructions, or a post + + office box number. + fullName: addressLine + remarks: '' + isDeprecated: false + syntax: + content: 'addressLine: string[]' + return: + description: '' + type: string[] + - name: city + uid: botbuilder.PaymentAddress.city + package: botbuilder + summary: This is the city/town portion of the address. + fullName: city + remarks: '' + isDeprecated: false + syntax: + content: 'city: string' + return: + description: '' + type: string + - name: country + uid: botbuilder.PaymentAddress.country + package: botbuilder + summary: >- + This is the CLDR (Common Locale Data Repository) region code. For example, + US, GB, CN, or JP + fullName: country + remarks: '' + isDeprecated: false + syntax: + content: 'country: string' + return: + description: '' + type: string + - name: dependentLocality + uid: botbuilder.PaymentAddress.dependentLocality + package: botbuilder + summary: >- + This is the dependent locality or sublocality within a city. For example, + used for + + neighborhoods, boroughs, districts, or UK dependent localities. + fullName: dependentLocality + remarks: '' + isDeprecated: false + syntax: + content: 'dependentLocality: string' + return: + description: '' + type: string + - name: languageCode + uid: botbuilder.PaymentAddress.languageCode + package: botbuilder + summary: >- + This is the BCP-47 language code for the address. It's used to determine + the field separators + + and the order of fields when formatting the address for display. + fullName: languageCode + remarks: '' + isDeprecated: false + syntax: + content: 'languageCode: string' + return: + description: '' + type: string + - name: organization + uid: botbuilder.PaymentAddress.organization + package: botbuilder + summary: This is the organization, firm, company, or institution at this address. + fullName: organization + remarks: '' + isDeprecated: false + syntax: + content: 'organization: string' + return: + description: '' + type: string + - name: phone + uid: botbuilder.PaymentAddress.phone + package: botbuilder + summary: This is the phone number of the recipient or contact person. + fullName: phone + remarks: '' + isDeprecated: false + syntax: + content: 'phone: string' + return: + description: '' + type: string + - name: postalCode + uid: botbuilder.PaymentAddress.postalCode + package: botbuilder + summary: This is the postal code or ZIP code, also known as PIN code in India. + fullName: postalCode + remarks: '' + isDeprecated: false + syntax: + content: 'postalCode: string' + return: + description: '' + type: string + - name: recipient + uid: botbuilder.PaymentAddress.recipient + package: botbuilder + summary: This is the name of the recipient or contact person. + fullName: recipient + remarks: '' + isDeprecated: false + syntax: + content: 'recipient: string' + return: + description: '' + type: string + - name: region + uid: botbuilder.PaymentAddress.region + package: botbuilder + summary: >- + This is the top level administrative subdivision of the country. For + example, this can be a + + state, a province, an oblast, or a prefecture. + fullName: region + remarks: '' + isDeprecated: false + syntax: + content: 'region: string' + return: + description: '' + type: string + - name: sortingCode + uid: botbuilder.PaymentAddress.sortingCode + package: botbuilder + summary: This is the sorting code as used in, for example, France. + fullName: sortingCode + remarks: '' + isDeprecated: false + syntax: + content: 'sortingCode: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentCurrencyAmount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentCurrencyAmount.yml new file mode 100644 index 00000000..a441e7df --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentCurrencyAmount.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentCurrencyAmount +uid: botbuilder.PaymentCurrencyAmount +package: botbuilder +summary: Supplies monetary amounts +fullName: PaymentCurrencyAmount +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: currency + uid: botbuilder.PaymentCurrencyAmount.currency + package: botbuilder + summary: A currency identifier + fullName: currency + remarks: '' + isDeprecated: false + syntax: + content: 'currency: string' + return: + description: '' + type: string + - name: currencySystem + uid: botbuilder.PaymentCurrencyAmount.currencySystem + package: botbuilder + summary: Currency system + fullName: currencySystem + remarks: '' + isDeprecated: false + syntax: + content: 'currencySystem: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.PaymentCurrencyAmount.value + package: botbuilder + summary: Decimal monetary value + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetails.yml new file mode 100644 index 00000000..b2afd067 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetails.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: PaymentDetails +uid: botbuilder.PaymentDetails +package: botbuilder +summary: Provides information about the requested transaction +fullName: PaymentDetails +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: displayItems + uid: botbuilder.PaymentDetails.displayItems + package: botbuilder + summary: >- + Contains line items for the payment request that the user agent may + display + fullName: displayItems + remarks: '' + isDeprecated: false + syntax: + content: 'displayItems: PaymentItem[]' + return: + description: '' + type: [] + - name: error + uid: botbuilder.PaymentDetails.error + package: botbuilder + summary: Error description + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: string' + return: + description: '' + type: string + - name: modifiers + uid: botbuilder.PaymentDetails.modifiers + package: botbuilder + summary: Contains modifiers for particular payment method identifiers + fullName: modifiers + remarks: '' + isDeprecated: false + syntax: + content: 'modifiers: PaymentDetailsModifier[]' + return: + description: '' + type: [] + - name: shippingOptions + uid: botbuilder.PaymentDetails.shippingOptions + package: botbuilder + summary: >- + A sequence containing the different shipping options for the user to + choose from + fullName: shippingOptions + remarks: '' + isDeprecated: false + syntax: + content: 'shippingOptions: PaymentShippingOption[]' + return: + description: '' + type: [] + - name: total + uid: botbuilder.PaymentDetails.total + package: botbuilder + summary: Contains the total amount of the payment request + fullName: total + remarks: '' + isDeprecated: false + syntax: + content: 'total: PaymentItem' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetailsModifier.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetailsModifier.yml new file mode 100644 index 00000000..5f96eef5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentDetailsModifier.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: PaymentDetailsModifier +uid: botbuilder.PaymentDetailsModifier +package: botbuilder +summary: >- + Provides details that modify the PaymentDetails based on payment method + identifier +fullName: PaymentDetailsModifier +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: additionalDisplayItems + uid: botbuilder.PaymentDetailsModifier.additionalDisplayItems + package: botbuilder + summary: >- + Provides additional display items that are appended to the displayItems + field in the + + PaymentDetails dictionary for the payment method identifiers in the + supportedMethods field + fullName: additionalDisplayItems + remarks: '' + isDeprecated: false + syntax: + content: 'additionalDisplayItems: PaymentItem[]' + return: + description: '' + type: [] + - name: data + uid: botbuilder.PaymentDetailsModifier.data + package: botbuilder + summary: >- + A JSON-serializable object that provides optional information that might + be needed by the + + supported payment methods + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: any' + return: + description: '' + type: any + - name: supportedMethods + uid: botbuilder.PaymentDetailsModifier.supportedMethods + package: botbuilder + summary: Contains a sequence of payment method identifiers + fullName: supportedMethods + remarks: '' + isDeprecated: false + syntax: + content: 'supportedMethods: string[]' + return: + description: '' + type: string[] + - name: total + uid: botbuilder.PaymentDetailsModifier.total + package: botbuilder + summary: >- + This value overrides the total field in the PaymentDetails dictionary for + the payment method + + identifiers in the supportedMethods field + fullName: total + remarks: '' + isDeprecated: false + syntax: + content: 'total: PaymentItem' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentItem.yml new file mode 100644 index 00000000..e64bc612 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentItem.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentItem +uid: botbuilder.PaymentItem +package: botbuilder +summary: Indicates what the payment request is for and the value asked for +fullName: PaymentItem +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: amount + uid: botbuilder.PaymentItem.amount + package: botbuilder + summary: Monetary amount for the item + fullName: amount + remarks: '' + isDeprecated: false + syntax: + content: 'amount: PaymentCurrencyAmount' + return: + description: '' + type: + - name: label + uid: botbuilder.PaymentItem.label + package: botbuilder + summary: Human-readable description of the item + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: pending + uid: botbuilder.PaymentItem.pending + package: botbuilder + summary: When set to true this flag means that the amount field is not final. + fullName: pending + remarks: '' + isDeprecated: false + syntax: + content: 'pending: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentMethodData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentMethodData.yml new file mode 100644 index 00000000..886c32c3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentMethodData.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentMethodData +uid: botbuilder.PaymentMethodData +package: botbuilder +summary: >- + Indicates a set of supported payment methods and any associated payment method + specific data for + + those methods +fullName: PaymentMethodData +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: data + uid: botbuilder.PaymentMethodData.data + package: botbuilder + summary: >- + A JSON-serializable object that provides optional information that might + be needed by the + + supported payment methods + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: any' + return: + description: '' + type: any + - name: supportedMethods + uid: botbuilder.PaymentMethodData.supportedMethods + package: botbuilder + summary: >- + Required sequence of strings containing payment method identifiers for + payment methods that + + the merchant web site accepts + fullName: supportedMethods + remarks: '' + isDeprecated: false + syntax: + content: 'supportedMethods: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentOptions.yml new file mode 100644 index 00000000..871ec8c7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentOptions.yml @@ -0,0 +1,92 @@ +### YamlMime:TSType +name: PaymentOptions +uid: botbuilder.PaymentOptions +package: botbuilder +summary: Provides information about the options desired for the payment request +fullName: PaymentOptions +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: requestPayerEmail + uid: botbuilder.PaymentOptions.requestPayerEmail + package: botbuilder + summary: >- + Indicates whether the user agent should collect and return the payer's + email address as part + + of the payment request + fullName: requestPayerEmail + remarks: '' + isDeprecated: false + syntax: + content: 'requestPayerEmail: boolean' + return: + description: '' + type: boolean + - name: requestPayerName + uid: botbuilder.PaymentOptions.requestPayerName + package: botbuilder + summary: >- + Indicates whether the user agent should collect and return the payer's + name as part of the + + payment request + fullName: requestPayerName + remarks: '' + isDeprecated: false + syntax: + content: 'requestPayerName: boolean' + return: + description: '' + type: boolean + - name: requestPayerPhone + uid: botbuilder.PaymentOptions.requestPayerPhone + package: botbuilder + summary: >- + Indicates whether the user agent should collect and return the payer's + phone number as part of + + the payment request + fullName: requestPayerPhone + remarks: '' + isDeprecated: false + syntax: + content: 'requestPayerPhone: boolean' + return: + description: '' + type: boolean + - name: requestShipping + uid: botbuilder.PaymentOptions.requestShipping + package: botbuilder + summary: >- + Indicates whether the user agent should collect and return a shipping + address as part of the + + payment request + fullName: requestShipping + remarks: '' + isDeprecated: false + syntax: + content: 'requestShipping: boolean' + return: + description: '' + type: boolean + - name: shippingType + uid: botbuilder.PaymentOptions.shippingType + package: botbuilder + summary: >- + If requestShipping is set to true, then the shippingType field may be used + to influence the + + way the user agent presents the user interface for gathering the shipping + address + fullName: shippingType + remarks: '' + isDeprecated: false + syntax: + content: 'shippingType: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequest.yml new file mode 100644 index 00000000..2223cd21 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequest.yml @@ -0,0 +1,71 @@ +### YamlMime:TSType +name: PaymentRequest +uid: botbuilder.PaymentRequest +package: botbuilder +summary: A request to make a payment +fullName: PaymentRequest +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder.PaymentRequest.details + package: botbuilder + summary: Details for this request + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: PaymentDetails' + return: + description: '' + type: + - name: expires + uid: botbuilder.PaymentRequest.expires + package: botbuilder + summary: Expiration for this request, in ISO 8601 duration format (e.g., 'P1D') + fullName: expires + remarks: '' + isDeprecated: false + syntax: + content: 'expires: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.PaymentRequest.id + package: botbuilder + summary: ID of this payment request + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: methodData + uid: botbuilder.PaymentRequest.methodData + package: botbuilder + summary: Allowed payment methods for this request + fullName: methodData + remarks: '' + isDeprecated: false + syntax: + content: 'methodData: PaymentMethodData[]' + return: + description: '' + type: [] + - name: options + uid: botbuilder.PaymentRequest.options + package: botbuilder + summary: Provides information about the options desired for the payment request + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options: PaymentOptions' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestComplete.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestComplete.yml new file mode 100644 index 00000000..3bc2c236 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestComplete.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PaymentRequestComplete +uid: botbuilder.PaymentRequestComplete +package: botbuilder +summary: Payload delivered when completing a payment request +fullName: PaymentRequestComplete +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: id + uid: botbuilder.PaymentRequestComplete.id + package: botbuilder + summary: Payment request ID + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: paymentRequest + uid: botbuilder.PaymentRequestComplete.paymentRequest + package: botbuilder + summary: Initial payment request + fullName: paymentRequest + remarks: '' + isDeprecated: false + syntax: + content: 'paymentRequest: PaymentRequest' + return: + description: '' + type: + - name: paymentResponse + uid: botbuilder.PaymentRequestComplete.paymentResponse + package: botbuilder + summary: Corresponding payment response + fullName: paymentResponse + remarks: '' + isDeprecated: false + syntax: + content: 'paymentResponse: PaymentResponse' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestCompleteResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestCompleteResult.yml new file mode 100644 index 00000000..fc34a9b7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestCompleteResult.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: PaymentRequestCompleteResult +uid: botbuilder.PaymentRequestCompleteResult +package: botbuilder +summary: Result from a completed payment request +fullName: PaymentRequestCompleteResult +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: result + uid: botbuilder.PaymentRequestCompleteResult.result + package: botbuilder + summary: Result of the payment request completion + fullName: result + remarks: '' + isDeprecated: false + syntax: + content: 'result: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdate.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdate.yml new file mode 100644 index 00000000..d2c61e6d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdate.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PaymentRequestUpdate +uid: botbuilder.PaymentRequestUpdate +package: botbuilder +summary: An update to a payment request +fullName: PaymentRequestUpdate +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder.PaymentRequestUpdate.details + package: botbuilder + summary: Update payment details + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: PaymentDetails' + return: + description: '' + type: + - name: id + uid: botbuilder.PaymentRequestUpdate.id + package: botbuilder + summary: ID for the payment request to update + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: shippingAddress + uid: botbuilder.PaymentRequestUpdate.shippingAddress + package: botbuilder + summary: Updated shipping address + fullName: shippingAddress + remarks: '' + isDeprecated: false + syntax: + content: 'shippingAddress: PaymentAddress' + return: + description: '' + type: + - name: shippingOption + uid: botbuilder.PaymentRequestUpdate.shippingOption + package: botbuilder + summary: Updated shipping options + fullName: shippingOption + remarks: '' + isDeprecated: false + syntax: + content: 'shippingOption: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdateResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdateResult.yml new file mode 100644 index 00000000..8ce4908b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentRequestUpdateResult.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: PaymentRequestUpdateResult +uid: botbuilder.PaymentRequestUpdateResult +package: botbuilder +summary: A result object from a Payment Request Update invoke operation +fullName: PaymentRequestUpdateResult +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder.PaymentRequestUpdateResult.details + package: botbuilder + summary: Update payment details + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: PaymentDetails' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentResponse.yml new file mode 100644 index 00000000..94692c09 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentResponse.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: PaymentResponse +uid: botbuilder.PaymentResponse +package: botbuilder +summary: >- + A PaymentResponse is returned when a user has selected a payment method and + approved a payment + + request +fullName: PaymentResponse +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: details + uid: botbuilder.PaymentResponse.details + package: botbuilder + summary: >- + A JSON-serializable object that provides a payment method specific message + used by the + + merchant to process the transaction and determine successful fund transfer + fullName: details + remarks: '' + isDeprecated: false + syntax: + content: 'details: any' + return: + description: '' + type: any + - name: methodName + uid: botbuilder.PaymentResponse.methodName + package: botbuilder + summary: >- + The payment method identifier for the payment method that the user + selected to fulfil the + + transaction + fullName: methodName + remarks: '' + isDeprecated: false + syntax: + content: 'methodName: string' + return: + description: '' + type: string + - name: payerEmail + uid: botbuilder.PaymentResponse.payerEmail + package: botbuilder + summary: >- + If the requestPayerEmail flag was set to true in the PaymentOptions passed + to the + + PaymentRequest constructor, then payerEmail will be the email address + chosen by the user + fullName: payerEmail + remarks: '' + isDeprecated: false + syntax: + content: 'payerEmail: string' + return: + description: '' + type: string + - name: payerPhone + uid: botbuilder.PaymentResponse.payerPhone + package: botbuilder + summary: >- + If the requestPayerPhone flag was set to true in the PaymentOptions passed + to the + + PaymentRequest constructor, then payerPhone will be the phone number + chosen by the user + fullName: payerPhone + remarks: '' + isDeprecated: false + syntax: + content: 'payerPhone: string' + return: + description: '' + type: string + - name: shippingAddress + uid: botbuilder.PaymentResponse.shippingAddress + package: botbuilder + summary: >- + If the requestShipping flag was set to true in the PaymentOptions passed + to the PaymentRequest + + constructor, then shippingAddress will be the full and final shipping + address chosen by the + + user + fullName: shippingAddress + remarks: '' + isDeprecated: false + syntax: + content: 'shippingAddress: PaymentAddress' + return: + description: '' + type: + - name: shippingOption + uid: botbuilder.PaymentResponse.shippingOption + package: botbuilder + summary: >- + If the requestShipping flag was set to true in the PaymentOptions passed + to the PaymentRequest + + constructor, then shippingOption will be the id attribute of the selected + shipping option + fullName: shippingOption + remarks: '' + isDeprecated: false + syntax: + content: 'shippingOption: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentShippingOption.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentShippingOption.yml new file mode 100644 index 00000000..cc8145c5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PaymentShippingOption.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PaymentShippingOption +uid: botbuilder.PaymentShippingOption +package: botbuilder +summary: Describes a shipping option +fullName: PaymentShippingOption +remarks: '' +isDeprecated: true +customDeprecatedMessage: Bot Framework no longer supports payments +type: interface +properties: + - name: amount + uid: botbuilder.PaymentShippingOption.amount + package: botbuilder + summary: Contains the monetary amount for the item + fullName: amount + remarks: '' + isDeprecated: false + syntax: + content: 'amount: PaymentCurrencyAmount' + return: + description: '' + type: + - name: id + uid: botbuilder.PaymentShippingOption.id + package: botbuilder + summary: String identifier used to reference this PaymentShippingOption + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: label + uid: botbuilder.PaymentShippingOption.label + package: botbuilder + summary: Human-readable description of the item + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: selected + uid: botbuilder.PaymentShippingOption.selected + package: botbuilder + summary: Indicates whether this is the default selected PaymentShippingOption + fullName: selected + remarks: '' + isDeprecated: false + syntax: + content: 'selected: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Place.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Place.yml new file mode 100644 index 00000000..f088b921 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Place.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Place +uid: botbuilder.Place +package: botbuilder +summary: 'Place (entity type: "https://schema.org/Place")' +fullName: Place +remarks: '' +isDeprecated: false +type: interface +properties: + - name: address + uid: botbuilder.Place.address + package: botbuilder + summary: >- + Address of the place (may be `string` or complex object of type + `PostalAddress`) + fullName: address + remarks: '' + isDeprecated: false + syntax: + content: 'address: any' + return: + description: '' + type: any + - name: geo + uid: botbuilder.Place.geo + package: botbuilder + summary: >- + Geo coordinates of the place (may be complex object of type + `GeoCoordinates` or `GeoShape`) + fullName: geo + remarks: '' + isDeprecated: false + syntax: + content: 'geo: any' + return: + description: '' + type: any + - name: hasMap + uid: botbuilder.Place.hasMap + package: botbuilder + summary: Map to the place (may be `string` (URL) or complex object of type `Map`) + fullName: hasMap + remarks: '' + isDeprecated: false + syntax: + content: 'hasMap: any' + return: + description: '' + type: any + - name: name + uid: botbuilder.Place.name + package: botbuilder + summary: The name of the thing + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.Place.type + package: botbuilder + summary: The type of the thing + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PopupWindowPosition.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PopupWindowPosition.yml new file mode 100644 index 00000000..f8112d22 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PopupWindowPosition.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: PopupWindowPosition +uid: botbuilder.PopupWindowPosition +package: botbuilder +summary: SharePoint property pane link popup window position. +fullName: PopupWindowPosition +remarks: '' +isDeprecated: false +fields: + - name: Center + uid: botbuilder.PopupWindowPosition.Center + package: botbuilder + summary: Center. + numericValue: 0 + - name: RightTop + uid: botbuilder.PopupWindowPosition.RightTop + package: botbuilder + summary: Right top. + numericValue: 1 + - name: LeftTop + uid: botbuilder.PopupWindowPosition.LeftTop + package: botbuilder + summary: Left top. + numericValue: 2 + - name: RightBottom + uid: botbuilder.PopupWindowPosition.RightBottom + package: botbuilder + summary: Right bottom. + numericValue: 3 + - name: LeftBottom + uid: botbuilder.PopupWindowPosition.LeftBottom + package: botbuilder + summary: Left bottom. + numericValue: 4 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PrivateConversationState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PrivateConversationState.yml new file mode 100644 index 00000000..a4cea50a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PrivateConversationState.yml @@ -0,0 +1,241 @@ +### YamlMime:TSType +name: PrivateConversationState +uid: botbuilder.PrivateConversationState +package: botbuilder +summary: Reads and writes PrivateConversation state for your bot to storage. +fullName: PrivateConversationState +remarks: >- + Each PrivateConversation your bot has with a user or group will have its own + isolated storage object + + that can be used to persist PrivateConversation tracking information between + turns of the PrivateConversation. + + This state information can be reset at any point by calling [clear()](#clear). + + + ```JavaScript + + const { PrivateConversationState, MemoryStorage } = require('botbuilder'); + + + const PrivateConversationState = new PrivateConversationState(new + MemoryStorage()); + + ``` +isDeprecated: false +type: class +constructors: + - name: PrivateConversationState(Storage, string) + uid: botbuilder.PrivateConversationState.constructor + package: botbuilder + summary: Creates a new PrivateConversationState instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new PrivateConversationState(storage: Storage, namespace?: string)' + parameters: + - id: storage + type: + description: Storage provider to persist PrivateConversation state to. + - id: namespace + type: string + description: >- + (Optional) namespace to append to storage keys. Defaults to an empty + string. +inheritedMethods: + - name: clear(TurnContext) + uid: botbuilder.PrivateConversationState.clear + package: botbuilder + summary: Clears the current state object for a turn. + remarks: >- + The cleared state object will not be persisted until + [saveChanges()](#savechanges) has + + been called. + + + ```JavaScript + + await botState.clear(context); + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: 'function clear(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: Inherited From [BotState.clear](xref:botbuilder.BotState.clear) + - name: createProperty(string) + uid: botbuilder.PrivateConversationState.createProperty + package: botbuilder + summary: >- + Creates a new property accessor for reading and writing an individual + property to the bot + + states storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createProperty(name: string): StatePropertyAccessor' + parameters: + - id: name + type: string + description: Name of the property to add. + return: + description: An accessor for the property. + type: <T> + inheritanceDescription: >- + Inherited From + [BotState.createProperty](xref:botbuilder.BotState.createProperty) + - name: delete(TurnContext) + uid: botbuilder.PrivateConversationState.delete + package: botbuilder + summary: Delete the backing state object for the current turn. + remarks: >- + The state object will be removed from storage if it exists. If the state + object has been + + read in and cached, the cache will be cleared. + + + ```JavaScript + + await botState.delete(context); + + ``` + isDeprecated: false + syntax: + content: 'function delete(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: Inherited From [BotState.delete](xref:botbuilder.BotState.delete) + - name: get(TurnContext) + uid: botbuilder.PrivateConversationState.get + package: botbuilder + summary: Returns a cached state object or undefined if not cached. + remarks: >- + This example shows how to synchronously get an already loaded and cached + state object: + + + ```JavaScript + + const state = botState.get(context); + + ``` + isDeprecated: false + syntax: + content: 'function get(context: TurnContext): any' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A cached state object or undefined if not cached. + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder.BotState.get) + - name: load(TurnContext, boolean) + uid: botbuilder.PrivateConversationState.load + package: botbuilder + summary: Reads in and caches the backing state object for a turn. + remarks: >- + Subsequent reads will return the cached object unless the `force` flag is + passed in which + + will force the state object to be re-read. + + + This method is automatically called on first access of any of created + property accessors. + + + ```JavaScript + + const state = await botState.load(context); + + ``` + isDeprecated: false + syntax: + content: 'function load(context: TurnContext, force?: boolean): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) If `true` the cache will be bypassed and the state will + always be read in directly from storage. Defaults to `false`. + return: + description: The cached state. + type: Promise<any> + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder.BotState.load) + - name: saveChanges(TurnContext, boolean) + uid: botbuilder.PrivateConversationState.saveChanges + package: botbuilder + summary: Saves the cached state object if it's been changed. + remarks: >- + If the `force` flag is passed in the cached state object will be saved + regardless of + + whether its been changed or not and if no object has been cached, an empty + object will be + + created and then saved. + + + ```JavaScript + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: >- + function saveChanges(context: TurnContext, force?: boolean): + Promise + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) if `true` the state will always be written out regardless + of its change state. Defaults to `false`. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotState.saveChanges](xref:botbuilder.BotState.saveChanges) +methods: + - name: getStorageKey(TurnContext) + uid: botbuilder.PrivateConversationState.getStorageKey + package: botbuilder + summary: Returns the storage key for the current PrivateConversation state. + remarks: '' + isDeprecated: false + syntax: + content: 'function getStorageKey(context: TurnContext): undefined | string' + parameters: + - id: context + type: + description: Context for current turn of PrivateConversation with the user. + return: + description: The storage key for the current PrivateConversation state. + type: undefined | string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyManager.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyManager.yml new file mode 100644 index 00000000..e81e5d5c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyManager.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: PropertyManager +uid: botbuilder.PropertyManager +package: botbuilder +summary: Interface implemented by classes capable of factoring property accessors. +fullName: PropertyManager +remarks: '' +isDeprecated: false +type: interface +methods: + - name: createProperty(string) + uid: botbuilder.PropertyManager.createProperty + package: botbuilder + summary: >- + Creates a new property accessor for reading and writing an individual + property to the bots + + state management system. + remarks: '' + isDeprecated: false + syntax: + content: 'function createProperty(name: string): StatePropertyAccessor' + parameters: + - id: name + type: string + description: Name of the property being created. + return: + description: '' + type: <T> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneCheckboxProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneCheckboxProperties.yml new file mode 100644 index 00000000..e1ec45bc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneCheckboxProperties.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PropertyPaneCheckboxProperties +uid: botbuilder.PropertyPaneCheckboxProperties +package: botbuilder +summary: SharePoint property pane checkbox field properties. +fullName: PropertyPaneCheckboxProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: checked + uid: botbuilder.PropertyPaneCheckboxProperties.checked + package: botbuilder + summary: Indicates whether the checkbox is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botbuilder.PropertyPaneCheckboxProperties.disabled + package: botbuilder + summary: Indicates whether the checkbox is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: text + uid: botbuilder.PropertyPaneCheckboxProperties.text + package: botbuilder + summary: The label text to display next to the checkbox. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupIconProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupIconProperties.yml new file mode 100644 index 00000000..8354f042 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupIconProperties.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupIconProperties +uid: botbuilder.PropertyPaneChoiceGroupIconProperties +package: botbuilder +summary: SharePoint property pane choice group icon properties. +fullName: PropertyPaneChoiceGroupIconProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: officeFabricIconFontName + uid: botbuilder.PropertyPaneChoiceGroupIconProperties.officeFabricIconFontName + package: botbuilder + summary: The name of the icon to use from Office Fabric icon set. + fullName: officeFabricIconFontName + remarks: '' + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupImageSize.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupImageSize.yml new file mode 100644 index 00000000..c60a5c58 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupImageSize.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupImageSize +uid: botbuilder.PropertyPaneChoiceGroupImageSize +package: botbuilder +summary: SharePoint property pane choice group image size. +fullName: PropertyPaneChoiceGroupImageSize +remarks: '' +isDeprecated: false +type: interface +properties: + - name: height + uid: botbuilder.PropertyPaneChoiceGroupImageSize.height + package: botbuilder + summary: The height of the image. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height: number' + return: + description: '' + type: number + - name: width + uid: botbuilder.PropertyPaneChoiceGroupImageSize.width + package: botbuilder + summary: The width of the image. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupOption.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupOption.yml new file mode 100644 index 00000000..88d324b7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupOption.yml @@ -0,0 +1,108 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupOption +uid: botbuilder.PropertyPaneChoiceGroupOption +package: botbuilder +summary: SharePoint property pane choice group option. +fullName: PropertyPaneChoiceGroupOption +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.PropertyPaneChoiceGroupOption.ariaLabel + package: botbuilder + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: checked + uid: botbuilder.PropertyPaneChoiceGroupOption.checked + package: botbuilder + summary: Indicates whether the choice group option is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botbuilder.PropertyPaneChoiceGroupOption.disabled + package: botbuilder + summary: Indicates whether the choice group option is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: iconProps + uid: botbuilder.PropertyPaneChoiceGroupOption.iconProps + package: botbuilder + summary: The icon properties to use for the choice group option. + fullName: iconProps + remarks: '' + isDeprecated: false + syntax: + content: 'iconProps?: PropertyPaneChoiceGroupIconProperties' + return: + description: '' + type: + - name: imageSize + uid: botbuilder.PropertyPaneChoiceGroupOption.imageSize + package: botbuilder + summary: The image size to use for the choice group option. + fullName: imageSize + remarks: '' + isDeprecated: false + syntax: + content: 'imageSize?: PropertyPaneChoiceGroupImageSize' + return: + description: '' + type: + - name: imageSrc + uid: botbuilder.PropertyPaneChoiceGroupOption.imageSrc + package: botbuilder + summary: The image source to use for the choice group option. + fullName: imageSrc + remarks: '' + isDeprecated: false + syntax: + content: 'imageSrc?: string' + return: + description: '' + type: string + - name: key + uid: botbuilder.PropertyPaneChoiceGroupOption.key + package: botbuilder + summary: The key to uniquely identify the choice group option. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.PropertyPaneChoiceGroupOption.text + package: botbuilder + summary: The text to display next for this choice group option. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupProperties.yml new file mode 100644 index 00000000..09b62925 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneChoiceGroupProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupProperties +uid: botbuilder.PropertyPaneChoiceGroupProperties +package: botbuilder +summary: SharePoint property pane choice group field properties. +fullName: PropertyPaneChoiceGroupProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: label + uid: botbuilder.PropertyPaneChoiceGroupProperties.label + package: botbuilder + summary: The label text to display next to the choice group. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: options + uid: botbuilder.PropertyPaneChoiceGroupProperties.options + package: botbuilder + summary: The options for the choice group. + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options: PropertyPaneChoiceGroupOption[]' + return: + description: '' + type: [] +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownOption.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownOption.yml new file mode 100644 index 00000000..8d77631b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownOption.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneDropDownOption +uid: botbuilder.PropertyPaneDropDownOption +package: botbuilder +summary: SharePoint property pane drop down option. +fullName: PropertyPaneDropDownOption +remarks: '' +isDeprecated: false +type: interface +properties: + - name: index + uid: botbuilder.PropertyPaneDropDownOption.index + package: botbuilder + summary: The index of the option. + fullName: index + remarks: '' + isDeprecated: false + syntax: + content: 'index?: number' + return: + description: '' + type: number + - name: key + uid: botbuilder.PropertyPaneDropDownOption.key + package: botbuilder + summary: The key to uniquely identify the option. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.PropertyPaneDropDownOption.text + package: botbuilder + summary: The text to render for this option. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.PropertyPaneDropDownOption.type + package: botbuilder + summary: The type of option to render. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: DropDownOptionType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownProperties.yml new file mode 100644 index 00000000..418b7143 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneDropDownProperties.yml @@ -0,0 +1,113 @@ +### YamlMime:TSType +name: PropertyPaneDropDownProperties +uid: botbuilder.PropertyPaneDropDownProperties +package: botbuilder +summary: SharePoint property pane dropdown field properties. +fullName: PropertyPaneDropDownProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.PropertyPaneDropDownProperties.ariaLabel + package: botbuilder + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: ariaPositionInSet + uid: botbuilder.PropertyPaneDropDownProperties.ariaPositionInSet + package: botbuilder + summary: >- + The elemement's number or position in the current set of controls. Maps to + native aria-positionset attribute. It starts from 1. + fullName: ariaPositionInSet + remarks: '' + isDeprecated: false + syntax: + content: 'ariaPositionInSet?: number' + return: + description: '' + type: number + - name: ariaSetSize + uid: botbuilder.PropertyPaneDropDownProperties.ariaSetSize + package: botbuilder + summary: >- + The total number of elements in the current set of controls. Maps to + native aria-setsize attribute. + fullName: ariaSetSize + remarks: '' + isDeprecated: false + syntax: + content: 'ariaSetSize?: number' + return: + description: '' + type: number + - name: disabled + uid: botbuilder.PropertyPaneDropDownProperties.disabled + package: botbuilder + summary: Indicates whether the dropdown is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: errorMessage + uid: botbuilder.PropertyPaneDropDownProperties.errorMessage + package: botbuilder + summary: The error message to display when the dropdown value is invalid. + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder.PropertyPaneDropDownProperties.label + package: botbuilder + summary: The label text to display next to the dropdown. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: options + uid: botbuilder.PropertyPaneDropDownProperties.options + package: botbuilder + summary: The options for the dropdown. + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options?: PropertyPaneDropDownOption[]' + return: + description: '' + type: [] + - name: selectedKey + uid: botbuilder.PropertyPaneDropDownProperties.selectedKey + package: botbuilder + summary: The key of the selected dropdown option. + fullName: selectedKey + remarks: '' + isDeprecated: false + syntax: + content: 'selectedKey?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneFieldProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneFieldProperties.yml new file mode 100644 index 00000000..e95951aa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneFieldProperties.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: PropertyPaneFieldProperties +uid: botbuilder.PropertyPaneFieldProperties +package: botbuilder +summary: SharePoint base property pane field properties +fullName: PropertyPaneFieldProperties +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroup.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroup.yml new file mode 100644 index 00000000..e6d7b81c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroup.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PropertyPaneGroup +uid: botbuilder.PropertyPaneGroup +package: botbuilder +summary: SharePoint property pane group. +fullName: PropertyPaneGroup +remarks: '' +isDeprecated: false +type: interface +properties: + - name: groupFields + uid: botbuilder.PropertyPaneGroup.groupFields + package: botbuilder + summary: The fields to be rendered inside this group. + fullName: groupFields + remarks: '' + isDeprecated: false + syntax: + content: 'groupFields: PropertyPaneGroupField[]' + return: + description: '' + type: [] + - name: groupName + uid: botbuilder.PropertyPaneGroup.groupName + package: botbuilder + summary: The name of the group. + fullName: groupName + remarks: '' + isDeprecated: false + syntax: + content: 'groupName?: string' + return: + description: '' + type: string + - name: isCollapsed + uid: botbuilder.PropertyPaneGroup.isCollapsed + package: botbuilder + summary: Whether the group is collapsed or not. + fullName: isCollapsed + remarks: '' + isDeprecated: false + syntax: + content: 'isCollapsed?: boolean' + return: + description: '' + type: boolean + - name: isGroupNameHidden + uid: botbuilder.PropertyPaneGroup.isGroupNameHidden + package: botbuilder + summary: Whether the group name is hidden or not. + fullName: isGroupNameHidden + remarks: '' + isDeprecated: false + syntax: + content: 'isGroupNameHidden?: boolean' + return: + description: '' + type: boolean +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupField.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupField.yml new file mode 100644 index 00000000..440cfc7e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupField.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneGroupField +uid: botbuilder.PropertyPaneGroupField +package: botbuilder +summary: SharePoint property pane group field. +fullName: PropertyPaneGroupField +remarks: '' +isDeprecated: false +type: interface +properties: + - name: properties + uid: botbuilder.PropertyPaneGroupField.properties + package: botbuilder + summary: The properties for the field. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties: PropertyPaneFieldProperties' + return: + description: '' + type: + - name: shouldFocus + uid: botbuilder.PropertyPaneGroupField.shouldFocus + package: botbuilder + summary: Indicates whether the field should be focused or not. + fullName: shouldFocus + remarks: '' + isDeprecated: false + syntax: + content: 'shouldFocus?: boolean' + return: + description: '' + type: boolean + - name: targetProperty + uid: botbuilder.PropertyPaneGroupField.targetProperty + package: botbuilder + summary: The target property for the field. + fullName: targetProperty + remarks: '' + isDeprecated: false + syntax: + content: 'targetProperty: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.PropertyPaneGroupField.type + package: botbuilder + summary: The type of the field. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: FieldType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupOrConditionalGroup.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupOrConditionalGroup.yml new file mode 100644 index 00000000..728c8fab --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneGroupOrConditionalGroup.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: PropertyPaneGroupOrConditionalGroup +uid: botbuilder.PropertyPaneGroupOrConditionalGroup +package: botbuilder +summary: SharePoint property pane group or conditional group +fullName: PropertyPaneGroupOrConditionalGroup +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLabelProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLabelProperties.yml new file mode 100644 index 00000000..641be8db --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLabelProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: PropertyPaneLabelProperties +uid: botbuilder.PropertyPaneLabelProperties +package: botbuilder +summary: SharePoint property pane label properties. +fullName: PropertyPaneLabelProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: required + uid: botbuilder.PropertyPaneLabelProperties.required + package: botbuilder + summary: Whether the label is required or not. + fullName: required + remarks: '' + isDeprecated: false + syntax: + content: 'required?: boolean' + return: + description: '' + type: boolean + - name: text + uid: botbuilder.PropertyPaneLabelProperties.text + package: botbuilder + summary: The text to display in the label. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkPopupWindowProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkPopupWindowProperties.yml new file mode 100644 index 00000000..6b5faee1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkPopupWindowProperties.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneLinkPopupWindowProperties +uid: botbuilder.PropertyPaneLinkPopupWindowProperties +package: botbuilder +summary: SharePoint property pane link popup window properties. +fullName: PropertyPaneLinkPopupWindowProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: height + uid: botbuilder.PropertyPaneLinkPopupWindowProperties.height + package: botbuilder + summary: The height of the popup window. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height: number' + return: + description: '' + type: number + - name: positionWindowPosition + uid: botbuilder.PropertyPaneLinkPopupWindowProperties.positionWindowPosition + package: botbuilder + summary: The position of the popup window. + fullName: positionWindowPosition + remarks: '' + isDeprecated: false + syntax: + content: 'positionWindowPosition: PopupWindowPosition' + return: + description: '' + type: + - name: title + uid: botbuilder.PropertyPaneLinkPopupWindowProperties.title + package: botbuilder + summary: The title of the popup window. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: width + uid: botbuilder.PropertyPaneLinkPopupWindowProperties.width + package: botbuilder + summary: The width of the popup window. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkProperties.yml new file mode 100644 index 00000000..61440c9f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneLinkProperties.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: PropertyPaneLinkProperties +uid: botbuilder.PropertyPaneLinkProperties +package: botbuilder +summary: SharePoint property pane link field properties. +fullName: PropertyPaneLinkProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.PropertyPaneLinkProperties.ariaLabel + package: botbuilder + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: disabled + uid: botbuilder.PropertyPaneLinkProperties.disabled + package: botbuilder + summary: Whether the link is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: href + uid: botbuilder.PropertyPaneLinkProperties.href + package: botbuilder + summary: The URL of the link. + fullName: href + remarks: '' + isDeprecated: false + syntax: + content: 'href: string' + return: + description: '' + type: string + - name: popupWindowProps + uid: botbuilder.PropertyPaneLinkProperties.popupWindowProps + package: botbuilder + summary: The properties of the popup window. + fullName: popupWindowProps + remarks: '' + isDeprecated: false + syntax: + content: 'popupWindowProps?: PropertyPaneLinkPopupWindowProperties' + return: + description: '' + type: + - name: target + uid: botbuilder.PropertyPaneLinkProperties.target + package: botbuilder + summary: The target of the link. + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target?: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.PropertyPaneLinkProperties.text + package: botbuilder + summary: The text to display in the link. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePage.yml new file mode 100644 index 00000000..56d08477 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePage.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: PropertyPanePage +uid: botbuilder.PropertyPanePage +package: botbuilder +summary: SharePoint property pane page. +fullName: PropertyPanePage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayGroupsAsAccordion + uid: botbuilder.PropertyPanePage.displayGroupsAsAccordion + package: botbuilder + summary: Whether the groups should be displayed as an accordion or not. + fullName: displayGroupsAsAccordion + remarks: '' + isDeprecated: false + syntax: + content: 'displayGroupsAsAccordion?: boolean' + return: + description: '' + type: boolean + - name: groups + uid: botbuilder.PropertyPanePage.groups + package: botbuilder + summary: The groups to be rendered inside this page. + fullName: groups + remarks: '' + isDeprecated: false + syntax: + content: 'groups: PropertyPaneGroupOrConditionalGroup[]' + return: + description: '' + type: [] + - name: header + uid: botbuilder.PropertyPanePage.header + package: botbuilder + summary: The header to be rendered inside this page. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header?: PropertyPanePageHeader' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePageHeader.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePageHeader.yml new file mode 100644 index 00000000..2ca8c278 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPanePageHeader.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: PropertyPanePageHeader +uid: botbuilder.PropertyPanePageHeader +package: botbuilder +summary: SharePoint property pane page header. +fullName: PropertyPanePageHeader +remarks: '' +isDeprecated: false +type: interface +properties: + - name: description + uid: botbuilder.PropertyPanePageHeader.description + package: botbuilder + summary: The description of the page. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneSliderProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneSliderProperties.yml new file mode 100644 index 00000000..1b29a2b1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneSliderProperties.yml @@ -0,0 +1,109 @@ +### YamlMime:TSType +name: PropertyPaneSliderProperties +uid: botbuilder.PropertyPaneSliderProperties +package: botbuilder +summary: SharePoint property pane slider field properties. +fullName: PropertyPaneSliderProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.PropertyPaneSliderProperties.ariaLabel + package: botbuilder + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: disabled + uid: botbuilder.PropertyPaneSliderProperties.disabled + package: botbuilder + summary: Whether the slider is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: label + uid: botbuilder.PropertyPaneSliderProperties.label + package: botbuilder + summary: The label of the slider. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: max + uid: botbuilder.PropertyPaneSliderProperties.max + package: botbuilder + summary: The maximum value of the slider. + fullName: max + remarks: '' + isDeprecated: false + syntax: + content: 'max: number' + return: + description: '' + type: number + - name: min + uid: botbuilder.PropertyPaneSliderProperties.min + package: botbuilder + summary: The minimum value of the slider. + fullName: min + remarks: '' + isDeprecated: false + syntax: + content: 'min: number' + return: + description: '' + type: number + - name: showValue + uid: botbuilder.PropertyPaneSliderProperties.showValue + package: botbuilder + summary: Whether to show the value on the right of the slider or no. + fullName: showValue + remarks: '' + isDeprecated: false + syntax: + content: 'showValue?: boolean' + return: + description: '' + type: boolean + - name: step + uid: botbuilder.PropertyPaneSliderProperties.step + package: botbuilder + summary: The step value of the slider. + fullName: step + remarks: '' + isDeprecated: false + syntax: + content: 'step?: number' + return: + description: '' + type: number + - name: value + uid: botbuilder.PropertyPaneSliderProperties.value + package: botbuilder + summary: The value of the slider. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneTextFieldProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneTextFieldProperties.yml new file mode 100644 index 00000000..8cf89b22 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneTextFieldProperties.yml @@ -0,0 +1,175 @@ +### YamlMime:TSType +name: PropertyPaneTextFieldProperties +uid: botbuilder.PropertyPaneTextFieldProperties +package: botbuilder +summary: SharePoint property pane text field properties. +fullName: PropertyPaneTextFieldProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.PropertyPaneTextFieldProperties.ariaLabel + package: botbuilder + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: description + uid: botbuilder.PropertyPaneTextFieldProperties.description + package: botbuilder + summary: The description to display under the text field. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description?: string' + return: + description: '' + type: string + - name: disabled + uid: botbuilder.PropertyPaneTextFieldProperties.disabled + package: botbuilder + summary: Whether the text field is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: errorMessage + uid: botbuilder.PropertyPaneTextFieldProperties.errorMessage + package: botbuilder + summary: >- + If set, this will be displayed as an error message underneath the text + field.. + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder.PropertyPaneTextFieldProperties.label + package: botbuilder + summary: The label of the text field. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: logName + uid: botbuilder.PropertyPaneTextFieldProperties.logName + package: botbuilder + summary: >- + Name used to log PropertyPaneTextField value changes for engagement + tracking. + fullName: logName + remarks: '' + isDeprecated: false + syntax: + content: 'logName?: string' + return: + description: '' + type: string + - name: maxLength + uid: botbuilder.PropertyPaneTextFieldProperties.maxLength + package: botbuilder + summary: The maximum length of the text field. + fullName: maxLength + remarks: '' + isDeprecated: false + syntax: + content: 'maxLength?: number' + return: + description: '' + type: number + - name: multiline + uid: botbuilder.PropertyPaneTextFieldProperties.multiline + package: botbuilder + summary: Whether or not the text field is multiline. + fullName: multiline + remarks: '' + isDeprecated: false + syntax: + content: 'multiline?: boolean' + return: + description: '' + type: boolean + - name: placeholder + uid: botbuilder.PropertyPaneTextFieldProperties.placeholder + package: botbuilder + summary: The placeholder text to display in the text field. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string + - name: resizable + uid: botbuilder.PropertyPaneTextFieldProperties.resizable + package: botbuilder + summary: Whether or not the multiline text field is resizable. + fullName: resizable + remarks: '' + isDeprecated: false + syntax: + content: 'resizable?: boolean' + return: + description: '' + type: boolean + - name: rows + uid: botbuilder.PropertyPaneTextFieldProperties.rows + package: botbuilder + summary: >- + Specifies the visible height of a text area(multiline text TextField), in + lines. + fullName: rows + remarks: '' + isDeprecated: false + syntax: + content: 'rows?: number' + return: + description: '' + type: number + - name: underlined + uid: botbuilder.PropertyPaneTextFieldProperties.underlined + package: botbuilder + summary: Whether or not the text field is underlined. + fullName: underlined + remarks: '' + isDeprecated: false + syntax: + content: 'underlined?: boolean' + return: + description: '' + type: boolean + - name: value + uid: botbuilder.PropertyPaneTextFieldProperties.value + package: botbuilder + summary: The value of the text field. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneToggleProperties.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneToggleProperties.yml new file mode 100644 index 00000000..d2a7e213 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/PropertyPaneToggleProperties.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: PropertyPaneToggleProperties +uid: botbuilder.PropertyPaneToggleProperties +package: botbuilder +summary: SharePoint property pane toggle field properties. +fullName: PropertyPaneToggleProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botbuilder.PropertyPaneToggleProperties.ariaLabel + package: botbuilder + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: checked + uid: botbuilder.PropertyPaneToggleProperties.checked + package: botbuilder + summary: Indicates whether the toggle is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botbuilder.PropertyPaneToggleProperties.disabled + package: botbuilder + summary: Indicates whether the toggle is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: key + uid: botbuilder.PropertyPaneToggleProperties.key + package: botbuilder + summary: A key to uniquely identify the toggle. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key?: string' + return: + description: '' + type: string + - name: label + uid: botbuilder.PropertyPaneToggleProperties.label + package: botbuilder + summary: A label for the toggle. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: offAriaLabel + uid: botbuilder.PropertyPaneToggleProperties.offAriaLabel + package: botbuilder + summary: >- + Optional offAriaLabel flag. Text for screen-reader to announce when toggle + is OFF. + fullName: offAriaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'offAriaLabel?: string' + return: + description: '' + type: string + - name: offText + uid: botbuilder.PropertyPaneToggleProperties.offText + package: botbuilder + summary: Text to display when toggle is OFF. + fullName: offText + remarks: '' + isDeprecated: false + syntax: + content: 'offText?: string' + return: + description: '' + type: string + - name: onAriaLabel + uid: botbuilder.PropertyPaneToggleProperties.onAriaLabel + package: botbuilder + summary: >- + Optional onAriaLabel flag. Text for screen-reader to announce when toggle + is ON. + fullName: onAriaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'onAriaLabel?: string' + return: + description: '' + type: string + - name: onText + uid: botbuilder.PropertyPaneToggleProperties.onText + package: botbuilder + summary: Text to display when toggle is ON. + fullName: onText + remarks: '' + isDeprecated: false + syntax: + content: 'onText?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/QueueStorage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/QueueStorage.yml new file mode 100644 index 00000000..87fe9de4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/QueueStorage.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: QueueStorage +uid: botbuilder.QueueStorage +package: botbuilder +summary: A base class for enqueueing an Activity for later processing. +fullName: QueueStorage +remarks: '' +isDeprecated: false +type: class +methods: + - name: queueActivity(Partial, number, number) + uid: botbuilder.QueueStorage.queueActivity + package: botbuilder + summary: >- + Enqueues an Activity for later processing. The visibility timeout + specifies how long the message should be visible + + to Dequeue and Peek operations. + remarks: '' + isDeprecated: false + syntax: + content: >- + function queueActivity(activity: Partial, visibilityTimeout?: + number, timeToLive?: number): Promise + parameters: + - id: activity + type: Partial<> + description: >- + The [Activity](xref:botframework-schema.Activity) to be queued for + later processing. + - id: visibilityTimeout + type: number + description: >- + Visibility timeout in seconds. Optional with a default value of 0. + Cannot be larger than 7 days. + - id: timeToLive + type: number + description: Specifies the time-to-live interval for the message in seconds. + return: + description: '' + type: Promise<string> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewCardAction.yml new file mode 100644 index 00000000..c46653cf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: QuickViewCardAction +uid: botbuilder.QuickViewCardAction +package: botbuilder +summary: SharePoint QuickView action. +fullName: QuickViewCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder.QuickViewCardAction.parameters + package: botbuilder + summary: Parameters for the quick view opened by this action + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: QuickViewParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.QuickViewCardAction.type + package: botbuilder + summary: Indicates this action opens the quick view. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "QuickView"' + return: + description: '' + type: '"QuickView"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewData.yml new file mode 100644 index 00000000..010da0af --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewData.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: QuickViewData +uid: botbuilder.QuickViewData +package: botbuilder +summary: '' +fullName: QuickViewData +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewHandleActionResponse.yml new file mode 100644 index 00000000..3ae2f86f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: QuickViewHandleActionResponse +uid: botbuilder.QuickViewHandleActionResponse +package: botbuilder +summary: The handle action response for quick view. +fullName: QuickViewHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botbuilder.QuickViewHandleActionResponse.renderArguments + package: botbuilder + summary: Quick view render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments: QuickViewResponse' + return: + description: '' + type: + - name: responseType + uid: botbuilder.QuickViewHandleActionResponse.responseType + package: botbuilder + summary: Quick view. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "QuickView"' + return: + description: '' + type: '"QuickView"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewParameters.yml new file mode 100644 index 00000000..582f4e13 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: QuickViewParameters +uid: botbuilder.QuickViewParameters +package: botbuilder +summary: Parameters for opening a Quick view. +fullName: QuickViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: view + uid: botbuilder.QuickViewParameters.view + package: botbuilder + summary: The view of the Quick view to open. + fullName: view + remarks: '' + isDeprecated: false + syntax: + content: 'view: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewResponse.yml new file mode 100644 index 00000000..93669770 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/QuickViewResponse.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: QuickViewResponse +uid: botbuilder.QuickViewResponse +package: botbuilder +summary: SharePoint ACE Quick view response payload. +fullName: QuickViewResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder.QuickViewResponse.data + package: botbuilder + summary: The quick view data. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: QuickViewData' + return: + description: '' + type: + - name: externalLink + uid: botbuilder.QuickViewResponse.externalLink + package: botbuilder + summary: >- + An optional external link to be displayed in the navigation bar above the + Adaptive Card. + fullName: externalLink + remarks: '' + isDeprecated: false + syntax: + content: 'externalLink: ExternalLinkActionParameters' + return: + description: '' + type: + - name: focusParameters + uid: botbuilder.QuickViewResponse.focusParameters + package: botbuilder + summary: >- + An optional focus element to set focus when the view is rendered for + accessibility purposes. + fullName: focusParameters + remarks: '' + isDeprecated: false + syntax: + content: 'focusParameters: FocusParameters' + return: + description: '' + type: + - name: template + uid: botbuilder.QuickViewResponse.template + package: botbuilder + summary: The adaptive card template for the quick view. + fullName: template + remarks: '' + isDeprecated: false + syntax: + content: 'template: AdaptiveCard' + return: + description: '' + type: AdaptiveCard + - name: title + uid: botbuilder.QuickViewResponse.title + package: botbuilder + summary: The title of the quick view. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: viewId + uid: botbuilder.QuickViewResponse.viewId + package: botbuilder + summary: The view id. + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ReactionType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ReactionType.yml new file mode 100644 index 00000000..23408213 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ReactionType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ReactionType +uid: botbuilder.ReactionType +package: botbuilder +summary: |- + Defines values for ReactionType. + Possible values include: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' +fullName: ReactionType +remarks: '' +isDeprecated: false +syntax: | + type ReactionType = "like" | "heart" | "laugh" | "surprised" | "sad" | "angry" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptCard.yml new file mode 100644 index 00000000..91a5231c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptCard.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: ReceiptCard +uid: botbuilder.ReceiptCard +package: botbuilder +summary: A receipt card +fullName: ReceiptCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder.ReceiptCard.buttons + package: botbuilder + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: facts + uid: botbuilder.ReceiptCard.facts + package: botbuilder + summary: Array of Fact objects + fullName: facts + remarks: '' + isDeprecated: false + syntax: + content: 'facts: Fact[]' + return: + description: '' + type: [] + - name: items + uid: botbuilder.ReceiptCard.items + package: botbuilder + summary: Array of Receipt Items + fullName: items + remarks: '' + isDeprecated: false + syntax: + content: 'items: ReceiptItem[]' + return: + description: '' + type: [] + - name: tap + uid: botbuilder.ReceiptCard.tap + package: botbuilder + summary: This action will be activated when user taps on the card + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: tax + uid: botbuilder.ReceiptCard.tax + package: botbuilder + summary: Total amount of tax paid (or to be paid) + fullName: tax + remarks: '' + isDeprecated: false + syntax: + content: 'tax: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.ReceiptCard.title + package: botbuilder + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: total + uid: botbuilder.ReceiptCard.total + package: botbuilder + summary: Total amount of money paid (or to be paid) + fullName: total + remarks: '' + isDeprecated: false + syntax: + content: 'total: string' + return: + description: '' + type: string + - name: vat + uid: botbuilder.ReceiptCard.vat + package: botbuilder + summary: Total amount of VAT paid (or to be paid) + fullName: vat + remarks: '' + isDeprecated: false + syntax: + content: 'vat: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptItem.yml new file mode 100644 index 00000000..df276aa8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ReceiptItem.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: ReceiptItem +uid: botbuilder.ReceiptItem +package: botbuilder +summary: An item on a receipt card +fullName: ReceiptItem +remarks: '' +isDeprecated: false +type: interface +properties: + - name: image + uid: botbuilder.ReceiptItem.image + package: botbuilder + summary: Image + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: CardImage' + return: + description: '' + type: + - name: price + uid: botbuilder.ReceiptItem.price + package: botbuilder + summary: Amount with currency + fullName: price + remarks: '' + isDeprecated: false + syntax: + content: 'price: string' + return: + description: '' + type: string + - name: quantity + uid: botbuilder.ReceiptItem.quantity + package: botbuilder + summary: Number of items of given kind + fullName: quantity + remarks: '' + isDeprecated: false + syntax: + content: 'quantity: string' + return: + description: '' + type: string + - name: subtitle + uid: botbuilder.ReceiptItem.subtitle + package: botbuilder + summary: >- + Subtitle appears just below Title field, differs from Title in font + styling only + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder.ReceiptItem.tap + package: botbuilder + summary: This action will be activated when user taps on the Item bubble. + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder.ReceiptItem.text + package: botbuilder + summary: >- + Text field appears just below subtitle, differs from Subtitle in font + styling only + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.ReceiptItem.title + package: botbuilder + summary: Title of the Card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/RecognizerResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/RecognizerResult.yml new file mode 100644 index 00000000..d0e399e6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/RecognizerResult.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: RecognizerResult +uid: botbuilder.RecognizerResult +package: botbuilder +summary: Value returned from a recognizer. +fullName: RecognizerResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alteredText + uid: botbuilder.RecognizerResult.alteredText + package: botbuilder + summary: If original text is changed by things like spelling, the altered version. + fullName: alteredText + remarks: '' + isDeprecated: false + syntax: + content: 'alteredText?: string' + return: + description: '' + type: string + - name: entities + uid: botbuilder.RecognizerResult.entities + package: botbuilder + summary: (Optional) entities recognized. + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities?: any' + return: + description: '' + type: any + - name: intents + uid: botbuilder.RecognizerResult.intents + package: botbuilder + summary: Intents recognized for the utterance. + fullName: intents + remarks: A map of intent names to an object with score is returned. + isDeprecated: false + syntax: + content: 'intents: Record' + return: + description: '' + type: Record<string, > + - name: text + uid: botbuilder.RecognizerResult.text + package: botbuilder + summary: Utterance sent to recognizer + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/RegisterClassMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/RegisterClassMiddleware.yml new file mode 100644 index 00000000..9bdd0109 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/RegisterClassMiddleware.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: RegisterClassMiddleware +uid: botbuilder.RegisterClassMiddleware +package: botbuilder +summary: >- + Middleware for adding an object to or registering a service with the current + turn context. +fullName: RegisterClassMiddleware +remarks: '' +isDeprecated: false +type: class +constructors: + - name: RegisterClassMiddleware(T, string | symbol) + uid: botbuilder.RegisterClassMiddleware.constructor + package: botbuilder + summary: Initialize a new instance of the RegisterClassMiddleware class. + remarks: '' + isDeprecated: false + syntax: + content: 'new RegisterClassMiddleware(service: T, key: string | symbol)' + parameters: + - id: service + type: T + description: The object or service to add. + - id: key + type: string | symbol + description: The key for service object in turn state. +properties: + - name: service + uid: botbuilder.RegisterClassMiddleware.service + package: botbuilder + summary: The object or service to add to the turn context. + fullName: service + remarks: '' + isDeprecated: false + syntax: + content: 'service: T' + return: + description: '' + type: T +methods: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.RegisterClassMiddleware.onTurn + package: botbuilder + summary: Adds the associated object or service to the current turn context. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(turnContext: TurnContext, next: () => Promise): + Promise + parameters: + - id: turnContext + type: + description: The context object for this turn. + - id: next + type: () => Promise<void> + description: The delegate to call to continue the bot middleware pipeline. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Request.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Request.yml index 76014b8b..d0bb4b15 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/Request.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Request.yml @@ -7,9 +7,8 @@ summary: >- properties. Compatible with Restify, Express, and Node.js core http. -fullName: 'Request' +fullName: Request remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: summary: '' fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: Body' @@ -32,7 +30,6 @@ properties: summary: '' fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'headers: Headers' @@ -45,7 +42,6 @@ properties: summary: '' fullName: method remarks: '' - isPreview: false isDeprecated: false syntax: content: 'method?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ResourceResponse.yml new file mode 100644 index 00000000..8b6393eb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ResourceResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ResourceResponse +uid: botbuilder.ResourceResponse +package: botbuilder +summary: A response containing a resource ID +fullName: ResourceResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.ResourceResponse.id + package: botbuilder + summary: Id of the resource + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Response.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Response.yml index b66548b7..a4b8b506 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/Response.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Response.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: Response remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: socket remarks: '' - isPreview: false isDeprecated: false syntax: content: 'socket: unknown' @@ -23,28 +21,26 @@ properties: description: '' type: unknown methods: - - name: 'end(unknown[])' + - name: end(unknown[]) uid: botbuilder.Response.end package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function end(args: unknown[]): unknown' parameters: - id: args - type: 'unknown[]' + type: unknown[] description: '' return: description: '' type: unknown - - name: 'header(string, unknown)' + - name: header(string, unknown) uid: botbuilder.Response.header package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function header(name: string, value: unknown): unknown' @@ -58,18 +54,17 @@ methods: return: description: '' type: unknown - - name: 'send(unknown[])' + - name: send(unknown[]) uid: botbuilder.Response.send package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(args: unknown[]): unknown' parameters: - id: args - type: 'unknown[]' + type: unknown[] description: '' return: description: '' @@ -79,7 +74,6 @@ methods: package: botbuilder summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function status(code: number): unknown' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/RoleTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/RoleTypes.yml new file mode 100644 index 00000000..5dad2b6b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/RoleTypes.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: RoleTypes +uid: botbuilder.RoleTypes +package: botbuilder +summary: |- + Defines values for RoleTypes. + Possible values include: 'user', 'bot', 'skill' +fullName: RoleTypes +remarks: '' +isDeprecated: false +fields: + - name: Bot + uid: botbuilder.RoleTypes.Bot + package: botbuilder + summary: '' + - name: Skill + uid: botbuilder.RoleTypes.Skill + package: botbuilder + summary: '' + - name: User + uid: botbuilder.RoleTypes.User + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteConstants.yml deleted file mode 100644 index 42bfd417..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteConstants.yml +++ /dev/null @@ -1,139 +0,0 @@ -### YamlMime:TSType -name: RouteConstants -uid: botbuilder.RouteConstants -package: botbuilder -summary: >+ - Constants representing the API path that immediately follows the basePath. - - These are currently internal but we will re-evaluate making them public, in - the future. - - - **Example** - - - RouteConstants.Activities = '/v3/conversations/:conversationId/activities'. - -fullName: RouteConstants -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: Activities - uid: botbuilder.RouteConstants.Activities - package: botbuilder - summary: API path for all activities from conversation. - fullName: Activities - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Activities: string' - return: - description: '' - type: string - - name: Activity - uid: botbuilder.RouteConstants.Activity - package: botbuilder - summary: API path for single activity from conversation. - fullName: Activity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Activity: string' - return: - description: '' - type: string - - name: ActivityMembers - uid: botbuilder.RouteConstants.ActivityMembers - package: botbuilder - summary: API path for all members from activity from conversation. - fullName: ActivityMembers - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ActivityMembers: string' - return: - description: '' - type: string - - name: Attachments - uid: botbuilder.RouteConstants.Attachments - package: botbuilder - summary: API path for conversation attachments. - fullName: Attachments - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Attachments: string' - return: - description: '' - type: string - - name: ConversationHistory - uid: botbuilder.RouteConstants.ConversationHistory - package: botbuilder - summary: API path for conversation history. - fullName: ConversationHistory - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ConversationHistory: string' - return: - description: '' - type: string - - name: ConversationMember - uid: botbuilder.RouteConstants.ConversationMember - package: botbuilder - summary: API path for single conversation member. - fullName: ConversationMember - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ConversationMember: string' - return: - description: '' - type: string - - name: ConversationMembers - uid: botbuilder.RouteConstants.ConversationMembers - package: botbuilder - summary: API path for all conversation members. - fullName: ConversationMembers - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ConversationMembers: string' - return: - description: '' - type: string - - name: ConversationPagedMembers - uid: botbuilder.RouteConstants.ConversationPagedMembers - package: botbuilder - summary: API path for page(s) of all conversation members. - fullName: ConversationPagedMembers - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ConversationPagedMembers: string' - return: - description: '' - type: string - - name: Conversations - uid: botbuilder.RouteConstants.Conversations - package: botbuilder - summary: Base API path for bot conversations. - fullName: Conversations - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Conversations: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteHandler.yml index 3de4391b..d05ae187 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/RouteHandler.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: RouteHandler remarks: '' -isPreview: false isDeprecated: false syntax: | type RouteHandler = (request: WebRequest, response: WebResponse) => void diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchCardViewParameters.yml new file mode 100644 index 00000000..082f4d79 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchCardViewParameters.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: SearchCardViewParameters +uid: botbuilder.SearchCardViewParameters +package: botbuilder +summary: The parameters for the search card view. +fullName: SearchCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.SearchCardViewParameters.body + package: botbuilder + summary: Body area components. Contains a single search box. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: [CardSearchBoxComponent]' + return: + description: '' + type: '[CardSearchBoxComponent]' + - name: cardViewType + uid: botbuilder.SearchCardViewParameters.cardViewType + package: botbuilder + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "search"' + return: + description: '' + type: '"search"' + - name: footer + uid: botbuilder.SearchCardViewParameters.footer + package: botbuilder + summary: Footer area components. Contains a single search footer. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: [CardSearchFooterComponent]' + return: + description: '' + type: '[CardSearchFooterComponent]' + - name: header + uid: botbuilder.SearchCardViewParameters.header + package: botbuilder + summary: Header area components. Contains a single text field. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' +inheritedProperties: + - name: cardBar + uid: botbuilder.SearchCardViewParameters.cardBar + package: botbuilder + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeOptions.yml new file mode 100644 index 00000000..9ee09ed7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeOptions.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: SearchInvokeOptions +uid: botbuilder.SearchInvokeOptions +package: botbuilder +summary: >- + Provides information about the options desired for a + [SearchInvokeValue](xref:botframework-schema.SearchInvokeValue) +fullName: SearchInvokeOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: skip + uid: botbuilder.SearchInvokeOptions.skip + package: botbuilder + summary: >- + Indicates starting reference number from which ordered search results + should be returned. + fullName: skip + remarks: '' + isDeprecated: false + syntax: + content: 'skip: number' + return: + description: '' + type: number + - name: top + uid: botbuilder.SearchInvokeOptions.top + package: botbuilder + summary: Indicates the number of search results that should be returned. + fullName: top + remarks: '' + isDeprecated: false + syntax: + content: 'top: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeResponse.yml new file mode 100644 index 00000000..3222757c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeResponse.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: SearchInvokeResponse +uid: botbuilder.SearchInvokeResponse +package: botbuilder +summary: >- + Defines the structure that is returned as the result of an Invoke activity + with + + Name of 'application/search'. +fullName: SearchInvokeResponse +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: statusCode + uid: botbuilder.SearchInvokeResponse.statusCode + package: botbuilder + summary: The Card Action response status code. + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AdaptiveCardInvokeResponse.statusCode](xref:botbuilder.AdaptiveCardInvokeResponse.statusCode) + - name: type + uid: botbuilder.SearchInvokeResponse.type + package: botbuilder + summary: The type of this response. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AdaptiveCardInvokeResponse.type](xref:botbuilder.AdaptiveCardInvokeResponse.type) + - name: value + uid: botbuilder.SearchInvokeResponse.value + package: botbuilder + summary: The json response object. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: Record' + return: + description: '' + type: Record<string, unknown> + inheritanceDescription: >- + Inherited From + [AdaptiveCardInvokeResponse.value](xref:botbuilder.AdaptiveCardInvokeResponse.value) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeValue.yml new file mode 100644 index 00000000..0e224df1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SearchInvokeValue.yml @@ -0,0 +1,73 @@ +### YamlMime:TSType +name: SearchInvokeValue +uid: botbuilder.SearchInvokeValue +package: botbuilder +summary: >- + Defines the structure that arrives in the Activity.Value for Invoke activity + with + + Name of 'application/search'. +fullName: SearchInvokeValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder.SearchInvokeValue.context + package: botbuilder + summary: >- + The the context information about the query. Such as the UI control that + issued the query. + + The type of the context field is object and is dependent on the kind + field. + + For search and searchAnswers, there is no defined context value. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context: any' + return: + description: '' + type: any + - name: kind + uid: botbuilder.SearchInvokeValue.kind + package: botbuilder + summary: |- + The kind of the search invoke value. + Must be either search, searchAnswer or typeAhead. + fullName: kind + remarks: '' + isDeprecated: false + syntax: + content: 'kind: string' + return: + description: '' + type: string + - name: queryOptions + uid: botbuilder.SearchInvokeValue.queryOptions + package: botbuilder + summary: |- + The [SearchInvokeOptions](xref:botframework-schema.SearchInvokeOptions) + for this search invoke value. + fullName: queryOptions + remarks: '' + isDeprecated: false + syntax: + content: 'queryOptions: SearchInvokeOptions' + return: + description: '' + type: + - name: queryText + uid: botbuilder.SearchInvokeValue.queryText + package: botbuilder + summary: The query text for the search invoke value. + fullName: queryText + remarks: '' + isDeprecated: false + syntax: + content: 'queryText: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaActionParameters.yml new file mode 100644 index 00000000..8138fc6b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaActionParameters.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: SelectMediaActionParameters +uid: botbuilder.SelectMediaActionParameters +package: botbuilder +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.SelectMendia + action. +fullName: SelectMediaActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: allowMultipleCapture + uid: botbuilder.SelectMediaActionParameters.allowMultipleCapture + package: botbuilder + summary: Allow multiple images to be selected. + fullName: allowMultipleCapture + remarks: '' + isDeprecated: false + syntax: + content: 'allowMultipleCapture?: boolean' + return: + description: '' + type: boolean + - name: maxSizePerFile + uid: botbuilder.SelectMediaActionParameters.maxSizePerFile + package: botbuilder + summary: Max file size that can be uploaded. + fullName: maxSizePerFile + remarks: '' + isDeprecated: false + syntax: + content: 'maxSizePerFile?: number' + return: + description: '' + type: number + - name: mediaType + uid: botbuilder.SelectMediaActionParameters.mediaType + package: botbuilder + summary: Specifies the specific media type that should be selected + fullName: mediaType + remarks: '' + isDeprecated: false + syntax: + content: 'mediaType: MediaType' + return: + description: '' + type: + - name: supportedFileFormats + uid: botbuilder.SelectMediaActionParameters.supportedFileFormats + package: botbuilder + summary: File formats supported for upload. + fullName: supportedFileFormats + remarks: '' + isDeprecated: false + syntax: + content: 'supportedFileFormats?: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaCardAction.yml new file mode 100644 index 00000000..a21e1555 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SelectMediaCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: SelectMediaCardAction +uid: botbuilder.SelectMediaCardAction +package: botbuilder +summary: SharePoint `VivaAction.SelectMedia` event. +fullName: SelectMediaCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder.SelectMediaCardAction.parameters + package: botbuilder + summary: Parameters for the Select Media Action + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: SelectMediaActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.SelectMediaCardAction.type + package: botbuilder + summary: Indicates this is a Viva Select Media button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.SelectMedia"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticAction.yml new file mode 100644 index 00000000..8fc7823f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SemanticAction +uid: botbuilder.SemanticAction +package: botbuilder +summary: Represents a reference to a programmatic action +fullName: SemanticAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: entities + uid: botbuilder.SemanticAction.entities + package: botbuilder + summary: Entities associated with this action + fullName: entities + remarks: '' + isDeprecated: false + syntax: + content: 'entities: {[propertyName: string]: Entity}' + return: + description: '' + type: '{[propertyName: string]: }' + - name: id + uid: botbuilder.SemanticAction.id + package: botbuilder + summary: ID of this action + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: state + uid: botbuilder.SemanticAction.state + package: botbuilder + summary: 'State of this action. Allowed values: ''start'', ''continue'', ''done''' + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticActionStateTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticActionStateTypes.yml new file mode 100644 index 00000000..7d3c0919 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SemanticActionStateTypes.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: SemanticActionStateTypes +uid: botbuilder.SemanticActionStateTypes +package: botbuilder +summary: |- + Defines values for SemanticActionStateTypes. + Possible values include: 'start', 'continue', 'done' +fullName: SemanticActionStateTypes +remarks: '' +isDeprecated: false +fields: + - name: Continue + uid: botbuilder.SemanticActionStateTypes.Continue + package: botbuilder + summary: '' + - name: Done + uid: botbuilder.SemanticActionStateTypes.Done + package: botbuilder + summary: '' + - name: Start + uid: botbuilder.SemanticActionStateTypes.Start + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SendActivitiesHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SendActivitiesHandler.yml new file mode 100644 index 00000000..e6409b8f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SendActivitiesHandler.yml @@ -0,0 +1,68 @@ +### YamlMime:TSTypeAlias +name: SendActivitiesHandler +uid: botbuilder.SendActivitiesHandler +package: botbuilder +summary: A handler that can participate in send activity events for the current turn. +fullName: SendActivitiesHandler +remarks: >- + **Parameters** + + + | Name | Type | Description | + + | :--- | :--- | :--- | + + | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The context + object for the turn. | + + | `activities` | Partial\<[Activity](xref:botframework-schema.Activity)>[] | + The activities to send. | + + | `next` | () => + Promise\<[ResourceResponse](xref:botframework-schema.ResourceResponse)[]> | + The function to call to continue event processing. | + + + **Returns** + + + Promise\<[ResourceResponse](xref:botframework-schema.ResourceResponse)[]> + + + A handler calls the `next` function to pass control to the next registered + handler. If a handler + + doesn't call the `next` function, the adapter does not call any of the + subsequent handlers and + + does not send the activities to the user. + + + If the activities are successfully sent, the `next` function returns an array + of + + [ResourceResponse](xref:botframework-schema.ResourceResponse) objects + containing the IDs that the + + receiving channel assigned to the activities. Use this array as the return + value of this handler. + + + **See also** + + + - [BotAdapter](xref:botbuilder-core.BotAdapter) + + - [UpdateActivityHandler](xref:botbuilder-core.UpdateActivityHandler) + + - [DeleteActivityHandler](xref:botbuilder-core.DeleteActivityHandler) + + - + [TurnContext.onSendActivities](xref:botbuilder-core.TurnContext.onSendActivities) +isDeprecated: false +syntax: | + type SendActivitiesHandler = ( + context: TurnContext, + activities: Partial[], + next: () => Promise + ) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SetPropertyPaneConfigurationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SetPropertyPaneConfigurationResponse.yml new file mode 100644 index 00000000..8665ec79 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SetPropertyPaneConfigurationResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: SetPropertyPaneConfigurationResponse +uid: botbuilder.SetPropertyPaneConfigurationResponse +package: botbuilder +summary: '' +fullName: SetPropertyPaneConfigurationResponse +remarks: '' +isDeprecated: false +syntax: | + type SetPropertyPaneConfigurationResponse = + | CardViewHandleActionResponse + | NoOpHandleActionResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SetSpeakMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SetSpeakMiddleware.yml index 1abdcdaa..d924ae6e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/SetSpeakMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SetSpeakMiddleware.yml @@ -9,36 +9,32 @@ summary: >- Activity Speak property. fullName: SetSpeakMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'SetSpeakMiddleware(string | null, boolean)' + - name: SetSpeakMiddleware(null | string, boolean) uid: botbuilder.SetSpeakMiddleware.constructor package: botbuilder summary: Initializes a new instance of the SetSpeakMiddleware class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new SetSpeakMiddleware(voiceName: string | null, fallbackToTextForSpeak: + new SetSpeakMiddleware(voiceName: null | string, fallbackToTextForSpeak: boolean) parameters: - id: voiceName - type: string | null + type: null | string description: The SSML voice name attribute value. - id: fallbackToTextForSpeak type: boolean - description: | - true if an empty Activity.Speak is populated with Activity.Text. + description: true if an empty Activity.Speak is populated with Activity.Text. methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder.SetSpeakMiddleware.onTurn package: botbuilder summary: Processes an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -46,7 +42,7 @@ methods: Promise parameters: - id: turnContext - type: TurnContext + type: description: The context object for this turn. - id: next type: () => Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Severity.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Severity.yml new file mode 100644 index 00000000..23d36ab2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Severity.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Severity +uid: botbuilder.Severity +package: botbuilder +summary: Defines the level of severity for the event. +fullName: Severity +remarks: '' +isDeprecated: false +fields: + - name: Verbose + uid: botbuilder.Severity.Verbose + package: botbuilder + summary: '' + numericValue: 0 + - name: Information + uid: botbuilder.Severity.Information + package: botbuilder + summary: '' + numericValue: 1 + - name: Warning + uid: botbuilder.Severity.Warning + package: botbuilder + summary: '' + numericValue: 2 + - name: Error + uid: botbuilder.Severity.Error + package: botbuilder + summary: '' + numericValue: 3 + - name: Critical + uid: botbuilder.Severity.Critical + package: botbuilder + summary: '' + numericValue: 4 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SharePointActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SharePointActivityHandler.yml new file mode 100644 index 00000000..e31f4bc7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SharePointActivityHandler.yml @@ -0,0 +1,761 @@ +### YamlMime:TSType +name: SharePointActivityHandler +uid: botbuilder.SharePointActivityHandler +package: botbuilder +summary: >- + The SharePointActivityHandler is derived from ActivityHandler. It adds support + for + + the SharePoint specific events and interactions +fullName: SharePointActivityHandler +remarks: '' +isDeprecated: false +type: class +inheritedMethods: + - name: onCommand(BotHandler) + uid: botbuilder.SharePointActivityHandler.onCommand + package: botbuilder + summary: Registers an activity event handler for the _command_ activity. + remarks: >- + To handle a Command event, use the + + [onCommand](xref:botbuilder-core.ActivityHandler.onCommand) type-specific + event handler. + isDeprecated: false + syntax: + content: 'function onCommand(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onCommand](xref:botbuilder.ActivityHandler.onCommand) + - name: onCommandResult(BotHandler) + uid: botbuilder.SharePointActivityHandler.onCommandResult + package: botbuilder + summary: Registers an activity event handler for the _CommandResult_ activity. + remarks: >- + To handle a CommandResult event, use the + + [onCommandResult](xref:botbuilder-core.ActivityHandler.onCommandResult) + type-specific event handler. + isDeprecated: false + syntax: + content: 'function onCommandResult(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onCommandResult](xref:botbuilder.ActivityHandler.onCommandResult) + - name: onConversationUpdate(BotHandler) + uid: botbuilder.SharePointActivityHandler.onConversationUpdate + package: botbuilder + summary: >- + Registers an activity event handler for the _conversation update_ event, + emitted for every incoming + + conversation update activity. + remarks: >- + Conversation update activities describe a changes to a conversation's + metadata, such as title, participants, + + or other channel-specific information. + + + To handle when members are added to or removed from the conversation, use + the + + [onMembersAdded](xref:botbuilder-core.ActivityHandler.onMembersAdded) and + + [onMembersRemoved](xref:botbuilder-core.ActivityHandler.onMembersRemoved) + sub-type event handlers. + isDeprecated: false + syntax: + content: >- + function onConversationUpdate(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onConversationUpdate](xref:botbuilder.ActivityHandler.onConversationUpdate) + - name: onDialog(BotHandler) + uid: botbuilder.SharePointActivityHandler.onDialog + package: botbuilder + summary: >- + Registers an activity event handler for the _dialog_ event, emitted as the + last event for an incoming activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function onDialog(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onDialog](xref:botbuilder.ActivityHandler.onDialog) + - name: onEndOfConversation(BotHandler) + uid: botbuilder.SharePointActivityHandler.onEndOfConversation + package: botbuilder + summary: >- + Registers an activity event handler for the _end of conversation_ + activity. + remarks: >- + This activity is typically send from a Skill to a Skill caller indicating + the end of that particular child conversation. + + + To handle an End of Conversation, use the + + [onEndOfConversation](xref:botbuilder-core.ActivityHandler.onEndOfConversation) + type-specific event handler. + isDeprecated: false + syntax: + content: >- + function onEndOfConversation(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onEndOfConversation](xref:botbuilder.ActivityHandler.onEndOfConversation) + - name: onEvent(BotHandler) + uid: botbuilder.SharePointActivityHandler.onEvent + package: botbuilder + summary: >- + Registers an activity event handler for the _event_ event, emitted for + every incoming event activity. + remarks: >- + Event activities communicate programmatic information from a client or + channel to a bot. + + The meaning of an event activity is defined by the activity's + + [name](xref:botframework-schema.Activity.name) property, which is + meaningful within the scope + + of a channel. Event activities are designed to carry both interactive + information (such as + + button clicks) and non-interactive information (such as a notification of + a client + + automatically updating an embedded speech model). + + + To handle a `tokens/response` event event, use the + + [onTokenResponseEvent](xref:botbuilder-core.ActivityHandler.onTokenResponseEvent) + sub-type + + event handler. To handle other named events, add logic to this handler. + isDeprecated: false + syntax: + content: 'function onEvent(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onEvent](xref:botbuilder.ActivityHandler.onEvent) + - name: onInstallationUpdate(BotHandler) + uid: botbuilder.SharePointActivityHandler.onInstallationUpdate + package: botbuilder + summary: Registers an activity event handler for the _installationupdate_ activity. + remarks: >- + To handle a InstallationUpdate event, use the + + [onInstallationUpdate](xref:botbuilder-core.ActivityHandler.onInstallationUpdate) + type-specific event handler. + isDeprecated: false + syntax: + content: >- + function onInstallationUpdate(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onInstallationUpdate](xref:botbuilder.ActivityHandler.onInstallationUpdate) + - name: onInstallationUpdateAdd(BotHandler) + uid: botbuilder.SharePointActivityHandler.onInstallationUpdateAdd + package: botbuilder + summary: >- + Registers an activity event handler for the _installationupdate add_ + activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onInstallationUpdateAdd(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + + To handle a InstallationUpdateAdd event, use the + + [onInstallationUpdateAdd](xref:botbuilder-core.ActivityHandler.onInstallationUpdateAdd) + type-specific event handler. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onInstallationUpdateAdd](xref:botbuilder.ActivityHandler.onInstallationUpdateAdd) + - name: onInstallationUpdateRemove(BotHandler) + uid: botbuilder.SharePointActivityHandler.onInstallationUpdateRemove + package: botbuilder + summary: >- + Registers an activity event handler for the _installationupdate remove_ + activity. + remarks: >- + To handle a InstallationUpdateRemove event, use the + + [onInstallationUpdateRemove](xref:botbuilder-core.ActivityHandler.onInstallationUpdateRemove) + type-specific event handler. + isDeprecated: false + syntax: + content: >- + function onInstallationUpdateRemove(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onInstallationUpdateRemove](xref:botbuilder.ActivityHandler.onInstallationUpdateRemove) + - name: onMembersAdded(BotHandler) + uid: botbuilder.SharePointActivityHandler.onMembersAdded + package: botbuilder + summary: >- + Registers an activity event handler for the _members added_ event, emitted + for any incoming + + conversation update activity that includes members added to the + conversation. + remarks: >- + The activity's + [membersAdded](xref:botframework-schema.Activity.membersAdded) property + + contains the members added to the conversation, which can include the bot. + + + To handle conversation update events in general, use the + + [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) + type-specific event handler. + isDeprecated: false + syntax: + content: 'function onMembersAdded(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMembersAdded](xref:botbuilder.ActivityHandler.onMembersAdded) + - name: onMembersRemoved(BotHandler) + uid: botbuilder.SharePointActivityHandler.onMembersRemoved + package: botbuilder + summary: >- + Registers an activity event handler for the _members removed_ event, + emitted for any incoming + + conversation update activity that includes members removed from the + conversation. + remarks: >- + The activity's + [membersRemoved](xref:botframework-schema.Activity.membersRemoved) + property + + contains the members removed from the conversation, which can include the + bot. + + + To handle conversation update events in general, use the + + [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) + type-specific event handler. + isDeprecated: false + syntax: + content: >- + function onMembersRemoved(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMembersRemoved](xref:botbuilder.ActivityHandler.onMembersRemoved) + - name: onMessage(BotHandler) + uid: botbuilder.SharePointActivityHandler.onMessage + package: botbuilder + summary: >- + Registers an activity event handler for the _message_ event, emitted for + every incoming message activity. + remarks: >- + Message activities represent content intended to be shown within a + conversational interface + + and can contain text, speech, interactive cards, and binary or unknown + attachments. + + Not all message activities contain text, the activity's + [text](xref:botframework-schema.Activity.text) + + property can be `null` or `undefined`. + isDeprecated: false + syntax: + content: 'function onMessage(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessage](xref:botbuilder.ActivityHandler.onMessage) + - name: onMessageDelete(BotHandler) + uid: botbuilder.SharePointActivityHandler.onMessageDelete + package: botbuilder + summary: >- + Registers an activity event handler for the _message delete_ event, + emitted for every incoming message activity. + remarks: >- + Message delete activities represent a deletion of an existing message + activity within a conversation. + + The deleted activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity. + + Message delete activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageDelete`. + isDeprecated: false + syntax: + content: 'function onMessageDelete(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessageDelete](xref:botbuilder.ActivityHandler.onMessageDelete) + - name: onMessageReaction(BotHandler) + uid: botbuilder.SharePointActivityHandler.onMessageReaction + package: botbuilder + summary: >- + Registers an activity event handler for the _message reaction_ event, + emitted for every incoming + + message reaction activity. + remarks: >- + Message reaction activities represent a social interaction on an existing + message activity + + within a conversation. The original activity is referred to by the message + reaction activity's + + [replyToId](xref:botframework-schema.Activity.replyToId) property. The + + [from](xref:botframework-schema.Activity.from) property represents the + source of the reaction, + + such as the user that reacted to the message. + + + To handle when reactions are added to or removed from messages in the + conversation, use the + + [onReactionsAdded](xref:botbuilder-core.ActivityHandler.onReactionsAdded) + and + + [onReactionsRemoved](xref:botbuilder-core.ActivityHandler.onReactionsRemoved) + sub-type event handlers. + isDeprecated: false + syntax: + content: >- + function onMessageReaction(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessageReaction](xref:botbuilder.ActivityHandler.onMessageReaction) + - name: onMessageUpdate(BotHandler) + uid: botbuilder.SharePointActivityHandler.onMessageUpdate + package: botbuilder + summary: >- + Registers an activity event handler for the _message update_ event, + emitted for every incoming message activity. + remarks: >- + Message update activities represent an update of an existing message + activity within a conversation. + + The updated activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity, and the + + message update activity contains all fields in the revised message + activity. + + Message update activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageUpdate`. + isDeprecated: false + syntax: + content: 'function onMessageUpdate(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessageUpdate](xref:botbuilder.ActivityHandler.onMessageUpdate) + - name: onReactionsAdded(BotHandler) + uid: botbuilder.SharePointActivityHandler.onReactionsAdded + package: botbuilder + summary: >- + Registers an activity event handler for the _reactions added_ event, + emitted for any incoming + + message reaction activity that describes reactions added to a message. + remarks: >- + The activity's + [reactionsAdded](xref:botframework-schema.Activity.reactionsAdded) + property + + includes one or more reactions that were added. + + + To handle message reaction events in general, use the + + [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) + type-specific event handler. + isDeprecated: false + syntax: + content: >- + function onReactionsAdded(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onReactionsAdded](xref:botbuilder.ActivityHandler.onReactionsAdded) + - name: onReactionsRemoved(BotHandler) + uid: botbuilder.SharePointActivityHandler.onReactionsRemoved + package: botbuilder + summary: >- + Registers an activity event handler for the _reactions removed_ event, + emitted for any incoming + + message reaction activity that describes reactions removed from a message. + remarks: >- + The activity's + [reactionsRemoved](xref:botframework-schema.Activity.reactionsRemoved) + property + + includes one or more reactions that were removed. + + + To handle message reaction events in general, use the + + [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) + type-specific event handler. + isDeprecated: false + syntax: + content: >- + function onReactionsRemoved(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onReactionsRemoved](xref:botbuilder.ActivityHandler.onReactionsRemoved) + - name: onTokenResponseEvent(BotHandler) + uid: botbuilder.SharePointActivityHandler.onTokenResponseEvent + package: botbuilder + summary: >- + Registers an activity event handler for the _tokens-response_ event, + emitted for any incoming + + `tokens/response` event activity. These are generated as part of the OAuth + authentication flow. + remarks: >- + The activity's [value](xref:botframework-schema.Activity.value) property + contains the user token. + + + If your bot handles authentication using an + [OAuthPrompt](xref:botbuilder-dialogs.OAuthPrompt) + + within a dialog, then the dialog will need to receive this activity to + complete the authentication flow. + + + To handle other named events and event events in general, use the + + [onEvent](xref:botbuilder-core.ActivityHandler.onEvent) type-specific + event handler. + isDeprecated: false + syntax: + content: >- + function onTokenResponseEvent(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onTokenResponseEvent](xref:botbuilder.ActivityHandler.onTokenResponseEvent) + - name: onTurn(BotHandler) + uid: botbuilder.SharePointActivityHandler.onTurn + package: botbuilder + summary: >- + Registers an activity event handler for the _turn_ event, emitted for + every incoming activity, regardless of type. + remarks: '' + isDeprecated: false + syntax: + content: 'function onTurn(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onTurn](xref:botbuilder.ActivityHandler.onTurn) + - name: onTyping(BotHandler) + uid: botbuilder.SharePointActivityHandler.onTyping + package: botbuilder + summary: Registers an activity event handler for the _typing_ activity. + remarks: >- + To handle a Typing event, use the + + [onTyping](xref:botbuilder-core.ActivityHandler.onTyping) type-specific + event handler. + isDeprecated: false + syntax: + content: 'function onTyping(handler: BotHandler): SharePointActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onTyping](xref:botbuilder.ActivityHandler.onTyping) + - name: onUnrecognizedActivityType(BotHandler) + uid: botbuilder.SharePointActivityHandler.onUnrecognizedActivityType + package: botbuilder + summary: >- + Registers an activity event handler for the _unrecognized activity type_ + event, emitted for an + + incoming activity with a type for which the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) + + doesn't provide an event handler. + remarks: >- + The `ActivityHandler` does not define events for all activity types + defined in the + + [Bot Framework Activity schema](http://aka.ms/botSpecs-activitySchema). In + addition, + + channels and custom adapters can create + [Activities](xref:botframework-schema.Activity) with + + types not in the schema. When the activity handler receives such an event, + it emits an unrecognized activity type event. + + + The activity's [type](xref:botframework-schema.Activity.type) property + contains the activity type. + isDeprecated: false + syntax: + content: >- + function onUnrecognizedActivityType(handler: BotHandler): + SharePointActivityHandler + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onUnrecognizedActivityType](xref:botbuilder.ActivityHandler.onUnrecognizedActivityType) + - name: run(TurnContext) + uid: botbuilder.SharePointActivityHandler.run + package: botbuilder + summary: Called to initiate the event emission process. + remarks: >- + Typically, you would provide this method as the function handler that the + adapter calls + + to perform the bot's logic after the received activity has been + pre-processed by the adapter + + and routed through any middleware. + + + For example: + + ```javascript + server.post('/api/messages', (req, res) => { + adapter.processActivity(req, res, async (context) => { + // Route to bot's activity logic. + await bot.run(context); + }); + }); + + ``` + + + **See also** + + - + [BotFrameworkAdapter.processActivity](xref:botbuilder.BotFrameworkAdapter.processActivity) + isDeprecated: false + syntax: + content: 'function run(context: TurnContext): Promise' + parameters: + - id: context + type: + description: The context object for the current turn. + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [ActivityHandler.run](xref:botbuilder.ActivityHandler.run) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationActionParameters.yml new file mode 100644 index 00000000..1bd5f1c9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationActionParameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: ShowLocationActionParameters +uid: botbuilder.ShowLocationActionParameters +package: botbuilder +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.ShowLocation + action. +fullName: ShowLocationActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: locationCoordinates + uid: botbuilder.ShowLocationActionParameters.locationCoordinates + package: botbuilder + summary: |- + If set, show the coordinates that were passed. + Otherwise, show the current location. + fullName: locationCoordinates + remarks: '' + isDeprecated: false + syntax: + content: 'locationCoordinates?: Location' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationCardAction.yml new file mode 100644 index 00000000..f49bbce3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowLocationCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ShowLocationCardAction +uid: botbuilder.ShowLocationCardAction +package: botbuilder +summary: SharePoint `VivaAction.ShowLocation` event. +fullName: ShowLocationCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botbuilder.ShowLocationCardAction.parameters + package: botbuilder + summary: Parameters that can be supplied with the Viva Show Location action. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: ShowLocationActionParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.ShowLocationCardAction.type + package: botbuilder + summary: Indicates this is a Viva show Location button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.ShowLocation"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowTypingMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowTypingMiddleware.yml new file mode 100644 index 00000000..d419a4ea --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ShowTypingMiddleware.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: ShowTypingMiddleware +uid: botbuilder.ShowTypingMiddleware +package: botbuilder +summary: Middleware that will send a typing indicator automatically for each message. +fullName: ShowTypingMiddleware +remarks: >- + When added, this middleware will send typing activities back to the user when + a Message activity + + is received to let them know that the bot has received the message and is + working on the response. + + You can specify a delay in milliseconds before the first typing activity is + sent and then a frequency, + + also in milliseconds which determines how often another typing activity is + sent. Typing activities + + will continue to be sent until your bot sends another message back to the user +isDeprecated: false +type: class +constructors: + - name: ShowTypingMiddleware(number, number) + uid: botbuilder.ShowTypingMiddleware.constructor + package: botbuilder + summary: Create the SendTypingIndicator middleware + remarks: '' + isDeprecated: false + syntax: + content: 'new ShowTypingMiddleware(delay?: number, period?: number)' + parameters: + - id: delay + type: number + description: >- + {number} Number of milliseconds to wait before sending the first + typing indicator. + - id: period + type: number + description: >- + {number} Number of milliseconds to wait before sending each + following indicator. +methods: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.ShowTypingMiddleware.onTurn + package: botbuilder + summary: Processes an incoming activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: '{TurnContext} An incoming TurnContext object.' + - id: next + type: () => Promise<void> + description: '{function} The next delegate function.' + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SignInCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SignInCardViewParameters.yml new file mode 100644 index 00000000..d4b5bb97 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SignInCardViewParameters.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: SignInCardViewParameters +uid: botbuilder.SignInCardViewParameters +package: botbuilder +summary: The parameters for the sign in card view. +fullName: SignInCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.SignInCardViewParameters.body + package: botbuilder + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: undefined | [CardTextComponent]' + return: + description: '' + type: undefined | [CardTextComponent] + - name: cardViewType + uid: botbuilder.SignInCardViewParameters.cardViewType + package: botbuilder + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "signIn"' + return: + description: '' + type: '"signIn"' + - name: footer + uid: botbuilder.SignInCardViewParameters.footer + package: botbuilder + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: [CardButtonComponent]' + return: + description: '' + type: '[CardButtonComponent]' + - name: header + uid: botbuilder.SignInCardViewParameters.header + package: botbuilder + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' +inheritedProperties: + - name: cardBar + uid: botbuilder.SignInCardViewParameters.cardBar + package: botbuilder + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SignInUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SignInUrlResponse.yml new file mode 100644 index 00000000..d3d07e4b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SignInUrlResponse.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SignInUrlResponse +uid: botbuilder.SignInUrlResponse +package: botbuilder +summary: '' +fullName: SignInUrlResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: signInLink + uid: botbuilder.SignInUrlResponse.signInLink + package: botbuilder + summary: '' + fullName: signInLink + remarks: '' + isDeprecated: false + syntax: + content: 'signInLink?: string' + return: + description: '' + type: string + - name: tokenExchangeResource + uid: botbuilder.SignInUrlResponse.tokenExchangeResource + package: botbuilder + summary: '' + fullName: tokenExchangeResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenExchangeResource?: TokenExchangeResource' + return: + description: '' + type: + - name: tokenPostResource + uid: botbuilder.SignInUrlResponse.tokenPostResource + package: botbuilder + summary: '' + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource?: TokenPostResource' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SigninCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SigninCard.yml new file mode 100644 index 00000000..d7e90baa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SigninCard.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: SigninCard +uid: botbuilder.SigninCard +package: botbuilder +summary: A card representing a request to sign in +fullName: SigninCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder.SigninCard.buttons + package: botbuilder + summary: Action to use to perform signin + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: text + uid: botbuilder.SigninCard.text + package: botbuilder + summary: Text for signin request + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SigninStateVerificationQuery.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SigninStateVerificationQuery.yml new file mode 100644 index 00000000..f95a31c5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SigninStateVerificationQuery.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: SigninStateVerificationQuery +uid: botbuilder.SigninStateVerificationQuery +package: botbuilder +summary: '' +fullName: SigninStateVerificationQuery +remarks: '' +isDeprecated: false +type: interface +properties: + - name: state + uid: botbuilder.SigninStateVerificationQuery.state + package: botbuilder + summary: The state string originally received when the + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactory.yml new file mode 100644 index 00000000..dbd8568c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactory.yml @@ -0,0 +1,148 @@ +### YamlMime:TSType +name: SkillConversationIdFactory +uid: botbuilder.SkillConversationIdFactory +package: botbuilder +summary: >- + A SkillConversationIdFactory that stores and retrieves + [ConversationReference](xref:botframework-schema:ConversationReference) + instances. +fullName: SkillConversationIdFactory +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SkillConversationIdFactory(Storage) + uid: botbuilder.SkillConversationIdFactory.constructor + package: botbuilder + summary: Creates a new instance of the SkillConversationIdFactory class. + remarks: '' + isDeprecated: false + syntax: + content: 'new SkillConversationIdFactory(storage: Storage)' + parameters: + - id: storage + type: + description: >- + The storage for the + [ConversationReference](xref:botframework-schema:ConversationReference) + instances. +inheritedMethods: + - name: createSkillConversationId(ConversationReference) + uid: botbuilder.SkillConversationIdFactory.createSkillConversationId + package: botbuilder + summary: >- + Creates a conversation ID for a skill conversation based on the caller's + ConversationReference. + remarks: >- + It should be possible to use the returned string on a request URL and it + should not contain special characters. + + Returns A unique conversation ID used to communicate with the skill. + isDeprecated: true + customDeprecatedMessage: >- + Method is deprecated, please use createSkillConversationIdWithOptions() + with SkillConversationIdFactoryOptions instead. + syntax: + content: >- + function createSkillConversationId(_conversationReference: + ConversationReference): Promise + parameters: + - id: _conversationReference + type: + description: The skill's caller ConversationReference. + return: + description: '' + type: Promise<string> + inheritanceDescription: >- + Inherited From + [SkillConversationIdFactoryBase.createSkillConversationId](xref:botbuilder.SkillConversationIdFactoryBase.createSkillConversationId) + - name: getConversationReference(string) + uid: botbuilder.SkillConversationIdFactory.getConversationReference + package: botbuilder + summary: >- + Gets the ConversationReference created using createSkillConversationId() + for a skillConversationId. + remarks: >- + Returns The caller's ConversationReference for a skillConversationId. null + if not found. + isDeprecated: true + customDeprecatedMessage: Method is deprecated, please use getSkillConversationReference() instead. + syntax: + content: >- + function getConversationReference(_skillConversationId: string): + Promise + parameters: + - id: _skillConversationId + type: string + description: A skill conversationId created using createSkillConversationId(). + return: + description: '' + type: Promise<> + inheritanceDescription: >- + Inherited From + [SkillConversationIdFactoryBase.getConversationReference](xref:botbuilder.SkillConversationIdFactoryBase.getConversationReference) +methods: + - name: createSkillConversationIdWithOptions(SkillConversationIdFactoryOptions) + uid: botbuilder.SkillConversationIdFactory.createSkillConversationIdWithOptions + package: botbuilder + summary: >- + Creates a conversation ID for a skill conversation based on the caller's + [ConversationReference](xref:botframework-schema:ConversationReference). + remarks: '' + isDeprecated: false + syntax: + content: >- + function createSkillConversationIdWithOptions(options: + SkillConversationIdFactoryOptions): Promise + parameters: + - id: options + type: + description: >- + The + [SkillConversationIdFactoryOptions](xref:botbuilder-core.SkillConversationIdFactoryOptions) + to use. + return: + description: A unique conversation ID used to communicate with the skill. + type: Promise<string> + - name: deleteConversationReference(string) + uid: botbuilder.SkillConversationIdFactory.deleteConversationReference + package: botbuilder + summary: >- + Deletes the + [SkillConversationReference](xref:botbuilder-core.SkillConversationReference) + from the storage. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteConversationReference(skillConversationId: string): + Promise + parameters: + - id: skillConversationId + type: string + description: The skill conversation id to use as key for the delete. + return: + description: A promise representing the asynchronous operation. + type: Promise<void> + - name: getSkillConversationReference(string) + uid: botbuilder.SkillConversationIdFactory.getSkillConversationReference + package: botbuilder + summary: >- + Gets the ConversationReference created using createSkillConversationId() + for a skillConversationId. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSkillConversationReference(skillConversationId: string): + Promise + parameters: + - id: skillConversationId + type: string + description: A skill conversationId created using createSkillConversationId(). + return: + description: >- + The caller's ConversationReference for a skillConversationId. Null if + not found. + type: Promise<> +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryBase.yml new file mode 100644 index 00000000..34acc6a9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryBase.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: SkillConversationIdFactoryBase +uid: botbuilder.SkillConversationIdFactoryBase +package: botbuilder +summary: >- + Defines the methods of a factory that is used to create unique conversation + IDs for skill conversations. +fullName: SkillConversationIdFactoryBase +remarks: '' +isDeprecated: false +type: class +methods: + - name: createSkillConversationId(ConversationReference) + uid: botbuilder.SkillConversationIdFactoryBase.createSkillConversationId + package: botbuilder + summary: >- + Creates a conversation ID for a skill conversation based on the caller's + ConversationReference. + remarks: >- + It should be possible to use the returned string on a request URL and it + should not contain special characters. + + Returns A unique conversation ID used to communicate with the skill. + isDeprecated: true + customDeprecatedMessage: >- + Method is deprecated, please use createSkillConversationIdWithOptions() + with SkillConversationIdFactoryOptions instead. + syntax: + content: >- + function createSkillConversationId(_conversationReference: + ConversationReference): Promise + parameters: + - id: _conversationReference + type: + description: The skill's caller ConversationReference. + return: + description: '' + type: Promise<string> + - name: createSkillConversationIdWithOptions(SkillConversationIdFactoryOptions) + uid: >- + botbuilder.SkillConversationIdFactoryBase.createSkillConversationIdWithOptions + package: botbuilder + summary: >- + Creates a conversation ID for a skill conversation based on the caller's + ConversationReference. + remarks: >- + It should be possible to use the returned string on a request URL and it + should not contain special characters. + + Returns A unique conversation ID used to communicate with the skill. + isDeprecated: false + syntax: + content: >- + function createSkillConversationIdWithOptions(_options: + SkillConversationIdFactoryOptions): Promise + parameters: + - id: _options + type: + description: >- + The + [SkillConversationIdFactoryOptions](xref:botbuilder-core.SkillConversationIdFactoryOptions) + to use. + return: + description: '' + type: Promise<string> + - name: deleteConversationReference(string) + uid: botbuilder.SkillConversationIdFactoryBase.deleteConversationReference + package: botbuilder + summary: Deletes a ConversationReference. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteConversationReference(skillConversationId: string): + Promise + parameters: + - id: skillConversationId + type: string + description: A skill conversationId created using createSkillConversationId(). + return: + description: '' + type: Promise<void> + - name: getConversationReference(string) + uid: botbuilder.SkillConversationIdFactoryBase.getConversationReference + package: botbuilder + summary: >- + Gets the ConversationReference created using createSkillConversationId() + for a skillConversationId. + remarks: >- + Returns The caller's ConversationReference for a skillConversationId. null + if not found. + isDeprecated: true + customDeprecatedMessage: Method is deprecated, please use getSkillConversationReference() instead. + syntax: + content: >- + function getConversationReference(_skillConversationId: string): + Promise + parameters: + - id: _skillConversationId + type: string + description: A skill conversationId created using createSkillConversationId(). + return: + description: '' + type: Promise<> + - name: getSkillConversationReference(string) + uid: botbuilder.SkillConversationIdFactoryBase.getSkillConversationReference + package: botbuilder + summary: >- + Gets the SkillConversationReference created using + createSkillConversationId() for a skillConversationId. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSkillConversationReference(_skillConversationId: string): + Promise + parameters: + - id: _skillConversationId + type: string + description: >- + Gets the SkillConversationReference used during + createSkillConversationId for a skillConversationId. + return: + description: '' + type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryOptions.yml new file mode 100644 index 00000000..9b97ef06 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationIdFactoryOptions.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: SkillConversationIdFactoryOptions +uid: botbuilder.SkillConversationIdFactoryOptions +package: botbuilder +summary: '' +fullName: SkillConversationIdFactoryOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: botbuilder.SkillConversationIdFactoryOptions.activity + package: botbuilder + summary: The activity which will be sent to the skill. + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity: Activity' + return: + description: '' + type: + - name: botFrameworkSkill + uid: botbuilder.SkillConversationIdFactoryOptions.botFrameworkSkill + package: botbuilder + summary: The skill to create the conversation Id for. + fullName: botFrameworkSkill + remarks: '' + isDeprecated: false + syntax: + content: 'botFrameworkSkill: BotFrameworkSkill' + return: + description: '' + type: + - name: fromBotId + uid: botbuilder.SkillConversationIdFactoryOptions.fromBotId + package: botbuilder + summary: The id of the parent bot that is messaging the skill. + fullName: fromBotId + remarks: '' + isDeprecated: false + syntax: + content: 'fromBotId: string' + return: + description: '' + type: string + - name: fromBotOAuthScope + uid: botbuilder.SkillConversationIdFactoryOptions.fromBotOAuthScope + package: botbuilder + summary: >- + The oauth audience scope, used during token retrieval (either + https://api.botframework.com or bot app id if this is a skill calling + another skill). + fullName: fromBotOAuthScope + remarks: '' + isDeprecated: false + syntax: + content: 'fromBotOAuthScope: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationReference.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationReference.yml new file mode 100644 index 00000000..453ca605 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillConversationReference.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: SkillConversationReference +uid: botbuilder.SkillConversationReference +package: botbuilder +summary: '' +fullName: SkillConversationReference +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversationReference + uid: botbuilder.SkillConversationReference.conversationReference + package: botbuilder + summary: '' + fullName: conversationReference + remarks: '' + isDeprecated: false + syntax: + content: 'conversationReference: ConversationReference' + return: + description: '' + type: + - name: oAuthScope + uid: botbuilder.SkillConversationReference.oAuthScope + package: botbuilder + summary: '' + fullName: oAuthScope + remarks: '' + isDeprecated: false + syntax: + content: 'oAuthScope: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandler.yml index c76fe7c4..106ff97c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandler.yml @@ -5,7 +5,6 @@ package: botbuilder summary: '' fullName: SkillHandler remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: |- Use `CloudSkillHandler` instead. @@ -20,7 +19,6 @@ constructors: package: botbuilder summary: Initializes a new instance of the SkillHandler class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,13 +28,13 @@ constructors: AuthenticationConfiguration, channelService?: string) parameters: - id: adapter - type: BotAdapter + type: description: An instance of the BotAdapter that will handle the request. - id: bot - type: ActivityHandlerBase + type: description: The ActivityHandlerBase instance. - id: conversationIdFactory - type: SkillConversationIdFactoryBase + type: description: >- A SkillConversationIdFactoryBase to unpack the conversation ID and map it to the calling bot. @@ -48,7 +46,7 @@ constructors: description: The authentication configuration. - id: channelService type: string - description: > + description: >- The string indicating if the bot is working in Public Azure or in Azure Government (https://aka.ms/AzureGovDocs). properties: @@ -62,7 +60,6 @@ properties: remarks: >- The value is the same as the SkillConversationReferenceKey exported from botbuilder-core. - isPreview: false isDeprecated: false syntax: content: 'SkillConversationReferenceKey: symbol' @@ -70,12 +67,11 @@ properties: description: '' type: symbol inheritedMethods: - - name: 'handleCreateConversation(string, ConversationParameters)' + - name: handleCreateConversation(string, ConversationParameters) uid: botbuilder.SkillHandler.handleCreateConversation package: botbuilder summary: Creates a new Conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -86,22 +82,21 @@ inheritedMethods: type: string description: The authentication header. - id: parameters - type: ConversationParameters + type: description: >- - (xref:botbuilder-core.ConversationParameters) to create the - conversation from. + [ConversationParameters](xref:botbuilder-core.ConversationParameters) + to create the conversation from. return: description: A `Promise` representation for the operation. - type: Promise<ConversationResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleCreateConversation](xref:botbuilder.ChannelServiceHandlerBase.handleCreateConversation) - - name: 'handleDeleteActivity(string, string, string)' + [ChannelServiceHandler.handleCreateConversation](xref:botbuilder.ChannelServiceHandler.handleCreateConversation) + - name: handleDeleteActivity(string, string, string) uid: botbuilder.SkillHandler.handleDeleteActivity package: botbuilder - summary: 'Deletes an existing [Activity](xref:botframework-schema.Activity).' + summary: Deletes an existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -116,20 +111,18 @@ inheritedMethods: description: The conversation Id. - id: activityId type: string - description: | - The activity Id to delete. + description: The activity Id to delete. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleDeleteActivity](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteActivity) - - name: 'handleDeleteConversationMember(string, string, string)' + [ChannelServiceHandler.handleDeleteActivity](xref:botbuilder.ChannelServiceHandler.handleDeleteActivity) + - name: handleDeleteConversationMember(string, string, string) uid: botbuilder.SkillHandler.handleDeleteConversationMember package: botbuilder summary: Deletes a member from a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -144,22 +137,20 @@ inheritedMethods: description: The conversation Id. - id: memberId type: string - description: | - Id of the member to delete from this conversation. + description: Id of the member to delete from this conversation. return: description: '' type: Promise<void> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleDeleteConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleDeleteConversationMember) - - name: 'handleGetActivityMembers(string, string, string)' + [ChannelServiceHandler.handleDeleteConversationMember](xref:botbuilder.ChannelServiceHandler.handleDeleteConversationMember) + - name: handleGetActivityMembers(string, string, string) uid: botbuilder.SkillHandler.handleGetActivityMembers package: botbuilder summary: >- Enumerates the members of an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -179,16 +170,15 @@ inheritedMethods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' + type: Promise<[]> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetActivityMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetActivityMembers) - - name: 'handleGetConversationMember(string, string, string)' + [ChannelServiceHandler.handleGetActivityMembers](xref:botbuilder.ChannelServiceHandler.handleGetActivityMembers) + - name: handleGetConversationMember(string, string, string) uid: botbuilder.SkillHandler.handleGetConversationMember package: botbuilder summary: Gets the account of a single conversation member. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -208,16 +198,15 @@ inheritedMethods: description: >- The [ChannelAccount](xref:botframework-schema.ChannelAccount) for the provided user id. - type: Promise<ChannelAccount> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversationMember](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMember) - - name: 'handleGetConversationMembers(string, string)' + [ChannelServiceHandler.handleGetConversationMember](xref:botbuilder.ChannelServiceHandler.handleGetConversationMember) + - name: handleGetConversationMembers(string, string) uid: botbuilder.SkillHandler.handleGetConversationMembers package: botbuilder summary: Enumerates the members of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -234,16 +223,15 @@ inheritedMethods: description: >- The enumerated [ChannelAccount](xref:botframework-schema.ChannelAccount) list. - type: 'Promise<ChannelAccount[]>' + type: Promise<[]> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversationMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationMembers) - - name: 'handleGetConversationPagedMembers(string, string, number, string)' + [ChannelServiceHandler.handleGetConversationMembers](xref:botbuilder.ChannelServiceHandler.handleGetConversationMembers) + - name: handleGetConversationPagedMembers(string, string, number, string) uid: botbuilder.SkillHandler.handleGetConversationPagedMembers package: botbuilder summary: Enumerates the members of a conversation one page at a time. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -268,16 +256,15 @@ inheritedMethods: A `Promise` representing the [PagedMembersResult](xref:botframework-schema.PagedMembersResult) for the operation. - type: Promise<PagedMembersResult> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversationPagedMembers](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversationPagedMembers) - - name: 'handleGetConversations(string, string, string)' + [ChannelServiceHandler.handleGetConversationPagedMembers](xref:botbuilder.ChannelServiceHandler.handleGetConversationPagedMembers) + - name: handleGetConversations(string, string, string) uid: botbuilder.SkillHandler.handleGetConversations package: botbuilder summary: Lists the Conversations in which the bot has participated. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -295,16 +282,15 @@ inheritedMethods: description: A skip or continuation token. return: description: A `Promise` representation for the operation. - type: Promise<ConversationsResult> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleGetConversations](xref:botbuilder.ChannelServiceHandlerBase.handleGetConversations) - - name: 'handleReplyToActivity(string, string, string, Activity)' + [ChannelServiceHandler.handleGetConversations](xref:botbuilder.ChannelServiceHandler.handleGetConversations) + - name: handleReplyToActivity(string, string, string, Activity) uid: botbuilder.SkillHandler.handleReplyToActivity package: botbuilder - summary: 'Sends a reply to an [Activity](xref:botframework-schema.Activity).' + summary: Sends a reply to an [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -322,23 +308,22 @@ inheritedMethods: type: string description: The activity Id the reply is to. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleReplyToActivity](xref:botbuilder.ChannelServiceHandlerBase.handleReplyToActivity) - - name: 'handleSendConversationHistory(string, string, Transcript)' + [ChannelServiceHandler.handleReplyToActivity](xref:botbuilder.ChannelServiceHandler.handleReplyToActivity) + - name: handleSendConversationHistory(string, string, Transcript) uid: botbuilder.SkillHandler.handleSendConversationHistory package: botbuilder summary: Uploads the historic activities of the conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -353,25 +338,24 @@ inheritedMethods: type: string description: The conversation Id. - id: transcript - type: Transcript - description: '(xref:botframework-schema.Transcript) of activities.' + type: + description: '[Transcript](xref:botframework-schema.Transcript) of activities.' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleSendConversationHistory](xref:botbuilder.ChannelServiceHandlerBase.handleSendConversationHistory) - - name: 'handleSendToConversation(string, string, Activity)' + [ChannelServiceHandler.handleSendConversationHistory](xref:botbuilder.ChannelServiceHandler.handleSendConversationHistory) + - name: handleSendToConversation(string, string, Activity) uid: botbuilder.SkillHandler.handleSendToConversation package: botbuilder summary: >- Sends an [Activity](xref:botframework-schema.Activity) to the end of a conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -385,25 +369,24 @@ inheritedMethods: type: string description: The conversation Id. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleSendToConversation](xref:botbuilder.ChannelServiceHandlerBase.handleSendToConversation) - - name: 'handleUpdateActivity(string, string, string, Activity)' + [ChannelServiceHandler.handleSendToConversation](xref:botbuilder.ChannelServiceHandler.handleSendToConversation) + - name: handleUpdateActivity(string, string, string, Activity) uid: botbuilder.SkillHandler.handleUpdateActivity package: botbuilder summary: >- Edits a previously sent existing [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -421,23 +404,22 @@ inheritedMethods: type: string description: The activity Id to update. - id: activity - type: Activity - description: 'The replacement [Activity](xref:botframework-schema.Activity).' + type: + description: The replacement [Activity](xref:botframework-schema.Activity). return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleUpdateActivity](xref:botbuilder.ChannelServiceHandlerBase.handleUpdateActivity) - - name: 'handleUploadAttachment(string, string, AttachmentData)' + [ChannelServiceHandler.handleUpdateActivity](xref:botbuilder.ChannelServiceHandler.handleUpdateActivity) + - name: handleUploadAttachment(string, string, AttachmentData) uid: botbuilder.SkillHandler.handleUploadAttachment package: botbuilder summary: Stores data in a compliant store when dealing with enterprises. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -451,15 +433,15 @@ inheritedMethods: type: string description: The conversation Id. - id: attachmentUpload - type: AttachmentData - description: '(xref:botframework-schema.AttachmentData).' + type: + description: '[AttachmentData](xref:botframework-schema.AttachmentData).' return: description: >- A `Promise` representing the [ResourceResponse](xref:botframework-schema.ResourceResponse) for the operation. - type: Promise<ResourceResponse> + type: Promise<> inheritanceDescription: >- Inherited From - [ChannelServiceHandlerBase.handleUploadAttachment](xref:botbuilder.ChannelServiceHandlerBase.handleUploadAttachment) + [ChannelServiceHandler.handleUploadAttachment](xref:botbuilder.ChannelServiceHandler.handleUploadAttachment) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandlerImpl.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandlerImpl.yml deleted file mode 100644 index a211835e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHandlerImpl.yml +++ /dev/null @@ -1,171 +0,0 @@ -### YamlMime:TSType -name: SkillHandlerImpl -uid: botbuilder.SkillHandlerImpl -package: botbuilder -summary: '' -fullName: SkillHandlerImpl -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - SkillHandlerImpl(symbol, BotAdapter, (context: TurnContext) => - Promise, SkillConversationIdFactoryBase, () => string | undefined) - uid: botbuilder.SkillHandlerImpl.constructor - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SkillHandlerImpl(skillConversationReferenceKey: symbol, adapter: - BotAdapter, logic: (context: TurnContext) => Promise, - conversationIdFactory: SkillConversationIdFactoryBase, getOauthScope?: - () => string | undefined) - parameters: - - id: skillConversationReferenceKey - type: symbol - description: '' - - id: adapter - type: BotAdapter - description: '' - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: '' - - id: conversationIdFactory - type: SkillConversationIdFactoryBase - description: '' - - id: getOauthScope - type: () => string | undefined - description: '' -methods: - - name: 'onDeleteActivity(ClaimsIdentity, string, string)' - uid: botbuilder.SkillHandlerImpl.onDeleteActivity - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onDeleteActivity(claimsIdentity: ClaimsIdentity, - conversationId: string, activityId: string): Promise - parameters: - - id: claimsIdentity - type: ClaimsIdentity - description: '' - - id: conversationId - type: string - description: '' - - id: activityId - type: string - description: '' - return: - description: '' - type: Promise<void> - - name: 'onGetMember(ClaimsIdentity, string, string)' - uid: botbuilder.SkillHandlerImpl.onGetMember - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onGetMember(claimsIdentity: ClaimsIdentity, userId: string, - conversationId: string): Promise - parameters: - - id: claimsIdentity - type: ClaimsIdentity - description: '' - - id: userId - type: string - description: '' - - id: conversationId - type: string - description: '' - return: - description: '' - type: Promise<ChannelAccount> - - name: 'onReplyToActivity(ClaimsIdentity, string, string, Activity)' - uid: botbuilder.SkillHandlerImpl.onReplyToActivity - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onReplyToActivity(claimsIdentity: ClaimsIdentity, - conversationId: string, activityId: string, activity: Activity): - Promise - parameters: - - id: claimsIdentity - type: ClaimsIdentity - description: '' - - id: conversationId - type: string - description: '' - - id: activityId - type: string - description: '' - - id: activity - type: Activity - description: '' - return: - description: '' - type: Promise<ResourceResponse> - - name: 'onSendToConversation(ClaimsIdentity, string, Activity)' - uid: botbuilder.SkillHandlerImpl.onSendToConversation - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onSendToConversation(claimsIdentity: ClaimsIdentity, - conversationId: string, activity: Activity): Promise - parameters: - - id: claimsIdentity - type: ClaimsIdentity - description: '' - - id: conversationId - type: string - description: '' - - id: activity - type: Activity - description: '' - return: - description: '' - type: Promise<ResourceResponse> - - name: 'onUpdateActivity(ClaimsIdentity, string, string, Activity)' - uid: botbuilder.SkillHandlerImpl.onUpdateActivity - package: botbuilder - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onUpdateActivity(claimsIdentity: ClaimsIdentity, - conversationId: string, activityId: string, activity: Activity): - Promise - parameters: - - id: claimsIdentity - type: ClaimsIdentity - description: '' - - id: conversationId - type: string - description: '' - - id: activityId - type: string - description: '' - - id: activity - type: Activity - description: '' - return: - description: '' - type: Promise<ResourceResponse> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHttpClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHttpClient.yml index 8e307777..9421948e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHttpClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkillHttpClient.yml @@ -7,7 +7,6 @@ summary: >- ID generation. fullName: SkillHttpClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -20,7 +19,6 @@ constructors: Creates a new instance of the [SkillHttpClient](xref:botbuilder-core.SkillHttpClient) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,21 +32,19 @@ constructors: An instance of [ICredentialProvider](xref:botframework-connector.ICredentialProvider). - id: conversationIdFactory - type: SkillConversationIdFactoryBase + type: description: >- An instance of a class derived from [SkillConversationIdFactoryBase](xref:botbuilder-core.SkillConversationIdFactoryBase). - id: channelService type: string - description: | - Optional. The channel service. + description: Optional. The channel service. inheritedMethods: - - name: 'postActivity(string, string, string, string, string, Activity)' + - name: postActivity(string, string, string, string, string, Activity) uid: botbuilder.SkillHttpClient.postActivity package: botbuilder summary: Forwards an activity to another bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -72,23 +68,22 @@ inheritedMethods: type: string description: A conversation ID to use for the conversation with the skill. - id: activity - type: Activity + type: description: Activity to forward. return: description: A promise representing the asynchronous operation. - type: Promise<InvokeResponse<T>> + type: Promise<<T>> inheritanceDescription: >- Inherited From [BotFrameworkHttpClient.postActivity](xref:botbuilder.BotFrameworkHttpClient.postActivity) methods: - - name: 'postToSkill(string, BotFrameworkSkill, string, Activity)' + - name: postToSkill(string, BotFrameworkSkill, string, Activity) uid: botbuilder.SkillHttpClient.postToSkill_1 package: botbuilder summary: >- Uses the SkillConversationIdFactory to create or retrieve a Skill Conversation Id, and sends the activity. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: >- This overload is deprecated. Please use SkillHttpClient.postToSkill() that @@ -96,32 +91,30 @@ methods: syntax: content: >- function postToSkill(fromBotId: string, toSkill: BotFrameworkSkill, - callbackUrl: string, activity: Activity): Promise + callbackUrl: string, activity: Activity): Promise> parameters: - id: fromBotId type: string description: The MicrosoftAppId of the bot sending the activity. - id: toSkill - type: BotFrameworkSkill + type: description: The skill to create the Conversation Id for. - id: callbackUrl type: string description: The callback Url for the skill host. - id: activity - type: Activity - description: | - The activity to send. + type: + description: The activity to send. return: description: '' - type: Promise<InvokeResponse> - - name: 'postToSkill(string, string, BotFrameworkSkill, string, Activity)' + type: Promise<<any>> + - name: postToSkill(string, string, BotFrameworkSkill, string, Activity) uid: botbuilder.SkillHttpClient.postToSkill package: botbuilder summary: >- Uses the SkillConversationIdFactory to create or retrieve a Skill Conversation Id, and sends the activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -138,16 +131,15 @@ methods: type: string description: The MicrosoftAppId of the bot sending the activity. - id: toSkill - type: BotFrameworkSkill + type: description: The skill to create the Conversation Id for. - id: callbackUrl type: string description: The callback Url for the skill host. - id: activity - type: Activity - description: | - The activity to send. + type: + description: The activity to send. return: description: '' - type: Promise<InvokeResponse<T>> + type: Promise<<T>> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SkypeMentionNormalizeMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkypeMentionNormalizeMiddleware.yml new file mode 100644 index 00000000..aefbf681 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SkypeMentionNormalizeMiddleware.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: SkypeMentionNormalizeMiddleware +uid: botbuilder.SkypeMentionNormalizeMiddleware +package: botbuilder +summary: >- + Middleware to patch mention Entities from Skype since they don't conform to + expected values. + + Bots that interact with Skype should use this middleware if mentions are used. +fullName: SkypeMentionNormalizeMiddleware +remarks: >- + A Skype mention "text" field is of the format: + botname + But Activity.Text doesn't contain those tags and RemoveMentionText can't + remove + + the entity from Activity.Text. + + This will remove the nodes, leaving just the name. +isDeprecated: false +type: class +methods: + - name: normalizeSkypeMentionText(Activity) + uid: botbuilder.SkypeMentionNormalizeMiddleware.normalizeSkypeMentionText + package: botbuilder + summary: Performs the normalization of Skype mention Entities. + remarks: '' + isDeprecated: false + syntax: + content: 'static function normalizeSkypeMentionText(activity: Activity)' + parameters: + - id: activity + type: + description: >- + [Activity](xref:botframework-schema.Activity) containing the + mentions to normalize. + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.SkypeMentionNormalizeMiddleware.onTurn + package: botbuilder + summary: >- + Middleware implementation which corrects the Entity text of type + [Mention](xref:botframework-schema.Mention) to a value that + [removeMentionText](xref:botbuilder-core.TurnContext.removeMentionText) + can work with. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(turnContext: TurnContext, next: () => Promise): + Promise + parameters: + - id: turnContext + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation. + - id: next + type: () => Promise<void> + description: Delegate to call to continue the bot middleware pipeline. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SpeechConstants.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SpeechConstants.yml new file mode 100644 index 00000000..1809d787 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SpeechConstants.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: SpeechConstants +uid: botbuilder.SpeechConstants +package: botbuilder +summary: Defines constants that can be used in the processing of speech interactions. +fullName: SpeechConstants +remarks: '' +isDeprecated: false +type: class +properties: + - name: EmptySpeakTag + uid: botbuilder.SpeechConstants.EmptySpeakTag + package: botbuilder + summary: >- + The xml tag structure to indicate an empty speak tag, to be used in the + 'speak' property of an Activity. When set this indicates to the channel + that speech should not be generated. + fullName: EmptySpeakTag + remarks: '' + isDeprecated: false + syntax: + content: 'static EmptySpeakTag: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StatePropertyAccessor.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StatePropertyAccessor.yml new file mode 100644 index 00000000..ebde66f5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StatePropertyAccessor.yml @@ -0,0 +1,123 @@ +### YamlMime:TSType +name: StatePropertyAccessor +uid: botbuilder.StatePropertyAccessor +package: botbuilder +summary: |- + Defines methods for accessing a state property created in a + [BotState](xref:botbuilder-core.BotState) object. +fullName: StatePropertyAccessor +remarks: |- + To create a state property in a state management objet, use the + [createProperty\](xref:botbuilder-core.BotState.createProperty) method. +isDeprecated: false +type: interface +methods: + - name: delete(TurnContext) + uid: botbuilder.StatePropertyAccessor.delete + package: botbuilder + summary: Deletes the persisted property from its backing storage object. + remarks: >- + The properties backing storage object SHOULD be loaded into memory on + first access. + + + ```JavaScript + + await myProperty.delete(context); + + ``` + isDeprecated: false + syntax: + content: 'function delete(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + return: + description: '' + type: Promise<void> + - name: get(TurnContext) + uid: botbuilder.StatePropertyAccessor.get + package: botbuilder + summary: Reads a persisted property from its backing storage object. + remarks: >- + The properties backing storage object SHOULD be loaded into memory on + first access. + + + If the property does not currently exist on the storage object and a + `defaultValue` has been + + specified, a clone of the `defaultValue` SHOULD be copied to the storage + object. If a + + `defaultValue` has not been specified then a value of `undefined` SHOULD + be returned. + + + ```JavaScript + + const value = await myProperty.get(context, { count: 0 }); + + ``` + isDeprecated: false + syntax: + content: 'function get(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + return: + description: '' + type: Promise<undefined | T> + - name: get(TurnContext, T) + uid: botbuilder.StatePropertyAccessor.get_1 + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function get(context: TurnContext, defaultValue: T): Promise' + parameters: + - id: context + type: + description: '' + - id: defaultValue + type: T + description: '' + return: + description: '' + type: Promise<T> + - name: set(TurnContext, T) + uid: botbuilder.StatePropertyAccessor.set + package: botbuilder + summary: Assigns a new value to the properties backing storage object. + remarks: >- + The properties backing storage object SHOULD be loaded into memory on + first access. + + + Depending on the state systems implementation, an additional step may be + required to + + persist the actual changes to disk. + + + ```JavaScript + + await myProperty.set(context, value); + + ``` + isDeprecated: false + syntax: + content: 'function set(context: TurnContext, value: T): Promise' + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: value + type: T + description: Value to assign. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodeError.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodeError.yml index 19e8d821..19eef7d2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodeError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodeError.yml @@ -5,56 +5,39 @@ package: botbuilder summary: Extends Error to provide specialized error messages. fullName: StatusCodeError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'StatusCodeError(StatusCodes, string)' + - name: StatusCodeError(StatusCodes, string) uid: botbuilder.StatusCodeError.constructor package: botbuilder summary: >- Creates a new instance of the [StatusCodeError](xref:botbuilder.StatusCodeError) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StatusCodeError(statusCode: StatusCodes, message?: string)' parameters: - id: statusCode - type: StatusCodes + type: description: The status code. - id: message type: string - description: | - Optional. The error message. + description: Optional. The error message. properties: - - name: Error - uid: botbuilder.StatusCodeError.Error - package: botbuilder - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor - name: statusCode uid: botbuilder.StatusCodeError.statusCode package: botbuilder summary: '' fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode: StatusCodes' return: description: '' - type: StatusCodes + type: inheritedProperties: - name: message uid: botbuilder.StatusCodeError.message @@ -62,7 +45,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -76,7 +58,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -84,13 +65,28 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: botbuilder.StatusCodeError.prepareStackTrace + package: botbuilder + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: botbuilder.StatusCodeError.stack package: botbuilder summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -98,4 +94,36 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: botbuilder.StatusCodeError.stackTraceLimit + package: botbuilder + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: botbuilder.StatusCodeError.captureStackTrace + package: botbuilder + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace extends: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodes.yml new file mode 100644 index 00000000..e9206a4f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StatusCodes.yml @@ -0,0 +1,76 @@ +### YamlMime:TSEnum +name: StatusCodes +uid: botbuilder.StatusCodes +package: botbuilder +summary: |- + Defines values for StatusCodes. + Possible values include: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 +fullName: StatusCodes +remarks: '' +isDeprecated: false +fields: + - name: OK + uid: botbuilder.StatusCodes.OK + package: botbuilder + summary: '' + numericValue: 200 + - name: CREATED + uid: botbuilder.StatusCodes.CREATED + package: botbuilder + summary: '' + numericValue: 201 + - name: MULTIPLE_CHOICES + uid: botbuilder.StatusCodes.MULTIPLE_CHOICES + package: botbuilder + summary: '' + numericValue: 300 + - name: BAD_REQUEST + uid: botbuilder.StatusCodes.BAD_REQUEST + package: botbuilder + summary: '' + numericValue: 400 + - name: UNAUTHORIZED + uid: botbuilder.StatusCodes.UNAUTHORIZED + package: botbuilder + summary: '' + numericValue: 401 + - name: NOT_FOUND + uid: botbuilder.StatusCodes.NOT_FOUND + package: botbuilder + summary: '' + numericValue: 404 + - name: METHOD_NOT_ALLOWED + uid: botbuilder.StatusCodes.METHOD_NOT_ALLOWED + package: botbuilder + summary: '' + numericValue: 405 + - name: CONFLICT + uid: botbuilder.StatusCodes.CONFLICT + package: botbuilder + summary: '' + numericValue: 409 + - name: PRECONDITION_FAILED + uid: botbuilder.StatusCodes.PRECONDITION_FAILED + package: botbuilder + summary: '' + numericValue: 412 + - name: UPGRADE_REQUIRED + uid: botbuilder.StatusCodes.UPGRADE_REQUIRED + package: botbuilder + summary: '' + numericValue: 426 + - name: INTERNAL_SERVER_ERROR + uid: botbuilder.StatusCodes.INTERNAL_SERVER_ERROR + package: botbuilder + summary: '' + numericValue: 500 + - name: NOT_IMPLEMENTED + uid: botbuilder.StatusCodes.NOT_IMPLEMENTED + package: botbuilder + summary: '' + numericValue: 501 + - name: BAD_GATEWAY + uid: botbuilder.StatusCodes.BAD_GATEWAY + package: botbuilder + summary: '' + numericValue: 502 diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Storage.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Storage.yml new file mode 100644 index 00000000..5492308c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Storage.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Storage +uid: botbuilder.Storage +package: botbuilder +summary: >- + Interface for a storage provider that stores and retrieves plain old JSON + objects. +fullName: Storage +remarks: '' +isDeprecated: false +type: interface +methods: + - name: delete(string[]) + uid: botbuilder.Storage.delete + package: botbuilder + summary: Removes store items from storage + remarks: |- + This example deletes an object from storage: + + ```JavaScript + await storage.delete(['botState']); + ``` + isDeprecated: false + syntax: + content: 'function delete(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: Array of item keys to remove from the store. + return: + description: '' + type: Promise<void> + - name: read(string[]) + uid: botbuilder.Storage.read + package: botbuilder + summary: Loads store items from storage + remarks: |- + This example reads in a single object from storage: + + ```JavaScript + const items = await storage.read(['botState']); + const state = items['botState'] || {}; + ``` + isDeprecated: false + syntax: + content: 'function read(keys: string[]): Promise' + parameters: + - id: keys + type: string[] + description: Array of item keys to read from the store. + return: + description: '' + type: Promise<> + - name: write(StoreItems) + uid: botbuilder.Storage.write + package: botbuilder + summary: Saves store items to storage. + remarks: |- + This example writes an object to storage after its been modified: + + ```JavaScript + state.topic = 'someTopic'; + await storage.write({ 'botState': state }); + ``` + isDeprecated: false + syntax: + content: 'function write(changes: StoreItems): Promise' + parameters: + - id: changes + type: + description: Map of items to write to storage. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StorageKeyFactory.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StorageKeyFactory.yml new file mode 100644 index 00000000..098e10df --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StorageKeyFactory.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: StorageKeyFactory +uid: botbuilder.StorageKeyFactory +package: botbuilder +summary: |- + Callback to calculate a storage key. + + ```TypeScript + type StorageKeyFactory = (context: TurnContext) => Promise; + ``` +fullName: StorageKeyFactory +remarks: '' +isDeprecated: false +syntax: | + type StorageKeyFactory = (context: TurnContext) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItem.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItem.yml new file mode 100644 index 00000000..ba900ba3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItem.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: StoreItem +uid: botbuilder.StoreItem +package: botbuilder +summary: Object which is stored in Storage with an optional eTag. +fullName: StoreItem +remarks: '' +isDeprecated: false +type: interface +properties: + - name: eTag + uid: botbuilder.StoreItem.eTag + package: botbuilder + summary: (Optional) eTag field for stores that support optimistic concurrency. + fullName: eTag + remarks: '' + isDeprecated: false + syntax: + content: 'eTag?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItems.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItems.yml new file mode 100644 index 00000000..a9269c13 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StoreItems.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: StoreItems +uid: botbuilder.StoreItems +package: botbuilder +summary: Map of named `StoreItem` objects. +fullName: StoreItems +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StreamingHttpClient.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StreamingHttpClient.yml index b205656b..ea142a31 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/StreamingHttpClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StreamingHttpClient.yml @@ -7,7 +7,6 @@ summary: >- connections. fullName: StreamingHttpClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,15 +15,13 @@ constructors: package: botbuilder summary: Creates a new streaming Http client. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new StreamingHttpClient(server: IStreamingTransportServer)' parameters: - id: server type: IStreamingTransportServer - description: | - Transport server implementation to be used. + description: Transport server implementation to be used. methods: - name: sendRequest(WebResource) uid: botbuilder.StreamingHttpClient.sendRequest @@ -38,7 +35,6 @@ methods: and converting it to a form that can be sent over a streaming transport. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -46,10 +42,10 @@ methods: Promise parameters: - id: httpRequest - type: WebResource + type: description: The outgoing request created by the BotframeworkAdapter. return: description: >- The streaming transport compatible response to send back to the client. - type: Promise<HttpOperationResponse> + type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/StringUtils.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/StringUtils.yml new file mode 100644 index 00000000..09dcabef --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/StringUtils.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: StringUtils +uid: botbuilder.StringUtils +package: botbuilder +summary: Helper class containing string utility methods. +fullName: StringUtils +remarks: '' +isDeprecated: false +type: class +methods: + - name: ellipsis(string, number) + uid: botbuilder.StringUtils.ellipsis + package: botbuilder + summary: Truncate string with ... + remarks: '' + isDeprecated: false + syntax: + content: 'static function ellipsis(text: string, length: number): string' + parameters: + - id: text + type: string + description: Text. + - id: length + type: number + description: Length to truncate text. + return: + description: Original string modified. + type: string + - name: ellipsisHash(string, number) + uid: botbuilder.StringUtils.ellipsisHash + package: botbuilder + summary: >- + EllipsisHash - create truncated string with unique hash for the truncated + part. + remarks: '' + isDeprecated: false + syntax: + content: 'static function ellipsisHash(text: string, length: number): string' + parameters: + - id: text + type: string + description: Text to truncate. + - id: length + type: number + description: Length to truncate at. + return: + description: The truncated string with unique hash for the truncated part. + type: string + - name: hash(string) + uid: botbuilder.StringUtils.hash + package: botbuilder + summary: UniqueHash - create a unique hash from a string. + remarks: >- + The source for this function was derived from the following article: + + + https://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/ + isDeprecated: false + syntax: + content: 'static function hash(text: string): string' + parameters: + - id: text + type: string + description: Text to hash. + return: + description: A string which is an unique hash. + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Style.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Style.yml new file mode 100644 index 00000000..716de846 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Style.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Style +uid: botbuilder.Style +package: botbuilder +summary: |- + Defines values for Style. + Possible values include: 'compact', 'expanded' +fullName: Style +remarks: '' +isDeprecated: false +syntax: | + type Style = "compact" | "expanded" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardAction.yml new file mode 100644 index 00000000..bdbdebc2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SubmitCardAction +uid: botbuilder.SubmitCardAction +package: botbuilder +summary: SharePoint `Action.Submit` event. +fullName: SubmitCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: confirmationDialog + uid: botbuilder.SubmitCardAction.confirmationDialog + package: botbuilder + summary: Confirmation dialog option passed to the submit handler. + fullName: confirmationDialog + remarks: '' + isDeprecated: false + syntax: + content: 'confirmationDialog?: ConfirmationDialog' + return: + description: '' + type: + - name: parameters + uid: botbuilder.SubmitCardAction.parameters + package: botbuilder + summary: Parameters passed to the Submit event handler. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: SubmitCardParameters' + return: + description: '' + type: + - name: type + uid: botbuilder.SubmitCardAction.type + package: botbuilder + summary: Indicates this is a Submit button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "Submit"' + return: + description: '' + type: '"Submit"' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardParameters.yml new file mode 100644 index 00000000..0acbe5e5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SubmitCardParameters.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: SubmitCardParameters +uid: botbuilder.SubmitCardParameters +package: botbuilder +summary: Parameters for SharePoint Action.Submit card action. +fullName: SubmitCardParameters +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/SuggestedActions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/SuggestedActions.yml new file mode 100644 index 00000000..73ee9bc6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/SuggestedActions.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: SuggestedActions +uid: botbuilder.SuggestedActions +package: botbuilder +summary: SuggestedActions that can be performed +fullName: SuggestedActions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder.SuggestedActions.actions + package: botbuilder + summary: Actions that can be shown to the user + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: CardAction[]' + return: + description: '' + type: [] + - name: to + uid: botbuilder.SuggestedActions.to + package: botbuilder + summary: >- + Ids of the recipients that the actions should be shown to. These Ids are + relative to the + + channelId and a subset of all recipients of the activity + fullName: to + remarks: '' + isDeprecated: false + syntax: + content: 'to: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabContext.yml new file mode 100644 index 00000000..e45e75b4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabContext.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabContext +uid: botbuilder.TabContext +package: botbuilder +summary: '' +fullName: TabContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: theme + uid: botbuilder.TabContext.theme + package: botbuilder + summary: The current user's theme. + fullName: theme + remarks: '' + isDeprecated: false + syntax: + content: 'theme?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabEntityContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabEntityContext.yml new file mode 100644 index 00000000..b3f776ce --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabEntityContext.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabEntityContext +uid: botbuilder.TabEntityContext +package: botbuilder +summary: '' +fullName: TabEntityContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: tabEntityId + uid: botbuilder.TabEntityContext.tabEntityId + package: botbuilder + summary: The entity id of the tab. + fullName: tabEntityId + remarks: '' + isDeprecated: false + syntax: + content: 'tabEntityId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabRequest.yml new file mode 100644 index 00000000..3f9e8410 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TabRequest +uid: botbuilder.TabRequest +package: botbuilder +summary: '' +fullName: TabRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder.TabRequest.context + package: botbuilder + summary: The current user context, i.e., the current theme. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TabContext' + return: + description: '' + type: + - name: state + uid: botbuilder.TabRequest.state + package: botbuilder + summary: The magic code for OAuth flow. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state?: string' + return: + description: '' + type: string + - name: tabContext + uid: botbuilder.TabRequest.tabContext + package: botbuilder + summary: The current tab entity request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponse.yml new file mode 100644 index 00000000..17768c2e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabResponse +uid: botbuilder.TabResponse +package: botbuilder +summary: '' +fullName: TabResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: tab + uid: botbuilder.TabResponse.tab + package: botbuilder + summary: The response to the tab/fetch message. + fullName: tab + remarks: '' + isDeprecated: false + syntax: + content: 'tab: TabResponsePayload' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCard.yml new file mode 100644 index 00000000..9a10cbae --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCard.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabResponseCard +uid: botbuilder.TabResponseCard +package: botbuilder +summary: '' +fullName: TabResponseCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: botbuilder.TabResponseCard.card + package: botbuilder + summary: The adaptive card for this card tab response. + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card: Record' + return: + description: '' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCards.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCards.yml new file mode 100644 index 00000000..f5a7a8b3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponseCards.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabResponseCards +uid: botbuilder.TabResponseCards +package: botbuilder +summary: '' +fullName: TabResponseCards +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cards + uid: botbuilder.TabResponseCards.cards + package: botbuilder + summary: Adaptive cards for this card tab response. + fullName: cards + remarks: '' + isDeprecated: false + syntax: + content: 'cards: TabResponseCard[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponsePayload.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponsePayload.yml new file mode 100644 index 00000000..1fa5fbb7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabResponsePayload.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TabResponsePayload +uid: botbuilder.TabResponsePayload +package: botbuilder +summary: '' +fullName: TabResponsePayload +remarks: '' +isDeprecated: false +type: interface +properties: + - name: suggestedActions + uid: botbuilder.TabResponsePayload.suggestedActions + package: botbuilder + summary: The Suggested Actions for this card tab. + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: TabSuggestedActions' + return: + description: '' + type: + - name: type + uid: botbuilder.TabResponsePayload.type + package: botbuilder + summary: Choice of action options when responding to the tab/fetch message. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: "auth" | "continue" | "silentAuth"' + return: + description: '' + type: '"auth" | "continue" | "silentAuth"' + - name: value + uid: botbuilder.TabResponsePayload.value + package: botbuilder + summary: The TabResponseCards to send when responding to + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: TabResponseCards' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmit.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmit.yml new file mode 100644 index 00000000..2be46c8b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmit.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TabSubmit +uid: botbuilder.TabSubmit +package: botbuilder +summary: '' +fullName: TabSubmit +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder.TabSubmit.context + package: botbuilder + summary: The current user context, i.e., the current theme. + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TabContext' + return: + description: '' + type: + - name: data + uid: botbuilder.TabSubmit.data + package: botbuilder + summary: User input. Free payload containing properties of key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: TabSubmitData' + return: + description: '' + type: + - name: tabContext + uid: botbuilder.TabSubmit.tabContext + package: botbuilder + summary: The current tab's entity request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmitData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmitData.yml new file mode 100644 index 00000000..da28cc71 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSubmitData.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabSubmitData +uid: botbuilder.TabSubmitData +package: botbuilder +summary: '' +fullName: TabSubmitData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder.TabSubmitData.type + package: botbuilder + summary: Should currently be 'tab/submit'. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSuggestedActions.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSuggestedActions.yml new file mode 100644 index 00000000..6717d56f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TabSuggestedActions.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TabSuggestedActions +uid: botbuilder.TabSuggestedActions +package: botbuilder +summary: '' +fullName: TabSuggestedActions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: actions + uid: botbuilder.TabSuggestedActions.actions + package: botbuilder + summary: Actions to show in the card response. + fullName: actions + remarks: '' + isDeprecated: false + syntax: + content: 'actions: CardAction[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotification.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotification.yml new file mode 100644 index 00000000..db03637a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotification.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: TargetedMeetingNotification +uid: botbuilder.TargetedMeetingNotification +package: botbuilder +summary: '' +fullName: TargetedMeetingNotification +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botbuilder.TargetedMeetingNotification.channelData + package: botbuilder + summary: The channel data of the meeting notification. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: MeetingNotificationChannelData' + return: + description: '' + type: + - name: type + uid: botbuilder.TargetedMeetingNotification.type + package: botbuilder + summary: The type of meeting notification. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "targetedMeetingNotification"' + return: + description: '' + type: '"targetedMeetingNotification"' +inheritedProperties: + - name: value + uid: botbuilder.TargetedMeetingNotification.value + package: botbuilder + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: TargetedMeetingNotificationValue' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [MeetingNotificationBase.value](xref:botbuilder.MeetingNotificationBase.value) +extends: >- + <> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotificationValue.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotificationValue.yml new file mode 100644 index 00000000..c683fafb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TargetedMeetingNotificationValue.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TargetedMeetingNotificationValue +uid: botbuilder.TargetedMeetingNotificationValue +package: botbuilder +summary: '' +fullName: TargetedMeetingNotificationValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: recipients + uid: botbuilder.TargetedMeetingNotificationValue.recipients + package: botbuilder + summary: The list of recipient meeting MRIs. + fullName: recipients + remarks: '' + isDeprecated: false + syntax: + content: 'recipients: string[]' + return: + description: '' + type: string[] + - name: surfaces + uid: botbuilder.TargetedMeetingNotificationValue.surfaces + package: botbuilder + summary: The List of notification surface configuration. + fullName: surfaces + remarks: '' + isDeprecated: false + syntax: + content: 'surfaces: MeetingSurface[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleCardResponse.yml new file mode 100644 index 00000000..28b9ae11 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleCardResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: TaskModuleCardResponse +uid: botbuilder.TaskModuleCardResponse +package: botbuilder +summary: '' +fullName: TaskModuleCardResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: value + uid: botbuilder.TaskModuleCardResponse.value + package: botbuilder + summary: JSON for Adaptive cards to appear in the tab. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +inheritedProperties: + - name: type + uid: botbuilder.TaskModuleCardResponse.type + package: botbuilder + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleResponseBase.type](xref:botbuilder.TaskModuleResponseBase.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleContinueResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleContinueResponse.yml new file mode 100644 index 00000000..487f9aa4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleContinueResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: TaskModuleContinueResponse +uid: botbuilder.TaskModuleContinueResponse +package: botbuilder +summary: '' +fullName: TaskModuleContinueResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: value + uid: botbuilder.TaskModuleContinueResponse.value + package: botbuilder + summary: The JSON for the Adaptive card to + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: TaskModuleTaskInfo' + return: + description: '' + type: +inheritedProperties: + - name: type + uid: botbuilder.TaskModuleContinueResponse.type + package: botbuilder + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleResponseBase.type](xref:botbuilder.TaskModuleResponseBase.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleMessageResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleMessageResponse.yml new file mode 100644 index 00000000..33114fff --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleMessageResponse.yml @@ -0,0 +1,39 @@ +### YamlMime:TSType +name: TaskModuleMessageResponse +uid: botbuilder.TaskModuleMessageResponse +package: botbuilder +summary: '' +fullName: TaskModuleMessageResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: value + uid: botbuilder.TaskModuleMessageResponse.value + package: botbuilder + summary: Teams will display the value of value in a popup + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +inheritedProperties: + - name: type + uid: botbuilder.TaskModuleMessageResponse.type + package: botbuilder + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [TaskModuleResponseBase.type](xref:botbuilder.TaskModuleResponseBase.type) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequest.yml new file mode 100644 index 00000000..c4a9f4ea --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TaskModuleRequest +uid: botbuilder.TaskModuleRequest +package: botbuilder +summary: '' +fullName: TaskModuleRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: context + uid: botbuilder.TaskModuleRequest.context + package: botbuilder + summary: Current user context, i.e., + fullName: context + remarks: '' + isDeprecated: false + syntax: + content: 'context?: TaskModuleRequestContext' + return: + description: '' + type: + - name: data + uid: botbuilder.TaskModuleRequest.data + package: botbuilder + summary: User input data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + - name: tabContext + uid: botbuilder.TaskModuleRequest.tabContext + package: botbuilder + summary: Tab request context. + fullName: tabContext + remarks: '' + isDeprecated: false + syntax: + content: 'tabContext?: TabEntityContext' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequestContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequestContext.yml new file mode 100644 index 00000000..ceaf3d63 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleRequestContext.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TaskModuleRequestContext +uid: botbuilder.TaskModuleRequestContext +package: botbuilder +summary: '' +fullName: TaskModuleRequestContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: theme + uid: botbuilder.TaskModuleRequestContext.theme + package: botbuilder + summary: '' + fullName: theme + remarks: '' + isDeprecated: false + syntax: + content: 'theme?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponse.yml new file mode 100644 index 00000000..437686ad --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: TaskModuleResponse +uid: botbuilder.TaskModuleResponse +package: botbuilder +summary: '' +fullName: TaskModuleResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botbuilder.TaskModuleResponse.cacheInfo + package: botbuilder + summary: The cache info for this response + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: task + uid: botbuilder.TaskModuleResponse.task + package: botbuilder + summary: The JSON for the response to + fullName: task + remarks: '' + isDeprecated: false + syntax: + content: 'task?: TaskModuleContinueResponse | TaskModuleMessageResponse' + return: + description: '' + type: >- + | diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponseBase.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponseBase.yml new file mode 100644 index 00000000..764edfc4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleResponseBase.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TaskModuleResponseBase +uid: botbuilder.TaskModuleResponseBase +package: botbuilder +summary: '' +fullName: TaskModuleResponseBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botbuilder.TaskModuleResponseBase.type + package: botbuilder + summary: Choice of action options when responding to the + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: BotMessagePreviewType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleTaskInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleTaskInfo.yml new file mode 100644 index 00000000..f628b595 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TaskModuleTaskInfo.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: TaskModuleTaskInfo +uid: botbuilder.TaskModuleTaskInfo +package: botbuilder +summary: '' +fullName: TaskModuleTaskInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: card + uid: botbuilder.TaskModuleTaskInfo.card + package: botbuilder + summary: The JSON for the Adaptive card to appear in + fullName: card + remarks: '' + isDeprecated: false + syntax: + content: 'card?: Attachment' + return: + description: '' + type: + - name: completionBotId + uid: botbuilder.TaskModuleTaskInfo.completionBotId + package: botbuilder + summary: If a client does not support the task + fullName: completionBotId + remarks: '' + isDeprecated: false + syntax: + content: 'completionBotId?: string' + return: + description: '' + type: string + - name: fallbackUrl + uid: botbuilder.TaskModuleTaskInfo.fallbackUrl + package: botbuilder + summary: If a client does not support the task + fullName: fallbackUrl + remarks: '' + isDeprecated: false + syntax: + content: 'fallbackUrl?: string' + return: + description: '' + type: string + - name: height + uid: botbuilder.TaskModuleTaskInfo.height + package: botbuilder + summary: This can be a number, representing the task + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height?: number | "small" | "medium" | "large"' + return: + description: '' + type: number | "small" | "medium" | "large" + - name: title + uid: botbuilder.TaskModuleTaskInfo.title + package: botbuilder + summary: Appears below the app name and to the right of + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string + - name: url + uid: botbuilder.TaskModuleTaskInfo.url + package: botbuilder + summary: The URL of what is loaded as an iframe inside the + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url?: string' + return: + description: '' + type: string + - name: width + uid: botbuilder.TaskModuleTaskInfo.width + package: botbuilder + summary: This can be a number, representing the task module's + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width?: number | "small" | "medium" | "large"' + return: + description: '' + type: number | "small" | "medium" | "large" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamDetails.yml new file mode 100644 index 00000000..537bd76e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamDetails.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: TeamDetails +uid: botbuilder.TeamDetails +package: botbuilder +summary: '' +fullName: TeamDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadGroupId + uid: botbuilder.TeamDetails.aadGroupId + package: botbuilder + summary: Azure Active Directory (AAD) Group Id for + fullName: aadGroupId + remarks: '' + isDeprecated: false + syntax: + content: 'aadGroupId?: string' + return: + description: '' + type: string + - name: channelCount + uid: botbuilder.TeamDetails.channelCount + package: botbuilder + summary: Count of channels in the team. + fullName: channelCount + remarks: '' + isDeprecated: false + syntax: + content: 'channelCount?: number' + return: + description: '' + type: number + - name: id + uid: botbuilder.TeamDetails.id + package: botbuilder + summary: Unique identifier representing a team + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: memberCount + uid: botbuilder.TeamDetails.memberCount + package: botbuilder + summary: Count of members in the team. + fullName: memberCount + remarks: '' + isDeprecated: false + syntax: + content: 'memberCount?: number' + return: + description: '' + type: number + - name: name + uid: botbuilder.TeamDetails.name + package: botbuilder + summary: Name of team. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.TeamDetails.type + package: botbuilder + summary: >- + The type of the team. Valid values are standard, sharedChannel and + privateChannel. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamInfo.yml new file mode 100644 index 00000000..15243c0d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TeamInfo +uid: botbuilder.TeamInfo +package: botbuilder +summary: '' +fullName: TeamInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aadGroupId + uid: botbuilder.TeamInfo.aadGroupId + package: botbuilder + summary: The Azure AD Teams group ID. + fullName: aadGroupId + remarks: '' + isDeprecated: false + syntax: + content: 'aadGroupId?: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.TeamInfo.id + package: botbuilder + summary: Unique identifier representing a team + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: name + uid: botbuilder.TeamInfo.name + package: botbuilder + summary: Name of team. + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsActivityHandler.yml index dae985dd..5aabefeb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsActivityHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsActivityHandler.yml @@ -5,19 +5,19 @@ package: botbuilder summary: Adds support for Microsoft Teams specific events and interactions. fullName: TeamsActivityHandler remarks: >- - Developers may handle Conversation Update activities sent from Microsoft Teams - via two methods: + Developers may handle Message Update, Message Delete, and Conversation Update + activities sent from Microsoft Teams via two methods: 1. Overriding methods starting with `on..` and *not* ending in `..Event()` (e.g. `onTeamsMembersAdded()`), or instead 2. Passing callbacks to methods starting with `on..` *and* ending in `...Event()` (e.g. `onTeamsMembersAddedEvent()`), to stay in line with older {@see ActivityHandler} implementation. - Developers should use either #1 or #2, above for all Conversation Update - activities and not *both* #2 and #3 for the same activity. Meaning, + Developers should use either #1 or #2, above for all Message Update, Message + Delete, and Conversation Update activities and not *both* #1 and #2 for the + same activity. Meaning, developers should override `onTeamsMembersAdded()` and not use both `onTeamsMembersAdded()` and `onTeamsMembersAddedEvent()`. Developers wanting to handle Invoke activities *must* override methods starting with `handle...()` (e.g. `handleTeamsTaskModuleFetch()`). -isPreview: false isDeprecated: false type: class inheritedMethods: @@ -30,20 +30,21 @@ inheritedMethods: [onCommand](xref:botbuilder-core.ActivityHandler.onCommand) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onCommand(handler: BotHandler): this' + content: 'function onCommand(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onCommand + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onCommand](xref:botbuilder.ActivityHandler.onCommand) - name: onCommandResult(BotHandler) uid: botbuilder.TeamsActivityHandler.onCommandResult package: botbuilder @@ -53,20 +54,21 @@ inheritedMethods: [onCommandResult](xref:botbuilder-core.ActivityHandler.onCommandResult) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onCommandResult(handler: BotHandler): this' + content: 'function onCommandResult(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onCommandResult + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onCommandResult](xref:botbuilder.ActivityHandler.onCommandResult) - name: onConversationUpdate(BotHandler) uid: botbuilder.TeamsActivityHandler.onConversationUpdate package: botbuilder @@ -89,20 +91,21 @@ inheritedMethods: [onMembersRemoved](xref:botbuilder-core.ActivityHandler.onMembersRemoved) sub-type event handlers. - isPreview: false isDeprecated: false syntax: - content: 'function onConversationUpdate(handler: BotHandler): this' + content: 'function onConversationUpdate(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onConversationUpdate + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onConversationUpdate](xref:botbuilder.ActivityHandler.onConversationUpdate) - name: onDialog(BotHandler) uid: botbuilder.TeamsActivityHandler.onDialog package: botbuilder @@ -110,20 +113,21 @@ inheritedMethods: Registers an activity event handler for the _dialog_ event, emitted as the last event for an incoming activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onDialog(handler: BotHandler): this' + content: 'function onDialog(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onDialog + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onDialog](xref:botbuilder.ActivityHandler.onDialog) - name: onEndOfConversation(BotHandler) uid: botbuilder.TeamsActivityHandler.onEndOfConversation package: botbuilder @@ -139,20 +143,21 @@ inheritedMethods: [onEndOfConversation](xref:botbuilder-core.ActivityHandler.onEndOfConversation) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onEndOfConversation(handler: BotHandler): this' + content: 'function onEndOfConversation(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onEndOfConversation + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onEndOfConversation](xref:botbuilder.ActivityHandler.onEndOfConversation) - name: onEvent(BotHandler) uid: botbuilder.TeamsActivityHandler.onEvent package: botbuilder @@ -183,20 +188,21 @@ inheritedMethods: sub-type event handler. To handle other named events, add logic to this handler. - isPreview: false isDeprecated: false syntax: - content: 'function onEvent(handler: BotHandler): this' + content: 'function onEvent(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onEvent + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onEvent](xref:botbuilder.ActivityHandler.onEvent) - name: onInstallationUpdate(BotHandler) uid: botbuilder.TeamsActivityHandler.onInstallationUpdate package: botbuilder @@ -206,20 +212,21 @@ inheritedMethods: [onInstallationUpdate](xref:botbuilder-core.ActivityHandler.onInstallationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdate(handler: BotHandler): this' + content: 'function onInstallationUpdate(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onInstallationUpdate + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onInstallationUpdate](xref:botbuilder.ActivityHandler.onInstallationUpdate) - name: onInstallationUpdateAdd(BotHandler) uid: botbuilder.TeamsActivityHandler.onInstallationUpdateAdd package: botbuilder @@ -227,13 +234,14 @@ inheritedMethods: Registers an activity event handler for the _installationupdate add_ activity. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdateAdd(handler: BotHandler): this' + content: >- + function onInstallationUpdateAdd(handler: BotHandler): + TeamsActivityHandler parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- @@ -244,8 +252,10 @@ inheritedMethods: [onInstallationUpdateAdd](xref:botbuilder-core.ActivityHandler.onInstallationUpdateAdd) type-specific event handler. - type: this - inheritanceDescription: Inherited From ActivityHandler.onInstallationUpdateAdd + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onInstallationUpdateAdd](xref:botbuilder.ActivityHandler.onInstallationUpdateAdd) - name: onInstallationUpdateRemove(BotHandler) uid: botbuilder.TeamsActivityHandler.onInstallationUpdateRemove package: botbuilder @@ -257,20 +267,23 @@ inheritedMethods: [onInstallationUpdateRemove](xref:botbuilder-core.ActivityHandler.onInstallationUpdateRemove) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onInstallationUpdateRemove(handler: BotHandler): this' + content: >- + function onInstallationUpdateRemove(handler: BotHandler): + TeamsActivityHandler parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onInstallationUpdateRemove + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onInstallationUpdateRemove](xref:botbuilder.ActivityHandler.onInstallationUpdateRemove) - name: onMembersAdded(BotHandler) uid: botbuilder.TeamsActivityHandler.onMembersAdded package: botbuilder @@ -291,20 +304,21 @@ inheritedMethods: [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onMembersAdded(handler: BotHandler): this' + content: 'function onMembersAdded(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMembersAdded + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMembersAdded](xref:botbuilder.ActivityHandler.onMembersAdded) - name: onMembersRemoved(BotHandler) uid: botbuilder.TeamsActivityHandler.onMembersRemoved package: botbuilder @@ -327,20 +341,21 @@ inheritedMethods: [onConversationUpdate](xref:botbuilder-core.ActivityHandler.onConversationUpdate) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onMembersRemoved(handler: BotHandler): this' + content: 'function onMembersRemoved(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMembersRemoved + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMembersRemoved](xref:botbuilder.ActivityHandler.onMembersRemoved) - name: onMessage(BotHandler) uid: botbuilder.TeamsActivityHandler.onMessage package: botbuilder @@ -358,20 +373,56 @@ inheritedMethods: [text](xref:botframework-schema.Activity.text) property can be `null` or `undefined`. - isPreview: false isDeprecated: false syntax: - content: 'function onMessage(handler: BotHandler): this' + content: 'function onMessage(handler: BotHandler): TeamsActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessage](xref:botbuilder.ActivityHandler.onMessage) + - name: onMessageDelete(BotHandler) + uid: botbuilder.TeamsActivityHandler.onMessageDelete + package: botbuilder + summary: >- + Registers an activity event handler for the _message delete_ event, + emitted for every incoming message activity. + remarks: >- + Message delete activities represent a deletion of an existing message + activity within a conversation. + + The deleted activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity. + + Message delete activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageDelete`. + isDeprecated: false + syntax: + content: 'function onMessageDelete(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMessage + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessageDelete](xref:botbuilder.ActivityHandler.onMessageDelete) - name: onMessageReaction(BotHandler) uid: botbuilder.TeamsActivityHandler.onMessageReaction package: botbuilder @@ -403,20 +454,59 @@ inheritedMethods: [onReactionsRemoved](xref:botbuilder-core.ActivityHandler.onReactionsRemoved) sub-type event handlers. - isPreview: false isDeprecated: false syntax: - content: 'function onMessageReaction(handler: BotHandler): this' + content: 'function onMessageReaction(handler: BotHandler): TeamsActivityHandler' + parameters: + - id: handler + type: + description: The event handler. + return: + description: >- + A reference to the + [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessageReaction](xref:botbuilder.ActivityHandler.onMessageReaction) + - name: onMessageUpdate(BotHandler) + uid: botbuilder.TeamsActivityHandler.onMessageUpdate + package: botbuilder + summary: >- + Registers an activity event handler for the _message update_ event, + emitted for every incoming message activity. + remarks: >- + Message update activities represent an update of an existing message + activity within a conversation. + + The updated activity is referred to by the + [id](xref:botbuilder-core.TurnContext.activity.id) and + + [conversation](xref:botbuilder-core.TurnContext.activity.conversation) + fields within the activity, and the + + message update activity contains all fields in the revised message + activity. + + Message update activities are identified by a + [type](xref:botbuilder-core.TurnContext.activity.type) value of + + `messageUpdate`. + isDeprecated: false + syntax: + content: 'function onMessageUpdate(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onMessageReaction + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onMessageUpdate](xref:botbuilder.ActivityHandler.onMessageUpdate) - name: onReactionsAdded(BotHandler) uid: botbuilder.TeamsActivityHandler.onReactionsAdded package: botbuilder @@ -437,20 +527,21 @@ inheritedMethods: [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onReactionsAdded(handler: BotHandler): this' + content: 'function onReactionsAdded(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onReactionsAdded + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onReactionsAdded](xref:botbuilder.ActivityHandler.onReactionsAdded) - name: onReactionsRemoved(BotHandler) uid: botbuilder.TeamsActivityHandler.onReactionsRemoved package: botbuilder @@ -471,20 +562,21 @@ inheritedMethods: [onMessageReaction](xref:botbuilder-core.ActivityHandler.onMessageReaction) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onReactionsRemoved(handler: BotHandler): this' + content: 'function onReactionsRemoved(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onReactionsRemoved + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onReactionsRemoved](xref:botbuilder.ActivityHandler.onReactionsRemoved) - name: onTokenResponseEvent(BotHandler) uid: botbuilder.TeamsActivityHandler.onTokenResponseEvent package: botbuilder @@ -510,20 +602,21 @@ inheritedMethods: [onEvent](xref:botbuilder-core.ActivityHandler.onEvent) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onTokenResponseEvent(handler: BotHandler): this' + content: 'function onTokenResponseEvent(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onTokenResponseEvent + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onTokenResponseEvent](xref:botbuilder.ActivityHandler.onTokenResponseEvent) - name: onTurn(BotHandler) uid: botbuilder.TeamsActivityHandler.onTurn package: botbuilder @@ -531,20 +624,21 @@ inheritedMethods: Registers an activity event handler for the _turn_ event, emitted for every incoming activity, regardless of type. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function onTurn(handler: BotHandler): this' + content: 'function onTurn(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onTurn + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onTurn](xref:botbuilder.ActivityHandler.onTurn) - name: onTyping(BotHandler) uid: botbuilder.TeamsActivityHandler.onTyping package: botbuilder @@ -554,20 +648,21 @@ inheritedMethods: [onTyping](xref:botbuilder-core.ActivityHandler.onTyping) type-specific event handler. - isPreview: false isDeprecated: false syntax: - content: 'function onTyping(handler: BotHandler): this' + content: 'function onTyping(handler: BotHandler): TeamsActivityHandler' parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onTyping + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onTyping](xref:botbuilder.ActivityHandler.onTyping) - name: onUnrecognizedActivityType(BotHandler) uid: botbuilder.TeamsActivityHandler.onUnrecognizedActivityType package: botbuilder @@ -595,20 +690,23 @@ inheritedMethods: The activity's [type](xref:botframework-schema.Activity.type) property contains the activity type. - isPreview: false isDeprecated: false syntax: - content: 'function onUnrecognizedActivityType(handler: BotHandler): this' + content: >- + function onUnrecognizedActivityType(handler: BotHandler): + TeamsActivityHandler parameters: - id: handler - type: BotHandler + type: description: The event handler. return: description: >- A reference to the [ActivityHandler](xref:botbuilder-core.ActivityHandler) object. - type: this - inheritanceDescription: Inherited From ActivityHandler.onUnrecognizedActivityType + type: + inheritanceDescription: >- + Inherited From + [ActivityHandler.onUnrecognizedActivityType](xref:botbuilder.ActivityHandler.onUnrecognizedActivityType) - name: run(TurnContext) uid: botbuilder.TeamsActivityHandler.run package: botbuilder @@ -640,19 +738,19 @@ inheritedMethods: - [BotFrameworkAdapter.processActivity](xref:botbuilder.BotFrameworkAdapter.processActivity) - isPreview: false isDeprecated: false syntax: content: 'function run(context: TurnContext): Promise' parameters: - id: context - type: TurnContext - description: | - The context object for the current turn. + type: + description: The context object for the current turn. return: description: '' type: Promise<void> - inheritanceDescription: Inherited From ActivityHandler.run + inheritanceDescription: >- + Inherited From + [ActivityHandler.run](xref:botbuilder.ActivityHandler.run) methods: - name: >- onTeamsChannelCreatedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, @@ -663,13 +761,12 @@ methods: Registers a handler for TeamsChannelCreated events, such as for when a channel is created. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsChannelCreatedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => - Promise): this + Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -678,7 +775,7 @@ methods: description: A callback to handle the teams channel created event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsChannelDeletedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -688,13 +785,12 @@ methods: Registers a handler for TeamsChannelDeleted events, such as for when a channel is deleted. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsChannelDeletedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => - Promise): this + Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -703,7 +799,7 @@ methods: description: A callback to handle the teams channel deleted event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsChannelRenamedEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -713,13 +809,12 @@ methods: Registers a handler for TeamsChannelRenamed events, such as for when a channel is renamed. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsChannelRenamedEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => - Promise): this + Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -728,7 +823,7 @@ methods: description: A callback to handle the teams channel renamed event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsChannelRestoredEvent((channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -738,13 +833,12 @@ methods: Registers a handler for TeamsChannelRestored events, such as for when a channel is restored. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsChannelRestoredEvent(handler: (channelInfo: ChannelInfo, teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => - Promise): this + Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -753,7 +847,7 @@ methods: description: A callback to handle the teams channel restored event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsMeetingEndEvent((meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise) => Promise) @@ -761,13 +855,12 @@ methods: package: botbuilder summary: Registers a handler for when a Teams meeting ends. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsMeetingEndEvent(handler: (meeting: MeetingEndEventDetails, context: TurnContext, next: () => Promise) - => Promise): this + => Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -776,7 +869,53 @@ methods: description: A callback that handles Meeting End events. return: description: A promise that represents the work queued. - type: this + type: + - name: >- + onTeamsMeetingParticipantsJoinEvent((meeting: + MeetingParticipantsEventDetails, context: TurnContext, next: () => + Promise) => Promise) + uid: botbuilder.TeamsActivityHandler.onTeamsMeetingParticipantsJoinEvent + package: botbuilder + summary: Registers a handler for when a Teams meeting participant join. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTeamsMeetingParticipantsJoinEvent(handler: (meeting: + MeetingParticipantsEventDetails, context: TurnContext, next: () => + Promise) => Promise): TeamsActivityHandler + parameters: + - id: handler + type: >- + (meeting: MeetingParticipantsEventDetails, context: TurnContext, + next: () => Promise<void>) => Promise<void> + description: A callback that handles Meeting Participant Join events. + return: + description: A promise that represents the work queued. + type: + - name: >- + onTeamsMeetingParticipantsLeaveEvent((meeting: + MeetingParticipantsEventDetails, context: TurnContext, next: () => + Promise) => Promise) + uid: botbuilder.TeamsActivityHandler.onTeamsMeetingParticipantsLeaveEvent + package: botbuilder + summary: Registers a handler for when a Teams meeting participant leave. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTeamsMeetingParticipantsLeaveEvent(handler: (meeting: + MeetingParticipantsEventDetails, context: TurnContext, next: () => + Promise) => Promise): TeamsActivityHandler + parameters: + - id: handler + type: >- + (meeting: MeetingParticipantsEventDetails, context: TurnContext, + next: () => Promise<void>) => Promise<void> + description: A callback that handles Meeting Participant Leave events. + return: + description: A promise that represents the work queued. + type: - name: >- onTeamsMeetingStartEvent((meeting: MeetingStartEventDetails, context: TurnContext, next: () => Promise) => Promise) @@ -784,13 +923,12 @@ methods: package: botbuilder summary: Registers a handler for when a Teams meeting starts. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsMeetingStartEvent(handler: (meeting: MeetingStartEventDetails, context: TurnContext, next: () => - Promise) => Promise): this + Promise) => Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -799,7 +937,7 @@ methods: description: A callback that handles Meeting Start events. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsMembersAddedEvent((membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => @@ -812,13 +950,12 @@ methods: join the channel, such as your bot's welcome logic. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsMembersAddedEvent(handler: (membersAdded: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: - () => Promise) => Promise): this + () => Promise) => Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -828,7 +965,7 @@ methods: description: A callback to handle the teams members added event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsMembersRemovedEvent((membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => @@ -841,13 +978,12 @@ methods: leave the channel, such as your bot's good-bye logic. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsMembersRemovedEvent(handler: (membersRemoved: TeamsChannelAccount[], teamInfo: TeamInfo, context: TurnContext, next: - () => Promise) => Promise): this + () => Promise) => Promise): TeamsActivityHandler parameters: - id: handler type: >- @@ -857,7 +993,85 @@ methods: description: A callback to handle the teams members removed event. return: description: A promise that represents the work queued. - type: this + type: + - name: >- + onTeamsMessageEditEvent((context: TurnContext, next: () => Promise) + => Promise) + uid: botbuilder.TeamsActivityHandler.onTeamsMessageEditEvent + package: botbuilder + summary: >- + Registers a handler for TeamsMessageEdit events, such as for when a + message in a conversation that is + + observed by the bot is edited. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTeamsMessageEditEvent(handler: (context: TurnContext, next: + () => Promise) => Promise): TeamsActivityHandler + parameters: + - id: handler + type: >- + (context: TurnContext, next: () => Promise<void>) => + Promise<void> + description: A callback to handle the teams edit message event. + return: + description: A promise that represents the work queued. + type: + - name: >- + onTeamsMessageSoftDeleteEvent((context: TurnContext, next: () => + Promise) => Promise) + uid: botbuilder.TeamsActivityHandler.onTeamsMessageSoftDeleteEvent + package: botbuilder + summary: >- + Registers a handler for TeamsMessageSoftDelete events, such as for when a + message in a conversation that is + + observed by the bot is soft deleted. This means that the deleted message, + up to a certain time period, + + can be undoed. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTeamsMessageSoftDeleteEvent(handler: (context: TurnContext, + next: () => Promise) => Promise): TeamsActivityHandler + parameters: + - id: handler + type: >- + (context: TurnContext, next: () => Promise<void>) => + Promise<void> + description: A callback to handle the teams edit message event. + return: + description: A promise that represents the work queued. + type: + - name: >- + onTeamsMessageUndeleteEvent((context: TurnContext, next: () => + Promise) => Promise) + uid: botbuilder.TeamsActivityHandler.onTeamsMessageUndeleteEvent + package: botbuilder + summary: >- + Registers a handler for TeamsMessageUndelete events, such as for when a + message in a conversation that is + + observed by the bot goes from a soft delete state to the normal state. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTeamsMessageUndeleteEvent(handler: (context: TurnContext, + next: () => Promise) => Promise): TeamsActivityHandler + parameters: + - id: handler + type: >- + (context: TurnContext, next: () => Promise<void>) => + Promise<void> + description: A callback to handle the teams undelete message event. + return: + description: A promise that represents the work queued. + type: - name: >- onTeamsReadReceiptEvent((receiptInfo: ReadReceiptInfo, context: TurnContext, next: () => Promise) => Promise) @@ -865,12 +1079,12 @@ methods: package: botbuilder summary: Registers a handler for when a Read Receipt is sent. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsReadReceiptEvent(handler: (receiptInfo: ReadReceiptInfo, - context: TurnContext, next: () => Promise) => Promise): this + context: TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -879,7 +1093,7 @@ methods: description: A callback that handles Read Receipt events. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsTeamArchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -889,12 +1103,12 @@ methods: Registers a handler for TeamsTeamArchived events, such as for when a team is archived. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsTeamArchivedEvent(handler: (teamInfo: TeamInfo, context: - TurnContext, next: () => Promise) => Promise): this + TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -903,7 +1117,7 @@ methods: description: A callback to handle the teams team archived event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsTeamDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -913,12 +1127,12 @@ methods: Registers a handler for TeamsTeamDeleted events, such as for when a team is deleted. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsTeamDeletedEvent(handler: (teamInfo: TeamInfo, context: - TurnContext, next: () => Promise) => Promise): this + TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -927,7 +1141,7 @@ methods: description: A callback to handle the teams team deleted event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsTeamHardDeletedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -937,12 +1151,12 @@ methods: Registers a handler for TeamsTeamHardDeleted events, such as for when a team is hard-deleted. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsTeamHardDeletedEvent(handler: (teamInfo: TeamInfo, - context: TurnContext, next: () => Promise) => Promise): this + context: TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -951,7 +1165,7 @@ methods: description: A callback to handle the teams team hard deleted event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsTeamRenamedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -961,12 +1175,12 @@ methods: Registers a handler for TeamsTeamRenamed events, such as for when a team is renamed. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsTeamRenamedEvent(handler: (teamInfo: TeamInfo, context: - TurnContext, next: () => Promise) => Promise): this + TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -975,7 +1189,7 @@ methods: description: A callback to handle the teams team renamed event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsTeamRestoredEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -985,12 +1199,12 @@ methods: Registers a handler for TeamsTeamRestored events, such as for when a team is restored. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsTeamRestoredEvent(handler: (teamInfo: TeamInfo, context: - TurnContext, next: () => Promise) => Promise): this + TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -999,7 +1213,7 @@ methods: description: A callback to handle the teams team restored event. return: description: A promise that represents the work queued. - type: this + type: - name: >- onTeamsTeamUnarchivedEvent((teamInfo: TeamInfo, context: TurnContext, next: () => Promise) => Promise) @@ -1009,12 +1223,12 @@ methods: Registers a handler for TeamsTeamUnarchived events, such as for when a team is unarchived. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function onTeamsTeamUnarchivedEvent(handler: (teamInfo: TeamInfo, - context: TurnContext, next: () => Promise) => Promise): this + context: TurnContext, next: () => Promise) => Promise): + TeamsActivityHandler parameters: - id: handler type: >- @@ -1023,5 +1237,5 @@ methods: description: A callback to handle the teams team unarchived event. return: description: A promise that represents the work queued. - type: this -extends: ActivityHandler + type: +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsAttachment.yml new file mode 100644 index 00000000..1c079c64 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsAttachment.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: TeamsAttachment +uid: botbuilder.TeamsAttachment +package: botbuilder +summary: An attachment within an activity +fullName: TeamsAttachment +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botbuilder.TeamsAttachment.content + package: botbuilder + summary: Embedded content + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content: ContentType' + return: + description: '' + type: ContentType +inheritedProperties: + - name: contentType + uid: botbuilder.TeamsAttachment.contentType + package: botbuilder + summary: mimetype/Contenttype for the file + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentType](xref:botbuilder.Attachment.contentType) + - name: contentUrl + uid: botbuilder.TeamsAttachment.contentUrl + package: botbuilder + summary: Content Url + fullName: contentUrl + remarks: '' + isDeprecated: false + syntax: + content: 'contentUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.contentUrl](xref:botbuilder.Attachment.contentUrl) + - name: name + uid: botbuilder.TeamsAttachment.name + package: botbuilder + summary: (OPTIONAL) The name of the attachment + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From [Attachment.name](xref:botbuilder.Attachment.name) + - name: thumbnailUrl + uid: botbuilder.TeamsAttachment.thumbnailUrl + package: botbuilder + summary: (OPTIONAL) Thumbnail associated with attachment + fullName: thumbnailUrl + remarks: '' + isDeprecated: false + syntax: + content: 'thumbnailUrl?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [Attachment.thumbnailUrl](xref:botbuilder.Attachment.thumbnailUrl) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelAccount.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelAccount.yml new file mode 100644 index 00000000..6f6a45cf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelAccount.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: TeamsChannelAccount +uid: botbuilder.TeamsChannelAccount +package: botbuilder +summary: '' +fullName: TeamsChannelAccount +remarks: '' +isDeprecated: false +type: interface +properties: + - name: email + uid: botbuilder.TeamsChannelAccount.email + package: botbuilder + summary: Email Id of the user. + fullName: email + remarks: '' + isDeprecated: false + syntax: + content: 'email?: string' + return: + description: '' + type: string + - name: givenName + uid: botbuilder.TeamsChannelAccount.givenName + package: botbuilder + summary: Given name part of the user name. + fullName: givenName + remarks: '' + isDeprecated: false + syntax: + content: 'givenName?: string' + return: + description: '' + type: string + - name: surname + uid: botbuilder.TeamsChannelAccount.surname + package: botbuilder + summary: Surname part of the user name. + fullName: surname + remarks: '' + isDeprecated: false + syntax: + content: 'surname?: string' + return: + description: '' + type: string + - name: tenantId + uid: botbuilder.TeamsChannelAccount.tenantId + package: botbuilder + summary: Tenant Id of the user. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string + - name: userPrincipalName + uid: botbuilder.TeamsChannelAccount.userPrincipalName + package: botbuilder + summary: Unique user principal name. + fullName: userPrincipalName + remarks: '' + isDeprecated: false + syntax: + content: 'userPrincipalName?: string' + return: + description: '' + type: string + - name: userRole + uid: botbuilder.TeamsChannelAccount.userRole + package: botbuilder + summary: User Role of the user. + fullName: userRole + remarks: '' + isDeprecated: false + syntax: + content: 'userRole?: string' + return: + description: '' + type: string +inheritedProperties: + - name: aadObjectId + uid: botbuilder.TeamsChannelAccount.aadObjectId + package: botbuilder + summary: This account's object ID within Azure Active Directory (AAD) + fullName: aadObjectId + remarks: '' + isDeprecated: false + syntax: + content: 'aadObjectId?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.aadObjectId](xref:botbuilder.ChannelAccount.aadObjectId) + - name: id + uid: botbuilder.TeamsChannelAccount.id + package: botbuilder + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.id](xref:botbuilder.ChannelAccount.id) + - name: name + uid: botbuilder.TeamsChannelAccount.name + package: botbuilder + summary: Display friendly name + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.name](xref:botbuilder.ChannelAccount.name) + - name: properties + uid: botbuilder.TeamsChannelAccount.properties + package: botbuilder + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [ChannelAccount.properties](xref:botbuilder.ChannelAccount.properties) + - name: role + uid: botbuilder.TeamsChannelAccount.role + package: botbuilder + summary: >- + Role of the entity behind the account (Example: User, Bot, etc.). Possible + values include: + + 'user', 'bot', 'skill' + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [ChannelAccount.role](xref:botbuilder.ChannelAccount.role) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelData.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelData.yml new file mode 100644 index 00000000..daf85840 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelData.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: TeamsChannelData +uid: botbuilder.TeamsChannelData +package: botbuilder +summary: '' +fullName: TeamsChannelData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channel + uid: botbuilder.TeamsChannelData.channel + package: botbuilder + summary: Information about the channel in which the + fullName: channel + remarks: '' + isDeprecated: false + syntax: + content: 'channel?: ChannelInfo' + return: + description: '' + type: + - name: eventType + uid: botbuilder.TeamsChannelData.eventType + package: botbuilder + summary: Type of event. + fullName: eventType + remarks: '' + isDeprecated: false + syntax: + content: 'eventType?: string' + return: + description: '' + type: string + - name: meeting + uid: botbuilder.TeamsChannelData.meeting + package: botbuilder + summary: Information about the tenant in which the + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting?: TeamsMeetingInfo' + return: + description: '' + type: + - name: notification + uid: botbuilder.TeamsChannelData.notification + package: botbuilder + summary: Notification settings for the + fullName: notification + remarks: '' + isDeprecated: false + syntax: + content: 'notification?: NotificationInfo' + return: + description: '' + type: + - name: onBehalfOf + uid: botbuilder.TeamsChannelData.onBehalfOf + package: botbuilder + summary: The OnBehalfOf information of the message. + fullName: onBehalfOf + remarks: '' + isDeprecated: false + syntax: + content: 'onBehalfOf?: OnBehalfOf[]' + return: + description: '' + type: [] + - name: settings + uid: botbuilder.TeamsChannelData.settings + package: botbuilder + summary: Information about the settings in which the + fullName: settings + remarks: '' + isDeprecated: false + syntax: + content: 'settings?: TeamsChannelDataSettings' + return: + description: '' + type: + - name: team + uid: botbuilder.TeamsChannelData.team + package: botbuilder + summary: Information about the team in which the message + fullName: team + remarks: '' + isDeprecated: false + syntax: + content: 'team?: TeamInfo' + return: + description: '' + type: + - name: tenant + uid: botbuilder.TeamsChannelData.tenant + package: botbuilder + summary: Information about the tenant in which the + fullName: tenant + remarks: '' + isDeprecated: false + syntax: + content: 'tenant?: TenantInfo' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelDataSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelDataSettings.yml new file mode 100644 index 00000000..9cf19d9b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsChannelDataSettings.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TeamsChannelDataSettings +uid: botbuilder.TeamsChannelDataSettings +package: botbuilder +summary: '' +fullName: TeamsChannelDataSettings +remarks: '' +isDeprecated: false +type: interface +properties: + - name: selectedChannel + uid: botbuilder.TeamsChannelDataSettings.selectedChannel + package: botbuilder + summary: Information about the selected Teams channel. + fullName: selectedChannel + remarks: '' + isDeprecated: false + syntax: + content: 'selectedChannel?: ChannelInfo' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsInfo.yml index 855853e0..da662d47 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsInfo.yml @@ -7,32 +7,70 @@ summary: >- Microsoft Teams. fullName: TeamsInfo remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'getMeetingInfo(TurnContext, string)' + - name: cancelOperation(TurnContext, string) + uid: botbuilder.TeamsInfo.cancelOperation + package: botbuilder + summary: Cancels a pending operation. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function cancelOperation(context: TurnContext, operationId: + string): Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: operationId + type: string + description: The id of the operation to cancel. + return: + description: Promise representing the asynchronous operation. + type: Promise<CancelOperationResponse> + - name: getFailedEntries(TurnContext, string) + uid: botbuilder.TeamsInfo.getFailedEntries + package: botbuilder + summary: Gets the failed entries of an executed operation. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getFailedEntries(context: TurnContext, operationId: + string): Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: operationId + type: string + description: The operationId to get the failed entries of. + return: + description: Promise with the list of failed entries of the operation. + type: Promise<> + - name: getMeetingInfo(TurnContext, string) uid: botbuilder.TeamsInfo.getMeetingInfo package: botbuilder summary: Gets the information for the given meeting id. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function getMeetingInfo(context: TurnContext, meetingId?: - string): Promise + string): Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: meetingId type: string description: The BASE64-encoded id of the Teams meeting. return: - description: 'The [TeamsMeetingInfo](xref:botbuilder-core.TeamsMeetingInfo) fetched' - type: Promise<TeamsMeetingInfo> - - name: 'getMeetingParticipant(TurnContext, string, string, string)' + description: The [MeetingInfo](xref:botframework-schema.MeetingInfo) fetched + type: Promise<> + - name: getMeetingParticipant(TurnContext, string, string, string) uid: botbuilder.TeamsInfo.getMeetingParticipant package: botbuilder summary: >- @@ -41,7 +79,6 @@ methods: teams scoped meeting conversations. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,8 +87,8 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: meetingId type: string description: The meeting ID to fetch @@ -66,13 +103,12 @@ methods: The [TeamsMeetingParticipant](xref:botbuilder-core.TeamsMeetingParticipant) fetched - type: Promise<TeamsMeetingParticipant> - - name: 'getMember(TurnContext, string)' + type: Promise<> + - name: getMember(TurnContext, string) uid: botbuilder.TeamsInfo.getMember package: botbuilder summary: Gets the account of a single conversation member. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -80,8 +116,8 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: userId type: string description: ID of the user in question. @@ -90,13 +126,12 @@ methods: The [TeamsChannelAccount](xref:botframework-schema.TeamsChannelAccount) of the member. - type: Promise<TeamsChannelAccount> + type: Promise<> - name: getMembers(TurnContext) uid: botbuilder.TeamsInfo.getMembers package: botbuilder summary: Gets the conversation members of a one-on-one or group chat. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use `getPagedTeamMembers` instead. syntax: @@ -105,19 +140,38 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. return: description: >- The list of [TeamsChannelAccount](xref:botframework-schema.TeamsChannelAccount). - type: 'Promise<TeamsChannelAccount[]>' - - name: 'getPagedMembers(TurnContext, number, string)' + type: Promise<[]> + - name: getOperationState(TurnContext, string) + uid: botbuilder.TeamsInfo.getOperationState + package: botbuilder + summary: Gets the operation state. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getOperationState(context: TurnContext, operationId: + string): Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: operationId + type: string + description: The operationId to get the state of. + return: + description: Promise with The state and responses of the operation. + type: Promise<> + - name: getPagedMembers(TurnContext, number, string) uid: botbuilder.TeamsInfo.getPagedMembers package: botbuilder - summary: 'Gets a pagined list of members of one-on-one, group, or team conversation.' + summary: Gets a pagined list of members of one-on-one, group, or team conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -125,8 +179,8 @@ methods: continuationToken?: string): Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: pageSize type: number description: Suggested number of entries on a page. @@ -138,13 +192,12 @@ methods: The [TeamsPagedMembersResult](xref:botframework-schema.TeamsPagedMembersResult) with the list of members. - type: Promise<TeamsPagedMembersResult> - - name: 'getPagedTeamMembers(TurnContext, string, number, string)' + type: Promise<> + - name: getPagedTeamMembers(TurnContext, string, number, string) uid: botbuilder.TeamsInfo.getPagedTeamMembers package: botbuilder summary: Gets a paginated list of members of a team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -153,8 +206,8 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: teamId type: string description: ID of the Teams team. @@ -169,15 +222,14 @@ methods: A [TeamsPagedMembersResult](xref:botframework-schema.TeamsPagedMembersResult) with the list of members. - type: Promise<TeamsPagedMembersResult> - - name: 'getTeamChannels(TurnContext, string)' + type: Promise<> + - name: getTeamChannels(TurnContext, string) uid: botbuilder.TeamsInfo.getTeamChannels package: botbuilder summary: >- Returns a list of channels in a Team. This only works in teams scoped conversations. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -185,8 +237,8 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: teamId type: string description: ID of the Teams team. @@ -194,15 +246,14 @@ methods: description: >- The list of [ChannelInfo](xref:botframework-schema.ChannelInfo) objects with the conversations. - type: 'Promise<ChannelInfo[]>' - - name: 'getTeamDetails(TurnContext, string)' + type: Promise<[]> + - name: getTeamDetails(TurnContext, string) uid: botbuilder.TeamsInfo.getTeamDetails package: botbuilder summary: >- Gets the details for the given team id. This only works in teams scoped conversations. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -210,20 +261,19 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: teamId type: string description: The id of the Teams team. return: - description: 'The [TeamDetails](xref:botbuilder-core.TeamDetails) fetched' - type: Promise<TeamDetails> - - name: 'getTeamMember(TurnContext, string, string)' + description: The [TeamDetails](xref:botbuilder-core.TeamDetails) fetched + type: Promise<> + - name: getTeamMember(TurnContext, string, string) uid: botbuilder.TeamsInfo.getTeamMember package: botbuilder summary: Gets the account of a member in a teams scoped conversation. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -231,8 +281,8 @@ methods: userId?: string): Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: teamId type: string description: ID of the Teams team. @@ -244,8 +294,8 @@ methods: The [TeamsChannelAccount](xref:botframework-schema.TeamsChannelAccount) of the member. - type: Promise<TeamsChannelAccount> - - name: 'getTeamMembers(TurnContext, string)' + type: Promise<> + - name: getTeamMembers(TurnContext, string) uid: botbuilder.TeamsInfo.getTeamMembers package: botbuilder summary: >- @@ -253,7 +303,6 @@ methods: [TeamsChannelAccount](xref:botframework-schema.TeamsChannelAccount) within a team. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: Use `getPagedTeamMembers` instead. syntax: @@ -262,8 +311,8 @@ methods: Promise parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: teamId type: string description: ID of the Teams team. @@ -272,15 +321,149 @@ methods: The list of [TeamsChannelAccount](xref:botframework-schema.TeamsChannelAccount) of the members. - type: 'Promise<TeamsChannelAccount[]>' - - name: 'sendMessageToTeamsChannel(TurnContext, Activity, string, string)' + type: Promise<[]> + - name: sendMeetingNotification(TurnContext, TargetedMeetingNotification, string) + uid: botbuilder.TeamsInfo.sendMeetingNotification + package: botbuilder + summary: Sends a meeting notification to specific users in a Teams meeting. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function sendMeetingNotification(context: TurnContext, + notification: TargetedMeetingNotification, meetingId?: string): + Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: notification + type: + description: The meeting notification payload. + - id: meetingId + type: string + description: Id of the Teams meeting. + return: + description: >- + Promise with either an empty object if notifications were successfully + sent to all recipients or + + [MeetingNotificationResponse](xref:botframework-schema.MeetingNotificationResponse) + if notifications + + were sent to some but not all recipients. + type: Promise<> + - name: sendMessageToAllUsersInTeam(TurnContext, Activity, string, string) + uid: botbuilder.TeamsInfo.sendMessageToAllUsersInTeam + package: botbuilder + summary: Sends a message to all the users in a team. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function sendMessageToAllUsersInTeam(context: TurnContext, + activity: Activity, tenantId: string, teamId: string): + Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: activity + type: + description: The activity to send. + - id: tenantId + type: string + description: The tenant ID. + - id: teamId + type: string + description: The team ID. + return: + description: Promise with operationId. + type: Promise<> + - name: sendMessageToAllUsersInTenant(TurnContext, Activity, string) + uid: botbuilder.TeamsInfo.sendMessageToAllUsersInTenant + package: botbuilder + summary: Sends a message to all the users in a tenant. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function sendMessageToAllUsersInTenant(context: TurnContext, + activity: Activity, tenantId: string): Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: activity + type: + description: The activity to send. + - id: tenantId + type: string + description: The tenant ID. + return: + description: Promise with operationId. + type: Promise<> + - name: sendMessageToListOfChannels(TurnContext, Activity, string, TeamsMember[]) + uid: botbuilder.TeamsInfo.sendMessageToListOfChannels + package: botbuilder + summary: Sends a message to the provided list of Teams channels. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function sendMessageToListOfChannels(context: TurnContext, + activity: Activity, tenantId: string, members: TeamsMember[]): + Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: activity + type: + description: The activity to send. + - id: tenantId + type: string + description: The tenant ID. + - id: members + type: [] + description: The list of channels recipients for the message. + return: + description: Promise with operationId. + type: Promise<> + - name: sendMessageToListOfUsers(TurnContext, Activity, string, TeamsMember[]) + uid: botbuilder.TeamsInfo.sendMessageToListOfUsers + package: botbuilder + summary: Sends a message to the provided users in the list of Teams members. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function sendMessageToListOfUsers(context: TurnContext, activity: + Activity, tenantId: string, members: TeamsMember[]): + Promise + parameters: + - id: context + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. + - id: activity + type: + description: The activity to send. + - id: tenantId + type: string + description: The tenant ID. + - id: members + type: [] + description: The list of users recipients for the message. + return: + description: Promise with operationId. + type: Promise<> + - name: sendMessageToTeamsChannel(TurnContext, Activity, string, string) uid: botbuilder.TeamsInfo.sendMessageToTeamsChannel package: botbuilder summary: >- Creates a new thread in a Teams chat and sends an [Activity](xref:botframework-schema.Activity) to that new thread. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -289,11 +472,11 @@ methods: Promise<[ConversationReference, string]> parameters: - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to send.' + type: + description: The [Activity](xref:botframework-schema.Activity) to send. - id: teamsChannelId type: string description: >- @@ -310,4 +493,4 @@ methods: [ConversationReference](xref:botframework-schema.ConversationReference) and the id of the [Activity](xref:botframework-schema.Activity) (if sent). - type: 'Promise<[ConversationReference, string]>' + type: Promise<[ConversationReference, string]> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingInfo.yml new file mode 100644 index 00000000..eeefdb44 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingInfo.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TeamsMeetingInfo +uid: botbuilder.TeamsMeetingInfo +package: botbuilder +summary: '' +fullName: TeamsMeetingInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.TeamsMeetingInfo.id + package: botbuilder + summary: Unique identifier representing a meeting + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingMember.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingMember.yml new file mode 100644 index 00000000..cb717164 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingMember.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TeamsMeetingMember +uid: botbuilder.TeamsMeetingMember +package: botbuilder +summary: '' +fullName: TeamsMeetingMember +remarks: '' +isDeprecated: false +type: interface +properties: + - name: meeting + uid: botbuilder.TeamsMeetingMember.meeting + package: botbuilder + summary: The participants info. + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting: UserMeetingDetails' + return: + description: '' + type: + - name: user + uid: botbuilder.TeamsMeetingMember.user + package: botbuilder + summary: The participant account. + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingParticipant.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingParticipant.yml new file mode 100644 index 00000000..425fbbc7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMeetingParticipant.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TeamsMeetingParticipant +uid: botbuilder.TeamsMeetingParticipant +package: botbuilder +summary: '' +fullName: TeamsMeetingParticipant +remarks: '' +isDeprecated: false +type: interface +properties: + - name: conversation + uid: botbuilder.TeamsMeetingParticipant.conversation + package: botbuilder + summary: The conversation account for the meeting. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation?: ConversationAccount' + return: + description: '' + type: + - name: meeting + uid: botbuilder.TeamsMeetingParticipant.meeting + package: botbuilder + summary: The meeting details. + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting?: Meeting' + return: + description: '' + type: + - name: user + uid: botbuilder.TeamsMeetingParticipant.user + package: botbuilder + summary: The user details + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user?: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMember.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMember.yml new file mode 100644 index 00000000..9938d7df --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsMember.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: TeamsMember +uid: botbuilder.TeamsMember +package: botbuilder +summary: '' +fullName: TeamsMember +remarks: '' +isDeprecated: false +syntax: | + type TeamsMember = { id: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsPagedMembersResult.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsPagedMembersResult.yml new file mode 100644 index 00000000..1ce61b82 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsPagedMembersResult.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TeamsPagedMembersResult +uid: botbuilder.TeamsPagedMembersResult +package: botbuilder +summary: '' +fullName: TeamsPagedMembersResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botbuilder.TeamsPagedMembersResult.continuationToken + package: botbuilder + summary: Paging token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: members + uid: botbuilder.TeamsPagedMembersResult.members + package: botbuilder + summary: The Channel Accounts. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: TeamsChannelAccount[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsSSOTokenExchangeMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsSSOTokenExchangeMiddleware.yml index 199a6b88..e1e418e1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsSSOTokenExchangeMiddleware.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TeamsSSOTokenExchangeMiddleware.yml @@ -2,13 +2,14 @@ name: TeamsSSOTokenExchangeMiddleware uid: botbuilder.TeamsSSOTokenExchangeMiddleware package: botbuilder -summary: > +summary: >- If the activity name is signin/tokenExchange, this middleware will attempt to exchange the token, and deduplicate the incoming call, ensuring only one exchange request is processed. + If a user is signed into multiple Teams clients, the Bot could receive a "signin/tokenExchange" from each client. Each token exchange request for a @@ -29,16 +30,14 @@ summary: > development. fullName: TeamsSSOTokenExchangeMiddleware remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TeamsSSOTokenExchangeMiddleware(Storage, string)' + - name: TeamsSSOTokenExchangeMiddleware(Storage, string) uid: botbuilder.TeamsSSOTokenExchangeMiddleware.constructor package: botbuilder summary: Initializes a new instance of the TeamsSSOTokenExchangeMiddleware class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -46,19 +45,17 @@ constructors: oAuthConnectionName: string) parameters: - id: storage - type: Storage - description: 'The [Storage](xref:botbuilder-core.Storage) to use for deduplication' + type: + description: The [Storage](xref:botbuilder-core.Storage) to use for deduplication - id: oAuthConnectionName type: string - description: | - The connection name to use for the single sign on token exchange + description: The connection name to use for the single sign on token exchange methods: - - name: 'onTurn(TurnContext, () => Promise)' + - name: onTurn(TurnContext, () => Promise) uid: botbuilder.TeamsSSOTokenExchangeMiddleware.onTurn package: botbuilder summary: Called each time the bot receives a new request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -66,11 +63,11 @@ methods: Promise parameters: - id: context - type: TurnContext + type: description: Context for current turn of conversation with the user. - id: next type: () => Promise<void> - description: > + description: >- Function to call to continue execution to the next step in the middleware chain. return: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryDependency.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryDependency.yml new file mode 100644 index 00000000..1239eb01 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryDependency.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: TelemetryDependency +uid: botbuilder.TelemetryDependency +package: botbuilder +summary: '' +fullName: TelemetryDependency +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botbuilder.TelemetryDependency.data + package: botbuilder + summary: '' + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: string' + return: + description: '' + type: string + - name: dependencyTypeName + uid: botbuilder.TelemetryDependency.dependencyTypeName + package: botbuilder + summary: '' + fullName: dependencyTypeName + remarks: '' + isDeprecated: false + syntax: + content: 'dependencyTypeName: string' + return: + description: '' + type: string + - name: duration + uid: botbuilder.TelemetryDependency.duration + package: botbuilder + summary: '' + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: number' + return: + description: '' + type: number + - name: name + uid: botbuilder.TelemetryDependency.name + package: botbuilder + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: resultCode + uid: botbuilder.TelemetryDependency.resultCode + package: botbuilder + summary: '' + fullName: resultCode + remarks: '' + isDeprecated: false + syntax: + content: 'resultCode: number' + return: + description: '' + type: number + - name: success + uid: botbuilder.TelemetryDependency.success + package: botbuilder + summary: '' + fullName: success + remarks: '' + isDeprecated: false + syntax: + content: 'success: boolean' + return: + description: '' + type: boolean + - name: target + uid: botbuilder.TelemetryDependency.target + package: botbuilder + summary: '' + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryEvent.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryEvent.yml new file mode 100644 index 00000000..62e2f817 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryEvent.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TelemetryEvent +uid: botbuilder.TelemetryEvent +package: botbuilder +summary: '' +fullName: TelemetryEvent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: metrics + uid: botbuilder.TelemetryEvent.metrics + package: botbuilder + summary: '' + fullName: metrics + remarks: '' + isDeprecated: false + syntax: + content: 'metrics?: {[key: string]: number}' + return: + description: '' + type: '{[key: string]: number}' + - name: name + uid: botbuilder.TelemetryEvent.name + package: botbuilder + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.TelemetryEvent.properties + package: botbuilder + summary: '' + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: {[key: string]: any}' + return: + description: '' + type: '{[key: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryException.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryException.yml new file mode 100644 index 00000000..f173a7b9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryException.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: TelemetryException +uid: botbuilder.TelemetryException +package: botbuilder +summary: '' +fullName: TelemetryException +remarks: '' +isDeprecated: false +type: interface +properties: + - name: exception + uid: botbuilder.TelemetryException.exception + package: botbuilder + summary: '' + fullName: exception + remarks: '' + isDeprecated: false + syntax: + content: 'exception: Error' + return: + description: '' + type: Error + - name: handledAt + uid: botbuilder.TelemetryException.handledAt + package: botbuilder + summary: '' + fullName: handledAt + remarks: '' + isDeprecated: false + syntax: + content: 'handledAt?: string' + return: + description: '' + type: string + - name: measurements + uid: botbuilder.TelemetryException.measurements + package: botbuilder + summary: '' + fullName: measurements + remarks: '' + isDeprecated: false + syntax: + content: 'measurements?: {[key: string]: number}' + return: + description: '' + type: '{[key: string]: number}' + - name: properties + uid: botbuilder.TelemetryException.properties + package: botbuilder + summary: '' + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + - name: severityLevel + uid: botbuilder.TelemetryException.severityLevel + package: botbuilder + summary: '' + fullName: severityLevel + remarks: '' + isDeprecated: false + syntax: + content: 'severityLevel?: Severity' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryLoggerMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryLoggerMiddleware.yml new file mode 100644 index 00000000..2160892c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryLoggerMiddleware.yml @@ -0,0 +1,134 @@ +### YamlMime:TSType +name: TelemetryLoggerMiddleware +uid: botbuilder.TelemetryLoggerMiddleware +package: botbuilder +summary: >- + Middleware for logging incoming, outgoing, updated or deleted Activity + messages. + + Uses the botTelemetryClient interface. +fullName: TelemetryLoggerMiddleware +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TelemetryLoggerMiddleware(BotTelemetryClient, boolean) + uid: botbuilder.TelemetryLoggerMiddleware.constructor + package: botbuilder + summary: Initializes a new instance of the TelemetryLoggerMiddleware class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new TelemetryLoggerMiddleware(telemetryClient: BotTelemetryClient, + logPersonalInformation?: boolean) + parameters: + - id: telemetryClient + type: + description: The BotTelemetryClient used for logging. + - id: logPersonalInformation + type: boolean + description: >- + (Optional) Enable/Disable logging original message name within + Application Insights. +properties: + - name: botMsgDeleteEvent + uid: botbuilder.TelemetryLoggerMiddleware.botMsgDeleteEvent + package: botbuilder + summary: The name of the event when a message is deleted by the bot. + fullName: botMsgDeleteEvent + remarks: '' + isDeprecated: false + syntax: + content: 'static botMsgDeleteEvent: string' + return: + description: '' + type: string + - name: botMsgReceiveEvent + uid: botbuilder.TelemetryLoggerMiddleware.botMsgReceiveEvent + package: botbuilder + summary: The name of the event when when new message is received from the user. + fullName: botMsgReceiveEvent + remarks: '' + isDeprecated: false + syntax: + content: 'static botMsgReceiveEvent: string' + return: + description: '' + type: string + - name: botMsgSendEvent + uid: botbuilder.TelemetryLoggerMiddleware.botMsgSendEvent + package: botbuilder + summary: The name of the event when a message is updated by the bot. + fullName: botMsgSendEvent + remarks: '' + isDeprecated: false + syntax: + content: 'static botMsgSendEvent: string' + return: + description: '' + type: string + - name: botMsgUpdateEvent + uid: botbuilder.TelemetryLoggerMiddleware.botMsgUpdateEvent + package: botbuilder + summary: The name of the event when a message is updated by the bot. + fullName: botMsgUpdateEvent + remarks: '' + isDeprecated: false + syntax: + content: 'static botMsgUpdateEvent: string' + return: + description: '' + type: string + - name: logPersonalInformation + uid: botbuilder.TelemetryLoggerMiddleware.logPersonalInformation + package: botbuilder + summary: >- + Gets a value indicating whether to log personal information that came from + the user. + fullName: logPersonalInformation + remarks: '' + isDeprecated: false + syntax: + content: boolean logPersonalInformation + return: + description: A value indicating whether to log personal information or not. + type: boolean + - name: telemetryClient + uid: botbuilder.TelemetryLoggerMiddleware.telemetryClient + package: botbuilder + summary: Gets the currently configured botTelemetryClient that logs the events. + fullName: telemetryClient + remarks: '' + isDeprecated: false + syntax: + content: BotTelemetryClient telemetryClient + return: + description: >- + The currently configured + [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) that + logs the events. + type: +methods: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.TelemetryLoggerMiddleware.onTurn + package: botbuilder + summary: >- + Logs events based on incoming and outgoing activities using the + botTelemetryClient class. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: The context object for this turn. + - id: next + type: () => Promise<void> + description: The delegate to call to continue the bot middleware pipeline + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryPageView.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryPageView.yml new file mode 100644 index 00000000..600bc68f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryPageView.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TelemetryPageView +uid: botbuilder.TelemetryPageView +package: botbuilder +summary: '' +fullName: TelemetryPageView +remarks: '' +isDeprecated: false +type: interface +properties: + - name: metrics + uid: botbuilder.TelemetryPageView.metrics + package: botbuilder + summary: '' + fullName: metrics + remarks: '' + isDeprecated: false + syntax: + content: 'metrics?: {[key: string]: number}' + return: + description: '' + type: '{[key: string]: number}' + - name: name + uid: botbuilder.TelemetryPageView.name + package: botbuilder + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.TelemetryPageView.properties + package: botbuilder + summary: '' + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryTrace.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryTrace.yml new file mode 100644 index 00000000..e534327f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TelemetryTrace.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TelemetryTrace +uid: botbuilder.TelemetryTrace +package: botbuilder +summary: '' +fullName: TelemetryTrace +remarks: '' +isDeprecated: false +type: interface +properties: + - name: message + uid: botbuilder.TelemetryTrace.message + package: botbuilder + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.TelemetryTrace.properties + package: botbuilder + summary: '' + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + - name: severityLevel + uid: botbuilder.TelemetryTrace.severityLevel + package: botbuilder + summary: '' + fullName: severityLevel + remarks: '' + isDeprecated: false + syntax: + content: 'severityLevel?: Severity' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TenantInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TenantInfo.yml new file mode 100644 index 00000000..60716207 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TenantInfo.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TenantInfo +uid: botbuilder.TenantInfo +package: botbuilder +summary: '' +fullName: TenantInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.TenantInfo.id + package: botbuilder + summary: Unique identifier representing a tenant + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TestActivityInspector.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TestActivityInspector.yml new file mode 100644 index 00000000..8dc708cb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TestActivityInspector.yml @@ -0,0 +1,25 @@ +### YamlMime:TSTypeAlias +name: TestActivityInspector +uid: botbuilder.TestActivityInspector +package: botbuilder +summary: >- + Signature for a function that can be used to inspect individual activities + returned by a bot + + that's being tested using the `TestAdapter`. + + + ```TypeScript + + type TestActivityInspector = (activity: Partial, description: + string) => void; + + ``` +fullName: TestActivityInspector +remarks: '' +isDeprecated: false +syntax: | + type TestActivityInspector = ( + activity: Partial, + description?: string + ) => void diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TestAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TestAdapter.yml new file mode 100644 index 00000000..1dd3d7ae --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TestAdapter.yml @@ -0,0 +1,888 @@ +### YamlMime:TSType +name: TestAdapter +uid: botbuilder.TestAdapter +package: botbuilder +summary: >- + Test adapter used for unit tests. This adapter can be used to simulate sending + messages from the + + user to the bot. +fullName: TestAdapter +remarks: >- + The following example sets up the test adapter and then executes a simple + test: + + + ```JavaScript + + const { TestAdapter } = require('botbuilder'); + + + const adapter = new TestAdapter(async (context) => { + await context.sendActivity(`Hello World`); + }); + + + adapter.test(`hi`, `Hello World`) + .then(() => done()); + ``` +isDeprecated: false +type: class +constructors: + - name: >- + TestAdapter(ConversationReference | (context: TurnContext) => + Promise, Partial, boolean) + uid: botbuilder.TestAdapter.constructor + package: botbuilder + summary: Creates a new TestAdapter instance. + remarks: '' + isDeprecated: false + syntax: + content: >- + new TestAdapter(logicOrConversation?: ConversationReference | (context: + TurnContext) => Promise, template?: Partial, + sendTraceActivity?: boolean) + parameters: + - id: logicOrConversation + type: >- + | (context: + TurnContext) => Promise<void> + description: The bots logic that's under test. + - id: template + type: Partial<> + description: >- + (Optional) activity containing default values to assign to all test + messages received. + - id: sendTraceActivity + type: boolean + description: >- + Indicates whether the adapter should add to its queue any trace + activities generated by the bot. +properties: + - name: activeQueue + uid: botbuilder.TestAdapter.activeQueue + package: botbuilder + summary: Gets the queue of responses from the bot. + fullName: activeQueue + remarks: '' + isDeprecated: false + syntax: + content: 'activeQueue: Partial[]' + return: + description: '' + type: Partial<>[] + - name: conversation + uid: botbuilder.TestAdapter.conversation + package: botbuilder + summary: Gets or sets a reference to the current conversation. + fullName: conversation + remarks: '' + isDeprecated: false + syntax: + content: 'conversation: ConversationReference' + return: + description: '' + type: + - name: enableTrace + uid: botbuilder.TestAdapter.enableTrace + package: botbuilder + summary: Gets a value indicating whether to send trace activities. + fullName: enableTrace + remarks: '' + isDeprecated: false + syntax: + content: boolean enableTrace + return: + description: A value indicating whether to send trace activities. + type: boolean + - name: locale + uid: botbuilder.TestAdapter.locale + package: botbuilder + summary: Gets or sets the locale for the conversation. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: 'locale: string' + return: + description: '' + type: string + - name: onTurnError + uid: botbuilder.TestAdapter.onTurnError + package: botbuilder + summary: >- + Gets or sets an error handler that can catch exceptions in the middleware + or application. + fullName: onTurnError + remarks: '' + isDeprecated: false + syntax: + content: '(context: TurnContext, error: Error) => Promise onTurnError' + return: + description: A promise representing the async operation. + type: '(context: TurnContext, error: Error) => Promise<void>' + - name: template + uid: botbuilder.TestAdapter.template + package: botbuilder + summary: >- + `Activity` template that will be merged with all activities sent to the + logic under test. + fullName: template + remarks: '' + isDeprecated: false + syntax: + content: 'template: Partial' + return: + description: '' + type: Partial<> +inheritedProperties: + - name: BotIdentityKey + uid: botbuilder.TestAdapter.BotIdentityKey + package: botbuilder + summary: '' + fullName: BotIdentityKey + remarks: '' + isDeprecated: false + syntax: + content: 'BotIdentityKey: symbol' + return: + description: '' + type: symbol + inheritanceDescription: >- + Inherited From + [BotAdapter.BotIdentityKey](xref:botbuilder.BotAdapter.BotIdentityKey) + - name: ConnectorClientKey + uid: botbuilder.TestAdapter.ConnectorClientKey + package: botbuilder + summary: '' + fullName: ConnectorClientKey + remarks: '' + isDeprecated: false + syntax: + content: 'ConnectorClientKey: symbol' + return: + description: '' + type: symbol + inheritanceDescription: >- + Inherited From + [BotAdapter.ConnectorClientKey](xref:botbuilder.BotAdapter.ConnectorClientKey) + - name: OAuthScopeKey + uid: botbuilder.TestAdapter.OAuthScopeKey + package: botbuilder + summary: '' + fullName: OAuthScopeKey + remarks: '' + isDeprecated: false + syntax: + content: 'OAuthScopeKey: symbol' + return: + description: '' + type: symbol + inheritanceDescription: >- + Inherited From + [BotAdapter.OAuthScopeKey](xref:botbuilder.BotAdapter.OAuthScopeKey) +inheritedMethods: + - name: >- + continueConversationAsync(ClaimsIdentity, Partial, + (context: TurnContext) => Promise) + uid: botbuilder.TestAdapter.continueConversationAsync_1 + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversationAsync(claimsIdentity: ClaimsIdentity, + reference: Partial, logic: (context: TurnContext) + => Promise): Promise + parameters: + - id: claimsIdentity + type: ClaimsIdentity + description: >- + A [ClaimsIdentity](xref:botframework-connector) for the + conversation. + - id: reference + type: Partial<> + description: >- + A partial + [ConversationReference](xref:botframework-schema.ConversationReference) + to the conversation to continue. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: a promise representing the async operation + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotAdapter.continueConversationAsync](xref:botbuilder.BotAdapter.continueConversationAsync) + - name: >- + continueConversationAsync(ClaimsIdentity, Partial, + string, (context: TurnContext) => Promise) + uid: botbuilder.TestAdapter.continueConversationAsync_2 + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversationAsync(claimsIdentity: ClaimsIdentity, + reference: Partial, audience: string, logic: + (context: TurnContext) => Promise): Promise + parameters: + - id: claimsIdentity + type: ClaimsIdentity + description: >- + A [ClaimsIdentity](xref:botframework-connector) for the + conversation. + - id: reference + type: Partial<> + description: >- + A partial + [ConversationReference](xref:botframework-schema.ConversationReference) + to the conversation to continue. + - id: audience + type: string + description: A value signifying the recipient of the proactive message. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: a promise representing the async operation + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotAdapter.continueConversationAsync](xref:botbuilder.BotAdapter.continueConversationAsync) + - name: >- + continueConversationAsync(string, Partial, + (context: TurnContext) => Promise) + uid: botbuilder.TestAdapter.continueConversationAsync + package: botbuilder + summary: >- + Asynchronously resumes a conversation with a user, possibly after some + time has gone by. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversationAsync(botAppId: string, reference: + Partial, logic: (context: TurnContext) => + Promise): Promise + parameters: + - id: botAppId + type: string + description: >- + The application ID of the bot. This parameter is ignored in single + tenant the Adapters (Console,Test, etc) but is critical to the + BotFrameworkAdapter which is multi-tenant aware. + - id: reference + type: Partial<> + description: >- + A partial + [ConversationReference](xref:botframework-schema.ConversationReference) + to the conversation to continue. + - id: logic + type: '(context: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: a promise representing the async operation + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotAdapter.continueConversationAsync](xref:botbuilder.BotAdapter.continueConversationAsync) + - name: >- + createConversationAsync(string, string, string, string, + ConversationParameters, (context: TurnContext) => Promise) + uid: botbuilder.TestAdapter.createConversationAsync + package: botbuilder + summary: Creates a conversation on the specified channel. + remarks: >- + To start a conversation, your bot must know its account information and + the user's account information on that + + channel. Most _channels only support initiating a direct message + (non-group) conversation. + + + The adapter attempts to create a new conversation on the channel, and then + sends a `conversationUpdate` activity + + through its middleware pipeline to the logic method. + + + If the conversation is established with the specified users, the ID of the + activity's converstion will contain + + the ID of the new conversation. + isDeprecated: false + syntax: + content: >- + function createConversationAsync(_botAppId: string, _channelId: string, + _serviceUrl: string, _audience: string, _conversationParameters: + ConversationParameters, _logic: (context: TurnContext) => + Promise): Promise + parameters: + - id: _botAppId + type: string + description: The application ID of the bot. + - id: _channelId + type: string + description: The ID for the channel. + - id: _serviceUrl + type: string + description: The ID for the channel. + - id: _audience + type: string + description: |- + The audience for the connector. + + - id: _conversationParameters + type: + description: The conversation information to use to create the conversation + - id: _logic + type: '(context: TurnContext) => Promise<void>' + description: The method to call for the resulting bot turn. + return: + description: A promise that represents the asynchronous operation + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotAdapter.createConversationAsync](xref:botbuilder.BotAdapter.createConversationAsync) + - name: use((MiddlewareHandler | Middleware)[]) + uid: botbuilder.TestAdapter.use + package: botbuilder + summary: Adds middleware to the adapter's pipeline. + remarks: >- + Middleware is added to the adapter at initialization time. + + Each turn, the adapter calls its middleware in the order in which you + added it. + isDeprecated: false + syntax: + content: >- + function use(middlewares: (MiddlewareHandler | Middleware)[]): + TestAdapter + parameters: + - id: middlewares + type: >- + ( | )[] + description: The middleware or middleware handlers to add. + return: + description: The updated adapter object. + type: + inheritanceDescription: Inherited From [BotAdapter.use](xref:botbuilder.BotAdapter.use) +methods: + - name: addExchangeableToken(string, string, string, string, string) + uid: botbuilder.TestAdapter.addExchangeableToken + package: botbuilder + summary: Adds a fake exchangeable token so it can be exchanged later. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addExchangeableToken(connectionName: string, channelId: string, + userId: string, exchangeableItem: string, token: string) + parameters: + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: channelId + type: string + description: Channel ID. + - id: userId + type: string + description: User ID. + - id: exchangeableItem + type: string + description: Exchangeable token or resource URI. + - id: token + type: string + description: Token to store. + - name: addUserToken(string, string, string, string, string) + uid: botbuilder.TestAdapter.addUserToken + package: botbuilder + summary: Adds a fake user token so it can later be retrieved. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addUserToken(connectionName: string, channelId: string, userId: + string, token: string, magicCode?: string) + parameters: + - id: connectionName + type: string + description: The connection name. + - id: channelId + type: string + description: The channel id. + - id: userId + type: string + description: The user id. + - id: token + type: string + description: The token to store. + - id: magicCode + type: string + description: (Optional) The optional magic code to associate with this token. + - name: >- + continueConversation(Partial, (revocableContext: + TurnContext) => Promise) + uid: botbuilder.TestAdapter.continueConversation + package: botbuilder + summary: >- + The `TestAdapter` doesn't implement `continueConversation()` and will + return an error if it's + + called. + remarks: '' + isDeprecated: false + syntax: + content: >- + function continueConversation(_reference: + Partial, _logic: (revocableContext: TurnContext) + => Promise): Promise + parameters: + - id: _reference + type: Partial<> + description: A reference to the conversation to continue. + - id: _logic + type: '(revocableContext: TurnContext) => Promise<void>' + description: The asynchronous method to call after the adapter middleware runs. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: createConversation(string, string, string) + uid: botbuilder.TestAdapter.createConversation + package: botbuilder + summary: Create a ConversationReference. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function createConversation(name: string, user?: string, bot?: + string): ConversationReference + parameters: + - id: name + type: string + description: name of the conversation (also id). + - id: user + type: string + description: 'name of the user (also id) default: User1.' + - id: bot + type: string + description: 'name of the bot (also id) default: Bot.' + return: + description: >- + The + [ConversationReference](xref:botframework-schema.ConversationReference). + type: + - name: exchangeToken(TurnContext, string, string, TokenExchangeRequest) + uid: botbuilder.TestAdapter.exchangeToken + package: botbuilder + summary: Performs a token exchange operation such as for single sign-on. + remarks: '' + isDeprecated: false + syntax: + content: >- + function exchangeToken(context: TurnContext, connectionName: string, + userId: string, tokenExchangeRequest: TokenExchangeRequest): + Promise + parameters: + - id: context + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: User id associated with the token. + - id: tokenExchangeRequest + type: + description: >- + Exchange request details, either a token to exchange or a uri to + exchange. + return: + description: If the promise completes, the exchanged token is returned. + type: Promise<> + - name: getAadTokens(TurnContext, string, string[]) + uid: botbuilder.TestAdapter.getAadTokens + package: botbuilder + summary: Signs the user out with the token server. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAadTokens(_context: TurnContext, _connectionName: string, + _resourceUrls: string[]): Promise<{[propertyName: string]: + TokenResponse}> + parameters: + - id: _context + type: + description: Context for the current turn of conversation with the user. + - id: _connectionName + type: string + description: Name of the auth connection to use. + - id: _resourceUrls + type: string[] + description: The list of resource URLs to retrieve tokens for. + return: + description: A Dictionary of resourceUrl to the corresponding TokenResponse. + type: >- + Promise<{[propertyName: string]: }> + - name: getNextReply() + uid: botbuilder.TestAdapter.getNextReply + package: botbuilder + summary: Dequeues and returns the next bot response from the activeQueue. + remarks: '' + isDeprecated: false + syntax: + content: 'function getNextReply(): Partial' + return: + description: The next activity in the queue; or undefined, if the queue is empty. + type: Partial<> + - name: getSignInLink(TurnContext, string) + uid: botbuilder.TestAdapter.getSignInLink + package: botbuilder + summary: >- + Gets a signin link from the token server that can be sent as part of a + SigninCard. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInLink(context: TurnContext, connectionName: string): + Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + return: + description: >- + A signin link from the token server that can be sent as part of a + SigninCard. + type: Promise<string> + - name: getSignInResource(TurnContext, string, string, string) + uid: botbuilder.TestAdapter.getSignInResource + package: botbuilder + summary: Gets a sign-in resource. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getSignInResource(context: TurnContext, connectionName: string, + userId?: string, _finalRedirect?: string): Promise + parameters: + - id: context + type: + description: >- + [TurnContext](xref:botbuilder-core.TurnContext) for the current turn + of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: User ID + - id: _finalRedirect + type: string + description: Final redirect URL. + return: + description: >- + A `Promise` with a new + [SignInUrlResponse](xref:botframework-schema.SignInUrlResponse) + object. + type: Promise<> + - name: getTokenStatus(TurnContext, string, string, any) + uid: botbuilder.TestAdapter.getTokenStatus + package: botbuilder + summary: >- + Asynchronously retrieves the token status for each configured connection + for the given user. + + In testAdapter, retrieves tokens which were previously added via + addUserToken. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTokenStatus(context: TurnContext, userId: string, + includeFilter?: string, _oAuthAppCredentials?: any): Promise + parameters: + - id: context + type: + description: The context object for the turn. + - id: userId + type: string + description: The ID of the user to retrieve the token status for. + - id: includeFilter + type: string + description: >- + Optional. A comma-separated list of connection's to include. If + present, + the `includeFilter` parameter limits the tokens this method returns. + - id: _oAuthAppCredentials + type: any + description: AppCredentials for OAuth. + return: + description: >- + The [TokenStatus](xref:botframework-connector.TokenStatus) objects + retrieved. + type: Promise<any[]> + - name: getUserToken(TurnContext, string, string) + uid: botbuilder.TestAdapter.getUserToken + package: botbuilder + summary: Retrieves the OAuth token for a user that is in a sign-in flow. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getUserToken(context: TurnContext, connectionName: string, + magicCode?: string): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: magicCode + type: string + description: (Optional) Optional user entered code to validate. + return: + description: The OAuth token for a user that is in a sign-in flow. + type: Promise<> + - name: makeActivity(string) + uid: botbuilder.TestAdapter.makeActivity + package: botbuilder + summary: >- + Creates a message activity from text and the current conversational + context. + remarks: '' + isDeprecated: false + syntax: + content: 'function makeActivity(text?: string): Partial' + parameters: + - id: text + type: string + description: The message text. + return: + description: An appropriate message activity. + type: Partial<> + - name: >- + processActivity(string | Partial, (context: TurnContext) => + Promise) + uid: botbuilder.TestAdapter.processActivity + package: botbuilder + summary: Receives an activity and runs it through the middleware pipeline. + remarks: '' + isDeprecated: false + syntax: + content: >- + function processActivity(activity: string | Partial, + callback?: (context: TurnContext) => Promise): Promise + parameters: + - id: activity + type: string | Partial<> + description: The activity to process. + - id: callback + type: '(context: TurnContext) => Promise<any>' + description: The bot logic to invoke. + return: + description: A promise representing the async operation. + type: Promise<any> + - name: send(string | Partial) + uid: botbuilder.TestAdapter.send + package: botbuilder + summary: >- + Sends something to the bot. This returns a new `TestFlow` instance which + can be used to add + + additional steps for inspecting the bots reply and then sending additional + activities. + remarks: >- + This example shows how to send a message and then verify that the response + was as expected: + + + ```JavaScript + + adapter.send('hi') + .assertReply('Hello World') + .then(() => done()); + ``` + isDeprecated: false + syntax: + content: 'function send(userSays: string | Partial): TestFlow' + parameters: + - id: userSays + type: string | Partial<> + description: Text or activity simulating user input. + return: + description: >- + a new [TestFlow](xref:botbuilder-core.TestFlow) instance which can be + used to add additional steps + + for inspecting the bots reply and then sending additional activities. + type: + - name: 'sendTextToBot(string, (context: TurnContext) => Promise)' + uid: botbuilder.TestAdapter.sendTextToBot + package: botbuilder + summary: Processes a message activity from a user. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendTextToBot(userSays: string, callback: (context: + TurnContext) => Promise): Promise + parameters: + - id: userSays + type: string + description: The text of the user's message. + - id: callback + type: '(context: TurnContext) => Promise<any>' + description: The bot logic to invoke. + return: + description: A promise representing the async operation. + type: Promise<any> + - name: signOutUser(TurnContext, string, string) + uid: botbuilder.TestAdapter.signOutUser + package: botbuilder + summary: Signs the user out with the token server. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signOutUser(context: TurnContext, connectionName?: string, + userId?: string): Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: connectionName + type: string + description: Name of the auth connection to use. + - id: userId + type: string + description: User ID to sign out. + return: + description: '' + type: Promise<void> + - name: >- + test(string | Partial, string | Partial | (activity: + Partial, description?: string) => void, string, number) + uid: botbuilder.TestAdapter.test + package: botbuilder + summary: >- + Send something to the bot and expects the bot to return with a given + reply. + remarks: >- + This is simply a wrapper around calls to `send()` and `assertReply()`. + This is such a + + common pattern that a helper is provided. + + + ```JavaScript + + adapter.test('hi', 'Hello World') + .then(() => done()); + ``` + isDeprecated: false + syntax: + content: >- + function test(userSays: string | Partial, expected: string | + Partial | (activity: Partial, description?: string) + => void, description?: string, _timeout?: number): TestFlow + parameters: + - id: userSays + type: string | Partial<> + description: Text or activity simulating user input. + - id: expected + type: >- + string | Partial<> | + (activity: Partial<Activity>, description?: string) => void + description: Expected text or activity of the reply sent by the bot. + - id: description + type: string + description: >- + (Optional) Description of the test case. If not provided one will be + generated. + - id: _timeout + type: number + description: >- + (Optional) number of milliseconds to wait for a response from bot. + Defaults to a value of `3000`. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: testActivities(Partial[], string, number) + uid: botbuilder.TestAdapter.testActivities + package: botbuilder + summary: Test a list of activities. + remarks: >- + Each activity with the "bot" role will be processed with assertReply() and + every other + + activity will be processed as a user message with send(). + isDeprecated: false + syntax: + content: >- + function testActivities(activities: Partial[], description?: + string, timeout?: number): TestFlow + parameters: + - id: activities + type: Partial<>[] + description: Array of activities. + - id: description + type: string + description: >- + (Optional) Description of the test case. If not provided one will be + generated. + - id: timeout + type: number + description: >- + (Optional) number of milliseconds to wait for a response from bot. + Defaults to a value of `3000`. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: throwOnExchangeRequest(string, string, string, string) + uid: botbuilder.TestAdapter.throwOnExchangeRequest + package: botbuilder + summary: Adds an instruction to throw an exception during exchange requests. + remarks: '' + isDeprecated: false + syntax: + content: >- + function throwOnExchangeRequest(connectionName: string, channelId: + string, userId: string, exchangeableItem: string) + parameters: + - id: connectionName + type: string + description: The connection name. + - id: channelId + type: string + description: The channel id. + - id: userId + type: string + description: The user id. + - id: exchangeableItem + type: string + description: The exchangeable token or resource URI. +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TestFlow.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TestFlow.yml new file mode 100644 index 00000000..94553ee3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TestFlow.yml @@ -0,0 +1,297 @@ +### YamlMime:TSType +name: TestFlow +uid: botbuilder.TestFlow +package: botbuilder +summary: >- + Support class for `TestAdapter` that allows for the simple construction of a + sequence of tests. +fullName: TestFlow +remarks: >- + Calling `adapter.send()` or `adapter.test()` will create a new test flow which + you can chain + + together additional tests using a fluent syntax. + + + ```JavaScript + + const { TestAdapter } = require('botbuilder'); + + + const adapter = new TestAdapter(async (context) => { + if (context.text === 'hi') { + await context.sendActivity(`Hello World`); + } else if (context.text === 'bye') { + await context.sendActivity(`Goodbye`); + } + }); + + + adapter.test(`hi`, `Hello World`) + .test(`bye`, `Goodbye`) + .then(() => done()); + ``` +isDeprecated: false +type: class +properties: + - name: previous + uid: botbuilder.TestFlow.previous + package: botbuilder + summary: '' + fullName: previous + remarks: '' + isDeprecated: false + syntax: + content: 'previous: Promise' + return: + description: '' + type: Promise<void> +methods: + - name: assertNoReply(string, number) + uid: botbuilder.TestFlow.assertNoReply + package: botbuilder + summary: >- + Generates an assertion that the turn processing logic did not generate a + reply from the bot, as expected. + remarks: '' + isDeprecated: false + syntax: + content: 'function assertNoReply(description?: string, timeout?: number): TestFlow' + parameters: + - id: description + type: string + description: >- + (Optional) Description of the test case. If not provided one will be + generated. + - id: timeout + type: number + description: >- + (Optional) number of milliseconds to wait for a response from bot. + Defaults to a value of `3000`. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: >- + assertReply(string | Partial | TestActivityInspector, string, + number) + uid: botbuilder.TestFlow.assertReply + package: botbuilder + summary: >- + Generates an assertion if the bots response doesn't match the expected + text/activity. + remarks: '' + isDeprecated: false + syntax: + content: >- + function assertReply(expected: string | Partial | + TestActivityInspector, description?: string, timeout?: number): TestFlow + parameters: + - id: expected + type: >- + string | Partial<> | + description: >- + Expected text or activity from the bot. Can be a callback to inspect + the response using custom logic. + - id: description + type: string + description: >- + (Optional) Description of the test case. If not provided one will be + generated. + - id: timeout + type: number + description: >- + (Optional) number of milliseconds to wait for a response from bot. + Defaults to a value of `3000`. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: assertReplyOneOf(string[], string, number) + uid: botbuilder.TestFlow.assertReplyOneOf + package: botbuilder + summary: >- + Generates an assertion if the bots response is not one of the candidate + strings. + remarks: '' + isDeprecated: false + syntax: + content: >- + function assertReplyOneOf(candidates: string[], description?: string, + timeout?: number): TestFlow + parameters: + - id: candidates + type: string[] + description: List of candidate responses. + - id: description + type: string + description: >- + (Optional) Description of the test case. If not provided one will be + generated. + - id: timeout + type: number + description: >- + (Optional) number of milliseconds to wait for a response from bot. + Defaults to a value of `3000`. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: 'catch((reason: any) => void)' + uid: botbuilder.TestFlow.catch + package: botbuilder + summary: Adds a `catch()` clause to the tests promise chain. + remarks: '' + isDeprecated: false + syntax: + content: 'function catch(onRejected?: (reason: any) => void): TestFlow' + parameters: + - id: onRejected + type: '(reason: any) => void' + description: Code to run if the test has thrown an error. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: delay(number) + uid: botbuilder.TestFlow.delay + package: botbuilder + summary: Inserts a delay before continuing. + remarks: '' + isDeprecated: false + syntax: + content: 'function delay(ms: number): TestFlow' + parameters: + - id: ms + type: number + description: ms to wait. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: finally(() => void) + uid: botbuilder.TestFlow.finally + package: botbuilder + summary: Adds a finally clause. Note that you can't keep chaining afterwards. + remarks: '' + isDeprecated: false + syntax: + content: 'function finally(onFinally: () => void): Promise' + parameters: + - id: onFinally + type: () => void + description: Code to run after the test chain. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: send(string | Partial) + uid: botbuilder.TestFlow.send + package: botbuilder + summary: Sends something to the bot. + remarks: '' + isDeprecated: false + syntax: + content: 'function send(userSays: string | Partial): TestFlow' + parameters: + - id: userSays + type: string | Partial<> + description: Text or activity simulating user input. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: sendConversationUpdate() + uid: botbuilder.TestFlow.sendConversationUpdate + package: botbuilder + summary: Creates a conversation update activity and process the activity. + remarks: '' + isDeprecated: false + syntax: + content: 'function sendConversationUpdate(): TestFlow' + return: + description: A new TestFlow object. + type: + - name: startTest() + uid: botbuilder.TestFlow.startTest + package: botbuilder + summary: Start the test sequence, returning a promise to await. + remarks: '' + isDeprecated: false + syntax: + content: 'function startTest(): Promise' + return: + description: A promise representing the async operation. + type: Promise<void> + - name: >- + test(string | Partial, string | Partial | (activity: + Partial, description?: string) => void, string, number) + uid: botbuilder.TestFlow.test + package: botbuilder + summary: >- + Send something to the bot and expects the bot to return with a given + reply. This is simply a + + wrapper around calls to `send()` and `assertReply()`. This is such a + common pattern that a + + helper is provided. + remarks: '' + isDeprecated: false + syntax: + content: >- + function test(userSays: string | Partial, expected: string | + Partial | (activity: Partial, description?: string) + => void, description?: string, timeout?: number): TestFlow + parameters: + - id: userSays + type: string | Partial<> + description: Text or activity simulating user input. + - id: expected + type: >- + string | Partial<> | + (activity: Partial<Activity>, description?: string) => void + description: Expected text or activity of the reply sent by the bot. + - id: description + type: string + description: >- + (Optional) Description of the test case. If not provided one will be + generated. + - id: timeout + type: number + description: >- + (Optional) number of milliseconds to wait for a response from bot. + Defaults to a value of `3000`. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: + - name: 'then(() => void, (err: any) => void)' + uid: botbuilder.TestFlow.then + package: botbuilder + summary: Adds a `then()` step to the tests promise chain. + remarks: '' + isDeprecated: false + syntax: + content: >- + function then(onFulfilled?: () => void, onRejected?: (err: any) => + void): TestFlow + parameters: + - id: onFulfilled + type: () => void + description: Code to run if the test is currently passing. + - id: onRejected + type: '(err: any) => void' + description: Code to run if the test has thrown an error. + return: + description: >- + A new [TestFlow](xref:botbuilder-core.TestFlow) object that appends + this exchange to the modeled exchange. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TextCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextCardViewParameters.yml new file mode 100644 index 00000000..855f3f46 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextCardViewParameters.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: TextCardViewParameters +uid: botbuilder.TextCardViewParameters +package: botbuilder +summary: The parameters for the card view with text or empty body. +fullName: TextCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.TextCardViewParameters.body + package: botbuilder + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: undefined | [CardTextComponent]' + return: + description: '' + type: undefined | [CardTextComponent] + - name: cardViewType + uid: botbuilder.TextCardViewParameters.cardViewType + package: botbuilder + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "text"' + return: + description: '' + type: '"text"' + - name: footer + uid: botbuilder.TextCardViewParameters.footer + package: botbuilder + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: CardViewFooterParameters' + return: + description: '' + type: + - name: header + uid: botbuilder.TextCardViewParameters.header + package: botbuilder + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' + - name: image + uid: botbuilder.TextCardViewParameters.image + package: botbuilder + summary: Image displayed on the card. + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: cardBar + uid: botbuilder.TextCardViewParameters.cardBar + package: botbuilder + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TextFormatTypes.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextFormatTypes.yml new file mode 100644 index 00000000..36b33c86 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextFormatTypes.yml @@ -0,0 +1,23 @@ +### YamlMime:TSEnum +name: TextFormatTypes +uid: botbuilder.TextFormatTypes +package: botbuilder +summary: |- + Defines values for TextFormatTypes. + Possible values include: 'markdown', 'plain', 'xml' +fullName: TextFormatTypes +remarks: '' +isDeprecated: false +fields: + - name: Markdown + uid: botbuilder.TextFormatTypes.Markdown + package: botbuilder + summary: '' + - name: Plain + uid: botbuilder.TextFormatTypes.Plain + package: botbuilder + summary: '' + - name: Xml + uid: botbuilder.TextFormatTypes.Xml + package: botbuilder + summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TextHighlight.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextHighlight.yml new file mode 100644 index 00000000..37dd57e9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextHighlight.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: TextHighlight +uid: botbuilder.TextHighlight +package: botbuilder +summary: Refers to a substring of content within another field +fullName: TextHighlight +remarks: '' +isDeprecated: false +type: interface +properties: + - name: occurrence + uid: botbuilder.TextHighlight.occurrence + package: botbuilder + summary: >- + Occurrence of the text field within the referenced text, if multiple + exist. + fullName: occurrence + remarks: '' + isDeprecated: false + syntax: + content: 'occurrence: number' + return: + description: '' + type: number + - name: text + uid: botbuilder.TextHighlight.text + package: botbuilder + summary: Defines the snippet of text to highlight + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TextInputCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextInputCardViewParameters.yml new file mode 100644 index 00000000..1458f259 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TextInputCardViewParameters.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: TextInputCardViewParameters +uid: botbuilder.TextInputCardViewParameters +package: botbuilder +summary: The parameters for the card view with text input in the body. +fullName: TextInputCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botbuilder.TextInputCardViewParameters.body + package: botbuilder + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: [CardTextInputComponent]' + return: + description: '' + type: '[CardTextInputComponent]' + - name: cardViewType + uid: botbuilder.TextInputCardViewParameters.cardViewType + package: botbuilder + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "textInput"' + return: + description: '' + type: '"textInput"' + - name: footer + uid: botbuilder.TextInputCardViewParameters.footer + package: botbuilder + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: CardViewActionsFooterParameters' + return: + description: '' + type: + - name: header + uid: botbuilder.TextInputCardViewParameters.header + package: botbuilder + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' + - name: image + uid: botbuilder.TextInputCardViewParameters.image + package: botbuilder + summary: Image displayed on the card. + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: cardBar + uid: botbuilder.TextInputCardViewParameters.cardBar + package: botbuilder + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botbuilder.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Thing.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Thing.yml new file mode 100644 index 00000000..14351571 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Thing.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: Thing +uid: botbuilder.Thing +package: botbuilder +summary: 'Thing (entity type: "https://schema.org/Thing")' +fullName: Thing +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: botbuilder.Thing.name + package: botbuilder + summary: The name of the thing + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + - name: type + uid: botbuilder.Thing.type + package: botbuilder + summary: The type of the thing + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailCard.yml new file mode 100644 index 00000000..c91d6634 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailCard.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: ThumbnailCard +uid: botbuilder.ThumbnailCard +package: botbuilder +summary: A thumbnail card (card with a single, small thumbnail image) +fullName: ThumbnailCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: buttons + uid: botbuilder.ThumbnailCard.buttons + package: botbuilder + summary: Set of actions applicable to the current card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: images + uid: botbuilder.ThumbnailCard.images + package: botbuilder + summary: Array of images for the card + fullName: images + remarks: '' + isDeprecated: false + syntax: + content: 'images: CardImage[]' + return: + description: '' + type: [] + - name: subtitle + uid: botbuilder.ThumbnailCard.subtitle + package: botbuilder + summary: Subtitle of the card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: tap + uid: botbuilder.ThumbnailCard.tap + package: botbuilder + summary: This action will be activated when user taps on the card itself + fullName: tap + remarks: '' + isDeprecated: false + syntax: + content: 'tap: CardAction' + return: + description: '' + type: + - name: text + uid: botbuilder.ThumbnailCard.text + package: botbuilder + summary: Text for the card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.ThumbnailCard.title + package: botbuilder + summary: Title of the card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailUrl.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailUrl.yml new file mode 100644 index 00000000..fadd7b4a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ThumbnailUrl.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ThumbnailUrl +uid: botbuilder.ThumbnailUrl +package: botbuilder +summary: Thumbnail URL +fullName: ThumbnailUrl +remarks: '' +isDeprecated: false +type: interface +properties: + - name: alt + uid: botbuilder.ThumbnailUrl.alt + package: botbuilder + summary: HTML alt text to include on this thumbnail image + fullName: alt + remarks: '' + isDeprecated: false + syntax: + content: 'alt: string' + return: + description: '' + type: string + - name: url + uid: botbuilder.ThumbnailUrl.url + package: botbuilder + summary: URL pointing to the thumbnail to use for media content + fullName: url + remarks: '' + isDeprecated: false + syntax: + content: 'url: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeRequest.yml new file mode 100644 index 00000000..69f1ff6b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TokenExchangeInvokeRequest +uid: botbuilder.TokenExchangeInvokeRequest +package: botbuilder +summary: A request to exchange a token. +fullName: TokenExchangeInvokeRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: connectionName + uid: botbuilder.TokenExchangeInvokeRequest.connectionName + package: botbuilder + summary: The connection name. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.TokenExchangeInvokeRequest.id + package: botbuilder + summary: The id from the OAuthCard. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: token + uid: botbuilder.TokenExchangeInvokeRequest.token + package: botbuilder + summary: The user token that can be exchanged. + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeResponse.yml new file mode 100644 index 00000000..463c57b5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeInvokeResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: TokenExchangeInvokeResponse +uid: botbuilder.TokenExchangeInvokeResponse +package: botbuilder +summary: The response object of a token exchange invoke. +fullName: TokenExchangeInvokeResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: connectionName + uid: botbuilder.TokenExchangeInvokeResponse.connectionName + package: botbuilder + summary: The connection name. + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: failureDetail + uid: botbuilder.TokenExchangeInvokeResponse.failureDetail + package: botbuilder + summary: The details of why the token exchange failed. + fullName: failureDetail + remarks: '' + isDeprecated: false + syntax: + content: 'failureDetail: string' + return: + description: '' + type: string + - name: id + uid: botbuilder.TokenExchangeInvokeResponse.id + package: botbuilder + summary: The id from the OAuthCard. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.TokenExchangeInvokeResponse.properties + package: botbuilder + summary: Extension data for overflow of properties. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: Record' + return: + description: '' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeRequest.yml new file mode 100644 index 00000000..23f01fcf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TokenExchangeRequest +uid: botbuilder.TokenExchangeRequest +package: botbuilder +summary: '' +fullName: TokenExchangeRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: token + uid: botbuilder.TokenExchangeRequest.token + package: botbuilder + summary: '' + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token?: string' + return: + description: '' + type: string + - name: uri + uid: botbuilder.TokenExchangeRequest.uri + package: botbuilder + summary: '' + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeResource.yml new file mode 100644 index 00000000..584c7af9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeResource.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TokenExchangeResource +uid: botbuilder.TokenExchangeResource +package: botbuilder +summary: '' +fullName: TokenExchangeResource +remarks: '' +isDeprecated: false +type: interface +properties: + - name: id + uid: botbuilder.TokenExchangeResource.id + package: botbuilder + summary: '' + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + - name: providerId + uid: botbuilder.TokenExchangeResource.providerId + package: botbuilder + summary: '' + fullName: providerId + remarks: '' + isDeprecated: false + syntax: + content: 'providerId?: string' + return: + description: '' + type: string + - name: uri + uid: botbuilder.TokenExchangeResource.uri + package: botbuilder + summary: '' + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeState.yml new file mode 100644 index 00000000..0a91f6c3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenExchangeState.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TokenExchangeState +uid: botbuilder.TokenExchangeState +package: botbuilder +summary: State object passed to the bot token service. +fullName: TokenExchangeState +remarks: '' +isDeprecated: false +syntax: | + type TokenExchangeState = { + connectionName: string + conversation: ConversationReference + msAppId: string + relatesTo: ConversationReference + } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPollingSettings.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPollingSettings.yml new file mode 100644 index 00000000..22b17337 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPollingSettings.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: TokenPollingSettings +uid: botbuilder.TokenPollingSettings +package: botbuilder +summary: Provides details for token polling. +fullName: TokenPollingSettings +remarks: '' +isDeprecated: false +type: interface +properties: + - name: interval + uid: botbuilder.TokenPollingSettings.interval + package: botbuilder + summary: Time Interval in milliseconds between token polling requests. + fullName: interval + remarks: '' + isDeprecated: false + syntax: + content: 'interval?: number' + return: + description: '' + type: number + - name: timeout + uid: botbuilder.TokenPollingSettings.timeout + package: botbuilder + summary: >- + Polling timeout time in milliseconds. This is equivalent to login flow + timeout. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPostResource.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPostResource.yml new file mode 100644 index 00000000..503794e8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenPostResource.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TokenPostResource +uid: botbuilder.TokenPostResource +package: botbuilder +summary: '' +fullName: TokenPostResource +remarks: '' +isDeprecated: false +type: interface +properties: + - name: sasUrl + uid: botbuilder.TokenPostResource.sasUrl + package: botbuilder + summary: '' + fullName: sasUrl + remarks: '' + isDeprecated: false + syntax: + content: 'sasUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenRequest.yml new file mode 100644 index 00000000..170c0d2d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TokenRequest +uid: botbuilder.TokenRequest +package: botbuilder +summary: A request to receive a user token +fullName: TokenRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: provider + uid: botbuilder.TokenRequest.provider + package: botbuilder + summary: The provider to request a user token from + fullName: provider + remarks: '' + isDeprecated: false + syntax: + content: 'provider: string' + return: + description: '' + type: string + - name: settings + uid: botbuilder.TokenRequest.settings + package: botbuilder + summary: A collection of settings for the specific provider for this request + fullName: settings + remarks: '' + isDeprecated: false + syntax: + content: 'settings: {[propertyName: string]: any}' + return: + description: '' + type: '{[propertyName: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResolver.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResolver.yml index bc698f64..05b323ff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResolver.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResolver.yml @@ -5,16 +5,14 @@ package: botbuilder summary: Looks for OAuthCards in Activity attachments and takes action on them fullName: TokenResolver remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'checkForOAuthCards(BotFrameworkAdapter, TurnContext, Activity, string[])' + - name: checkForOAuthCards(BotFrameworkAdapter, TurnContext, Activity, string[]) uid: botbuilder.TokenResolver.checkForOAuthCards package: botbuilder summary: Checks if we have token responses from OAuth cards. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -23,14 +21,13 @@ methods: parameters: - id: adapter type: - description: 'The [BotFrameworkAdapter](xref:botbuilder.BotFrameworkAdapter).' + description: The [BotFrameworkAdapter](xref:botbuilder.BotFrameworkAdapter). - id: context - type: TurnContext - description: 'The [TurnContext](xref:botbuilder-core.TurnContext) for this turn.' + type: + description: The [TurnContext](xref:botbuilder-core.TurnContext) for this turn. - id: activity - type: Activity - description: 'The [Activity](xref:botframework-schema.Activity) to be checked.' + type: + description: The [Activity](xref:botframework-schema.Activity) to be checked. - id: log - type: 'string[]' - description: | - Optional. The log to write on. + type: string[] + description: Optional. The log to write on. diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResponse.yml new file mode 100644 index 00000000..8b1ca343 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenResponse.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: TokenResponse +uid: botbuilder.TokenResponse +package: botbuilder +summary: A response that includes a user token +fullName: TokenResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: botbuilder.TokenResponse.channelId + package: botbuilder + summary: '' + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string + - name: connectionName + uid: botbuilder.TokenResponse.connectionName + package: botbuilder + summary: The connection name + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName: string' + return: + description: '' + type: string + - name: expiration + uid: botbuilder.TokenResponse.expiration + package: botbuilder + summary: Expiration for the token, in ISO 8601 format (e.g. "2007-04-05T14:30Z") + fullName: expiration + remarks: '' + isDeprecated: false + syntax: + content: 'expiration: string' + return: + description: '' + type: string + - name: properties + uid: botbuilder.TokenResponse.properties + package: botbuilder + summary: >- + A collection of properties about this response, such as token polling + parameters + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: {[propertyName: string]: any}' + return: + description: '' + type: '{[propertyName: string]: any}' + - name: token + uid: botbuilder.TokenResponse.token + package: botbuilder + summary: The user token + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenStatus.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenStatus.yml new file mode 100644 index 00000000..cf22efdb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TokenStatus.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TokenStatus +uid: botbuilder.TokenStatus +package: botbuilder +summary: The status of a particular token. +fullName: TokenStatus +remarks: '' +isDeprecated: false +syntax: | + type TokenStatus = { + channelId: string + connectionName: string + hasToken: boolean + serviceProviderDisplayName: string + } diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Transcript.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Transcript.yml new file mode 100644 index 00000000..3371f5a5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Transcript.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: Transcript +uid: botbuilder.Transcript +package: botbuilder +summary: Transcript +fullName: Transcript +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activities + uid: botbuilder.Transcript.activities + package: botbuilder + summary: A collection of Activities that conforms to the Transcript schema. + fullName: activities + remarks: '' + isDeprecated: false + syntax: + content: 'activities: Activity[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptInfo.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptInfo.yml new file mode 100644 index 00000000..c9bebf0c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptInfo.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: TranscriptInfo +uid: botbuilder.TranscriptInfo +package: botbuilder +summary: Metadata for a stored transcript. +fullName: TranscriptInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: botbuilder.TranscriptInfo.channelId + package: botbuilder + summary: ChannelId that the transcript was taken from. + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId: string' + return: + description: '' + type: string + - name: created + uid: botbuilder.TranscriptInfo.created + package: botbuilder + summary: Date conversation was started. + fullName: created + remarks: '' + isDeprecated: false + syntax: + content: 'created: Date' + return: + description: '' + type: Date + - name: id + uid: botbuilder.TranscriptInfo.id + package: botbuilder + summary: Conversation Id. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLogger.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLogger.yml new file mode 100644 index 00000000..520e295f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLogger.yml @@ -0,0 +1,25 @@ +### YamlMime:TSType +name: TranscriptLogger +uid: botbuilder.TranscriptLogger +package: botbuilder +summary: Transcript logger stores activities for conversations for recall. +fullName: TranscriptLogger +remarks: '' +isDeprecated: false +type: interface +methods: + - name: logActivity(Activity) + uid: botbuilder.TranscriptLogger.logActivity + package: botbuilder + summary: Log an activity to the transcript. + remarks: '' + isDeprecated: false + syntax: + content: 'function logActivity(activity: Activity): void | Promise' + parameters: + - id: activity + type: + description: Activity being logged. + return: + description: '' + type: void | Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLoggerMiddleware.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLoggerMiddleware.yml new file mode 100644 index 00000000..2d704c51 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptLoggerMiddleware.yml @@ -0,0 +1,45 @@ +### YamlMime:TSType +name: TranscriptLoggerMiddleware +uid: botbuilder.TranscriptLoggerMiddleware +package: botbuilder +summary: Logs incoming and outgoing activities to a TranscriptStore. +fullName: TranscriptLoggerMiddleware +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TranscriptLoggerMiddleware(TranscriptLogger) + uid: botbuilder.TranscriptLoggerMiddleware.constructor + package: botbuilder + summary: >- + Middleware for logging incoming and outgoing activities to a transcript + store. + remarks: '' + isDeprecated: false + syntax: + content: 'new TranscriptLoggerMiddleware(logger: TranscriptLogger)' + parameters: + - id: logger + type: + description: Transcript logger +methods: + - name: onTurn(TurnContext, () => Promise) + uid: botbuilder.TranscriptLoggerMiddleware.onTurn + package: botbuilder + summary: Initialization for middleware turn. + remarks: '' + isDeprecated: false + syntax: + content: >- + function onTurn(context: TurnContext, next: () => Promise): + Promise + parameters: + - id: context + type: + description: Context for the current turn of conversation with the user. + - id: next + type: () => Promise<void> + description: Function to call at the end of the middleware chain. + return: + description: '' + type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptStore.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptStore.yml new file mode 100644 index 00000000..18071997 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TranscriptStore.yml @@ -0,0 +1,101 @@ +### YamlMime:TSType +name: TranscriptStore +uid: botbuilder.TranscriptStore +package: botbuilder +summary: Transcript logger stores activities for conversations for recall. +fullName: TranscriptStore +remarks: '' +isDeprecated: false +type: interface +inheritedMethods: + - name: logActivity(Activity) + uid: botbuilder.TranscriptStore.logActivity + package: botbuilder + summary: Log an activity to the transcript. + remarks: '' + isDeprecated: false + syntax: + content: 'function logActivity(activity: Activity): void | Promise' + parameters: + - id: activity + type: + description: Activity being logged. + return: + description: '' + type: void | Promise<void> + inheritanceDescription: >- + Inherited From + [TranscriptLogger.logActivity](xref:botbuilder.TranscriptLogger.logActivity) +methods: + - name: deleteTranscript(string, string) + uid: botbuilder.TranscriptStore.deleteTranscript + package: botbuilder + summary: Delete a specific conversation and all of its activities. + remarks: '' + isDeprecated: false + syntax: + content: >- + function deleteTranscript(channelId: string, conversationId: string): + Promise + parameters: + - id: channelId + type: string + description: Channel Id where conversation took place. + - id: conversationId + type: string + description: Id of the conversation to delete. + return: + description: '' + type: Promise<void> + - name: getTranscriptActivities(string, string, string, Date) + uid: botbuilder.TranscriptStore.getTranscriptActivities + package: botbuilder + summary: Get activities for a conversation (Aka the transcript) + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTranscriptActivities(channelId: string, conversationId: + string, continuationToken?: string, startDate?: Date): + Promise> + parameters: + - id: channelId + type: string + description: Channel Id. + - id: conversationId + type: string + description: Conversation Id. + - id: continuationToken + type: string + description: Continuation token to page through results. + - id: startDate + type: Date + description: Earliest time to include. + return: + description: '' + type: >- + Promise<<>> + - name: listTranscripts(string, string) + uid: botbuilder.TranscriptStore.listTranscripts + package: botbuilder + summary: List conversations in the channelId. + remarks: '' + isDeprecated: false + syntax: + content: >- + function listTranscripts(channelId: string, continuationToken?: string): + Promise> + parameters: + - id: channelId + type: string + description: Channel Id. + - id: continuationToken + type: string + description: Continuation token to page through results. + return: + description: '' + type: >- + Promise<<>> +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContext.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContext.yml new file mode 100644 index 00000000..14b3d3f0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContext.yml @@ -0,0 +1,795 @@ +### YamlMime:TSType +name: TurnContext +uid: botbuilder.TurnContext +package: botbuilder +summary: Provides context for a turn of a bot. +fullName: TurnContext +remarks: >- + Context provides information needed to process an incoming activity. The + context object is + + created by a [BotAdapter](xref:botbuilder-core.BotAdapter) and persists for + the length of the turn. +isDeprecated: false +type: class +constructors: + - name: TurnContext(BotAdapter, Partial) + uid: botbuilder.TurnContext.constructor + package: botbuilder + summary: >- + Creates an new instance of the + [TurnContext](xref:xref:botbuilder-core.TurnContext) class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new TurnContext(adapterOrContext: BotAdapter, request: + Partial) + parameters: + - id: adapterOrContext + type: + description: The adapter creating the context. + - id: request + type: Partial<> + description: The incoming activity for the turn. + - name: TurnContext(TurnContext) + uid: botbuilder.TurnContext.constructor_1 + package: botbuilder + summary: >- + Creates an new instance of the + [TurnContext](xref:xref:botbuilder-core.TurnContext) class. + remarks: '' + isDeprecated: false + syntax: + content: 'new TurnContext(adapterOrContext: TurnContext)' + parameters: + - id: adapterOrContext + type: + description: The context object to clone. +properties: + - name: activity + uid: botbuilder.TurnContext.activity + package: botbuilder + summary: Gets the activity associated with this turn. + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: Activity activity + return: + description: The activity associated with this turn. + type: + - name: adapter + uid: botbuilder.TurnContext.adapter + package: botbuilder + summary: Gets the bot adapter that created this context object. + fullName: adapter + remarks: '' + isDeprecated: false + syntax: + content: BotAdapter adapter + return: + description: The bot adapter that created this context object. + type: + - name: bufferedReplyActivities + uid: botbuilder.TurnContext.bufferedReplyActivities + package: botbuilder + summary: >- + List of activities to send when `context.activity.deliveryMode == + 'expectReplies'`. + fullName: bufferedReplyActivities + remarks: '' + isDeprecated: false + syntax: + content: 'bufferedReplyActivities: Partial[]' + return: + description: '' + type: Partial<>[] + - name: locale + uid: botbuilder.TurnContext.locale + package: botbuilder + summary: Gets the locale stored in the turnState. + fullName: locale + remarks: '' + isDeprecated: false + syntax: + content: undefined | string locale + return: + description: The locale stored in the turnState. + type: undefined | string + - name: responded + uid: botbuilder.TurnContext.responded + package: botbuilder + summary: Indicates whether the bot has replied to the user this turn. + fullName: responded + remarks: '' + isDeprecated: false + syntax: + content: boolean responded + return: + description: >- + True if at least one response was sent for the current turn; + otherwise, false. + type: boolean + - name: turnState + uid: botbuilder.TurnContext.turnState + package: botbuilder + summary: Gets the services registered on this context object. + fullName: turnState + remarks: '' + isDeprecated: false + syntax: + content: TurnContextStateCollection turnState + return: + description: The services registered on this context object. + type: +methods: + - name: >- + applyConversationReference(Partial, + Partial, boolean) + uid: botbuilder.TurnContext.applyConversationReference + package: botbuilder + summary: >- + Updates an activity with the delivery information from an existing + conversation reference. + remarks: >- + Call the + [getConversationReference](xref:botbuilder-core.TurnContext.getConversationReference) + + method on an incoming activity to get a conversation reference that you + can then use + + to update an outgoing activity with the correct delivery information. + isDeprecated: false + syntax: + content: >- + static function applyConversationReference(activity: Partial, + reference: Partial, isIncoming?: boolean): + Partial + parameters: + - id: activity + type: Partial<> + description: The activity to update. + - id: reference + type: Partial<> + description: The conversation reference to copy delivery information from. + - id: isIncoming + type: boolean + description: >- + Optional. `true` to treat the activity as an incoming activity, + where the + bot is the recipient; otherwise, `false`. Default is `false`, and the activity will show + the bot as the sender. + return: + description: This activity, updated with the delivery information. + type: Partial<> + - name: deleteActivity(string | Partial) + uid: botbuilder.TurnContext.deleteActivity + package: botbuilder + summary: Asynchronously deletes a previously sent activity. + remarks: >- + If an ID is specified, the conversation reference for the current request + is used + + to get the rest of the information needed. + + + For example: + + ```JavaScript + + const matched = /approve (.*)/i.exec(context.activity.text); + + if (matched) { + const savedId = await approveExpenseReport(matched[1]); + await context.deleteActivity(savedId); + } + + ``` + + + **See also** + + + - [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) + + - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + + - + [getReplyConversationReference](xref:botbuilder-core.TurnContext.getReplyConversationReference) + isDeprecated: false + syntax: + content: >- + function deleteActivity(idOrReference: string | + Partial): Promise + parameters: + - id: idOrReference + type: >- + string | Partial<> + description: ID or conversation reference for the activity to delete. + return: + description: A promise representing the async operation. + type: Promise<void> + - name: getConversationReference(Partial) + uid: botbuilder.TurnContext.getConversationReference + package: botbuilder + summary: Copies conversation reference information from an activity. + remarks: >- + You can save the conversation reference as a JSON object and use it later + to proactively message the user. + + + For example: + + ```JavaScript + + const reference = TurnContext.getConversationReference(context.request); + + ``` + + + **See also** + + + - + [BotAdapter.continueConversation](xref:botbuilder-core.BotAdapter.continueConversation) + isDeprecated: false + syntax: + content: >- + static function getConversationReference(activity: Partial): + Partial + parameters: + - id: activity + type: Partial<> + description: The activity to get the information from. + return: + description: >- + A conversation reference for the conversation that contains this + activity. + type: Partial<> + - name: getMentions(Partial) + uid: botbuilder.TurnContext.getMentions + package: botbuilder + summary: Gets all at-mention entities included in an activity. + remarks: >- + The activity's [entities](xref:botframework-schema.Activity.entities) + property contains a flat + + list of metadata objects pertaining to this activity and can contain + + [mention](xref:botframework-schema.Mention) entities. This method returns + all such entities + + for a given activity. + + + For example: + + ```JavaScript + + const mentions = TurnContext.getMentions(turnContext.request); + + ``` + isDeprecated: false + syntax: + content: 'static function getMentions(activity: Partial): Mention[]' + parameters: + - id: activity + type: Partial<> + description: The activity. + return: + description: All the at-mention entities included in an activity. + type: [] + - name: getReplyConversationReference(Partial, ResourceResponse) + uid: botbuilder.TurnContext.getReplyConversationReference + package: botbuilder + summary: >- + Copies conversation reference information from a resource response for a + sent activity. + remarks: >- + You can save the conversation reference as a JSON object and use it later + to update or delete the message. + + + For example: + + ```javascript + + var reply = await context.sendActivity('Hi'); + + var reference = + TurnContext.getReplyConversationReference(context.activity, reply); + + ``` + + + **See also** + + + - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + + - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + isDeprecated: false + syntax: + content: >- + static function getReplyConversationReference(activity: + Partial, reply: ResourceResponse): + Partial + parameters: + - id: activity + type: Partial<> + description: The sent activity. + - id: reply + type: + description: |- + The resource response for the activity, returned by the + [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or + [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) method. + return: + description: >- + A ConversationReference that can be stored and used later to delete or + update the activity. + type: Partial<> + - name: onDeleteActivity(DeleteActivityHandler) + uid: botbuilder.TurnContext.onDeleteActivity + package: botbuilder + summary: Adds a response handler for delete activity operations. + remarks: >- + This method returns a reference to the turn context object. + + + When the [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + method is called, + + the registered handlers are called in the order in which they were added + to the context object + + before the activity is deleted. + + + This example shows how to listen for and log activity deletions. + + + ```JavaScript + + context.onDeleteActivity(async (ctx, reference, next) => { + // Delete activity + await next(); + + // Log delete + logDelete(activity); + }); + + ``` + isDeprecated: false + syntax: + content: 'function onDeleteActivity(handler: DeleteActivityHandler): TurnContext' + parameters: + - id: handler + type: + description: The handler to add to the context object. + return: + description: The updated context object. + type: + - name: onSendActivities(SendActivitiesHandler) + uid: botbuilder.TurnContext.onSendActivities + package: botbuilder + summary: Adds a response handler for send activity operations. + remarks: >- + This method returns a reference to the turn context object. + + + When the [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) or + + [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) method + is called, + + the registered handlers are called in the order in which they were added + to the context object + + before the activities are sent. + + + This example shows how to listen for and log outgoing `message` + activities. + + + ```JavaScript + + context.onSendActivities(async (ctx, activities, next) => { + // Log activities before sending them. + activities.filter(a => a.type === 'message').forEach(a => logSend(a)); + + // Allow the send process to continue. + next(); + }); + + ``` + isDeprecated: false + syntax: + content: 'function onSendActivities(handler: SendActivitiesHandler): TurnContext' + parameters: + - id: handler + type: + description: The handler to add to the context object. + return: + description: The updated context object. + type: + - name: onUpdateActivity(UpdateActivityHandler) + uid: botbuilder.TurnContext.onUpdateActivity + package: botbuilder + summary: Adds a response handler for update activity operations. + remarks: >- + This method returns a reference to the turn context object. + + + When the [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + method is called, + + the registered handlers are called in the order in which they were added + to the context object + + before the activity is updated. + + + This example shows how to listen for and log activity updates. + + + ```JavaScript + + context.onUpdateActivity(async (ctx, activity, next) => { + // Replace activity + await next(); + + // Log update + logUpdate(activity); + }); + + ``` + isDeprecated: false + syntax: + content: 'function onUpdateActivity(handler: UpdateActivityHandler): TurnContext' + parameters: + - id: handler + type: + description: The handler to add to the context object. + return: + description: The updated context object. + type: + - name: removeMentionText(Partial, string) + uid: botbuilder.TurnContext.removeMentionText + package: botbuilder + summary: >- + Removes at mentions for a given ID from the text of an activity and + returns the updated text. + + Use with caution; this function alters the activity's + [text](xref:botframework-schema.Activity.text) property. + remarks: >- + Some channels, for example Microsoft Teams, add at mentions to the text of + a message activity. + + + Use this helper method to modify the activity's + [text](xref:botframework-schema.Activity.text) property. + + It removes all at mentions for the given bot or user ID and then returns + the updated property value. + + + For example, when you remove mentions of **echoBot** from an activity + containing the text "@echoBot Hi Bot", + + the activity text is updated, and the method returns "Hi Bot". + + + The format of a mention [entity](xref:botframework-schema.Entity) is + channel-dependent. + + However, the mention's [text](xref:botframework-schema.Mention.text) + property should contain + + the exact text for the user as it appears in the activity text. + + + For example, whether the channel uses "username" or "@username", + this string is in + + the activity's text, and this method will remove all occurrences of that + string from the text. + + + For example: + + ```JavaScript + + const updatedText = TurnContext.removeMentionText(activity, + activity.recipient.id); + + ``` + + **See also** + + - + [removeRecipientMention](xref:botbuilder-core.TurnContext.removeRecipientMention) + isDeprecated: false + syntax: + content: >- + static function removeMentionText(activity: Partial, id: + string): string + parameters: + - id: activity + type: Partial<> + description: The activity to remove at mentions from. + - id: id + type: string + description: The ID of the user or bot to remove at mentions for. + return: + description: The updated activity's text. + type: string + - name: removeRecipientMention(Partial) + uid: botbuilder.TurnContext.removeRecipientMention + package: botbuilder + summary: >- + Removes at mentions for the activity's + [recipient](xref:botframework-schema.Activity.recipient) + + from the text of an activity and returns the updated text. + + Use with caution; this function alters the activity's + [text](xref:botframework-schema.Activity.text) property. + remarks: >- + Some channels, for example Microsoft Teams, add at-mention details to the + text of a message activity. + + + Use this helper method to modify the activity's + [text](xref:botframework-schema.Activity.text) property. + + It removes all at mentions of the activity's + [recipient](xref:botframework-schema.Activity.recipient) + + and then returns the updated property value. + + + For example: + + ```JavaScript + + const updatedText = + TurnContext.removeRecipientMention(turnContext.request); + + ``` + + **See also** + + - [removeMentionText](xref:botbuilder-core.TurnContext.removeMentionText) + isDeprecated: false + syntax: + content: >- + static function removeRecipientMention(activity: Partial): + string + parameters: + - id: activity + type: Partial<> + description: The activity to remove at mentions from. + return: + description: The updated activity's text. + type: string + - name: sendActivities(Partial[]) + uid: botbuilder.TurnContext.sendActivities + package: botbuilder + summary: >- + Asynchronously sends a set of activities to the sender of the incoming + activity. + remarks: >- + If the activities are successfully sent, results in an array of + + [ResourceResponse](xref:botframework-schema.ResourceResponse) objects + containing the IDs that + + the receiving channel assigned to the activities. + + + Before they are sent, the delivery information of each outbound activity + is updated based on the + + delivery information of the inbound inbound activity. + + + For example: + + ```JavaScript + + await context.sendActivities([ + { type: 'typing' }, + { type: 'delay', value: 2000 }, + { type: 'message', text: 'Hello... How are you?' } + ]); + + ``` + + + **See also** + + + - [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) + + - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + + - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + isDeprecated: false + syntax: + content: >- + function sendActivities(activities: Partial[]): + Promise + parameters: + - id: activities + type: Partial<>[] + description: The activities to send. + return: + description: A promise with a ResourceResponse. + type: Promise<[]> + - name: sendActivity(string | Partial, string, string) + uid: botbuilder.TurnContext.sendActivity + package: botbuilder + summary: Asynchronously sends an activity to the sender of the incoming activity. + remarks: >- + If the activity is successfully sent, results in a + + [ResourceResponse](xref:botframework-schema.ResourceResponse) object + containing the ID that the + + receiving channel assigned to the activity. + + + See the channel's documentation for limits imposed upon the contents of + the **activityOrText** parameter. + + + To control various characteristics of your bot's speech such as voice, + rate, volume, pronunciation, + + and pitch, specify **speak** in Speech Synthesis Markup Language (SSML) + format. + + + For example: + + ```JavaScript + + await context.sendActivity(`Hello World`); + + ``` + + + **See also** + + + - [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) + + - [updateActivity](xref:botbuilder-core.TurnContext.updateActivity) + + - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + isDeprecated: false + syntax: + content: >- + function sendActivity(activityOrText: string | Partial, + speak?: string, inputHint?: string): Promise + parameters: + - id: activityOrText + type: string | Partial<> + description: The activity or text to send. + - id: speak + type: string + description: >- + Optional. The text to be spoken by your bot on a speech-enabled + channel. + - id: inputHint + type: string + description: >- + Optional. Indicates whether your bot is accepting, expecting, or + ignoring user + input after the message is delivered to the client. One of: 'acceptingInput', 'ignoringInput', + or 'expectingInput'. Default is 'acceptingInput'. + return: + description: A promise with a ResourceResponse. + type: Promise<undefined | > + - name: sendTraceActivity(string, any, string, string) + uid: botbuilder.TurnContext.sendTraceActivity + package: botbuilder + summary: Asynchronously sends an activity to the sender of the incoming activity. + remarks: >- + Creates and sends a Trace activity. Trace activities are only sent when + the channel is the emulator. + + + For example: + + ```JavaScript + + await context.sendTraceActivity(`The following exception was thrown + ${msg}`); + + ``` + + + **See also** + + + - [sendActivities](xref:botbuilder-core.TurnContext.sendActivities) + isDeprecated: false + syntax: + content: >- + function sendTraceActivity(name: string, value?: any, valueType?: + string, label?: string): Promise + parameters: + - id: name + type: string + description: The activity or text to send. + - id: value + type: any + description: >- + Optional. The text to be spoken by your bot on a speech-enabled + channel. + - id: valueType + type: string + description: >- + Optional. Indicates whether your bot is accepting, expecting, or + ignoring user + - id: label + type: string + description: >- + Optional. Indicates whether your bot is accepting, expecting, or + ignoring user + return: + description: A promise with a ResourceResponse. + type: Promise<undefined | > + - name: updateActivity(Partial) + uid: botbuilder.TurnContext.updateActivity + package: botbuilder + summary: Asynchronously updates a previously sent activity. + remarks: >- + The [id](xref:botframework-schema.Activity.id) of the replacement activity + indicates the activity + + in the conversation to replace. + + + For example: + + ```JavaScript + + const matched = /approve (.*)/i.exec(context.activity.text); + + if (matched) { + const update = await approveExpenseReport(matched[1]); + await context.updateActivity(update); + } + + ``` + + + **See also** + + + - [sendActivity](xref:botbuilder-core.TurnContext.sendActivity) + + - [deleteActivity](xref:botbuilder-core.TurnContext.deleteActivity) + + - + [getReplyConversationReference](xref:botbuilder-core.TurnContext.getReplyConversationReference) + isDeprecated: false + syntax: + content: >- + function updateActivity(activity: Partial): Promise + parameters: + - id: activity + type: Partial<> + description: The replacement for the original activity. + return: + description: A promise with a ResourceResponse. + type: Promise<void | > diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContextStateCollection.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContextStateCollection.yml new file mode 100644 index 00000000..9909a47d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/TurnContextStateCollection.yml @@ -0,0 +1,291 @@ +### YamlMime:TSType +name: TurnContextStateCollection +uid: botbuilder.TurnContextStateCollection +package: botbuilder +summary: >- + Values persisted for the lifetime of the turn as part of the + [TurnContext](xref:botbuilder-core.TurnContext). +fullName: TurnContextStateCollection +remarks: >- + Typical values stored here are objects which are needed for the lifetime of a + turn, such + + as [Storage](xref:botbuilder-core.Storage), + [BotState](xref:botbuilder-core.BotState), + [ConversationState](xref:botbuilder-core.ConversationState), + [LanguageGenerator](xref:botbuilder-dialogs-adaptive.LanguageGenerator), + [ResourceExplorer](xref:botbuilder-dialogs-declarative.ResourceExplorer), etc. +isDeprecated: false +type: class +constructors: + - name: TurnContextStateCollection(null | (readonly (readonly [any, any])[])) + uid: botbuilder.TurnContextStateCollection.constructor + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TurnContextStateCollection(entries?: null | (readonly (readonly + [any, any])[])) + parameters: + - id: entries + type: null | (readonly (readonly [any, any])[]) + description: '' + - name: TurnContextStateCollection(null | Iterable) + uid: botbuilder.TurnContextStateCollection.constructor_1 + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TurnContextStateCollection(iterable?: null | Iterable) + parameters: + - id: iterable + type: null | Iterable<readonly [any, any]> + description: '' +inheritedProperties: + - name: size + uid: botbuilder.TurnContextStateCollection.size + package: botbuilder + summary: '' + fullName: size + remarks: '' + isDeprecated: false + syntax: + content: 'size: number' + return: + description: the number of elements in the Map. + type: number + inheritanceDescription: Inherited From Map.size + - name: '[species]' + uid: botbuilder.TurnContextStateCollection.[species] + package: botbuilder + summary: '' + fullName: '[species]' + remarks: '' + isDeprecated: false + syntax: + content: 'static [species]: MapConstructor' + return: + description: '' + type: MapConstructor + inheritanceDescription: Inherited From Map.__@species@2480 + - name: '[toStringTag]' + uid: botbuilder.TurnContextStateCollection.[toStringTag] + package: botbuilder + summary: '' + fullName: '[toStringTag]' + remarks: '' + isDeprecated: false + syntax: + content: '[toStringTag]: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Map.__@toStringTag@1194 +inheritedMethods: + - name: clear() + uid: botbuilder.TurnContextStateCollection.clear + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function clear() + inheritanceDescription: Inherited From Map.clear + - name: delete(any) + uid: botbuilder.TurnContextStateCollection.delete + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function delete(key: any): boolean' + parameters: + - id: key + type: any + description: '' + return: + description: >- + true if an element in the Map existed and has been removed, or false + if the element does not exist. + type: boolean + inheritanceDescription: Inherited From Map.delete + - name: entries() + uid: botbuilder.TurnContextStateCollection.entries + package: botbuilder + summary: Returns an iterable of key, value pairs for every entry in the map. + remarks: '' + isDeprecated: false + syntax: + content: 'function entries(): IterableIterator<[any, any]>' + return: + description: '' + type: IterableIterator<[any, any]> + inheritanceDescription: Inherited From Map.entries + - name: 'forEach((value: any, key: any, map: Map) => void, any)' + uid: botbuilder.TurnContextStateCollection.forEach + package: botbuilder + summary: >- + Executes a provided function once per each key/value pair in the Map, in + insertion order. + remarks: '' + isDeprecated: false + syntax: + content: >- + function forEach(callbackfn: (value: any, key: any, map: Map) + => void, thisArg?: any) + parameters: + - id: callbackfn + type: '(value: any, key: any, map: Map<any, any>) => void' + description: '' + - id: thisArg + type: any + description: '' + inheritanceDescription: Inherited From Map.forEach + - name: has(any) + uid: botbuilder.TurnContextStateCollection.has + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function has(key: any): boolean' + parameters: + - id: key + type: any + description: '' + return: + description: >- + boolean indicating whether an element with the specified key exists or + not. + type: boolean + inheritanceDescription: Inherited From Map.has + - name: keys() + uid: botbuilder.TurnContextStateCollection.keys + package: botbuilder + summary: Returns an iterable of keys in the map + remarks: '' + isDeprecated: false + syntax: + content: 'function keys(): IterableIterator' + return: + description: '' + type: IterableIterator<any> + inheritanceDescription: Inherited From Map.keys + - name: set(any, any) + uid: botbuilder.TurnContextStateCollection.set + package: botbuilder + summary: >- + Adds a new element with a specified key and value to the Map. If an + element with the same key already exists, the element will be updated. + remarks: '' + isDeprecated: false + syntax: + content: 'function set(key: any, value: any): TurnContextStateCollection' + parameters: + - id: key + type: any + description: '' + - id: value + type: any + description: '' + return: + description: '' + type: + inheritanceDescription: Inherited From Map.set + - name: values() + uid: botbuilder.TurnContextStateCollection.values + package: botbuilder + summary: Returns an iterable of values in the map + remarks: '' + isDeprecated: false + syntax: + content: 'function values(): IterableIterator' + return: + description: '' + type: IterableIterator<any> + inheritanceDescription: Inherited From Map.values + - name: '[iterator]()' + uid: botbuilder.TurnContextStateCollection.[iterator] + package: botbuilder + summary: Returns an iterable of entries in the map. + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator<[any, any]>' + return: + description: '' + type: IterableIterator<[any, any]> + inheritanceDescription: Inherited From Map.__@iterator@1513 +methods: + - name: get(any) + uid: botbuilder.TurnContextStateCollection.get_1 + package: botbuilder + summary: >- + Gets a value from the + [TurnContextStateCollection](xref:botbuilder-core.TurnContextStateCollection). + remarks: '' + isDeprecated: false + syntax: + content: 'function get(key: any): any' + parameters: + - id: key + type: any + description: The values key. + return: + description: '' + type: any + - name: get(any) + uid: botbuilder.TurnContextStateCollection.get + package: botbuilder + summary: >- + Gets a typed value from the + [TurnContextStateCollection](xref:botbuilder-core.TurnContextStateCollection). + remarks: '' + isDeprecated: false + syntax: + content: 'function get(key: any): T' + parameters: + - id: key + type: any + description: The values key. + return: + description: '' + type: T + - name: pop(any) + uid: botbuilder.TurnContextStateCollection.pop + package: botbuilder + summary: Restores a keys previous value, and returns the value that was removed. + remarks: '' + isDeprecated: false + syntax: + content: 'function pop(key: any): any' + parameters: + - id: key + type: any + description: The values key. + return: + description: The removed value. + type: any + - name: push(any, any) + uid: botbuilder.TurnContextStateCollection.push + package: botbuilder + summary: Push a value by key to the turn's context. + remarks: >- + The keys current value (if any) will be saved and can be restored by + calling [pop()](#pop). + isDeprecated: false + syntax: + content: 'function push(key: any, value: any)' + parameters: + - id: key + type: any + description: The values key. + - id: value + type: any + description: The new value. +extends: Map<any, any> diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Type.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type.yml new file mode 100644 index 00000000..45df4f79 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: Type +uid: botbuilder.Type +package: botbuilder +summary: |- + Defines values for Type. + Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' +fullName: Type +remarks: '' +isDeprecated: false +syntax: | + type Type = "ViewAction" | "OpenUri" | "HttpPOST" | "ActionCard" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Type1.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type1.yml new file mode 100644 index 00000000..8a70f2be --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type1.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Type1 +uid: botbuilder.Type1 +package: botbuilder +summary: '' +fullName: Type1 +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use O365ConnectorCardInputBaseType instead. +syntax: | + type Type1 = O365ConnectorCardInputBaseType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Type2.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type2.yml new file mode 100644 index 00000000..de455917 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type2.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Type2 +uid: botbuilder.Type2 +package: botbuilder +summary: '' +fullName: Type2 +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use BotMessagePreviewType +syntax: | + type Type2 = BotMessagePreviewType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/Type3.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type3.yml new file mode 100644 index 00000000..75a0bb9c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/Type3.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: Type3 +uid: botbuilder.Type3 +package: botbuilder +summary: '' +fullName: Type3 +remarks: '' +isDeprecated: true +customDeprecatedMessage: Use MessagingExtensionResultType instead +syntax: | + type Type3 = MessagingExtensionResultType diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/UpdateActivityHandler.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/UpdateActivityHandler.yml new file mode 100644 index 00000000..78fcf572 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/UpdateActivityHandler.yml @@ -0,0 +1,57 @@ +### YamlMime:TSTypeAlias +name: UpdateActivityHandler +uid: botbuilder.UpdateActivityHandler +package: botbuilder +summary: A handler that can participate in update activity events for the current turn. +fullName: UpdateActivityHandler +remarks: >- + **Parameters** + + + | Name | Type | Description | + + | :--- | :--- | :--- | + + | `context` | [TurnContext](xref:botbuilder-core.TurnContext) | The context + object for the turn. | + + | `activities` | Partial\<[Activity](xref:botframework-schema.Activity)> | The + replacement activity. | + + | `next` | () => Promise\ | The function to call to continue event + processing. | + + + A handler calls the `next` function to pass control to the next registered + handler. + + If a handler doesn’t call the `next` function, the adapter does not call any + of the + + subsequent handlers and does not attempt to update the activity. + + + The `activity` parameter's [id](xref:botframework-schema.Activity.id) property + indicates which activity + + in the conversation to replace. + + + **See also** + + + - [BotAdapter](xref:botbuilder-core.BotAdapter) + + - [SendActivitiesHandler](xref:botbuilder-core.SendActivitiesHandler) + + - [DeleteActivityHandler](xref:botbuilder-core.DeleteActivityHandler) + + - + [TurnContext.onUpdateActivity](xref:botbuilder-core.TurnContext.onUpdateActivity) +isDeprecated: false +syntax: | + type UpdateActivityHandler = ( + context: TurnContext, + activity: Partial, + next: () => Promise + ) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/UserIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/UserIdentityType.yml new file mode 100644 index 00000000..c85141c5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/UserIdentityType.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: UserIdentityType +uid: botbuilder.UserIdentityType +package: botbuilder +summary: >- + Defines values for UserIdentityType. + + Possible values include: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', + 'federatedUser' +fullName: UserIdentityType +remarks: '' +isDeprecated: false +syntax: | + type UserIdentityType = + | "aadUser" + | "onPremiseAadUser" + | "anonymousGuest" + | "federatedUser" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/UserMeetingDetails.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/UserMeetingDetails.yml new file mode 100644 index 00000000..0659c1a2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/UserMeetingDetails.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: UserMeetingDetails +uid: botbuilder.UserMeetingDetails +package: botbuilder +summary: '' +fullName: UserMeetingDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: inMeeting + uid: botbuilder.UserMeetingDetails.inMeeting + package: botbuilder + summary: The user in meeting indicator. + fullName: inMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'inMeeting: boolean' + return: + description: '' + type: boolean + - name: role + uid: botbuilder.UserMeetingDetails.role + package: botbuilder + summary: The user's role. + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/UserState.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/UserState.yml new file mode 100644 index 00000000..9f64a13e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/UserState.yml @@ -0,0 +1,238 @@ +### YamlMime:TSType +name: UserState +uid: botbuilder.UserState +package: botbuilder +summary: Reads and writes user state for your bot to storage. +fullName: UserState +remarks: >- + Each user your bot communicates with will have its own isolated storage object + that can be used + + to persist information about the user across all of the conversation you have + with that user. + + + ```JavaScript + + const { UserState, MemoryStorage } = require('botbuilder'); + + + const userState = new UserState(new MemoryStorage()); + + ``` +isDeprecated: false +type: class +constructors: + - name: UserState(Storage, string) + uid: botbuilder.UserState.constructor + package: botbuilder + summary: Creates a new UserState instance. + remarks: '' + isDeprecated: false + syntax: + content: 'new UserState(storage: Storage, namespace?: string)' + parameters: + - id: storage + type: + description: Storage provider to persist user state to. + - id: namespace + type: string + description: >- + (Optional) namespace to append to storage keys. Defaults to an empty + string. +inheritedMethods: + - name: clear(TurnContext) + uid: botbuilder.UserState.clear + package: botbuilder + summary: Clears the current state object for a turn. + remarks: >- + The cleared state object will not be persisted until + [saveChanges()](#savechanges) has + + been called. + + + ```JavaScript + + await botState.clear(context); + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: 'function clear(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: Inherited From [BotState.clear](xref:botbuilder.BotState.clear) + - name: createProperty(string) + uid: botbuilder.UserState.createProperty + package: botbuilder + summary: >- + Creates a new property accessor for reading and writing an individual + property to the bot + + states storage object. + remarks: '' + isDeprecated: false + syntax: + content: 'function createProperty(name: string): StatePropertyAccessor' + parameters: + - id: name + type: string + description: Name of the property to add. + return: + description: An accessor for the property. + type: <T> + inheritanceDescription: >- + Inherited From + [BotState.createProperty](xref:botbuilder.BotState.createProperty) + - name: delete(TurnContext) + uid: botbuilder.UserState.delete + package: botbuilder + summary: Delete the backing state object for the current turn. + remarks: >- + The state object will be removed from storage if it exists. If the state + object has been + + read in and cached, the cache will be cleared. + + + ```JavaScript + + await botState.delete(context); + + ``` + isDeprecated: false + syntax: + content: 'function delete(context: TurnContext): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: Inherited From [BotState.delete](xref:botbuilder.BotState.delete) + - name: get(TurnContext) + uid: botbuilder.UserState.get + package: botbuilder + summary: Returns a cached state object or undefined if not cached. + remarks: >- + This example shows how to synchronously get an already loaded and cached + state object: + + + ```JavaScript + + const state = botState.get(context); + + ``` + isDeprecated: false + syntax: + content: 'function get(context: TurnContext): any' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: A cached state object or undefined if not cached. + type: any + inheritanceDescription: Inherited From [BotState.get](xref:botbuilder.BotState.get) + - name: load(TurnContext, boolean) + uid: botbuilder.UserState.load + package: botbuilder + summary: Reads in and caches the backing state object for a turn. + remarks: >- + Subsequent reads will return the cached object unless the `force` flag is + passed in which + + will force the state object to be re-read. + + + This method is automatically called on first access of any of created + property accessors. + + + ```JavaScript + + const state = await botState.load(context); + + ``` + isDeprecated: false + syntax: + content: 'function load(context: TurnContext, force?: boolean): Promise' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) If `true` the cache will be bypassed and the state will + always be read in directly from storage. Defaults to `false`. + return: + description: The cached state. + type: Promise<any> + inheritanceDescription: Inherited From [BotState.load](xref:botbuilder.BotState.load) + - name: saveChanges(TurnContext, boolean) + uid: botbuilder.UserState.saveChanges + package: botbuilder + summary: Saves the cached state object if it's been changed. + remarks: >- + If the `force` flag is passed in the cached state object will be saved + regardless of + + whether its been changed or not and if no object has been cached, an empty + object will be + + created and then saved. + + + ```JavaScript + + await botState.saveChanges(context); + + ``` + isDeprecated: false + syntax: + content: >- + function saveChanges(context: TurnContext, force?: boolean): + Promise + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + - id: force + type: boolean + description: >- + (Optional) if `true` the state will always be written out regardless + of its change state. Defaults to `false`. + return: + description: A promise representing the async operation. + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BotState.saveChanges](xref:botbuilder.BotState.saveChanges) +methods: + - name: getStorageKey(TurnContext) + uid: botbuilder.UserState.getStorageKey + package: botbuilder + summary: Returns the storage key for the current user state. + remarks: '' + isDeprecated: false + syntax: + content: 'function getStorageKey(context: TurnContext): undefined | string' + parameters: + - id: context + type: + description: Context for current turn of conversation with the user. + return: + description: The storage key for the current user state. + type: undefined | string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/VideoCard.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/VideoCard.yml new file mode 100644 index 00000000..af9ad723 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/VideoCard.yml @@ -0,0 +1,166 @@ +### YamlMime:TSType +name: VideoCard +uid: botbuilder.VideoCard +package: botbuilder +summary: Video card +fullName: VideoCard +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aspect + uid: botbuilder.VideoCard.aspect + package: botbuilder + summary: >- + Aspect ratio of thumbnail/media placeholder. Allowed values are "16:9" and + "4:3" + fullName: aspect + remarks: '' + isDeprecated: false + syntax: + content: 'aspect: string' + return: + description: '' + type: string + - name: autoloop + uid: botbuilder.VideoCard.autoloop + package: botbuilder + summary: Should the client loop playback at end of content (default:true) + fullName: autoloop + remarks: '' + isDeprecated: false + syntax: + content: 'autoloop: boolean' + return: + description: '' + type: boolean + - name: autostart + uid: botbuilder.VideoCard.autostart + package: botbuilder + summary: >- + Should the client automatically start playback of media in this card + (default:true) + fullName: autostart + remarks: '' + isDeprecated: false + syntax: + content: 'autostart: boolean' + return: + description: '' + type: boolean + - name: buttons + uid: botbuilder.VideoCard.buttons + package: botbuilder + summary: Actions on this card + fullName: buttons + remarks: '' + isDeprecated: false + syntax: + content: 'buttons: CardAction[]' + return: + description: '' + type: [] + - name: duration + uid: botbuilder.VideoCard.duration + package: botbuilder + summary: >- + Describes the length of the media content without requiring a receiver to + open the content. + + Formatted as an ISO 8601 Duration field. + fullName: duration + remarks: '' + isDeprecated: false + syntax: + content: 'duration: string' + return: + description: '' + type: string + - name: image + uid: botbuilder.VideoCard.image + package: botbuilder + summary: Thumbnail placeholder + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image: ThumbnailUrl' + return: + description: '' + type: + - name: media + uid: botbuilder.VideoCard.media + package: botbuilder + summary: >- + Media URLs for this card. When this field contains more than one URL, each + URL is an + + alternative format of the same content. + fullName: media + remarks: '' + isDeprecated: false + syntax: + content: 'media: MediaUrl[]' + return: + description: '' + type: [] + - name: shareable + uid: botbuilder.VideoCard.shareable + package: botbuilder + summary: This content may be shared with others (default:true) + fullName: shareable + remarks: '' + isDeprecated: false + syntax: + content: 'shareable: boolean' + return: + description: '' + type: boolean + - name: subtitle + uid: botbuilder.VideoCard.subtitle + package: botbuilder + summary: Subtitle of this card + fullName: subtitle + remarks: '' + isDeprecated: false + syntax: + content: 'subtitle: string' + return: + description: '' + type: string + - name: text + uid: botbuilder.VideoCard.text + package: botbuilder + summary: Text of this card + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botbuilder.VideoCard.title + package: botbuilder + summary: Title of this card + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: value + uid: botbuilder.VideoCard.value + package: botbuilder + summary: Supplementary parameter for this card + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/ViewResponseType.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/ViewResponseType.yml new file mode 100644 index 00000000..8f47ac35 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/ViewResponseType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ViewResponseType +uid: botbuilder.ViewResponseType +package: botbuilder +summary: The type of the view in the handle action response. +fullName: ViewResponseType +remarks: '' +isDeprecated: false +syntax: | + type ViewResponseType = "Card" | "QuickView" | "NoOp" diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/WebRequest.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/WebRequest.yml index f8cca860..168d4dba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/WebRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/WebRequest.yml @@ -2,14 +2,14 @@ name: WebRequest uid: botbuilder.WebRequest package: botbuilder -summary: > +summary: >- Represents an Express or Restify request object. + This interface supports the framework and is not intended to be called directly for your code. fullName: WebRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +19,6 @@ properties: summary: Optional. The request body. fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: any' @@ -32,7 +31,6 @@ properties: summary: Optional. The request headers. fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'headers: any' @@ -45,7 +43,6 @@ properties: summary: Optional. The request method. fullName: method remarks: '' - isPreview: false isDeprecated: false syntax: content: 'method?: any' @@ -58,7 +55,6 @@ properties: summary: Optional. The request parameters from the url. fullName: params remarks: '' - isPreview: false isDeprecated: false syntax: content: 'params?: any' @@ -71,7 +67,6 @@ properties: summary: Optional. The values from the query string. fullName: query remarks: '' - isPreview: false isDeprecated: false syntax: content: 'query?: any' @@ -79,7 +74,7 @@ properties: description: '' type: any methods: - - name: 'on(string, any[])' + - name: on(string, any[]) uid: botbuilder.WebRequest.on package: botbuilder summary: |- @@ -87,7 +82,6 @@ methods: The framework uses this method to retrieve the request body when the [body](xref:botbuilder.WebRequest.body) property is `null` or `undefined`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function on(event: string, args: any[]): any' @@ -96,9 +90,8 @@ methods: type: string description: The event name. - id: args - type: 'any[]' - description: | - Arguments used to handle the event. + type: any[] + description: Arguments used to handle the event. return: description: A reference to the request object. type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/WebResponse.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/WebResponse.yml index 9ea96f22..9bbb47f5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/WebResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/WebResponse.yml @@ -2,14 +2,14 @@ name: WebResponse uid: botbuilder.WebResponse package: botbuilder -summary: > +summary: >- Represents an Express or Restify response object. + This interface supports the framework and is not intended to be called directly for your code. fullName: WebResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +19,6 @@ properties: summary: Optional. The underlying socket. fullName: socket remarks: '' - isPreview: false isDeprecated: false syntax: content: 'socket?: any' @@ -27,37 +26,33 @@ properties: description: '' type: any methods: - - name: 'end(any[])' + - name: end(any[]) uid: botbuilder.WebResponse.end package: botbuilder - summary: 'When implemented in a derived class, sends a FIN packet.' + summary: When implemented in a derived class, sends a FIN packet. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function end(args: any[]): any' parameters: - id: args - type: 'any[]' - description: | - The arguments for the end event. + type: any[] + description: The arguments for the end event. return: description: A reference to the response object. type: any - name: send(any) uid: botbuilder.WebResponse.send package: botbuilder - summary: 'When implemented in a derived class, sends the response.' + summary: When implemented in a derived class, sends the response. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(body: any): any' parameters: - id: body type: any - description: | - The response payload. + description: The response payload. return: description: A reference to the response object. type: any @@ -68,15 +63,13 @@ methods: When implemented in a derived class, sets the HTTP status code for the response. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function status(status: number): any' parameters: - id: status type: number - description: | - The status code to use. + description: The status code to use. return: description: The status code. type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/WebServer.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/WebServer.yml index 8bf1a034..c3e4e33d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/WebServer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/WebServer.yml @@ -5,7 +5,6 @@ package: botbuilder summary: Interface representing an Express Application or a Restify Server. fullName: WebServer remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: del remarks: '' - isPreview: false isDeprecated: false syntax: content: 'del?: (path: string, handler: RouteHandler) => void' @@ -28,7 +26,6 @@ properties: summary: '' fullName: delete remarks: '' - isPreview: false isDeprecated: false syntax: content: 'delete?: (path: string, handler: RouteHandler) => void' @@ -41,7 +38,6 @@ properties: summary: '' fullName: get remarks: '' - isPreview: false isDeprecated: false syntax: content: 'get: (path: string, handler: RouteHandler) => void' @@ -54,7 +50,6 @@ properties: summary: '' fullName: post remarks: '' - isPreview: false isDeprecated: false syntax: content: 'post: (path: string, handler: RouteHandler) => void' @@ -67,7 +62,6 @@ properties: summary: '' fullName: put remarks: '' - isPreview: false isDeprecated: false syntax: content: 'put: (path: string, handler: RouteHandler) => void' diff --git a/botbuilder-typescript/docs-ref-autogen/botbuilder/index.yml b/botbuilder-typescript/docs-ref-autogen/botbuilder/index.yml index 288e1a4d..549fb04e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botbuilder/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botbuilder/index.yml @@ -3,38 +3,846 @@ uid: botbuilder name: botbuilder summary: '' type: package +enums: + - botbuilder.ActionTypes + - botbuilder.ActivityEventNames + - botbuilder.ActivityImportance + - botbuilder.ActivityTypes + - botbuilder.AttachmentLayoutTypes + - botbuilder.Channels + - botbuilder.ContactRelationUpdateActionTypes + - botbuilder.DeliveryModes + - botbuilder.DropDownOptionType + - botbuilder.EndOfConversationCodes + - botbuilder.FieldType + - botbuilder.InputHints + - botbuilder.InstallationUpdateActionTypes + - botbuilder.MediaType + - botbuilder.MessageReactionTypes + - botbuilder.PopupWindowPosition + - botbuilder.RoleTypes + - botbuilder.SemanticActionStateTypes + - botbuilder.Severity + - botbuilder.StatusCodes + - botbuilder.TextFormatTypes +classes: + - botbuilder.ActivityFactory + - botbuilder.ActivityHandler + - botbuilder.ActivityHandlerBase + - botbuilder.AutoSaveStateMiddleware + - botbuilder.BotAdapter + - botbuilder.BotComponent + - botbuilder.BotFrameworkAdapter + - botbuilder.BotFrameworkHttpClient + - botbuilder.BotState + - botbuilder.BotStatePropertyAccessor + - botbuilder.BotStateSet + - botbuilder.BrowserLocalStorage + - botbuilder.BrowserSessionStorage + - botbuilder.CallerIdConstants + - botbuilder.CardFactory + - botbuilder.ChannelServiceHandler + - botbuilder.ChannelServiceHandlerBase + - botbuilder.ChannelServiceRoutes + - botbuilder.CloudAdapter + - botbuilder.CloudAdapterBase + - botbuilder.CloudSkillHandler + - botbuilder.ComponentRegistration + - botbuilder.ConfigurationBotFrameworkAuthentication + - botbuilder.ConfigurationServiceClientCredentialFactory + - botbuilder.ConsoleTranscriptLogger + - botbuilder.ConversationState + - botbuilder.EventFactory + - botbuilder.FileTranscriptStore + - botbuilder.HandoffEventNames + - botbuilder.InspectionMiddleware + - botbuilder.InspectionState + - botbuilder.InvokeException + - botbuilder.MemoryStorage + - botbuilder.MemoryTranscriptStore + - botbuilder.MessageFactory + - botbuilder.MiddlewareSet + - botbuilder.NullTelemetryClient + - botbuilder.PrivateConversationState + - botbuilder.QueueStorage + - botbuilder.RegisterClassMiddleware + - botbuilder.SetSpeakMiddleware + - botbuilder.SharePointActivityHandler + - botbuilder.ShowTypingMiddleware + - botbuilder.SkillConversationIdFactory + - botbuilder.SkillConversationIdFactoryBase + - botbuilder.SkillHandler + - botbuilder.SkillHttpClient + - botbuilder.SkypeMentionNormalizeMiddleware + - botbuilder.SpeechConstants + - botbuilder.StatusCodeError + - botbuilder.StreamingHttpClient + - botbuilder.StringUtils + - botbuilder.TeamsActivityHandler + - botbuilder.TeamsInfo + - botbuilder.TeamsSSOTokenExchangeMiddleware + - botbuilder.TelemetryLoggerMiddleware + - botbuilder.TestAdapter + - botbuilder.TestFlow + - botbuilder.TokenResolver + - botbuilder.TranscriptLoggerMiddleware + - botbuilder.TurnContext + - botbuilder.TurnContextStateCollection + - botbuilder.UserState +interfaces: + - botbuilder.AceData + - botbuilder.AceRequest + - botbuilder.Activity + - botbuilder.ActivityTimestamps + - botbuilder.AdaptiveCardAuthentication + - botbuilder.AdaptiveCardInvokeAction + - botbuilder.AdaptiveCardInvokeResponse + - botbuilder.AdaptiveCardInvokeValue + - botbuilder.AnimationCard + - botbuilder.AppBasedLinkQuery + - botbuilder.Attachment + - botbuilder.AttachmentData + - botbuilder.AttachmentInfo + - botbuilder.AttachmentView + - botbuilder.AudioCard + - botbuilder.BaseCardComponent + - botbuilder.BaseCardViewParameters + - botbuilder.BaseHandleActionResponse + - botbuilder.BasicCard + - botbuilder.BatchFailedEntriesResponse + - botbuilder.BatchFailedEntry + - botbuilder.BatchOperationRequest + - botbuilder.BatchOperationResponse + - botbuilder.BatchOperationStateResponse + - botbuilder.BotConfigAuth + - botbuilder.BotFrameworkAdapterSettings + - botbuilder.BotFrameworkClient + - botbuilder.BotFrameworkHttpAdapter + - botbuilder.BotFrameworkSkill + - botbuilder.BotPageViewTelemetryClient + - botbuilder.BotTelemetryClient + - botbuilder.CacheInfo + - botbuilder.CachedBotState + - botbuilder.CardAction + - botbuilder.CardBarComponent + - botbuilder.CardButtonBase + - botbuilder.CardButtonComponent + - botbuilder.CardImage + - botbuilder.CardSearchBoxComponent + - botbuilder.CardSearchFooterComponent + - botbuilder.CardTextComponent + - botbuilder.CardTextInputComponent + - botbuilder.CardViewHandleActionResponse + - botbuilder.CardViewResponse + - botbuilder.ChannelAccount + - botbuilder.ChannelInfo + - botbuilder.CommandResultValue + - botbuilder.CommandValue + - botbuilder.ConfigResponse + - botbuilder.ConfirmationDialog + - botbuilder.ConversationAccount + - botbuilder.ConversationList + - botbuilder.ConversationMembers + - botbuilder.ConversationParameters + - botbuilder.ConversationReference + - botbuilder.ConversationResourceResponse + - botbuilder.ConversationsResult + - botbuilder.CoreAppCredentials + - botbuilder.Entity + - botbuilder.ErrorModel + - botbuilder.ErrorResponse + - botbuilder.ExecuteCardAction + - botbuilder.ExecuteCardParameters + - botbuilder.ExpectedReplies + - botbuilder.ExtendedUserTokenProvider + - botbuilder.ExternalLinkActionParameters + - botbuilder.ExternalLinkCardAction + - botbuilder.Fact + - botbuilder.FileConsentCard + - botbuilder.FileConsentCardResponse + - botbuilder.FileDownloadInfo + - botbuilder.FileInfoCard + - botbuilder.FileUploadInfo + - botbuilder.FocusParameters + - botbuilder.GeoCoordinates + - botbuilder.GetLocationActionParameters + - botbuilder.GetLocationCardAction + - botbuilder.GetPropertyPaneConfigurationResponse + - botbuilder.HeroCard + - botbuilder.IActivity + - botbuilder.ICardSearchBoxButton + - botbuilder.ICardTextInputIconButton + - botbuilder.ICardTextInputTitleButton + - botbuilder.ICommandActivity + - botbuilder.ICommandResultActivity + - botbuilder.IContactRelationUpdateActivity + - botbuilder.IConversationUpdateActivity + - botbuilder.IEndOfConversationActivity + - botbuilder.IEventActivity + - botbuilder.IInstallationUpdateActivity + - botbuilder.IInvokeActivity + - botbuilder.IMessageActivity + - botbuilder.IMessageReactionActivity + - botbuilder.IMessageUpdateActivity + - botbuilder.IStatusCodeError + - botbuilder.ISuggestionActivity + - botbuilder.ITraceActivity + - botbuilder.IUserTokenProvider + - botbuilder.InnerHttpError + - botbuilder.IntentScore + - botbuilder.InvokeResponse + - botbuilder.Location + - botbuilder.MediaCard + - botbuilder.MediaEventValue + - botbuilder.MediaUrl + - botbuilder.Meeting + - botbuilder.MeetingDetails + - botbuilder.MeetingEndEventDetails + - botbuilder.MeetingEventDetails + - botbuilder.MeetingInfo + - botbuilder.MeetingNotificationBase + - botbuilder.MeetingNotificationChannelData + - botbuilder.MeetingNotificationRecipientFailureInfo + - botbuilder.MeetingNotificationResponse + - botbuilder.MeetingParticipantsEventDetails + - botbuilder.MeetingStageSurface + - botbuilder.MeetingStartEventDetails + - botbuilder.MeetingTabIconSurface + - botbuilder.Mention + - botbuilder.MessageActionsPayload + - botbuilder.MessageActionsPayloadApp + - botbuilder.MessageActionsPayloadAttachment + - botbuilder.MessageActionsPayloadBody + - botbuilder.MessageActionsPayloadConversation + - botbuilder.MessageActionsPayloadFrom + - botbuilder.MessageActionsPayloadMention + - botbuilder.MessageActionsPayloadReaction + - botbuilder.MessageActionsPayloadUser + - botbuilder.MessageReaction + - botbuilder.MessagingExtensionAction + - botbuilder.MessagingExtensionActionResponse + - botbuilder.MessagingExtensionAttachment + - botbuilder.MessagingExtensionParameter + - botbuilder.MessagingExtensionQuery + - botbuilder.MessagingExtensionQueryOptions + - botbuilder.MessagingExtensionResponse + - botbuilder.MessagingExtensionResult + - botbuilder.MessagingExtensionSuggestedAction + - botbuilder.MicrosoftPayMethodData + - botbuilder.Middleware + - botbuilder.NoOpHandleActionResponse + - botbuilder.NotificationInfo + - botbuilder.O365ConnectorCard + - botbuilder.O365ConnectorCardActionBase + - botbuilder.O365ConnectorCardActionCard + - botbuilder.O365ConnectorCardActionQuery + - botbuilder.O365ConnectorCardDateInput + - botbuilder.O365ConnectorCardFact + - botbuilder.O365ConnectorCardHttpPOST + - botbuilder.O365ConnectorCardImage + - botbuilder.O365ConnectorCardInputBase + - botbuilder.O365ConnectorCardMultichoiceInput + - botbuilder.O365ConnectorCardMultichoiceInputChoice + - botbuilder.O365ConnectorCardOpenUri + - botbuilder.O365ConnectorCardOpenUriTarget + - botbuilder.O365ConnectorCardSection + - botbuilder.O365ConnectorCardTextInput + - botbuilder.O365ConnectorCardViewAction + - botbuilder.OAuthCard + - botbuilder.OnBehalfOf + - botbuilder.PagedMembersResult + - botbuilder.PagedResult + - botbuilder.PaymentAddress + - botbuilder.PaymentCurrencyAmount + - botbuilder.PaymentDetails + - botbuilder.PaymentDetailsModifier + - botbuilder.PaymentItem + - botbuilder.PaymentMethodData + - botbuilder.PaymentOptions + - botbuilder.PaymentRequest + - botbuilder.PaymentRequestComplete + - botbuilder.PaymentRequestCompleteResult + - botbuilder.PaymentRequestUpdate + - botbuilder.PaymentRequestUpdateResult + - botbuilder.PaymentResponse + - botbuilder.PaymentShippingOption + - botbuilder.Place + - botbuilder.PropertyManager + - botbuilder.PropertyPaneCheckboxProperties + - botbuilder.PropertyPaneChoiceGroupIconProperties + - botbuilder.PropertyPaneChoiceGroupImageSize + - botbuilder.PropertyPaneChoiceGroupOption + - botbuilder.PropertyPaneChoiceGroupProperties + - botbuilder.PropertyPaneDropDownOption + - botbuilder.PropertyPaneDropDownProperties + - botbuilder.PropertyPaneFieldProperties + - botbuilder.PropertyPaneGroup + - botbuilder.PropertyPaneGroupField + - botbuilder.PropertyPaneGroupOrConditionalGroup + - botbuilder.PropertyPaneLabelProperties + - botbuilder.PropertyPaneLinkPopupWindowProperties + - botbuilder.PropertyPaneLinkProperties + - botbuilder.PropertyPanePage + - botbuilder.PropertyPanePageHeader + - botbuilder.PropertyPaneSliderProperties + - botbuilder.PropertyPaneTextFieldProperties + - botbuilder.PropertyPaneToggleProperties + - botbuilder.QuickViewCardAction + - botbuilder.QuickViewData + - botbuilder.QuickViewHandleActionResponse + - botbuilder.QuickViewParameters + - botbuilder.QuickViewResponse + - botbuilder.ReceiptCard + - botbuilder.ReceiptItem + - botbuilder.RecognizerResult + - botbuilder.Request + - botbuilder.ResourceResponse + - botbuilder.Response + - botbuilder.SearchCardViewParameters + - botbuilder.SearchInvokeOptions + - botbuilder.SearchInvokeResponse + - botbuilder.SearchInvokeValue + - botbuilder.SelectMediaActionParameters + - botbuilder.SelectMediaCardAction + - botbuilder.SemanticAction + - botbuilder.ShowLocationActionParameters + - botbuilder.ShowLocationCardAction + - botbuilder.SignInCardViewParameters + - botbuilder.SignInUrlResponse + - botbuilder.SigninCard + - botbuilder.SigninStateVerificationQuery + - botbuilder.SkillConversationIdFactoryOptions + - botbuilder.SkillConversationReference + - botbuilder.StatePropertyAccessor + - botbuilder.Storage + - botbuilder.StoreItem + - botbuilder.StoreItems + - botbuilder.SubmitCardAction + - botbuilder.SubmitCardParameters + - botbuilder.SuggestedActions + - botbuilder.TabContext + - botbuilder.TabEntityContext + - botbuilder.TabRequest + - botbuilder.TabResponse + - botbuilder.TabResponseCard + - botbuilder.TabResponseCards + - botbuilder.TabResponsePayload + - botbuilder.TabSubmit + - botbuilder.TabSubmitData + - botbuilder.TabSuggestedActions + - botbuilder.TargetedMeetingNotification + - botbuilder.TargetedMeetingNotificationValue + - botbuilder.TaskModuleCardResponse + - botbuilder.TaskModuleContinueResponse + - botbuilder.TaskModuleMessageResponse + - botbuilder.TaskModuleRequest + - botbuilder.TaskModuleRequestContext + - botbuilder.TaskModuleResponse + - botbuilder.TaskModuleResponseBase + - botbuilder.TaskModuleTaskInfo + - botbuilder.TeamDetails + - botbuilder.TeamInfo + - botbuilder.TeamsAttachment + - botbuilder.TeamsChannelAccount + - botbuilder.TeamsChannelData + - botbuilder.TeamsChannelDataSettings + - botbuilder.TeamsMeetingInfo + - botbuilder.TeamsMeetingMember + - botbuilder.TeamsMeetingParticipant + - botbuilder.TeamsPagedMembersResult + - botbuilder.TelemetryDependency + - botbuilder.TelemetryEvent + - botbuilder.TelemetryException + - botbuilder.TelemetryPageView + - botbuilder.TelemetryTrace + - botbuilder.TenantInfo + - botbuilder.TextCardViewParameters + - botbuilder.TextHighlight + - botbuilder.TextInputCardViewParameters + - botbuilder.Thing + - botbuilder.ThumbnailCard + - botbuilder.ThumbnailUrl + - botbuilder.TokenExchangeInvokeRequest + - botbuilder.TokenExchangeInvokeResponse + - botbuilder.TokenExchangeRequest + - botbuilder.TokenExchangeResource + - botbuilder.TokenPollingSettings + - botbuilder.TokenPostResource + - botbuilder.TokenRequest + - botbuilder.TokenResponse + - botbuilder.Transcript + - botbuilder.TranscriptInfo + - botbuilder.TranscriptLogger + - botbuilder.TranscriptStore + - botbuilder.UserMeetingDetails + - botbuilder.VideoCard + - botbuilder.WebRequest + - botbuilder.WebResponse + - botbuilder.WebServer +typeAliases: + - botbuilder.AceCardSize + - botbuilder.Action + - botbuilder.ActivityImageType + - botbuilder.ApplicationIdentityType + - botbuilder.AttachmentLayout + - botbuilder.BotConfigAuthType + - botbuilder.BotHandler + - botbuilder.BotMessagePreviewActionType + - botbuilder.BotMessagePreviewType + - botbuilder.CardComponentName + - botbuilder.CardViewActionsFooterParameters + - botbuilder.CardViewFooterParameters + - botbuilder.CardViewParameters + - botbuilder.CommandContext + - botbuilder.ConfigResponseConfig + - botbuilder.ConfigurationBotFrameworkAuthenticationOptions + - botbuilder.ConfigurationServiceClientCredentialFactoryOptions + - botbuilder.ContentType + - botbuilder.ConversationIdentityType + - botbuilder.DeleteActivityHandler + - botbuilder.FileDownloadInfoAttachment + - botbuilder.HandleActionResponse + - botbuilder.IHandoffActivity + - botbuilder.IMessageDeleteActivity + - botbuilder.ITypingActivity + - botbuilder.Importance + - botbuilder.MeetingNotification + - botbuilder.MeetingSurface + - botbuilder.MessageType + - botbuilder.MessagingExtensionResultType + - botbuilder.MiddlewareHandler + - botbuilder.O365ConnectorCardActionType + - botbuilder.O365ConnectorCardInputBaseType + - botbuilder.O365ConnectorCardInputType + - botbuilder.OnCardSelectionAction + - botbuilder.Os + - botbuilder.ReactionType + - botbuilder.RouteHandler + - botbuilder.SendActivitiesHandler + - botbuilder.SetPropertyPaneConfigurationResponse + - botbuilder.StorageKeyFactory + - botbuilder.Style + - botbuilder.TeamsMember + - botbuilder.TestActivityInspector + - botbuilder.TokenExchangeState + - botbuilder.TokenStatus + - botbuilder.Type + - botbuilder.Type1 + - botbuilder.Type2 + - botbuilder.Type3 + - botbuilder.UpdateActivityHandler + - botbuilder.UserIdentityType + - botbuilder.ViewResponseType functions: - - name: validateAndFixActivity(Activity) - uid: botbuilder.validateAndFixActivity + - name: >- + BasicCardView(CardBarComponent, CardTextComponent, + CardViewFooterParameters) + uid: botbuilder.BasicCardView package: botbuilder summary: >- - Validates an [Activity](xref:botbuilder-core.Activity) and formats the - timestamp fields. + Helper method to create a Basic Card View. + + The Basic Text card view displays the following: + + - Card bar + + - One primary text field + + - Zero or one button in the Medium card size, up to two buttons in Large + card size; or text input. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function validateAndFixActivity(activity: Activity): Activity' + content: >- + function BasicCardView(cardBar: CardBarComponent, header: + CardTextComponent, footer?: CardViewFooterParameters): + TextCardViewParameters parameters: - - id: activity - type: Activity - description: '(xref:botbuilder-core.Activity) to be validated.' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: footer + type: + description: up to two buttons or text input to display as footer + return: + description: basic card view parameters. + type: + - name: >- + ImageCardView(CardBarComponent, CardTextComponent, CardImage, + CardViewFooterParameters) + uid: botbuilder.ImageCardView + package: botbuilder + summary: >- + Helper method to create an Image Card View. + + The Image Card view displays the following: + + - Card bar + + - One primary text field + + - One image + + - Zero buttons in the Medium card size, up to two buttons in Large card + size; or text input. + remarks: '' + isDeprecated: false + syntax: + content: >- + function ImageCardView(cardBar: CardBarComponent, header: + CardTextComponent, image: CardImage, footer?: CardViewFooterParameters): + TextCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: image + type: CardImage + description: image to display + - id: footer + type: + description: up to two buttons or text input to display as footer return: - description: 'The [Activity](xref:botframework-schema.Activity).' - type: Activity + description: image card view parameters + type: + - name: >- + PrimaryTextCardView(CardBarComponent, CardTextComponent, + CardTextComponent, CardViewFooterParameters) + uid: botbuilder.PrimaryTextCardView + package: botbuilder + summary: >- + Helper method to create a Primary Text Card View. + + The Primary Text card view displays the following: + + - Card bar + + - One primary text field + + - One description text field + + - Zero or one button in the Medium card size, up to two buttons in Large + card size; or text input. + remarks: '' + isDeprecated: false + syntax: + content: >- + function PrimaryTextCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextComponent, footer?: + CardViewFooterParameters): TextCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text component to display as body + - id: footer + type: + description: up to two buttons or text input to display as footer + return: + description: primary text card view parameters. + type: + - name: >- + SearchCardView(CardBarComponent, CardTextComponent, + CardSearchBoxComponent, CardSearchFooterComponent) + uid: botbuilder.SearchCardView + package: botbuilder + summary: |- + Helper method to create a Search Card View. + The Search Card view displays the following: + - Card bar + - One primary text field + - One search box + - One search footer + remarks: '' + isDeprecated: false + syntax: + content: >- + function SearchCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardSearchBoxComponent, footer: + CardSearchFooterComponent): SearchCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: search box component to display as body + - id: footer + type: + description: search footer component to display as footer + return: + description: search card view parameters + type: + - name: >- + SignInCardView(CardBarComponent, CardTextComponent, CardTextComponent, + CardButtonComponent) + uid: botbuilder.SignInCardView + package: botbuilder + summary: |- + Helper method to create a Sign In Card View. + The Sign In Card view displays the following: + - Card bar + - One primary text field + - One description text field + - Two buttons. + remarks: >- + The first button (sign in button) is always displayed based on the + signInText property of the Adaptive Card Extension. Here you should + specify the second button (sign in complete button) to display. + isDeprecated: false + syntax: + content: >- + function SignInCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextComponent, footer: + CardButtonComponent): SignInCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text component to display as body + - id: footer + type: + description: sign in complete button to display as footer + return: + description: sign in card view parameters + type: + - name: >- + TextInputCardView(CardBarComponent, CardTextComponent, + CardTextInputComponent, CardViewActionsFooterParameters) + uid: botbuilder.TextInputCardView + package: botbuilder + summary: >- + Helper method to create an Text Input Card View. + + The Text Input Card view displays the following: + + - Card bar + + - One primary text field + + - Zero or one image + + - Zero text input in Medium card size if image is presented, one text + input in Medium card size if no image is presented, one text input in + Large card size + + - Zero buttons in the Medium card size if image is presented, one button + in Medium card size if no image is presented, up to two buttons in Large + card size; or text input. + remarks: '' + isDeprecated: false + syntax: + content: >- + function TextInputCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextInputComponent, footer?: + CardViewActionsFooterParameters): TextInputCardViewParameters + parameters: + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text input component to display as body + - id: footer + type: + description: up to two buttons to display as footer + return: + description: text input card view parameters + type: + - name: calculateChangeHash(StoreItem) + uid: botbuilder.calculateChangeHash + package: botbuilder + summary: Utility function to calculate a change hash for a `StoreItem`. + remarks: >- + This example calculates a change hash for an object that's been read in + and then only writes it + + back out if it's been modified: + + + ```JavaScript + + // Calculate state objects initial hash + + const hash = calculateChangeHash(state); + + + // Process the received activity + + await processActivity(context, state); + + + // Save state if changed + + if (calculateChangeHash(state) !== hash) { + await storage.write({ 'botState': state }); + } + + ``` + isDeprecated: false + syntax: + content: 'function calculateChangeHash(item: StoreItem): string' + parameters: + - id: item + type: + description: Item to calculate the change hash for. + return: + description: change hash string + type: string + - name: >- + createBotFrameworkAuthenticationFromConfiguration(Configuration, + ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: + RequestInfo, init?: RequestInit) => Promise, + ConnectorClientOptions) + uid: botbuilder.createBotFrameworkAuthenticationFromConfiguration + package: botbuilder + summary: >- + Creates a new instance of the + [ConfigurationBotFrameworkAuthentication](xref:botbuilder-core.ConfigurationBotFrameworkAuthentication) + class. + remarks: >- + The + [Configuration](xref:botbuilder-dialogs-adaptive-runtime-core.Configuration) + instance provided to the constructor should + + have the desired authentication values available at the root, using the + properties of + [ConfigurationBotFrameworkAuthenticationOptions](xref:botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions) + as its keys. + isDeprecated: false + syntax: + content: >- + function + createBotFrameworkAuthenticationFromConfiguration(configuration: + Configuration, credentialsFactory?: ServiceClientCredentialsFactory, + authConfiguration?: AuthenticationConfiguration, + botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => + Promise, connectorClientOptions?: ConnectorClientOptions): + BotFrameworkAuthentication + parameters: + - id: configuration + type: Configuration + description: >- + A + [Configuration](xref:botbuilder-dialogs-adaptive-runtime-core.Configuration) + instance. + - id: credentialsFactory + type: ServiceClientCredentialsFactory + description: >- + A + [ServiceClientCredentialsFactory](xref:botframework-connector.ServiceClientCredentialsFactory) + instance. + - id: authConfiguration + type: AuthenticationConfiguration + description: >- + A + [Configuration](xref:botframework-connector.AuthenticationConfiguration) + object. + - id: botFrameworkClientFetch + type: >- + (input: RequestInfo, init?: RequestInit) => + Promise<Response> + description: >- + A custom Fetch implementation to be used in the + [BotFrameworkClient](xref:botframework-connector.BotFrameworkClient). + - id: connectorClientOptions + type: ConnectorClientOptions + description: >- + A + [ConnectorClientOptions](xref:botframework-connector.ConnectorClientOptions) + object. + return: + description: >- + A + [ConfigurationBotFrameworkAuthentication](xref:botbuilder-core.ConfigurationBotFrameworkAuthentication) + instance. + type: BotFrameworkAuthentication + - name: createServiceClientCredentialFactoryFromConfiguration(Configuration) + uid: botbuilder.createServiceClientCredentialFactoryFromConfiguration + package: botbuilder + summary: >- + Creates a new instance of the + [ConfigurationServiceClientCredentialFactory](xref:botbuilder-core.ConfigurationServiceClientCredentialFactory) + class. + remarks: >- + The + [Configuration](xref:botbuilder-dialogs-adaptive-runtime-core.Configuration) + instance provided to the constructor should + + have the desired authentication values available at the root, using the + properties of + [ConfigurationServiceClientCredentialFactoryOptions](xref:botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions) + as its keys. + isDeprecated: false + syntax: + content: >- + function + createServiceClientCredentialFactoryFromConfiguration(configuration: + Configuration): ConfigurationServiceClientCredentialFactory + parameters: + - id: configuration + type: Configuration + description: >- + A + [Configuration](xref:botbuilder-dialogs-adaptive-runtime-core.Configuration) + instance. + return: + description: >- + A + [ConfigurationServiceClientCredentialFactory](xref:botbuilder-core.ConfigurationServiceClientCredentialFactory) + instance. + type: + - name: getTopScoringIntent(RecognizerResult) + uid: botbuilder.getTopScoringIntent + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTopScoringIntent(result: RecognizerResult): { intent: + string, score: number } + parameters: + - id: result + type: + description: '' + return: + description: '' + type: '{ intent: string, score: number }' - name: teamsGetChannelId(Activity) uid: botbuilder.teamsGetChannelId package: botbuilder summary: Activity helper methods for Teams. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function teamsGetChannelId(activity: Activity): string | null' parameters: - id: activity - type: Activity - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: + description: The current [Activity](xref:botframework-schema.Activity). return: description: >- The current [Activity](xref:botframework-schema.Activity)'s team's @@ -45,16 +853,15 @@ functions: package: botbuilder summary: Gets the Team's selected channel id from the current activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function teamsGetSelectedChannelId(activity: Activity): string' parameters: - id: activity - type: Activity - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: + description: The current [Activity](xref:botframework-schema.Activity). return: - description: 'The current activity''s team''s selected channel, or empty string.' + description: The current activity's team's selected channel, or empty string. type: string - name: teamsGetTeamId(Activity) uid: botbuilder.teamsGetTeamId @@ -63,14 +870,13 @@ functions: Gets the Team Id from the current [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function teamsGetTeamId(activity: Activity): string | null' parameters: - id: activity - type: Activity - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: + description: The current [Activity](xref:botframework-schema.Activity). return: description: >- The current [Activity](xref:botframework-schema.Activity)'s team's Id, @@ -83,19 +889,18 @@ functions: Gets the TeamsInfo object from the current [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function teamsGetTeamInfo(activity: Activity): TeamInfo | null' parameters: - id: activity - type: Activity - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: + description: The current [Activity](xref:botframework-schema.Activity). return: description: >- The current [Activity](xref:botframework-schema.Activity)'s team's info, or null. - type: TeamInfo | null + type: | null - name: teamsGetTeamMeetingInfo(Activity) uid: botbuilder.teamsGetTeamMeetingInfo package: botbuilder @@ -103,7 +908,6 @@ functions: Gets the TeamsMeetingInfo object from the current [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -111,13 +915,30 @@ functions: null parameters: - id: activity - type: Activity - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: + description: The current [Activity](xref:botframework-schema.Activity). return: description: >- The current [Activity](xref:botframework-schema.Activity)'s team meeting info, or null. - type: TeamsMeetingInfo | null + type: | null + - name: teamsGetTeamOnBehalfOf(Activity) + uid: botbuilder.teamsGetTeamOnBehalfOf + package: botbuilder + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function teamsGetTeamOnBehalfOf(activity: Activity): OnBehalfOf[]' + parameters: + - id: activity + type: + description: The current [Activity](xref:botframework-schema.Activity). + return: + description: >- + The current [Activity](xref:botframework-schema.Activity)'s team's + onBehalfOf list, or null. + type: [] - name: teamsGetTenant(Activity) uid: botbuilder.teamsGetTenant package: botbuilder @@ -125,27 +946,25 @@ functions: Gets the TenantInfo object from the current [Activity](xref:botframework-schema.Activity). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function teamsGetTenant(activity: Activity): TenantInfo | null' parameters: - id: activity - type: Activity - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: + description: The current [Activity](xref:botframework-schema.Activity). return: description: >- The current [Activity](xref:botframework-schema.Activity)'s tenant info, or null. - type: TenantInfo | null - - name: 'teamsNotifyUser(Partial, boolean, string)' + type: | null + - name: teamsNotifyUser(Partial, boolean, string) uid: botbuilder.teamsNotifyUser package: botbuilder summary: >- Configures the current [Activity](xref:botframework-schema.Activity) to generate a notification within Teams. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -153,8 +972,8 @@ functions: boolean, externalResourceUrl?: string) parameters: - id: activity - type: Partial<Activity> - description: 'The current [Activity](xref:botframework-schema.Activity).' + type: Partial<> + description: The current [Activity](xref:botframework-schema.Activity). - id: alertInMeeting type: boolean description: >- @@ -162,42 +981,67 @@ functions: it in a notification popup as well as in the chat thread. - id: externalResourceUrl type: string - description: > + description: >- Url to external resource. Must be included in manifest's valid domains. -classes: - - botbuilder.BotFrameworkAdapter - - botbuilder.BotFrameworkHttpClient - - botbuilder.ChannelServiceHandler - - botbuilder.ChannelServiceHandlerBase - - botbuilder.ChannelServiceRoutes - - botbuilder.CloudAdapter - - botbuilder.CloudChannelServiceHandler - - botbuilder.EventFactory - - botbuilder.FileTranscriptStore - - botbuilder.HandoffEventNames - - botbuilder.InspectionMiddleware - - botbuilder.InspectionState - - botbuilder.RouteConstants - - botbuilder.SetSpeakMiddleware - - botbuilder.CloudSkillHandler - - botbuilder.SkillHandler - - botbuilder.SkillHandlerImpl - - botbuilder.SkillHttpClient - - botbuilder.StatusCodeError - - botbuilder.StreamingHttpClient - - botbuilder.TokenResolver - - botbuilder.TeamsSSOTokenExchangeMiddleware - - botbuilder.TeamsActivityHandler - - botbuilder.TeamsInfo -interfaces: - - botbuilder.BotFrameworkAdapterSettings - - botbuilder.BotFrameworkHttpAdapter - - botbuilder.WebServer - - botbuilder.ConnectorClientBuilder - - botbuilder.Request - - botbuilder.Response - - botbuilder.WebRequest - - botbuilder.WebResponse -typeAliases: - - botbuilder.RouteHandler + - name: >- + telemetryTrackDialogView(BotTelemetryClient, string, {[key: string]: any}, + {[key: string]: number}) + uid: botbuilder.telemetryTrackDialogView + package: botbuilder + summary: >- + Logs a DialogView using the + [trackPageView](xref:botbuilder-core.BotTelemetryClient.trackPageView) + method on the + [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) if + [BotPageViewTelemetryClient](xref:botbuilder-core.BotPageViewTelemetryClient) + has been implemented. + + Alternatively logs the information out via TrackTrace. + remarks: '' + isDeprecated: false + syntax: + content: >- + function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, + dialogName: string, properties?: {[key: string]: any}, metrics?: {[key: + string]: number}) + parameters: + - id: telemetryClient + type: + description: >- + TelemetryClient that implements + [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient). + - id: dialogName + type: string + description: Name of the dialog to log the entry / start for. + - id: properties + type: '{[key: string]: any}' + description: Named string values you can use to search and classify events. + - id: metrics + type: '{[key: string]: number}' + description: Measurements associated with this event. + - name: useBotState(BotAdapter, BotState[]) + uid: botbuilder.useBotState + package: botbuilder + summary: >- + Adds middleware to the adapter to register one or more BotState objects on + the turn context. + + The middleware registers the state objects on the turn context at the + start of each turn. + remarks: '' + isDeprecated: false + syntax: + content: >- + function useBotState(botAdapter: BotAdapter, botStates: BotState[]): + BotAdapter + parameters: + - id: botAdapter + type: + description: The adapter on which to register the state objects. + - id: botStates + type: [] + description: The state objects to register. + return: + description: The updated adapter. + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/AppInsightsService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/AppInsightsService.yml index 7cf93b67..7a9b385f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/AppInsightsService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/AppInsightsService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines an App Insights service connection. fullName: AppInsightsService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: AppInsightsService(IAppInsightsService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new AppInsightService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AppInsightsService(source?: IAppInsightsService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: apiKeys uid: botframework-config.AppInsightsService.apiKeys @@ -31,20 +28,18 @@ properties: summary: (Optional) named api keys for programmatic access to AppInsights. fullName: apiKeys remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'apiKeys: [key: string]: string' + content: 'apiKeys: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: applicationId uid: botframework-config.AppInsightsService.applicationId package: botframework-config summary: (Optional) application ID used for programmatic access to AppInsights. fullName: applicationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationId: string' @@ -57,7 +52,6 @@ properties: summary: Instrumentation key for logging data to appInsights. fullName: instrumentationKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'instrumentationKey: string' @@ -71,135 +65,110 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.id](xref:botframework-config.ConnectedService.id) + inheritanceDescription: Inherited From AzureService.id - name: name uid: botframework-config.AppInsightsService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.name](xref:botframework-config.ConnectedService.name) + inheritanceDescription: Inherited From AzureService.name - name: resourceGroup uid: botframework-config.AppInsightsService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.resourceGroup](xref:botframework-config.AzureService.resourceGroup) + inheritanceDescription: Inherited From AzureService.resourceGroup - name: serviceName uid: botframework-config.AppInsightsService.serviceName package: botframework-config summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.serviceName](xref:botframework-config.AzureService.serviceName) + inheritanceDescription: Inherited From AzureService.serviceName - name: subscriptionId uid: botframework-config.AppInsightsService.subscriptionId package: botframework-config summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.subscriptionId](xref:botframework-config.AzureService.subscriptionId) + inheritanceDescription: Inherited From AzureService.subscriptionId - name: tenantId uid: botframework-config.AppInsightsService.tenantId package: botframework-config summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.tenantId](xref:botframework-config.AzureService.tenantId) + inheritanceDescription: Inherited From AzureService.tenantId - name: type uid: botframework-config.AppInsightsService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' return: description: '' type: - inheritanceDescription: >- - Inherited From - [ConnectedService.type](xref:botframework-config.ConnectedService.type) + inheritanceDescription: Inherited From AzureService.type inheritedMethods: - name: toJSON() uid: botframework-config.AppInsightsService.toJSON package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' return: description: An IConnectedService JSON. type: - inheritanceDescription: >- - Inherited From - [ConnectedService.toJSON](xref:botframework-config.ConnectedService.toJSON) + inheritanceDescription: Inherited From AzureService.toJSON methods: - name: 'decrypt(string, (value: string, secret: string) => string)' uid: botframework-config.AppInsightsService.decrypt package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -211,14 +180,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.AppInsightsService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -230,6 +197,5 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. -extends: + description: Function called to encrypt an individual value. +extends: AzureService diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/AzureService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/AzureService.yml deleted file mode 100644 index 1fa8b2e1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/AzureService.yml +++ /dev/null @@ -1,192 +0,0 @@ -### YamlMime:TSType -name: AzureService -uid: botframework-config.AzureService -package: botframework-config -summary: Base class for all azure service definitions. -fullName: AzureService -remarks: '' -isPreview: false -isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' -type: class -constructors: - - name: 'AzureService(IAzureService, ServiceTypes)' - uid: botframework-config.AzureService.constructor - package: botframework-config - summary: Creates a new AzureService instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new AzureService(source: IAzureService, type: ServiceTypes)' - parameters: - - id: source - type: - description: (Optional) JSON based service definition. - - id: type - type: - description: | - Type of service being defined. -properties: - - name: resourceGroup - uid: botframework-config.AzureService.resourceGroup - package: botframework-config - summary: Resource group for azure. - fullName: resourceGroup - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'resourceGroup: string' - return: - description: '' - type: string - - name: serviceName - uid: botframework-config.AzureService.serviceName - package: botframework-config - summary: Name of the service. - fullName: serviceName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'serviceName: string' - return: - description: '' - type: string - - name: subscriptionId - uid: botframework-config.AzureService.subscriptionId - package: botframework-config - summary: Subscription ID for azure. - fullName: subscriptionId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'subscriptionId: string' - return: - description: '' - type: string - - name: tenantId - uid: botframework-config.AzureService.tenantId - package: botframework-config - summary: Tenant ID for azure. - fullName: tenantId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tenantId: string' - return: - description: '' - type: string -inheritedProperties: - - name: id - uid: botframework-config.AzureService.id - package: botframework-config - summary: Unique Id for the service. - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.id](xref:botframework-config.ConnectedService.id) - - name: name - uid: botframework-config.AzureService.name - package: botframework-config - summary: Friendly name for the service. - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.name](xref:botframework-config.ConnectedService.name) - - name: type - uid: botframework-config.AzureService.type - package: botframework-config - summary: '' - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type?: ServiceTypes' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ConnectedService.type](xref:botframework-config.ConnectedService.type) -inheritedMethods: - - name: 'decrypt(string, (value: string, secret: string) => string)' - uid: botframework-config.AzureService.decrypt - package: botframework-config - summary: Decrypt properties on this service. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function decrypt(_secret: string, _decryptString: (value: string, - secret: string) => string) - parameters: - - id: _secret - type: string - description: Secret to use to decrypt the keys in this service. - - id: _decryptString - type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. - inheritanceDescription: >- - Inherited From - [ConnectedService.decrypt](xref:botframework-config.ConnectedService.decrypt) - - name: 'encrypt(string, (value: string, secret: string) => string)' - uid: botframework-config.AzureService.encrypt - package: botframework-config - summary: Encrypt properties on this service. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function encrypt(_secret: string, _encryptString: (value: string, - secret: string) => string) - parameters: - - id: _secret - type: string - description: Secret to use to encrypt the keys in this service. - - id: _encryptString - type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. - inheritanceDescription: >- - Inherited From - [ConnectedService.encrypt](xref:botframework-config.ConnectedService.encrypt) - - name: toJSON() - uid: botframework-config.AzureService.toJSON - package: botframework-config - summary: Creates a JSON based version of the model for saving to disk. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function toJSON(): IConnectedService' - return: - description: An IConnectedService JSON. - type: - inheritanceDescription: >- - Inherited From - [ConnectedService.toJSON](xref:botframework-config.ConnectedService.toJSON) -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/BlobStorageService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/BlobStorageService.yml index 8fc84524..cfc82ad8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/BlobStorageService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/BlobStorageService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines an blob storage service connection. fullName: BlobStorageService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: BlobStorageService(IBlobStorageService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new BlobStorageService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BlobStorageService(source?: IBlobStorageService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: connectionString uid: botframework-config.BlobStorageService.connectionString @@ -31,7 +28,6 @@ properties: summary: Connection string for blob storage. fullName: connectionString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionString: string' @@ -44,7 +40,6 @@ properties: summary: (Optional) container name. fullName: container remarks: '' - isPreview: false isDeprecated: false syntax: content: 'container: string' @@ -58,135 +53,110 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.id](xref:botframework-config.ConnectedService.id) + inheritanceDescription: Inherited From AzureService.id - name: name uid: botframework-config.BlobStorageService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.name](xref:botframework-config.ConnectedService.name) + inheritanceDescription: Inherited From AzureService.name - name: resourceGroup uid: botframework-config.BlobStorageService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.resourceGroup](xref:botframework-config.AzureService.resourceGroup) + inheritanceDescription: Inherited From AzureService.resourceGroup - name: serviceName uid: botframework-config.BlobStorageService.serviceName package: botframework-config summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.serviceName](xref:botframework-config.AzureService.serviceName) + inheritanceDescription: Inherited From AzureService.serviceName - name: subscriptionId uid: botframework-config.BlobStorageService.subscriptionId package: botframework-config summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.subscriptionId](xref:botframework-config.AzureService.subscriptionId) + inheritanceDescription: Inherited From AzureService.subscriptionId - name: tenantId uid: botframework-config.BlobStorageService.tenantId package: botframework-config summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.tenantId](xref:botframework-config.AzureService.tenantId) + inheritanceDescription: Inherited From AzureService.tenantId - name: type uid: botframework-config.BlobStorageService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' return: description: '' type: - inheritanceDescription: >- - Inherited From - [ConnectedService.type](xref:botframework-config.ConnectedService.type) + inheritanceDescription: Inherited From AzureService.type inheritedMethods: - name: toJSON() uid: botframework-config.BlobStorageService.toJSON package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' return: description: An IConnectedService JSON. type: - inheritanceDescription: >- - Inherited From - [ConnectedService.toJSON](xref:botframework-config.ConnectedService.toJSON) + inheritanceDescription: Inherited From AzureService.toJSON methods: - name: 'decrypt(string, (value: string, secret: string) => string)' uid: botframework-config.BlobStorageService.decrypt package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -198,14 +168,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.BlobStorageService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -217,6 +185,5 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. -extends: + description: Function called to encrypt an individual value. +extends: AzureService diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfiguration.yml index d63e3ebf..f4ad8314 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfiguration.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: BotConfiguration remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: BotConfiguration() @@ -15,7 +14,6 @@ constructors: package: botframework-config summary: Creates a new BotConfigurationBase instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: new BotConfiguration() @@ -26,7 +24,6 @@ inheritedProperties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -42,7 +39,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -58,7 +54,6 @@ inheritedProperties: summary: '' fullName: padlock remarks: '' - isPreview: false isDeprecated: false syntax: content: 'padlock: string' @@ -74,13 +69,12 @@ inheritedProperties: summary: '' fullName: services remarks: '' - isPreview: false isDeprecated: false syntax: content: 'services: IConnectedService[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [BotConfigurationBase.services](xref:botframework-config.BotConfigurationBase.services) @@ -90,7 +84,6 @@ inheritedProperties: summary: '' fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' @@ -106,7 +99,6 @@ inheritedMethods: package: botframework-config summary: Connect a service to the bot file. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connectService(newService: IConnectedService): string' @@ -125,15 +117,13 @@ inheritedMethods: package: botframework-config summary: Remove service by id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function disconnectService(id: string)' parameters: - id: id type: string - description: | - ID of the service to remove. + description: ID of the service to remove. inheritanceDescription: >- Inherited From [BotConfigurationBase.disconnectService](xref:botframework-config.BotConfigurationBase.disconnectService) @@ -142,7 +132,6 @@ inheritedMethods: package: botframework-config summary: Remove service by name or id. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,7 +152,6 @@ inheritedMethods: package: botframework-config summary: Find service by id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function findService(id: string): IConnectedService' @@ -182,7 +170,6 @@ inheritedMethods: package: botframework-config summary: Find service by name or id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function findServiceByNameOrId(nameOrId: string): IConnectedService' @@ -203,7 +190,6 @@ inheritedMethods: Loads a ConnectedService instance given a JSON based service configuration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,7 +210,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the current bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IBotConfiguration' @@ -240,7 +225,6 @@ methods: package: botframework-config summary: Clear secret. remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearSecret() @@ -249,35 +233,30 @@ methods: package: botframework-config summary: Decrypt all values in the in memory config. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function decrypt(secret?: string)' parameters: - id: secret type: string - description: | - Secret to decrypt. + description: Secret to decrypt. - name: encrypt(string) uid: botframework-config.BotConfiguration.encrypt package: botframework-config summary: Encrypt all values in the in memory config. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function encrypt(secret: string)' parameters: - id: secret type: string - description: | - Secret to encrypt. + description: Secret to encrypt. - name: fromJSON(Partial) uid: botframework-config.BotConfiguration.fromJSON package: botframework-config summary: Load the bot configuration from a JSON. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -295,7 +274,6 @@ methods: package: botframework-config summary: Generate a new key suitable for encrypting. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function generateKey(): string' @@ -311,19 +289,17 @@ methods: Gets the path that this config was loaded from. .save() will save to this path. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getPath(): string' return: description: The path. type: string - - name: 'load(string, string)' + - name: load(string, string) uid: botframework-config.BotConfiguration.load package: botframework-config summary: Load the configuration from a .bot file. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -339,7 +315,7 @@ methods: return: description: A Promise with the new BotConfiguration instance. type: Promise<> - - name: 'loadBotFromFolder(string, string)' + - name: loadBotFromFolder(string, string) uid: botframework-config.BotConfiguration.loadBotFromFolder package: botframework-config summary: >- @@ -348,7 +324,6 @@ methods: folder. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -366,7 +341,7 @@ methods: return: description: A Promise with the new BotConfiguration instance. type: Promise<> - - name: 'loadBotFromFolderSync(string, string)' + - name: loadBotFromFolderSync(string, string) uid: botframework-config.BotConfiguration.loadBotFromFolderSync package: botframework-config summary: >- @@ -375,7 +350,6 @@ methods: folder. (blocking) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -393,12 +367,11 @@ methods: return: description: A new BotConfiguration instance. type: - - name: 'loadSync(string, string)' + - name: loadSync(string, string) uid: botframework-config.BotConfiguration.loadSync package: botframework-config summary: Load the configuration from a .bot file. (blocking) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -419,7 +392,6 @@ methods: package: botframework-config summary: Save the file with secret. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function save(secret?: string): Promise' @@ -430,12 +402,11 @@ methods: return: description: A promise representing the asynchronous operation. type: Promise<void> - - name: 'saveAs(string, string)' + - name: saveAs(string, string) uid: botframework-config.BotConfiguration.saveAs package: botframework-config summary: Save the configuration to a .bot file. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveAs(botpath: string, secret?: string): Promise' @@ -445,17 +416,15 @@ methods: description: Path to bot file. - id: secret type: string - description: | - (Optional) secret used to encrypt the bot file. + description: (Optional) secret used to encrypt the bot file. return: description: '' type: Promise<void> - - name: 'saveAsSync(string, string)' + - name: saveAsSync(string, string) uid: botframework-config.BotConfiguration.saveAsSync package: botframework-config summary: Save the configuration to a .bot file. (blocking) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveAsSync(botpath: string, secret?: string)' @@ -465,34 +434,29 @@ methods: description: Path to bot file. - id: secret type: string - description: | - (Optional) secret used to encrypt the bot file. + description: (Optional) secret used to encrypt the bot file. - name: saveSync(string) uid: botframework-config.BotConfiguration.saveSync package: botframework-config summary: Save the file with secret. (blocking) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveSync(secret?: string)' parameters: - id: secret type: string - description: | - (Optional) secret used to encrypt the bot file. + description: (Optional) secret used to encrypt the bot file. - name: validateSecret(string) uid: botframework-config.BotConfiguration.validateSecret package: botframework-config summary: Make sure secret is correct by decrypting the secretKey with it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateSecret(secret: string)' parameters: - id: secret type: string - description: | - Secret to use. + description: Secret to use. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfigurationBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfigurationBase.yml index edb0610b..64c25ec2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfigurationBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/BotConfigurationBase.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: BotConfigurationBase remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: BotConfigurationBase() @@ -15,7 +14,6 @@ constructors: package: botframework-config summary: Creates a new BotConfigurationBase instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: new BotConfigurationBase() @@ -26,7 +24,6 @@ properties: summary: '' fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -39,7 +36,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -52,7 +48,6 @@ properties: summary: '' fullName: padlock remarks: '' - isPreview: false isDeprecated: false syntax: content: 'padlock: string' @@ -65,20 +60,18 @@ properties: summary: '' fullName: services remarks: '' - isPreview: false isDeprecated: false syntax: content: 'services: IConnectedService[]' return: description: '' - type: '[]' + type: [] - name: version uid: botframework-config.BotConfigurationBase.version package: botframework-config summary: '' fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' @@ -91,7 +84,6 @@ methods: package: botframework-config summary: Connect a service to the bot file. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connectService(newService: IConnectedService): string' @@ -107,21 +99,18 @@ methods: package: botframework-config summary: Remove service by id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function disconnectService(id: string)' parameters: - id: id type: string - description: | - ID of the service to remove. + description: ID of the service to remove. - name: disconnectServiceByNameOrId(string) uid: botframework-config.BotConfigurationBase.disconnectServiceByNameOrId package: botframework-config summary: Remove service by name or id. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -139,7 +128,6 @@ methods: package: botframework-config summary: Find service by id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function findService(id: string): IConnectedService' @@ -155,7 +143,6 @@ methods: package: botframework-config summary: Find service by name or id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function findServiceByNameOrId(nameOrId: string): IConnectedService' @@ -173,7 +160,6 @@ methods: Loads a new BotConfigurationBase instance given a JSON based configuration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -193,7 +179,6 @@ methods: Loads a ConnectedService instance given a JSON based service configuration. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -211,7 +196,6 @@ methods: package: botframework-config summary: Creates a JSON based version of the current bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IBotConfiguration' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/BotService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/BotService.yml index 21b317cf..55b73b98 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/BotService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/BotService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines an Azure Bot Service connection. fullName: BotService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: BotService(IBotService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new BotService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BotService(source?: IBotService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: appId uid: botframework-config.BotService.appId @@ -31,7 +28,6 @@ properties: summary: MSA App ID for the bot. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -45,135 +41,110 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.id](xref:botframework-config.ConnectedService.id) + inheritanceDescription: Inherited From AzureService.id - name: name uid: botframework-config.BotService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.name](xref:botframework-config.ConnectedService.name) + inheritanceDescription: Inherited From AzureService.name - name: resourceGroup uid: botframework-config.BotService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.resourceGroup](xref:botframework-config.AzureService.resourceGroup) + inheritanceDescription: Inherited From AzureService.resourceGroup - name: serviceName uid: botframework-config.BotService.serviceName package: botframework-config summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.serviceName](xref:botframework-config.AzureService.serviceName) + inheritanceDescription: Inherited From AzureService.serviceName - name: subscriptionId uid: botframework-config.BotService.subscriptionId package: botframework-config summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.subscriptionId](xref:botframework-config.AzureService.subscriptionId) + inheritanceDescription: Inherited From AzureService.subscriptionId - name: tenantId uid: botframework-config.BotService.tenantId package: botframework-config summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.tenantId](xref:botframework-config.AzureService.tenantId) + inheritanceDescription: Inherited From AzureService.tenantId - name: type uid: botframework-config.BotService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' return: description: '' type: - inheritanceDescription: >- - Inherited From - [ConnectedService.type](xref:botframework-config.ConnectedService.type) + inheritanceDescription: Inherited From AzureService.type inheritedMethods: - name: toJSON() uid: botframework-config.BotService.toJSON package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' return: description: An IConnectedService JSON. type: - inheritanceDescription: >- - Inherited From - [ConnectedService.toJSON](xref:botframework-config.ConnectedService.toJSON) + inheritanceDescription: Inherited From AzureService.toJSON methods: - name: 'decrypt(string, (value: string, secret: string) => string)' uid: botframework-config.BotService.decrypt package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -185,14 +156,12 @@ methods: description: Secret to use to decrypt. - id: _decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.BotService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -204,6 +173,5 @@ methods: description: Secret to use to encrypt. - id: _encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. -extends: + description: Function called to encrypt an individual value. +extends: AzureService diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/ConnectedService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/ConnectedService.yml index 25db0d7d..662eafb0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/ConnectedService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/ConnectedService.yml @@ -5,17 +5,15 @@ package: botframework-config summary: Base class for all connected service definitions. fullName: ConnectedService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - - name: 'ConnectedService(IConnectedService, ServiceTypes)' + - name: ConnectedService(IConnectedService, ServiceTypes) uid: botframework-config.ConnectedService.constructor package: botframework-config summary: Creates a new ConnectedService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ConnectedService(source?: IConnectedService, type?: ServiceTypes)' @@ -25,8 +23,7 @@ constructors: description: (Optional) JSON based service definition. - id: type type: - description: | - (Optional) type of service being defined. + description: (Optional) type of service being defined. properties: - name: id uid: botframework-config.ConnectedService.id @@ -34,7 +31,6 @@ properties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -47,7 +43,6 @@ properties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -57,10 +52,9 @@ properties: - name: type uid: botframework-config.ConnectedService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -73,7 +67,6 @@ methods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -85,14 +78,12 @@ methods: description: Secret to use to decrypt the keys in this service. - id: _decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.ConnectedService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -104,14 +95,12 @@ methods: description: Secret to use to encrypt the keys in this service. - id: _encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. - name: toJSON() uid: botframework-config.ConnectedService.toJSON package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/CosmosDbService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/CosmosDbService.yml index 009f2565..0e86b7b0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/CosmosDbService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/CosmosDbService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines a CosmosDB service connection. fullName: CosmosDbService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: CosmosDbService(ICosmosDBService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new CosmosDBService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CosmosDbService(source?: ICosmosDBService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: collection uid: botframework-config.CosmosDbService.collection @@ -31,7 +28,6 @@ properties: summary: Collection name. fullName: collection remarks: '' - isPreview: false isDeprecated: false syntax: content: 'collection: string' @@ -44,7 +40,6 @@ properties: summary: Database name. fullName: database remarks: '' - isPreview: false isDeprecated: false syntax: content: 'database: string' @@ -57,7 +52,6 @@ properties: summary: Endpoint/uri for CosmosDB. fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpoint: string' @@ -70,7 +64,6 @@ properties: summary: Key for accessing CosmosDB. fullName: key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'key: string' @@ -84,135 +77,110 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.id](xref:botframework-config.ConnectedService.id) + inheritanceDescription: Inherited From AzureService.id - name: name uid: botframework-config.CosmosDbService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ConnectedService.name](xref:botframework-config.ConnectedService.name) + inheritanceDescription: Inherited From AzureService.name - name: resourceGroup uid: botframework-config.CosmosDbService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.resourceGroup](xref:botframework-config.AzureService.resourceGroup) + inheritanceDescription: Inherited From AzureService.resourceGroup - name: serviceName uid: botframework-config.CosmosDbService.serviceName package: botframework-config summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.serviceName](xref:botframework-config.AzureService.serviceName) + inheritanceDescription: Inherited From AzureService.serviceName - name: subscriptionId uid: botframework-config.CosmosDbService.subscriptionId package: botframework-config summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.subscriptionId](xref:botframework-config.AzureService.subscriptionId) + inheritanceDescription: Inherited From AzureService.subscriptionId - name: tenantId uid: botframework-config.CosmosDbService.tenantId package: botframework-config summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [AzureService.tenantId](xref:botframework-config.AzureService.tenantId) + inheritanceDescription: Inherited From AzureService.tenantId - name: type uid: botframework-config.CosmosDbService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' return: description: '' type: - inheritanceDescription: >- - Inherited From - [ConnectedService.type](xref:botframework-config.ConnectedService.type) + inheritanceDescription: Inherited From AzureService.type inheritedMethods: - name: toJSON() uid: botframework-config.CosmosDbService.toJSON package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' return: description: An IConnectedService JSON. type: - inheritanceDescription: >- - Inherited From - [ConnectedService.toJSON](xref:botframework-config.ConnectedService.toJSON) + inheritanceDescription: Inherited From AzureService.toJSON methods: - name: 'decrypt(string, (value: string, secret: string) => string)' uid: botframework-config.CosmosDbService.decrypt package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,14 +192,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.CosmosDbService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -243,6 +209,5 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. -extends: + description: Function called to encrypt an individual value. +extends: AzureService diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/DispatchService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/DispatchService.yml index e4e38eb6..9437c1ad 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/DispatchService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/DispatchService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines a dispatch service connection. fullName: DispatchService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: DispatchService(IDispatchService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new DispatchService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DispatchService(source?: IDispatchService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: serviceIds uid: botframework-config.DispatchService.serviceIds @@ -31,13 +28,12 @@ properties: summary: Service IDs that the dispatch model will dispatch across. fullName: serviceIds remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceIds: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: appId uid: botframework-config.DispatchService.appId @@ -45,7 +41,6 @@ inheritedProperties: summary: Luis app ID. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -61,7 +56,6 @@ inheritedProperties: summary: Authoring key for using authoring api. fullName: authoringKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authoringKey: string' @@ -82,7 +76,6 @@ inheritedProperties: Custom Endpoint. fullName: customEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'customEndpoint: string' @@ -98,7 +91,6 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -107,14 +99,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [ConnectedService.id](xref:botframework-config.ConnectedService.id) + [LuisService.id](xref:botframework-config.LuisService.id) - name: name uid: botframework-config.DispatchService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -123,14 +114,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [ConnectedService.name](xref:botframework-config.ConnectedService.name) + [LuisService.name](xref:botframework-config.LuisService.name) - name: region uid: botframework-config.DispatchService.region package: botframework-config summary: Region for luis. fullName: region remarks: '' - isPreview: false isDeprecated: false syntax: content: 'region: string' @@ -146,7 +136,6 @@ inheritedProperties: summary: Subscription key for using calling model api for predictions. fullName: subscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionKey: string' @@ -159,10 +148,9 @@ inheritedProperties: - name: type uid: botframework-config.DispatchService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -171,14 +159,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [ConnectedService.type](xref:botframework-config.ConnectedService.type) + [LuisService.type](xref:botframework-config.LuisService.type) - name: version uid: botframework-config.DispatchService.version package: botframework-config summary: Version of the application. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' @@ -194,7 +181,6 @@ inheritedMethods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -206,8 +192,7 @@ inheritedMethods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. inheritanceDescription: >- Inherited From [LuisService.decrypt](xref:botframework-config.LuisService.decrypt) @@ -216,7 +201,6 @@ inheritedMethods: package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -228,8 +212,7 @@ inheritedMethods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. inheritanceDescription: >- Inherited From [LuisService.encrypt](xref:botframework-config.LuisService.encrypt) @@ -242,7 +225,6 @@ inheritedMethods: otherwise the endpoint is automatically generated based on the region set. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getEndpoint(): string' @@ -257,7 +239,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' @@ -266,5 +247,5 @@ inheritedMethods: type: inheritanceDescription: >- Inherited From - [ConnectedService.toJSON](xref:botframework-config.ConnectedService.toJSON) + [LuisService.toJSON](xref:botframework-config.LuisService.toJSON) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/EndpointService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/EndpointService.yml index 70d32c59..c8da23d4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/EndpointService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/EndpointService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines an endpoint service connection. fullName: EndpointService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: EndpointService(IEndpointService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new EndpointService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new EndpointService(source: IEndpointService)' parameters: - id: source type: - description: | - JSON based service definition. + description: JSON based service definition. properties: - name: appId uid: botframework-config.EndpointService.appId @@ -31,7 +28,6 @@ properties: summary: MSA App ID. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -44,7 +40,6 @@ properties: summary: MSA app password for the bot. fullName: appPassword remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appPassword: string' @@ -63,7 +58,6 @@ properties: An undefined or null value means the bot will be talking to public Azure fullName: channelService remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelService: string' @@ -76,7 +70,6 @@ properties: summary: Endpoint of localhost service. fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpoint: string' @@ -90,7 +83,6 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -106,7 +98,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -119,10 +110,9 @@ inheritedProperties: - name: type uid: botframework-config.EndpointService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -138,7 +128,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' @@ -154,7 +143,6 @@ methods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -166,14 +154,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.EndpointService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -185,6 +171,5 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/FileService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/FileService.yml index 38d153ca..705c5bbb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/FileService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/FileService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines an file service connection. fullName: FileService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: FileService(IFileService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new FileService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new FileService(source?: IFileService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: path uid: botframework-config.FileService.path @@ -31,7 +28,6 @@ properties: summary: File path. fullName: path remarks: '' - isPreview: false isDeprecated: false syntax: content: 'path: string' @@ -45,7 +41,6 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -61,7 +56,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -74,10 +68,9 @@ inheritedProperties: - name: type uid: botframework-config.FileService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -93,7 +86,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' @@ -109,7 +101,6 @@ methods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -121,14 +112,12 @@ methods: description: Secret to use to decrypt. - id: _decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.FileService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -140,6 +129,5 @@ methods: description: Secret to use to encrypt. - id: _encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/GenericService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/GenericService.yml index 5754aae8..0cfdddb9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/GenericService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/GenericService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines a generic service connection. fullName: GenericService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: GenericService(IGenericService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new GenericService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new GenericService(source?: IGenericService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: configuration uid: botframework-config.GenericService.configuration @@ -31,20 +28,18 @@ properties: summary: Named/value configuration data. fullName: configuration remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'configuration: [key: string]: string' + content: 'configuration: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: url uid: botframework-config.GenericService.url package: botframework-config summary: Deep link to service. fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url: string' @@ -58,7 +53,6 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -74,7 +68,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -87,10 +80,9 @@ inheritedProperties: - name: type uid: botframework-config.GenericService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -106,7 +98,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' @@ -122,7 +113,6 @@ methods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -134,14 +124,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.GenericService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -153,6 +141,5 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IAppInsightsService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IAppInsightsService.yml index 4e065a2b..46ef02fc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IAppInsightsService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IAppInsightsService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IAppInsightsService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: apiKeys @@ -16,20 +15,18 @@ properties: summary: (Optional) named api keys for programmatic access to AppInsights. fullName: apiKeys remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'apiKeys?: [key: string]: string' + content: 'apiKeys?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: applicationId uid: botframework-config.IAppInsightsService.applicationId package: botframework-config summary: (Optional) application ID used for programmatic access to AppInsights. fullName: applicationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationId?: string' @@ -42,7 +39,6 @@ properties: summary: Instrumentation key for logging data to appInsights. fullName: instrumentationKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'instrumentationKey: string' @@ -56,7 +52,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -65,14 +60,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.id](xref:botframework-config.IConnectedService.id) + [IAzureService.id](xref:botframework-config.IAzureService.id) - name: name uid: botframework-config.IAppInsightsService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -81,14 +75,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.name](xref:botframework-config.IConnectedService.name) + [IAzureService.name](xref:botframework-config.IAzureService.name) - name: resourceGroup uid: botframework-config.IAppInsightsService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' @@ -104,7 +97,6 @@ inheritedProperties: summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' @@ -120,7 +112,6 @@ inheritedProperties: summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' @@ -136,7 +127,6 @@ inheritedProperties: summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' @@ -149,10 +139,9 @@ inheritedProperties: - name: type uid: botframework-config.IAppInsightsService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -161,5 +150,5 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [IConnectedService.type](xref:botframework-config.IConnectedService.type) + [IAzureService.type](xref:botframework-config.IAzureService.type) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IAzureService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IAzureService.yml index b7c50716..4da81eea 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IAzureService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IAzureService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IAzureService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: resourceGroup @@ -16,7 +15,6 @@ properties: summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' @@ -29,7 +27,6 @@ properties: summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' @@ -42,7 +39,6 @@ properties: summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' @@ -55,7 +51,6 @@ properties: summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' @@ -69,7 +64,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -85,7 +79,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -98,10 +91,9 @@ inheritedProperties: - name: type uid: botframework-config.IAzureService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IBlobStorageService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IBlobStorageService.yml index e30a1fad..130fe211 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IBlobStorageService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IBlobStorageService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IBlobStorageService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: connectionString @@ -16,7 +15,6 @@ properties: summary: Connection string for blob storage. fullName: connectionString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionString: string' @@ -29,13 +27,12 @@ properties: summary: (Optional) container name. fullName: container remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'container?: string | null' + content: 'container?: null | string' return: description: '' - type: string | null + type: null | string inheritedProperties: - name: id uid: botframework-config.IBlobStorageService.id @@ -43,7 +40,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -52,14 +48,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.id](xref:botframework-config.IConnectedService.id) + [IAzureService.id](xref:botframework-config.IAzureService.id) - name: name uid: botframework-config.IBlobStorageService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -68,14 +63,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.name](xref:botframework-config.IConnectedService.name) + [IAzureService.name](xref:botframework-config.IAzureService.name) - name: resourceGroup uid: botframework-config.IBlobStorageService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' @@ -91,7 +85,6 @@ inheritedProperties: summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' @@ -107,7 +100,6 @@ inheritedProperties: summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' @@ -123,7 +115,6 @@ inheritedProperties: summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' @@ -136,10 +127,9 @@ inheritedProperties: - name: type uid: botframework-config.IBlobStorageService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -148,5 +138,5 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [IConnectedService.type](xref:botframework-config.IConnectedService.type) + [IAzureService.type](xref:botframework-config.IAzureService.type) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotConfiguration.yml index ac84a139..a9c537a4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotConfiguration.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IBotConfiguration remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: description @@ -16,7 +15,6 @@ properties: summary: Description of the bot. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description: string' @@ -29,7 +27,6 @@ properties: summary: Name of the bot. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -46,7 +43,6 @@ properties: will use the secret to encrypt new values. - isPreview: false isDeprecated: false syntax: content: 'padlock: string' @@ -59,20 +55,18 @@ properties: summary: Connected services for the bot. fullName: services remarks: '' - isPreview: false isDeprecated: false syntax: content: 'services: IConnectedService[]' return: description: '' - type: '[]' + type: [] - name: version uid: botframework-config.IBotConfiguration.version package: botframework-config summary: Version of the schema of this file. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotService.yml index c521dfa2..8c3d558a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IBotService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IBotService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: appId @@ -16,7 +15,6 @@ properties: summary: MSA App ID for the bot. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -30,7 +28,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -39,14 +36,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.id](xref:botframework-config.IConnectedService.id) + [IAzureService.id](xref:botframework-config.IAzureService.id) - name: name uid: botframework-config.IBotService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -55,14 +51,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.name](xref:botframework-config.IConnectedService.name) + [IAzureService.name](xref:botframework-config.IAzureService.name) - name: resourceGroup uid: botframework-config.IBotService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' @@ -78,7 +73,6 @@ inheritedProperties: summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' @@ -94,7 +88,6 @@ inheritedProperties: summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' @@ -110,7 +103,6 @@ inheritedProperties: summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' @@ -123,10 +115,9 @@ inheritedProperties: - name: type uid: botframework-config.IBotService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -135,5 +126,5 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [IConnectedService.type](xref:botframework-config.IConnectedService.type) + [IAzureService.type](xref:botframework-config.IAzureService.type) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IConnectedService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IConnectedService.yml index 0966a46c..e06c3a1b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IConnectedService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IConnectedService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IConnectedService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: id @@ -16,7 +15,6 @@ properties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -29,7 +27,6 @@ properties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -39,10 +36,9 @@ properties: - name: type uid: botframework-config.IConnectedService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/ICosmosDBService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/ICosmosDBService.yml index 9d64583d..97b13a2a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/ICosmosDBService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/ICosmosDBService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: ICosmosDBService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: collection @@ -16,7 +15,6 @@ properties: summary: Collection name. fullName: collection remarks: '' - isPreview: false isDeprecated: false syntax: content: 'collection: string' @@ -29,7 +27,6 @@ properties: summary: Database name. fullName: database remarks: '' - isPreview: false isDeprecated: false syntax: content: 'database: string' @@ -42,7 +39,6 @@ properties: summary: Endpoint/uri for CosmosDB. fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpoint: string' @@ -55,7 +51,6 @@ properties: summary: Key for accessing CosmosDB. fullName: key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'key: string' @@ -69,7 +64,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -78,14 +72,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.id](xref:botframework-config.IConnectedService.id) + [IAzureService.id](xref:botframework-config.IAzureService.id) - name: name uid: botframework-config.ICosmosDBService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -94,14 +87,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.name](xref:botframework-config.IConnectedService.name) + [IAzureService.name](xref:botframework-config.IAzureService.name) - name: resourceGroup uid: botframework-config.ICosmosDBService.resourceGroup package: botframework-config summary: Resource group for azure. fullName: resourceGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceGroup: string' @@ -117,7 +109,6 @@ inheritedProperties: summary: Name of the service. fullName: serviceName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceName: string' @@ -133,7 +124,6 @@ inheritedProperties: summary: Subscription ID for azure. fullName: subscriptionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionId: string' @@ -149,7 +139,6 @@ inheritedProperties: summary: Tenant ID for azure. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' @@ -162,10 +151,9 @@ inheritedProperties: - name: type uid: botframework-config.ICosmosDBService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -174,5 +162,5 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [IConnectedService.type](xref:botframework-config.IConnectedService.type) + [IAzureService.type](xref:botframework-config.IAzureService.type) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IDispatchService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IDispatchService.yml index 2b452515..e08b9752 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IDispatchService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IDispatchService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IDispatchService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: serviceIds @@ -16,13 +15,12 @@ properties: summary: Service IDs that the dispatch model will dispatch across. fullName: serviceIds remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceIds: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: appId uid: botframework-config.IDispatchService.appId @@ -30,7 +28,6 @@ inheritedProperties: summary: Luis app ID. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -46,7 +43,6 @@ inheritedProperties: summary: Authoring key for using authoring api. fullName: authoringKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authoringKey: string' @@ -62,7 +58,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -71,14 +66,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.id](xref:botframework-config.IConnectedService.id) + [ILuisService.id](xref:botframework-config.ILuisService.id) - name: name uid: botframework-config.IDispatchService.name package: botframework-config summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -87,14 +81,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [IConnectedService.name](xref:botframework-config.IConnectedService.name) + [ILuisService.name](xref:botframework-config.ILuisService.name) - name: region uid: botframework-config.IDispatchService.region package: botframework-config summary: Region for luis. fullName: region remarks: '' - isPreview: false isDeprecated: false syntax: content: 'region: string' @@ -110,7 +103,6 @@ inheritedProperties: summary: Subscription key for using calling model api for predictions. fullName: subscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionKey: string' @@ -123,10 +115,9 @@ inheritedProperties: - name: type uid: botframework-config.IDispatchService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -135,14 +126,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [IConnectedService.type](xref:botframework-config.IConnectedService.type) + [ILuisService.type](xref:botframework-config.ILuisService.type) - name: version uid: botframework-config.IDispatchService.version package: botframework-config summary: Version of the application. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' @@ -158,7 +148,6 @@ inheritedMethods: package: botframework-config summary: getEndpoint() Returns the full region endpoint for the LUIS service. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getEndpoint(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IEndpointService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IEndpointService.yml index 51e5c199..ba63a3f5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IEndpointService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IEndpointService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IEndpointService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: appId @@ -16,7 +15,6 @@ properties: summary: MSA App ID. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -29,7 +27,6 @@ properties: summary: MSA app password for the bot. fullName: appPassword remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appPassword: string' @@ -48,7 +45,6 @@ properties: An undefined or null value means the bot will be talking to public Azure fullName: channelService remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelService?: string' @@ -61,7 +57,6 @@ properties: summary: Endpoint of localhost service. fullName: endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpoint: string' @@ -75,7 +70,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -91,7 +85,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -104,10 +97,9 @@ inheritedProperties: - name: type uid: botframework-config.IEndpointService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IFileService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IFileService.yml index 3165bd23..da886aed 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IFileService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IFileService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IFileService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: path @@ -16,7 +15,6 @@ properties: summary: File path. fullName: path remarks: '' - isPreview: false isDeprecated: false syntax: content: 'path: string' @@ -30,7 +28,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -46,7 +43,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -59,10 +55,9 @@ inheritedProperties: - name: type uid: botframework-config.IFileService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IGenericService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IGenericService.yml index cb198116..d29a4d04 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IGenericService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IGenericService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IGenericService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: configuration @@ -16,20 +15,18 @@ properties: summary: Named/value configuration data. fullName: configuration remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'configuration: [key: string]: string' + content: 'configuration: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' - name: url uid: botframework-config.IGenericService.url package: botframework-config summary: Deep link to service. fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url: string' @@ -43,7 +40,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -59,7 +55,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -72,10 +67,9 @@ inheritedProperties: - name: type uid: botframework-config.IGenericService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/ILuisService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/ILuisService.yml index 1944dda3..59352ab9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/ILuisService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/ILuisService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: ILuisService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: appId @@ -16,7 +15,6 @@ properties: summary: Luis app ID. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -29,7 +27,6 @@ properties: summary: Authoring key for using authoring api. fullName: authoringKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authoringKey: string' @@ -42,7 +39,6 @@ properties: summary: Region for luis. fullName: region remarks: '' - isPreview: false isDeprecated: false syntax: content: 'region: string' @@ -55,7 +51,6 @@ properties: summary: Subscription key for using calling model api for predictions. fullName: subscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionKey: string' @@ -68,7 +63,6 @@ properties: summary: Version of the application. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' @@ -82,7 +76,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -98,7 +91,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -111,10 +103,9 @@ inheritedProperties: - name: type uid: botframework-config.ILuisService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -130,7 +121,6 @@ methods: package: botframework-config summary: getEndpoint() Returns the full region endpoint for the LUIS service. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getEndpoint(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/IQnAService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/IQnAService.yml index c159a9da..ed3ef3a0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/IQnAService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/IQnAService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: IQnAService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: interface properties: - name: endpointKey @@ -16,7 +15,6 @@ properties: summary: Endpoint Key for querying the kb. fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: string' @@ -31,7 +29,6 @@ properties: https://myqna.azurewebsites.net. fullName: hostname remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hostname: string' @@ -44,7 +41,6 @@ properties: summary: Knowledge base id. fullName: kbId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'kbId: string' @@ -57,7 +53,6 @@ properties: summary: Subscription key for calling admin api. fullName: subscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionKey: string' @@ -71,7 +66,6 @@ inheritedProperties: summary: (Optional) unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -87,7 +81,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -100,10 +93,9 @@ inheritedProperties: - name: type uid: botframework-config.IQnAService.type package: botframework-config - summary: '(Optional) ServiceType of the service (LUIS, QnA, etc.)' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/LuisService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/LuisService.yml index 5918e77d..33b5a0ef 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/LuisService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/LuisService.yml @@ -5,17 +5,15 @@ package: botframework-config summary: Defines a LUIS service connection. fullName: LuisService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - - name: 'LuisService(ILuisService, ServiceTypes)' + - name: LuisService(ILuisService, ServiceTypes) uid: botframework-config.LuisService.constructor package: botframework-config summary: Creates a new LuisService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new LuisService(source?: ILuisService, serviceType?: ServiceTypes)' @@ -25,8 +23,7 @@ constructors: description: (Optional) JSON based service definition. - id: serviceType type: - description: | - (Optional) type of service being defined. + description: (Optional) type of service being defined. properties: - name: appId uid: botframework-config.LuisService.appId @@ -34,7 +31,6 @@ properties: summary: Luis app ID. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -47,7 +43,6 @@ properties: summary: Authoring key for using authoring api. fullName: authoringKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authoringKey: string' @@ -65,7 +60,6 @@ properties: Custom Endpoint. fullName: customEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'customEndpoint: string' @@ -78,7 +72,6 @@ properties: summary: Region for luis. fullName: region remarks: '' - isPreview: false isDeprecated: false syntax: content: 'region: string' @@ -91,7 +84,6 @@ properties: summary: Subscription key for using calling model api for predictions. fullName: subscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionKey: string' @@ -104,7 +96,6 @@ properties: summary: Version of the application. fullName: version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'version: string' @@ -118,7 +109,6 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -134,7 +124,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -147,10 +136,9 @@ inheritedProperties: - name: type uid: botframework-config.LuisService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -166,7 +154,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' @@ -182,7 +169,6 @@ methods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -194,14 +180,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.LuisService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -213,8 +197,7 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. - name: getEndpoint() uid: botframework-config.LuisService.getEndpoint package: botframework-config @@ -224,7 +207,6 @@ methods: otherwise the endpoint is automatically generated based on the region set. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getEndpoint(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/QnaMakerService.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/QnaMakerService.yml index f750df78..418ba7dc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/QnaMakerService.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/QnaMakerService.yml @@ -5,9 +5,8 @@ package: botframework-config summary: Defines a QnA Maker service connection. fullName: QnaMakerService remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. type: class constructors: - name: QnaMakerService(IQnAService) @@ -15,15 +14,13 @@ constructors: package: botframework-config summary: Creates a new QnaMakerService instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new QnaMakerService(source?: IQnAService)' parameters: - id: source type: - description: | - (Optional) JSON based service definition. + description: (Optional) JSON based service definition. properties: - name: endpointKey uid: botframework-config.QnaMakerService.endpointKey @@ -31,7 +28,6 @@ properties: summary: Endpoint Key for querying the kb. fullName: endpointKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointKey: string' @@ -46,7 +42,6 @@ properties: https://myqna.azurewebsites.net. fullName: hostname remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hostname: string' @@ -59,7 +54,6 @@ properties: summary: Knowledge base id. fullName: kbId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'kbId: string' @@ -72,7 +66,6 @@ properties: summary: Subscription key for calling admin api. fullName: subscriptionKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subscriptionKey: string' @@ -86,7 +79,6 @@ inheritedProperties: summary: Unique Id for the service. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -102,7 +94,6 @@ inheritedProperties: summary: Friendly name for the service. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -115,10 +106,9 @@ inheritedProperties: - name: type uid: botframework-config.QnaMakerService.type package: botframework-config - summary: '' + summary: (Optional) ServiceType of the service (LUIS, QnA, etc.) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: ServiceTypes' @@ -134,7 +124,6 @@ inheritedMethods: package: botframework-config summary: Creates a JSON based version of the model for saving to disk. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): IConnectedService' @@ -150,7 +139,6 @@ methods: package: botframework-config summary: Decrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -162,14 +150,12 @@ methods: description: Secret to use to decrypt. - id: decryptString type: '(value: string, secret: string) => string' - description: | - Function called to decrypt an individual value. + description: Function called to decrypt an individual value. - name: 'encrypt(string, (value: string, secret: string) => string)' uid: botframework-config.QnaMakerService.encrypt package: botframework-config summary: Encrypt properties on this service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -181,6 +167,5 @@ methods: description: Secret to use to encrypt. - id: encryptString type: '(value: string, secret: string) => string' - description: | - Function called to encrypt an individual value. + description: Function called to encrypt an individual value. extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/ServiceTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/ServiceTypes.yml index 6a9ec4d9..202e8972 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/ServiceTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/ServiceTypes.yml @@ -5,9 +5,8 @@ package: botframework-config summary: '' fullName: ServiceTypes remarks: '' -isPreview: false isDeprecated: true -customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.' +customDeprecatedMessage: See https://aka.ms/bot-file-basics for more information. fields: - name: AppInsights uid: botframework-config.ServiceTypes.AppInsights diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-config/index.yml b/botbuilder-typescript/docs-ref-autogen/botframework-config/index.yml index 17947ea0..b81164c0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-config/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-config/index.yml @@ -3,12 +3,13 @@ uid: botframework-config name: botframework-config summary: '' type: package +enums: + - botframework-config.ServiceTypes classes: - - botframework-config.BotConfiguration - - botframework-config.BotConfigurationBase - botframework-config.AppInsightsService - - botframework-config.AzureService - botframework-config.BlobStorageService + - botframework-config.BotConfiguration + - botframework-config.BotConfigurationBase - botframework-config.BotService - botframework-config.ConnectedService - botframework-config.CosmosDbService @@ -18,8 +19,6 @@ classes: - botframework-config.GenericService - botframework-config.LuisService - botframework-config.QnaMakerService -enums: - - botframework-config.ServiceTypes interfaces: - botframework-config.IAppInsightsService - botframework-config.IAzureService diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AadResourceUrls.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AadResourceUrls.yml index 199eda00..9cea462a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AadResourceUrls.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AadResourceUrls.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: AadResourceUrls remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: resourceUrls remarks: '' - isPreview: false isDeprecated: false syntax: content: 'resourceUrls?: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AppCredentials.yml index 46ce64ef..9e2e3403 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AppCredentials.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AppCredentials.yml @@ -2,25 +2,21 @@ name: AppCredentials uid: botframework-connector.AppCredentials package: botframework-connector -summary: >- - General AppCredentials auth implementation and cache. Supports any ADAL client - credential flow. - +summary: |- + General AppCredentials auth implementation and cache. Subclasses can implement refreshToken to acquire the token. fullName: AppCredentials remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AppCredentials(string, string, string)' + - name: AppCredentials(string, string, string) uid: botframework-connector.AppCredentials.constructor package: botframework-connector summary: >- Initializes a new instance of the [AppCredentials](xref:botframework-connector.AppCredentials) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,11 +28,16 @@ constructors: description: The App ID. - id: channelAuthTenant type: string - description: Optional. The oauth token tenant. + description: >- + Tenant ID of the Azure AD tenant where the bot is created. + * Required for SingleTenant app types. + * Optional for MultiTenant app types. **Note**: '_botframework.com_' is the default tenant when no value is provided. + + More information: + https://learn.microsoft.com/en-us/security/zero-trust/develop/identity-supported-account-types. - id: oAuthScope type: string - description: | - The scope for the token. + description: The scope for the token. properties: - name: appId uid: botframework-connector.AppCredentials.appId @@ -44,7 +45,6 @@ properties: summary: '' fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -54,12 +54,9 @@ properties: - name: oAuthEndpoint uid: botframework-connector.AppCredentials.oAuthEndpoint package: botframework-connector - summary: |- - Gets the OAuth endpoint to use. - Sets the OAuth endpoint to use. + summary: Gets the OAuth endpoint to use. fullName: oAuthEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthEndpoint @@ -69,12 +66,9 @@ properties: - name: oAuthScope uid: botframework-connector.AppCredentials.oAuthScope package: botframework-connector - summary: |- - Gets the OAuth scope to use. - Sets the OAuth scope to use. + summary: Gets the OAuth scope to use. fullName: oAuthScope remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthScope @@ -87,7 +81,6 @@ properties: summary: '' fullName: tokenCacheKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenCacheKey: string' @@ -99,8 +92,7 @@ methods: uid: botframework-connector.AppCredentials.getToken package: botframework-connector summary: Gets an OAuth access token. - remarks: 'If the promise is successful, the result contains the access token string.' - isPreview: false + remarks: If the promise is successful, the result contains the access token string. isDeprecated: false syntax: content: 'function getToken(forceRefresh?: boolean): Promise' @@ -118,7 +110,6 @@ methods: package: botframework-connector summary: Checks if the service url is for a trusted host or not. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -135,18 +126,17 @@ methods: package: botframework-connector summary: Apply the credentials to the HTTP request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function signRequest(webResource: WebResource): Promise' parameters: - id: webResource - type: WebResource + type: description: The WebResource HTTP request. return: description: A Promise representing the asynchronous operation. - type: Promise<WebResource> - - name: 'trustServiceUrl(string, Date)' + type: Promise<> + - name: trustServiceUrl(string, Date) uid: botframework-connector.AppCredentials.trustServiceUrl package: botframework-connector summary: >- @@ -155,7 +145,6 @@ methods: If expiration time is not provided, the expiration date will be current (utc) date + 1 day. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AseChannelValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AseChannelValidation.yml new file mode 100644 index 00000000..582c99ff --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AseChannelValidation.yml @@ -0,0 +1,59 @@ +### YamlMime:TSPackage +uid: botframework-connector.AseChannelValidation +name: AseChannelValidation +type: module +package: botframework-connector +summary: '' +functions: + - name: authenticateAseChannelToken(string, AuthenticationConfiguration) + uid: botframework-connector.AseChannelValidation.authenticateAseChannelToken + package: botframework-connector + summary: >- + Validate the incoming Auth Header as a token sent from the Bot Framework + AseChannel. + + A token issued by the Bot Framework will FAIL this check. Only AseChannel + tokens will pass. + remarks: '' + isDeprecated: false + syntax: + content: >- + function authenticateAseChannelToken(authHeader: string, authConfig?: + AuthenticationConfiguration): Promise + parameters: + - id: authHeader + type: string + description: 'The raw HTTP header in the format: ''Bearer [longString]''' + - id: authConfig + type: + description: The authentication configuration. + return: + description: A valid ClaimsIdentity. + type: Promise<> + - name: init(any) + uid: botframework-connector.AseChannelValidation.init + package: botframework-connector + summary: init authentication from user .env configuration. + remarks: '' + isDeprecated: false + syntax: + content: 'function init(configuration: any)' + parameters: + - id: configuration + type: any + description: The user .env configuration. + - name: isTokenFromAseChannel(string) + uid: botframework-connector.AseChannelValidation.isTokenFromAseChannel + package: botframework-connector + summary: Determines if a given Auth header is from the Bot Framework AseChannel + remarks: '' + isDeprecated: false + syntax: + content: 'function isTokenFromAseChannel(channelId: string): boolean' + parameters: + - id: channelId + type: string + description: The channelId. + return: + description: True, if the token was issued by the AseChannel. Otherwise, false. + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Attachments.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/Attachments.yml deleted file mode 100644 index 0538827e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Attachments.yml +++ /dev/null @@ -1,164 +0,0 @@ -### YamlMime:TSType -name: Attachments -uid: botframework-connector.Attachments -package: botframework-connector -summary: Class representing a Attachments. -fullName: Attachments -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Attachments(ConnectorClientContext) - uid: botframework-connector.Attachments.constructor - package: botframework-connector - summary: Create a Attachments. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new Attachments(client: ConnectorClientContext)' - parameters: - - id: client - type: - description: | - Reference to the service client. -methods: - - name: 'getAttachment(string, string, RequestOptionsBase)' - uid: botframework-connector.Attachments.getAttachment - package: botframework-connector - summary: Get the named view as binary content - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAttachment(attachmentId: string, viewId: string, options?: - RequestOptionsBase): Promise - parameters: - - id: attachmentId - type: string - description: attachment id - - id: viewId - type: string - description: View id from attachmentInfo - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: Promise<> - - name: 'getAttachment(string, string, RequestOptionsBase, ServiceCallback)' - uid: botframework-connector.Attachments.getAttachment_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAttachment(attachmentId: string, viewId: string, options: - RequestOptionsBase, callback: ServiceCallback) - parameters: - - id: attachmentId - type: string - description: attachment id - - id: viewId - type: string - description: View id from attachmentInfo - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<void> - description: | - The callback - - name: 'getAttachment(string, string, ServiceCallback)' - uid: botframework-connector.Attachments.getAttachment_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAttachment(attachmentId: string, viewId: string, callback: - ServiceCallback) - parameters: - - id: attachmentId - type: string - description: attachment id - - id: viewId - type: string - description: View id from attachmentInfo - - id: callback - type: ServiceCallback<void> - description: | - The callback - - name: 'getAttachmentInfo(string, RequestOptionsBase)' - uid: botframework-connector.Attachments.getAttachmentInfo - package: botframework-connector - summary: Get AttachmentInfo structure describing the attachment views - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAttachmentInfo(attachmentId: string, options?: - RequestOptionsBase): - Promise - parameters: - - id: attachmentId - type: string - description: attachment id - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - getAttachmentInfo(string, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Attachments.getAttachmentInfo_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAttachmentInfo(attachmentId: string, options: - RequestOptionsBase, callback: ServiceCallback) - parameters: - - id: attachmentId - type: string - description: attachment id - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<AttachmentInfo> - description: | - The callback - - name: 'getAttachmentInfo(string, ServiceCallback)' - uid: botframework-connector.Attachments.getAttachmentInfo_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAttachmentInfo(attachmentId: string, callback: - ServiceCallback) - parameters: - - id: attachmentId - type: string - description: attachment id - - id: callback - type: ServiceCallback<AttachmentInfo> - description: | - The callback diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentInfoResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentInfoResponse.yml deleted file mode 100644 index bcff07ad..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentInfoResponse.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: AttachmentsGetAttachmentInfoResponse -uid: botframework-connector.AttachmentsGetAttachmentInfoResponse -package: botframework-connector -summary: Contains response data for the getAttachmentInfo operation. -fullName: AttachmentsGetAttachmentInfoResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AttachmentsGetAttachmentInfoResponse = AttachmentInfo & { - _response: HttpResponse & { bodyAsText: string, parsedBody: AttachmentInfo }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentResponse.yml deleted file mode 100644 index 71180c0c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AttachmentsGetAttachmentResponse.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: AttachmentsGetAttachmentResponse -uid: botframework-connector.AttachmentsGetAttachmentResponse -package: botframework-connector -summary: Contains response data for the getAttachment operation. -fullName: AttachmentsGetAttachmentResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AttachmentsGetAttachmentResponse = { - _response: HttpResponse, - blobBody: Promise, - readableStreamBody: NodeJS.ReadableStream, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticateRequestResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticateRequestResult.yml index b4a2c8c4..f3d51249 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticateRequestResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticateRequestResult.yml @@ -5,12 +5,11 @@ package: botframework-connector summary: The result from a call to authenticate a Bot Framework Protocol request. fullName: AuthenticateRequestResult remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthenticateRequestResult = { - audience: string, - callerId?: string, - claimsIdentity: ClaimsIdentity, - connectorFactory?: ConnectorFactory, + audience: string + callerId?: string + claimsIdentity: ClaimsIdentity + connectorFactory?: ConnectorFactory } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationConfiguration.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationConfiguration.yml index 59e17eed..4acf8386 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationConfiguration.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationConfiguration.yml @@ -5,16 +5,14 @@ package: botframework-connector summary: General configuration settings for authentication. fullName: AuthenticationConfiguration remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AuthenticationConfiguration(string[], ValidateClaims, string[])' + - name: AuthenticationConfiguration(string[], ValidateClaims, string[]) uid: botframework-connector.AuthenticationConfiguration.constructor package: botframework-connector summary: General configuration settings for authentication. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -22,7 +20,7 @@ constructors: validateClaims?: ValidateClaims, validTokenIssuers?: string[]) parameters: - id: requiredEndorsements - type: 'string[]' + type: string[] description: An array of JWT endorsements. - id: validateClaims type: @@ -30,9 +28,8 @@ constructors: Function that validates a list of Claims and should throw an exception if the validation fails. - id: validTokenIssuers - type: 'string[]' - description: | - An array of valid JWT token issuers. + type: string[] + description: An array of valid JWT token issuers. properties: - name: requiredEndorsements uid: botframework-connector.AuthenticationConfiguration.requiredEndorsements @@ -40,20 +37,18 @@ properties: summary: '' fullName: requiredEndorsements remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requiredEndorsements: string[]' return: description: '' - type: 'string[]' + type: string[] - name: validateClaims uid: botframework-connector.AuthenticationConfiguration.validateClaims package: botframework-connector summary: '' fullName: validateClaims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validateClaims?: ValidateClaims' @@ -66,10 +61,9 @@ properties: summary: '' fullName: validTokenIssuers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'validTokenIssuers?: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationError.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationError.yml index d9c88a2d..db33f137 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticationError.yml @@ -7,11 +7,10 @@ summary: >- a Code Status. fullName: AuthenticationError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AuthenticationError(string, StatusCode)' + - name: AuthenticationError(string, number) uid: botframework-connector.AuthenticationError.constructor package: botframework-connector summary: >- @@ -19,45 +18,29 @@ constructors: [AuthenticationError](xref:botframework-connector.AuthenticationError) class. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new AuthenticationError(message: string, statusCode: StatusCode)' + content: 'new AuthenticationError(message: string, statusCode: number)' parameters: - id: message type: string description: The Error message. - id: statusCode - type: - description: | - The `StatusCode` number to use. + type: number + description: The `StatusCode` number to use. properties: - - name: Error - uid: botframework-connector.AuthenticationError.Error - package: botframework-connector - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor - name: statusCode uid: botframework-connector.AuthenticationError.statusCode package: botframework-connector summary: '' fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'statusCode: StatusCode' + content: 'statusCode: number' return: description: '' - type: + type: number inheritedProperties: - name: message uid: botframework-connector.AuthenticationError.message @@ -65,7 +48,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -79,7 +61,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -87,13 +68,28 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: botframework-connector.AuthenticationError.prepareStackTrace + package: botframework-connector + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: botframework-connector.AuthenticationError.stack package: botframework-connector summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -101,6 +97,38 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: botframework-connector.AuthenticationError.stackTraceLimit + package: botframework-connector + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: botframework-connector.AuthenticationError.captureStackTrace + package: botframework-connector + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace methods: - name: determineStatusCodeAndBuildMessage(any) uid: >- @@ -110,14 +138,13 @@ methods: Used to determine a status code from the error message for non-`IStatusCodeError`'s. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function determineStatusCodeAndBuildMessage(err: any): string' parameters: - id: err type: any - description: 'The error thrown, used to determine an appropriate status code.' + description: The error thrown, used to determine an appropriate status code. return: description: The error message to be sent as a response. type: string @@ -128,10 +155,9 @@ methods: Corroborates that the error is of type [IStatusCodeError](xref:botframework-schema.IStatusCodeError). remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function isStatusCodeError(err: any): boolean' + content: 'static function isStatusCodeError(err: any): err' parameters: - id: err type: any @@ -141,5 +167,5 @@ methods: If `err` is an [IStatusCodeError](xref:botframework-schema.IStatusCodeError), the result is true; otherwise false. - type: boolean + type: err extends: Error diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticatorResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticatorResult.yml new file mode 100644 index 00000000..f3dbeadd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/AuthenticatorResult.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: AuthenticatorResult +uid: botframework-connector.AuthenticatorResult +package: botframework-connector +summary: >- + Contains tokens and metadata upon successful completion of an acquireToken + call. +fullName: AuthenticatorResult +remarks: '' +isDeprecated: false +type: interface +properties: + - name: accessToken + uid: botframework-connector.AuthenticatorResult.accessToken + package: botframework-connector + summary: The value of the access token resulting from an authentication process. + fullName: accessToken + remarks: '' + isDeprecated: false + syntax: + content: 'accessToken: string' + return: + description: '' + type: string + - name: expiresOn + uid: botframework-connector.AuthenticatorResult.expiresOn + package: botframework-connector + summary: >- + The date and time of expiration relative to Coordinated Universal Time + (UTC). + fullName: expiresOn + remarks: '' + isDeprecated: false + syntax: + content: 'expiresOn: Date' + return: + description: '' + type: Date diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchFailedEntriesResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchFailedEntriesResponse.yml new file mode 100644 index 00000000..76e579be --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchFailedEntriesResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: BatchBatchFailedEntriesResponse +uid: botframework-connector.BatchBatchFailedEntriesResponse +package: botframework-connector +summary: Contains response data for the Teams batch failed entries. +fullName: BatchBatchFailedEntriesResponse +remarks: '' +isDeprecated: false +syntax: | + type BatchBatchFailedEntriesResponse = BatchFailedEntriesResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: BatchFailedEntriesResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchOperationStateResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchOperationStateResponse.yml new file mode 100644 index 00000000..0893f06d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BatchBatchOperationStateResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: BatchBatchOperationStateResponse +uid: botframework-connector.BatchBatchOperationStateResponse +package: botframework-connector +summary: Contains response data for the Teams batch operation state. +fullName: BatchBatchOperationStateResponse +remarks: '' +isDeprecated: false +syntax: | + type BatchBatchOperationStateResponse = BatchOperationStateResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: BatchOperationStateResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthentication.yml index ba49b788..f0cff98e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthentication.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthentication.yml @@ -7,7 +7,6 @@ summary: >- network calls within this environment. fullName: BotFrameworkAuthentication remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -17,7 +16,6 @@ methods: package: botframework-connector summary: Authenticate Bot Framework Protocol request to Skills. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -28,14 +26,13 @@ methods: type: string description: The HTTP auth header in the skill request. return: - description: 'A [ClaimsIdentity](xref:botframework-connector.ClaimsIdentity).' + description: A [ClaimsIdentity](xref:botframework-connector.ClaimsIdentity). type: Promise<> - - name: 'authenticateRequest(Activity, string)' + - name: authenticateRequest(Activity, string) uid: botframework-connector.BotFrameworkAuthentication.authenticateRequest package: botframework-connector summary: Validate Bot Framework Protocol requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -55,13 +52,12 @@ methods: type: >- Promise<> - - name: 'authenticateStreamingRequest(string, string)' + - name: authenticateStreamingRequest(string, string) uid: >- botframework-connector.BotFrameworkAuthentication.authenticateStreamingRequest package: botframework-connector summary: Validate Bot Framework Protocol requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -86,7 +82,6 @@ methods: package: botframework-connector summary: Creates a BotFrameworkClient for calling Skills. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createBotFrameworkClient(): BotFrameworkClient' @@ -102,7 +97,6 @@ methods: Creates a ConnectorFactory that can be used to create ConnectorClients that can use credentials from this particular Cloud Environment. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -113,14 +107,13 @@ methods: type: description: The inbound Activity's ClaimsIdentity. return: - description: 'A [ConnectorFactory](xref:botframework-connector.ConnectorFactory).' + description: A [ConnectorFactory](xref:botframework-connector.ConnectorFactory). type: - name: createUserTokenClient(ClaimsIdentity) uid: botframework-connector.BotFrameworkAuthentication.createUserTokenClient package: botframework-connector summary: Creates the appropriate UserTokenClient instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,14 +124,13 @@ methods: type: description: The inbound Activity's ClaimsIdentity. return: - description: 'An [UserTokenClient](xref:botframework-connector.UserTokenClient).' + description: An [UserTokenClient](xref:botframework-connector.UserTokenClient). type: Promise<> - name: getOriginatingAudience() uid: botframework-connector.BotFrameworkAuthentication.getOriginatingAudience package: botframework-connector summary: Gets the originating audience from Bot OAuth scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getOriginatingAudience(): string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthenticationFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthenticationFactory.yml index b7cb2ca3..5aab1538 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthenticationFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkAuthenticationFactory.yml @@ -8,7 +8,6 @@ summary: >- which encapsulates the environment specific Bot Framework Protocol auth code. fullName: BotFrameworkAuthenticationFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -20,7 +19,6 @@ methods: [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) instance for anonymous testing scenarios. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function create(): BotFrameworkAuthentication' @@ -42,7 +40,6 @@ methods: [BotFrameworkAuthentication](xref:botframework-connector.BotFrameworkAuthentication) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -107,7 +104,7 @@ methods: description: The fetch to use in BotFrameworkClient. - id: connectorClientOptions type: - description: > + description: >- The [ConnectorClientOptions](xref:botframework-connector.ConnectorClientOptions) to use when creating ConnectorClients. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClient.yml index 62a3a930..24431495 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClient.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: BotFrameworkClient remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Forwards an activity to a another bot. fullName: postActivity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClientImpl.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClientImpl.yml deleted file mode 100644 index f2d6d3e8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotFrameworkClientImpl.yml +++ /dev/null @@ -1,75 +0,0 @@ -### YamlMime:TSType -name: BotFrameworkClientImpl -uid: botframework-connector.BotFrameworkClientImpl -package: botframework-connector -summary: '' -fullName: BotFrameworkClientImpl -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'BotFrameworkClientImpl(ServiceClientCredentialsFactory, string, fetch)' - uid: botframework-connector.BotFrameworkClientImpl.constructor - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new BotFrameworkClientImpl(credentialsFactory: - ServiceClientCredentialsFactory, loginEndpoint: string, - botFrameworkClientFetch?: fetch) - parameters: - - id: credentialsFactory - type: >- - - description: >- - A - [ServiceClientCredentialsFactory](xref:botframework-connector.ServiceClientCredentialsFactory) - instance. - - id: loginEndpoint - type: string - description: The login url. - - id: botFrameworkClientFetch - type: fetch - description: > - A custom Fetch implementation to be used in the - [BotFrameworkClient](xref:botframework-connector.BotFrameworkClient). -methods: - - name: 'postActivity(string, string, string, string, string, Activity)' - uid: botframework-connector.BotFrameworkClientImpl.postActivity - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function postActivity(fromBotId: string, toBotId: string, toUrl: - string, serviceUrl: string, conversationId: string, activity: Activity): - Promise> - parameters: - - id: fromBotId - type: string - description: The MicrosoftAppId of the bot sending the activity. - - id: toBotId - type: string - description: The MicrosoftAppId of the bot receiving the activity. - - id: toUrl - type: string - description: The URL of the bot receiving the activity. - - id: serviceUrl - type: string - description: The callback Url for the skill host. - - id: conversationId - type: string - description: A conversation ID to use for the conversation with the skill. - - id: activity - type: Activity - description: The Activity to send to forward. - return: - description: A promise representing the asynchronous operation. - type: Promise<InvokeResponse<T>> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignIn.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignIn.yml deleted file mode 100644 index 8f431c9e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignIn.yml +++ /dev/null @@ -1,167 +0,0 @@ -### YamlMime:TSType -name: BotSignIn -uid: botframework-connector.BotSignIn -package: botframework-connector -summary: Class representing a BotSignIn. -fullName: BotSignIn -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: BotSignIn(TokenApiClientContext) - uid: botframework-connector.BotSignIn.constructor - package: botframework-connector - summary: Create a BotSignIn. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new BotSignIn(client: TokenApiClientContext)' - parameters: - - id: client - type: - description: | - Reference to the service client. -methods: - - name: 'getSignInResource(string, BotSignInGetSignInResourceOptionalParams)' - uid: botframework-connector.BotSignIn.getSignInResource - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInResource(state: string, options?: - BotSignInGetSignInResourceOptionalParams): - Promise - parameters: - - id: state - type: string - description: '' - - id: options - type: >- - - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - getSignInResource(string, BotSignInGetSignInResourceOptionalParams, - ServiceCallback) - uid: botframework-connector.BotSignIn.getSignInResource_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInResource(state: string, options: - BotSignInGetSignInResourceOptionalParams, callback: - ServiceCallback) - parameters: - - id: state - type: string - description: '' - - id: options - type: >- - - description: The optional parameters - - id: callback - type: ServiceCallback<SignInUrlResponse> - description: | - The callback - - name: 'getSignInResource(string, ServiceCallback)' - uid: botframework-connector.BotSignIn.getSignInResource_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInResource(state: string, callback: - ServiceCallback) - parameters: - - id: state - type: string - description: '' - - id: callback - type: ServiceCallback<SignInUrlResponse> - description: | - The callback - - name: 'getSignInUrl(string, BotSignInGetSignInUrlOptionalParams)' - uid: botframework-connector.BotSignIn.getSignInUrl - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInUrl(state: string, options?: - BotSignInGetSignInUrlOptionalParams): - Promise - parameters: - - id: state - type: string - description: '' - - id: options - type: >- - - description: '' - return: - description: Promise - type: Promise<> - - name: >- - getSignInUrl(string, BotSignInGetSignInUrlOptionalParams, - ServiceCallback) - uid: botframework-connector.BotSignIn.getSignInUrl_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInUrl(state: string, options: - BotSignInGetSignInUrlOptionalParams, callback: ServiceCallback) - parameters: - - id: state - type: string - description: '' - - id: options - type: >- - - description: The optional parameters - - id: callback - type: ServiceCallback<string> - description: | - The callback - - name: 'getSignInUrl(string, ServiceCallback)' - uid: botframework-connector.BotSignIn.getSignInUrl_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getSignInUrl(state: string, callback: ServiceCallback)' - parameters: - - id: state - type: string - description: '' - - id: callback - type: ServiceCallback<string> - description: | - The callback diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceOptionalParams.yml index 4f0c4ca0..dc4221b1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: BotSignInGetSignInResourceOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: '' fullName: codeChallenge remarks: '' - isPreview: false isDeprecated: false syntax: content: 'codeChallenge?: string' @@ -30,7 +28,6 @@ properties: summary: '' fullName: emulatorUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'emulatorUrl?: string' @@ -44,7 +41,6 @@ properties: summary: '' fullName: finalRedirect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'finalRedirect?: string' @@ -56,33 +52,31 @@ inheritedProperties: uid: >- botframework-connector.BotSignInGetSignInResourceOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: >- botframework-connector.BotSignInGetSignInResourceOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: >- @@ -91,7 +85,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -106,7 +99,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -114,15 +106,50 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.BotSignInGetSignInResourceOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.BotSignInGetSignInResourceOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.BotSignInGetSignInResourceOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -130,4 +157,18 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: >- + botframework-connector.BotSignInGetSignInResourceOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceResponse.yml index 0d9ad10c..ee1ffbd6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInResourceResponse.yml @@ -5,12 +5,11 @@ package: botframework-connector summary: Contains response data for the getSignInResource operation. fullName: BotSignInGetSignInResourceResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type BotSignInGetSignInResourceResponse = SignInUrlResponse & { _response: HttpResponse & { - bodyAsText: string, - parsedBody: SignInUrlResponse, - }, + bodyAsText: string + parsedBody: SignInUrlResponse + } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlOptionalParams.yml index bc6db79a..1d280b30 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: BotSignInGetSignInUrlOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: codeChallenge remarks: '' - isPreview: false isDeprecated: false syntax: content: 'codeChallenge?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: emulatorUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'emulatorUrl?: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: finalRedirect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'finalRedirect?: string' @@ -52,32 +48,30 @@ inheritedProperties: - name: abortSignal uid: botframework-connector.BotSignInGetSignInUrlOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: botframework-connector.BotSignInGetSignInUrlOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: >- @@ -86,7 +80,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -101,7 +94,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -109,15 +101,50 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.BotSignInGetSignInUrlOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.BotSignInGetSignInUrlOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.BotSignInGetSignInUrlOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -125,4 +152,17 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: botframework-connector.BotSignInGetSignInUrlOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlResponse.yml index a82398c6..1118899e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/BotSignInGetSignInUrlResponse.yml @@ -5,10 +5,9 @@ package: botframework-connector summary: Contains response data for the getSignInUrl operation. fullName: BotSignInGetSignInUrlResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type BotSignInGetSignInUrlResponse = { - _response: HttpResponse & { bodyAsText: string, parsedBody: string }, - body: string, + _response: HttpResponse & { bodyAsText: string; parsedBody: string } + body: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/CancelOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/CancelOperationResponse.yml new file mode 100644 index 00000000..7c4d2f73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/CancelOperationResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: CancelOperationResponse +uid: botframework-connector.CancelOperationResponse +package: botframework-connector +summary: Contains response data for the Teams batch cancel operation. +fullName: CancelOperationResponse +remarks: '' +isDeprecated: false +syntax: | + type CancelOperationResponse = { + _response: HttpResponse & { bodyAsText: string; parsedBody: {} } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateAppCredentials.yml index e4679416..4a867330 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateAppCredentials.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateAppCredentials.yml @@ -5,11 +5,10 @@ package: botframework-connector summary: CertificateAppCredentials auth implementation fullName: CertificateAppCredentials remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'CertificateAppCredentials(string, string, string, string, string)' + - name: CertificateAppCredentials(string, string, string, string, string, string) uid: botframework-connector.CertificateAppCredentials.constructor package: botframework-connector summary: >- @@ -17,13 +16,12 @@ constructors: [CertificateAppCredentials](xref:botframework-connector.CertificateAppCredentials) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new CertificateAppCredentials(appId: string, certificateThumbprint: string, certificatePrivateKey: string, channelAuthTenant?: string, - oAuthScope?: string) + oAuthScope?: string, x5c?: string) parameters: - id: appId type: string @@ -36,11 +34,25 @@ constructors: description: A PEM encoded certificate private key. - id: channelAuthTenant type: string - description: Optional. The oauth token tenant. + description: >- + Tenant ID of the Azure AD tenant where the bot is created. + * Required for SingleTenant app types. + * Optional for MultiTenant app types. **Note**: '_botframework.com_' is the default tenant when no value is provided. + + More information: + https://learn.microsoft.com/en-us/security/zero-trust/develop/identity-supported-account-types. - id: oAuthScope type: string - description: | - Optional. The scope for the token. + description: Optional. The scope for the token. + - id: x5c + type: string + description: >- + Optional. Enables application developers to achieve easy + certificates roll-over in Azure AD: + + set this parameter to send the public certificate (BEGIN + CERTIFICATE) to Azure AD, so that Azure AD can use it to validate + the subject name based on a trusted issuer policy. properties: - name: certificatePrivateKey uid: botframework-connector.CertificateAppCredentials.certificatePrivateKey @@ -48,7 +60,6 @@ properties: summary: '' fullName: certificatePrivateKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'certificatePrivateKey: string' @@ -61,7 +72,6 @@ properties: summary: '' fullName: certificateThumbprint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'certificateThumbprint: string' @@ -71,12 +81,9 @@ properties: - name: oAuthEndpoint uid: botframework-connector.CertificateAppCredentials.oAuthEndpoint package: botframework-connector - summary: |- - Gets the OAuth endpoint to use. - Sets the OAuth endpoint to use. + summary: Gets the OAuth endpoint to use. fullName: oAuthEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthEndpoint @@ -86,18 +93,27 @@ properties: - name: oAuthScope uid: botframework-connector.CertificateAppCredentials.oAuthScope package: botframework-connector - summary: |- - Gets the OAuth scope to use. - Sets the OAuth scope to use. + summary: Gets the OAuth scope to use. fullName: oAuthScope remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthScope return: description: The OAuth scope to use. type: string + - name: x5c + uid: botframework-connector.CertificateAppCredentials.x5c + package: botframework-connector + summary: '' + fullName: x5c + remarks: '' + isDeprecated: false + syntax: + content: 'x5c: string' + return: + description: '' + type: string inheritedProperties: - name: appId uid: botframework-connector.CertificateAppCredentials.appId @@ -105,7 +121,6 @@ inheritedProperties: summary: '' fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -121,7 +136,6 @@ inheritedProperties: summary: '' fullName: tokenCacheKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenCacheKey: string' @@ -132,33 +146,11 @@ inheritedProperties: Inherited From [AppCredentials.tokenCacheKey](xref:botframework-connector.AppCredentials.tokenCacheKey) inheritedMethods: - - name: getToken(boolean) - uid: botframework-connector.CertificateAppCredentials.getToken - package: botframework-connector - summary: Gets an OAuth access token. - remarks: 'If the promise is successful, the result contains the access token string.' - isPreview: false - isDeprecated: false - syntax: - content: 'function getToken(forceRefresh?: boolean): Promise' - parameters: - - id: forceRefresh - type: boolean - description: |- - True to force a refresh of the token; or false to get - a cached token if it exists. - return: - description: A Promise that represents the work queued to execute. - type: Promise<string> - inheritanceDescription: >- - Inherited From - [AppCredentials.getToken](xref:botframework-connector.AppCredentials.getToken) - name: isTrustedServiceUrl(string) uid: botframework-connector.CertificateAppCredentials.isTrustedServiceUrl package: botframework-connector summary: Checks if the service url is for a trusted host or not. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -178,21 +170,20 @@ inheritedMethods: package: botframework-connector summary: Apply the credentials to the HTTP request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function signRequest(webResource: WebResource): Promise' parameters: - id: webResource - type: WebResource + type: description: The WebResource HTTP request. return: description: A Promise representing the asynchronous operation. - type: Promise<WebResource> + type: Promise<> inheritanceDescription: >- Inherited From [AppCredentials.signRequest](xref:botframework-connector.AppCredentials.signRequest) - - name: 'trustServiceUrl(string, Date)' + - name: trustServiceUrl(string, Date) uid: botframework-connector.CertificateAppCredentials.trustServiceUrl package: botframework-connector summary: >- @@ -201,7 +192,6 @@ inheritedMethods: If expiration time is not provided, the expiration date will be current (utc) date + 1 day. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -216,4 +206,22 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AppCredentials.trustServiceUrl](xref:botframework-connector.AppCredentials.trustServiceUrl) +methods: + - name: getToken(boolean) + uid: botframework-connector.CertificateAppCredentials.getToken + package: botframework-connector + summary: Gets an OAuth access token. + remarks: If the promise is successful, the result contains the access token string. + isDeprecated: false + syntax: + content: 'function getToken(forceRefresh?: boolean): Promise' + parameters: + - id: forceRefresh + type: boolean + description: |- + True to force a refresh of the token; or false to get + a cached token if it exists. + return: + description: A Promise that represents the work queued to execute. + type: Promise<string> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateServiceClientCredentialsFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateServiceClientCredentialsFactory.yml new file mode 100644 index 00000000..749a521f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/CertificateServiceClientCredentialsFactory.yml @@ -0,0 +1,154 @@ +### YamlMime:TSType +name: CertificateServiceClientCredentialsFactory +uid: botframework-connector.CertificateServiceClientCredentialsFactory +package: botframework-connector +summary: >- + A Certificate implementation of the + [ServiceClientCredentialsFactory](xref:botframework-connector.ServiceClientCredentialsFactory) + abstract class. +fullName: CertificateServiceClientCredentialsFactory +remarks: '' +isDeprecated: false +type: class +constructors: + - name: CertificateServiceClientCredentialsFactory(string, string, string, string) + uid: >- + botframework-connector.CertificateServiceClientCredentialsFactory.constructor_1 + package: botframework-connector + summary: >- + Initializes a new instance of the + CertificateServiceClientCredentialsFactory class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new CertificateServiceClientCredentialsFactory(appId: string, x5c: + string, certificatePrivateKey: string, tenantId?: string) + parameters: + - id: appId + type: string + description: Microsoft application Id related to the certificate. + - id: x5c + type: string + description: >- + Value that enables application developers to achieve easy + certificates roll-over in Azure AD + + set this parameter to send the public certificate (BEGIN + CERTIFICATE) to Azure AD, so that Azure AD can use it to validate + the subject name based on a trusted issuer policy. + - id: certificatePrivateKey + type: string + description: A PEM encoded certificate private key. + - id: tenantId + type: string + description: >- + Tenant ID of the Azure AD tenant where the bot is created. + * Required for SingleTenant app types. + * Optional for MultiTenant app types. **Note**: '_botframework.com_' is the default tenant when no value is provided. + + More information: + https://learn.microsoft.com/en-us/security/zero-trust/develop/identity-supported-account-types. + - name: >- + CertificateServiceClientCredentialsFactory(string, string, string, string, + string) + uid: >- + botframework-connector.CertificateServiceClientCredentialsFactory.constructor + package: botframework-connector + summary: >- + Initializes a new instance of the + CertificateServiceClientCredentialsFactory class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new CertificateServiceClientCredentialsFactory(appId: string, + certificateThumbprint: string, certificatePrivateKey: string, tenantId?: + string, x5c?: string) + parameters: + - id: appId + type: string + description: Microsoft application Id related to the certificate. + - id: certificateThumbprint + type: string + description: A hex encoded thumbprint of the certificate. + - id: certificatePrivateKey + type: string + description: A PEM encoded certificate private key. + - id: tenantId + type: string + description: >- + Tenant ID of the Azure AD tenant where the bot is created. + * Required for SingleTenant app types. + * Optional for MultiTenant app types. **Note**: '_botframework.com_' is the default tenant when no value is provided. + + More information: + https://learn.microsoft.com/en-us/security/zero-trust/develop/identity-supported-account-types. + - id: x5c + type: string + description: >- + Optional. Enables application developers to achieve easy + certificates roll-over in Azure AD: + + set this parameter to send the public certificate (BEGIN + CERTIFICATE) to Azure AD, so that Azure AD can use it to validate + the subject name based on a trusted issuer policy. +methods: + - name: createCredentials(string, string) + uid: >- + botframework-connector.CertificateServiceClientCredentialsFactory.createCredentials + package: botframework-connector + summary: A factory method for creating ServiceClientCredentials. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createCredentials(appId: string, audience: string): + Promise + parameters: + - id: appId + type: string + description: The appId. + - id: audience + type: string + description: The audience. + return: + description: >- + A + [ServiceClientCredentials](xref:botframework-connector.ServiceClientCredentials). + type: >- + Promise<> + - name: isAuthenticationDisabled() + uid: >- + botframework-connector.CertificateServiceClientCredentialsFactory.isAuthenticationDisabled + package: botframework-connector + summary: Checks whether bot authentication is disabled. + remarks: '' + isDeprecated: false + syntax: + content: 'function isAuthenticationDisabled(): Promise' + return: + description: >- + If bot authentication is disabled, the result is true; otherwise, + false. + type: Promise<boolean> + - name: isValidAppId(string) + uid: >- + botframework-connector.CertificateServiceClientCredentialsFactory.isValidAppId + package: botframework-connector + summary: Validates an app ID. + remarks: '' + isDeprecated: false + syntax: + content: 'function isValidAppId(appId: string): Promise' + parameters: + - id: appId + type: string + description: The app ID to validate. + return: + description: >- + The result is true if `appId` is valid for the controller; otherwise, + false. + type: Promise<boolean> +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ChannelValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ChannelValidation.yml index a75a6aea..32050fff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ChannelValidation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ChannelValidation.yml @@ -16,7 +16,6 @@ functions: A token issued by the Bot Framework emulator will FAIL this check. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,7 +28,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: channelId type: string description: The ID of the channel to validate. @@ -51,7 +50,6 @@ functions: A token issued by the Bot Framework emulator will FAIL this check. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -64,7 +62,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: serviceUrl type: string description: The ServiceUrl Claim value that must match in the identity. @@ -77,12 +75,11 @@ functions: return: description: A valid ClaimsIdentity. type: Promise<> - - name: 'validateIdentity(ClaimsIdentity, ICredentialProvider)' + - name: validateIdentity(ClaimsIdentity, ICredentialProvider) uid: botframework-connector.ChannelValidation.validateIdentity package: botframework-connector summary: Validate the ClaimsIdentity to ensure it came from the channel service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -94,7 +91,7 @@ functions: description: The identity to validate - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. return: description: A valid ClaimsIdentity. type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Claim.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/Claim.yml index cff2ea4a..80e8edf2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Claim.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/Claim.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: Represents a claim. fullName: Claim remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ClaimsIdentity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ClaimsIdentity.yml index a798d73e..2ce39cbf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ClaimsIdentity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ClaimsIdentity.yml @@ -5,18 +5,16 @@ package: botframework-connector summary: Represents a claims-based identity. fullName: ClaimsIdentity remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ClaimsIdentity(Claim[], string | boolean)' + - name: ClaimsIdentity(Claim[], string | boolean) uid: botframework-connector.ClaimsIdentity.constructor package: botframework-connector summary: >- Initializes a new instance of the [ClaimsIdentity](xref:botframework-connector.ClaimsIdentity) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -24,11 +22,11 @@ constructors: boolean) parameters: - id: claims - type: '[]' - description: 'An array of [Claim](xref:botframework-connector.Claim).' + type: [] + description: An array of [Claim](xref:botframework-connector.Claim). - id: authenticationType type: string | boolean - description: > + description: >- The type of auth for this set of claims, or boolean to override isAuthenticated properties: @@ -38,20 +36,18 @@ properties: summary: '' fullName: claims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'claims: Claim[]' return: description: '' - type: '[]' + type: [] - name: isAuthenticated uid: botframework-connector.ClaimsIdentity.isAuthenticated package: botframework-connector summary: Returns authentication status. fullName: isAuthenticated remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean isAuthenticated @@ -64,14 +60,13 @@ methods: package: botframework-connector summary: Returns a claim value (if its present) remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getClaimValue(claimType: string): string | null' + content: 'function getClaimValue(claimType: string): null | string' parameters: - id: claimType type: string description: The claim type to look for return: description: The claim value or null if not found - type: string | null + type: null | string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClient.yml index 1fca5a49..844d5fa9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClient.yml @@ -5,16 +5,14 @@ package: botframework-connector summary: '' fullName: ConnectorClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ConnectorClient(ServiceClientCredentials, ConnectorClientOptions)' + - name: ConnectorClient(ServiceClientCredentials, ConnectorClientOptions) uid: botframework-connector.ConnectorClient.constructor package: botframework-connector summary: Initializes a new instance of the ConnectorClient class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -22,13 +20,13 @@ constructors: ConnectorClientOptions) parameters: - id: credentials - type: ServiceClientCredentials + type: description: >- Subscription credentials which uniquely identify client subscription. - id: options type: - description: '' + description: The parameter options properties: - name: attachments uid: botframework-connector.ConnectorClient.attachments @@ -36,26 +34,24 @@ properties: summary: '' fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments: Attachments' return: description: '' - type: + type: Attachments - name: conversations uid: botframework-connector.ConnectorClient.conversations package: botframework-connector summary: '' fullName: conversations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversations: Conversations' return: description: '' - type: + type: Conversations inheritedProperties: - name: credentials uid: botframework-connector.ConnectorClient.credentials @@ -63,16 +59,13 @@ inheritedProperties: summary: '' fullName: credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentials: ServiceClientCredentials' return: description: '' - type: ServiceClientCredentials - inheritanceDescription: >- - Inherited From - [ConnectorClientContext.credentials](xref:botframework-connector.ConnectorClientContext.credentials) + type: + inheritanceDescription: Inherited From ConnectorClientContext.credentials inheritedMethods: - name: >- sendOperationRequest(OperationArguments, OperationSpec, @@ -81,7 +74,6 @@ inheritedMethods: package: botframework-connector summary: Send an HTTP request that is populated using the provided OperationSpec. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -90,27 +82,25 @@ inheritedMethods: Promise parameters: - id: operationArguments - type: OperationArguments + type: description: >- The arguments that the HTTP request's templated values will be populated from. - id: operationSpec - type: OperationSpec + type: description: The OperationSpec to use to populate the httpRequest. - id: callback - type: ServiceCallback<any> - description: | - The callback to call when the response is received. + type: <any> + description: The callback to call when the response is received. return: description: '' - type: Promise<RestResponse> - inheritanceDescription: Inherited From ServiceClient.sendOperationRequest + type: Promise<> + inheritanceDescription: Inherited From ConnectorClientContext.sendOperationRequest - name: sendRequest(RequestPrepareOptions | WebResourceLike) uid: botframework-connector.ConnectorClient.sendRequest package: botframework-connector summary: Send the provided httpRequest. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,10 +108,12 @@ inheritedMethods: Promise parameters: - id: options - type: RequestPrepareOptions | WebResourceLike + type: >- + | description: '' return: description: '' - type: Promise<HttpOperationResponse> - inheritanceDescription: Inherited From ServiceClient.sendRequest -extends: + type: Promise<> + inheritanceDescription: Inherited From ConnectorClientContext.sendRequest +extends: ConnectorClientContext diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientContext.yml deleted file mode 100644 index 795cf469..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientContext.yml +++ /dev/null @@ -1,97 +0,0 @@ -### YamlMime:TSType -name: ConnectorClientContext -uid: botframework-connector.ConnectorClientContext -package: botframework-connector -summary: '' -fullName: ConnectorClientContext -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ConnectorClientContext(ServiceClientCredentials, ConnectorClientOptions)' - uid: botframework-connector.ConnectorClientContext.constructor - package: botframework-connector - summary: Initializes a new instance of the ConnectorClientContext class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ConnectorClientContext(credentials: ServiceClientCredentials, - options?: ConnectorClientOptions) - parameters: - - id: credentials - type: ServiceClientCredentials - description: >- - Subscription credentials which uniquely identify client - subscription. - - id: options - type: - description: '' -properties: - - name: credentials - uid: botframework-connector.ConnectorClientContext.credentials - package: botframework-connector - summary: '' - fullName: credentials - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'credentials: ServiceClientCredentials' - return: - description: '' - type: ServiceClientCredentials -inheritedMethods: - - name: >- - sendOperationRequest(OperationArguments, OperationSpec, - ServiceCallback) - uid: botframework-connector.ConnectorClientContext.sendOperationRequest - package: botframework-connector - summary: Send an HTTP request that is populated using the provided OperationSpec. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendOperationRequest(operationArguments: OperationArguments, - operationSpec: OperationSpec, callback?: ServiceCallback): - Promise - parameters: - - id: operationArguments - type: OperationArguments - description: >- - The arguments that the HTTP request's templated values will be - populated from. - - id: operationSpec - type: OperationSpec - description: The OperationSpec to use to populate the httpRequest. - - id: callback - type: ServiceCallback<any> - description: | - The callback to call when the response is received. - return: - description: '' - type: Promise<RestResponse> - inheritanceDescription: Inherited From ServiceClient.sendOperationRequest - - name: sendRequest(RequestPrepareOptions | WebResourceLike) - uid: botframework-connector.ConnectorClientContext.sendRequest - package: botframework-connector - summary: Send the provided httpRequest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendRequest(options: RequestPrepareOptions | WebResourceLike): - Promise - parameters: - - id: options - type: RequestPrepareOptions | WebResourceLike - description: '' - return: - description: '' - type: Promise<HttpOperationResponse> - inheritanceDescription: Inherited From ServiceClient.sendRequest -extends: ServiceClient diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientOptions.yml index 517b106b..a573fe51 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorClientOptions.yml @@ -5,10 +5,23 @@ package: botframework-connector summary: An interface representing ConnectorClientOptions. fullName: ConnectorClientOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: + - name: agentSettings + uid: botframework-connector.ConnectorClientOptions.agentSettings + package: botframework-connector + summary: >- + HTTP and HTTPS agents which will be used for every HTTP request (Node.js + only). + fullName: agentSettings + remarks: '' + isDeprecated: false + syntax: + content: 'agentSettings?: AgentSettings' + return: + description: '' + type: AgentSettings - name: baseUri uid: botframework-connector.ConnectorClientOptions.baseUri package: botframework-connector @@ -17,7 +30,6 @@ properties: but is required if using the ConnectorClient outside of the adapter. fullName: baseUri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'baseUri?: string' @@ -25,22 +37,6 @@ properties: description: '' type: string inheritedProperties: - - name: agentSettings - uid: botframework-connector.ConnectorClientOptions.agentSettings - package: botframework-connector - summary: >- - HTTP and HTTPS agents which will be used for every HTTP request (Node.js - only). - fullName: agentSettings - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'agentSettings?: AgentSettings' - return: - description: '' - type: AgentSettings - inheritanceDescription: Inherited From ServiceClientOptions.agentSettings - name: clientRequestIdHeaderName uid: botframework-connector.ConnectorClientOptions.clientRequestIdHeaderName package: botframework-connector @@ -52,7 +48,6 @@ inheritedProperties: the request ID. fullName: clientRequestIdHeaderName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientRequestIdHeaderName?: string' @@ -60,19 +55,31 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From ServiceClientOptions.clientRequestIdHeaderName + - name: credentialScopes + uid: botframework-connector.ConnectorClientOptions.credentialScopes + package: botframework-connector + summary: If specified, will be used to build the BearerTokenAuthenticationPolicy. + fullName: credentialScopes + remarks: '' + isDeprecated: false + syntax: + content: 'credentialScopes?: string | string[]' + return: + description: '' + type: string | string[] + inheritanceDescription: Inherited From ServiceClientOptions.credentialScopes - name: deserializationContentTypes uid: botframework-connector.ConnectorClientOptions.deserializationContentTypes package: botframework-connector summary: The content-types that will be associated with JSON or XML serialization. fullName: deserializationContentTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'deserializationContentTypes?: DeserializationContentTypes' return: description: '' - type: DeserializationContentTypes + type: inheritanceDescription: Inherited From ServiceClientOptions.deserializationContentTypes - name: generateClientRequestIdHeader uid: >- @@ -83,7 +90,6 @@ inheritedProperties: request. fullName: generateClientRequestIdHeader remarks: '' - isPreview: false isDeprecated: false syntax: content: 'generateClientRequestIdHeader?: boolean' @@ -97,13 +103,12 @@ inheritedProperties: summary: The HttpClient that will be used to send HTTP requests. fullName: httpClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpClient?: HttpClient' return: description: '' - type: HttpClient + type: inheritanceDescription: Inherited From ServiceClientOptions.httpClient - name: httpPipelineLogger uid: botframework-connector.ConnectorClientOptions.httpPipelineLogger @@ -113,21 +118,19 @@ inheritedProperties: the HTTP pipeline. fullName: httpPipelineLogger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpPipelineLogger?: HttpPipelineLogger' return: description: '' - type: HttpPipelineLogger + type: inheritanceDescription: Inherited From ServiceClientOptions.httpPipelineLogger - name: noRetryPolicy uid: botframework-connector.ConnectorClientOptions.noRetryPolicy package: botframework-connector - summary: 'If set to true, turn off the default retry policy.' + summary: If set to true, turn off the default retry policy. fullName: noRetryPolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noRetryPolicy?: boolean' @@ -141,28 +144,13 @@ inheritedProperties: summary: Proxy settings which will be used for every HTTP request (Node.js only). fullName: proxySettings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'proxySettings?: ProxySettings' return: description: '' - type: ProxySettings + type: inheritanceDescription: Inherited From ServiceClientOptions.proxySettings - - name: redirectOptions - uid: botframework-connector.ConnectorClientOptions.redirectOptions - package: botframework-connector - summary: Options for how redirect responses are handled. - fullName: redirectOptions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectOptions?: RedirectOptions' - return: - description: '' - type: RedirectOptions - inheritanceDescription: Inherited From ServiceClientOptions.redirectOptions - name: requestPolicyFactories uid: botframework-connector.ConnectorClientOptions.requestPolicyFactories package: botframework-connector @@ -176,7 +164,6 @@ inheritedProperties: the requestPolicyFactories that will be used. fullName: requestPolicyFactories remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -186,8 +173,9 @@ inheritedProperties: return: description: '' type: >- - RequestPolicyFactory[] | (defaultRequestPolicyFactories: - RequestPolicyFactory[]) => void | RequestPolicyFactory[] + [] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] inheritanceDescription: Inherited From ServiceClientOptions.requestPolicyFactories - name: rpRegistrationRetryTimeout uid: botframework-connector.ConnectorClientOptions.rpRegistrationRetryTimeout @@ -197,7 +185,6 @@ inheritedProperties: Default value is 30. fullName: rpRegistrationRetryTimeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rpRegistrationRetryTimeout?: number' @@ -216,7 +203,6 @@ inheritedProperties: that will be used. fullName: userAgent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAgent?: string | (defaultUserAgent: string) => string' @@ -232,12 +218,11 @@ inheritedProperties: If this is not specified, then "User-Agent" will be used when running on Node.js and - "x-ms-command-name" will + "x-ms-useragent" will be used when running in a browser. fullName: userAgentHeaderName remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -258,7 +243,6 @@ inheritedProperties: for more information. fullName: withCredentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'withCredentials?: boolean' @@ -266,4 +250,4 @@ inheritedProperties: description: '' type: boolean inheritanceDescription: Inherited From ServiceClientOptions.withCredentials -extends: ServiceClientOptions +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactory.yml index 733c3890..ccacd2d6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactory.yml @@ -7,18 +7,16 @@ summary: >- for the current appId. fullName: ConnectorFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'create(string, string)' + - name: create(string, string) uid: botframework-connector.ConnectorFactory.create package: botframework-connector summary: >- A factory method used to create [ConnectorClient](xref:botframework-connector.ConnectorClient) instances. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactoryImpl.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactoryImpl.yml deleted file mode 100644 index 0c7e00bb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConnectorFactoryImpl.yml +++ /dev/null @@ -1,75 +0,0 @@ -### YamlMime:TSType -name: ConnectorFactoryImpl -uid: botframework-connector.ConnectorFactoryImpl -package: botframework-connector -summary: '' -fullName: ConnectorFactoryImpl -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - ConnectorFactoryImpl(string, string, string, boolean, - ServiceClientCredentialsFactory, ConnectorClientOptions) - uid: botframework-connector.ConnectorFactoryImpl.constructor - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ConnectorFactoryImpl(appId: string, toChannelFromBotOAuthScope: - string, loginEndpoint: string, validateAuthority: boolean, - credentialFactory: ServiceClientCredentialsFactory, - connectorClientOptions?: ConnectorClientOptions) - parameters: - - id: appId - type: string - description: The AppID. - - id: toChannelFromBotOAuthScope - type: string - description: The to Channel from bot oauth scope. - - id: loginEndpoint - type: string - description: The login url. - - id: validateAuthority - type: boolean - description: The validate authority value to use. - - id: credentialFactory - type: >- - - description: A ServiceClientCredentialsFactory to use. - - id: connectorClientOptions - type: - description: > - The - [ConnectorClientOptions](xref:botframework-connector.ConnectorClientOptions) - to use when creating ConnectorClients. -methods: - - name: 'create(string, string)' - uid: botframework-connector.ConnectorFactoryImpl.create - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function create(serviceUrl: string, audience?: string): - Promise - parameters: - - id: serviceUrl - type: string - description: The client's service URL. - - id: audience - type: string - description: >- - The audience to use for outbound communication. It will vary by - cloud environment. - return: - description: The new instance of the ConnectorClient class. - type: Promise<> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationConstants.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationConstants.yml new file mode 100644 index 00000000..c67feeb6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationConstants.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: botframework-connector.ConversationConstants +name: ConversationConstants +type: module +package: botframework-connector +summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Conversations.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/Conversations.yml deleted file mode 100644 index 2f1ffaf0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Conversations.yml +++ /dev/null @@ -1,1166 +0,0 @@ -### YamlMime:TSType -name: Conversations -uid: botframework-connector.Conversations -package: botframework-connector -summary: Class representing a Conversations. -fullName: Conversations -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: Conversations(ConnectorClientContext) - uid: botframework-connector.Conversations.constructor - package: botframework-connector - summary: Create a Conversations. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new Conversations(client: ConnectorClientContext)' - parameters: - - id: client - type: - description: | - Reference to the service client. -methods: - - name: 'createConversation(ConversationParameters, RequestOptionsBase)' - uid: botframework-connector.Conversations.createConversation - package: botframework-connector - summary: >- - Create a new Conversation. - - POST to this method with a - - * Bot being the bot creating the conversation - - * IsGroup set to true if this is not a direct message (default is false) - - * Array containing the members to include in the conversation - - - The return value is a ResourceResponse which contains a conversation id - which is suitable for - - use - - in the message payload and REST API uris. - - - Most channels only support the semantics of bots initiating a direct - message conversation. An - - example of how to do that would be: - - - ``` - - const resource = await connector.conversations.createConversation({ - bot, - members: [{ id: 'user1' }] - }); - - await connector.conversations.sendToConversation(resource.Id, ... ); - - ``` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createConversation(parameters: ConversationParameters, - options?: RequestOptionsBase): - Promise - parameters: - - id: parameters - type: ConversationParameters - description: Parameters to create the conversation from - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - createConversation(ConversationParameters, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.createConversation_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createConversation(parameters: ConversationParameters, options: - RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: parameters - type: ConversationParameters - description: Parameters to create the conversation from - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<ConversationResourceResponse> - description: | - The callback - - name: >- - createConversation(ConversationParameters, - ServiceCallback) - uid: botframework-connector.Conversations.createConversation_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createConversation(parameters: ConversationParameters, - callback: ServiceCallback) - parameters: - - id: parameters - type: ConversationParameters - description: Parameters to create the conversation from - - id: callback - type: ServiceCallback<ConversationResourceResponse> - description: | - The callback - - name: 'deleteActivity(string, string, RequestOptionsBase)' - uid: botframework-connector.Conversations.deleteActivity - package: botframework-connector - summary: >- - Delete an existing activity. - - Some channels allow you to delete an existing activity, and if successful - this method will - - remove the specified activity. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteActivity(conversationId: string, activityId: string, - options?: RequestOptionsBase): Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId to delete - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: Promise<RestResponse> - - name: 'deleteActivity(string, string, RequestOptionsBase, ServiceCallback)' - uid: botframework-connector.Conversations.deleteActivity_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteActivity(conversationId: string, activityId: string, - options: RequestOptionsBase, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId to delete - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<void> - description: | - The callback - - name: 'deleteActivity(string, string, ServiceCallback)' - uid: botframework-connector.Conversations.deleteActivity_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteActivity(conversationId: string, activityId: string, - callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId to delete - - id: callback - type: ServiceCallback<void> - description: | - The callback - - name: 'deleteConversationMember(string, string, RequestOptionsBase)' - uid: botframework-connector.Conversations.deleteConversationMember - package: botframework-connector - summary: >- - Deletes a member from a conversation. - - This REST API takes a ConversationId and a memberId (of type string) and - removes that member - - from the conversation. If that member was the last member - - of the conversation, the conversation will also be deleted. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteConversationMember(conversationId: string, memberId: - string, options?: RequestOptionsBase): Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: memberId - type: string - description: ID of the member to delete from this conversation - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: Promise<RestResponse> - - name: >- - deleteConversationMember(string, string, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.deleteConversationMember_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteConversationMember(conversationId: string, memberId: - string, options: RequestOptionsBase, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: memberId - type: string - description: ID of the member to delete from this conversation - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<void> - description: | - The callback - - name: 'deleteConversationMember(string, string, ServiceCallback)' - uid: botframework-connector.Conversations.deleteConversationMember_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function deleteConversationMember(conversationId: string, memberId: - string, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: memberId - type: string - description: ID of the member to delete from this conversation - - id: callback - type: ServiceCallback<void> - description: | - The callback - - name: 'getActivityMembers(string, string, RequestOptionsBase)' - uid: botframework-connector.Conversations.getActivityMembers - package: botframework-connector - summary: >- - Enumerate the members of an activity. - - This REST API takes a ConversationId and a ActivityId, returning an array - of ChannelAccount - - objects representing the members of the particular activity in the - conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getActivityMembers(conversationId: string, activityId: string, - options?: RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: Activity ID - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - getActivityMembers(string, string, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.getActivityMembers_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getActivityMembers(conversationId: string, activityId: string, - options: RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: Activity ID - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: 'ServiceCallback<ChannelAccount[]>' - description: | - The callback - - name: 'getActivityMembers(string, string, ServiceCallback)' - uid: botframework-connector.Conversations.getActivityMembers_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getActivityMembers(conversationId: string, activityId: string, - callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: Activity ID - - id: callback - type: 'ServiceCallback<ChannelAccount[]>' - description: | - The callback - - name: >- - getConversationMember(string, string, RequestOptionsBase | - ServiceCallback, ServiceCallback) - uid: botframework-connector.Conversations.getConversationMember - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationMember(conversationId: string, memberId: string, - options?: RequestOptionsBase | ServiceCallback, - callback?: ServiceCallback): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: memberId - type: string - description: MemberId for the user - - id: options - type: 'RequestOptionsBase | ServiceCallback<ChannelAccount[]>' - description: The optional parameters - - id: callback - type: 'ServiceCallback<ChannelAccount[]>' - description: | - The callback - return: - description: '' - type: >- - Promise<> - - name: 'getConversationMembers(string, RequestOptionsBase)' - uid: botframework-connector.Conversations.getConversationMembers - package: botframework-connector - summary: >- - Enumerate the members of a conversation. - - This REST API takes a ConversationId and returns an array of - ChannelAccount objects representing - - the members of the conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationMembers(conversationId: string, options?: - RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - getConversationMembers(string, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.getConversationMembers_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationMembers(conversationId: string, options: - RequestOptionsBase, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: 'ServiceCallback<ChannelAccount[]>' - description: | - The callback - - name: 'getConversationMembers(string, ServiceCallback)' - uid: botframework-connector.Conversations.getConversationMembers_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationMembers(conversationId: string, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: callback - type: 'ServiceCallback<ChannelAccount[]>' - description: | - The callback - - name: >- - getConversationPagedMembers(string, - ConversationsGetConversationPagedMembersOptionalParams) - uid: botframework-connector.Conversations.getConversationPagedMembers - package: botframework-connector - summary: >- - Enumerate the members of a conversation one page at a time. - - This REST API takes a ConversationId. Optionally a pageSize and/or - continuationToken can be - - provided. It returns a PagedMembersResult, which contains an array - - of ChannelAccounts representing the members of the conversation and a - continuation token that - - can be used to get more values. - - - One page of ChannelAccounts records are returned with each call. The - number of records in a page - - may vary between channels and calls. The pageSize parameter can be used as - - a suggestion. If there are no additional results the response will not - contain a continuation - - token. If there are no members in the conversation the Members will be - empty or not present in - - the response. - - - A response to a request that has a continuation token from a prior request - may rarely return - - members from a previous request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationPagedMembers(conversationId: string, options?: - ConversationsGetConversationPagedMembersOptionalParams): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: options - type: >- - - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - getConversationPagedMembers(string, - ConversationsGetConversationPagedMembersOptionalParams, - ServiceCallback) - uid: botframework-connector.Conversations.getConversationPagedMembers_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationPagedMembers(conversationId: string, options: - ConversationsGetConversationPagedMembersOptionalParams, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: options - type: >- - - description: The optional parameters - - id: callback - type: ServiceCallback<PagedMembersResult> - description: | - The callback - - name: 'getConversationPagedMembers(string, ServiceCallback)' - uid: botframework-connector.Conversations.getConversationPagedMembers_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversationPagedMembers(conversationId: string, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: callback - type: ServiceCallback<PagedMembersResult> - description: | - The callback - - name: getConversations(ConversationsGetConversationsOptionalParams) - uid: botframework-connector.Conversations.getConversations - package: botframework-connector - summary: >- - List the Conversations in which this bot has participated. - - GET from this method with a skip token - - - The return value is a ConversationsResult, which contains an array of - ConversationMembers and a - - skip token. If the skip token is not empty, then - - there are further values to be returned. Call this method again with the - returned token to get - - more values. - - - Each ConversationMembers object contains the ID of the conversation and an - array of - - ChannelAccounts that describe the members of the conversation. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversations(options?: - ConversationsGetConversationsOptionalParams): - Promise - parameters: - - id: options - type: >- - - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - getConversations(ConversationsGetConversationsOptionalParams, - ServiceCallback) - uid: botframework-connector.Conversations.getConversations_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversations(options: - ConversationsGetConversationsOptionalParams, callback: - ServiceCallback) - parameters: - - id: options - type: >- - - description: The optional parameters - - id: callback - type: ServiceCallback<ConversationsResult> - description: | - The callback - - name: getConversations(ServiceCallback) - uid: botframework-connector.Conversations.getConversations_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getConversations(callback: - ServiceCallback) - parameters: - - id: callback - type: ServiceCallback<ConversationsResult> - description: | - The callback - - name: 'replyToActivity(string, string, Partial, RequestOptionsBase)' - uid: botframework-connector.Conversations.replyToActivity - package: botframework-connector - summary: >- - This method allows you to reply to an activity. - - This is slightly different from SendToConversation(). - - * SendToConversation(conversationId) - will append the activity to the end - of the conversation - - according to the timestamp or semantics of the channel. - - * ReplyToActivity(conversationId,ActivityId) - adds the activity as a - reply to another activity, - - if the channel supports it. If the channel does not support nested - replies, ReplyToActivity - - falls back to SendToConversation. - - - Use ReplyToActivity when replying to a specific activity in the - conversation. - - - Use SendToConversation in all other cases. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function replyToActivity(conversationId: string, activityId: string, - activity: Partial, options?: RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId the reply is to (OPTIONAL) - - id: activity - type: Partial<Activity> - description: Activity to send - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - replyToActivity(string, string, Partial, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.replyToActivity_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function replyToActivity(conversationId: string, activityId: string, - activity: Partial, options: RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId the reply is to (OPTIONAL) - - id: activity - type: Partial<Activity> - description: Activity to send - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: >- - replyToActivity(string, string, Partial, - ServiceCallback) - uid: botframework-connector.Conversations.replyToActivity_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function replyToActivity(conversationId: string, activityId: string, - activity: Partial, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId the reply is to (OPTIONAL) - - id: activity - type: Partial<Activity> - description: Activity to send - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: 'sendConversationHistory(string, Transcript, RequestOptionsBase)' - uid: botframework-connector.Conversations.sendConversationHistory - package: botframework-connector - summary: >- - This method allows you to upload the historic activities to the - conversation. - - Sender must ensure that the historic activities have unique ids and - appropriate timestamps. The - - ids are used by the client to deal with duplicate activities and the - timestamps are used by the - - client to render the activities in the right order. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendConversationHistory(conversationId: string, history: - Transcript, options?: RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: history - type: Transcript - description: Historic activities - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - sendConversationHistory(string, Transcript, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.sendConversationHistory_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendConversationHistory(conversationId: string, history: - Transcript, options: RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: history - type: Transcript - description: Historic activities - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: >- - sendConversationHistory(string, Transcript, - ServiceCallback) - uid: botframework-connector.Conversations.sendConversationHistory_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendConversationHistory(conversationId: string, history: - Transcript, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: history - type: Transcript - description: Historic activities - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: 'sendToConversation(string, Partial, RequestOptionsBase)' - uid: botframework-connector.Conversations.sendToConversation - package: botframework-connector - summary: >- - This method allows you to send an activity to the end of a conversation. - - This is slightly different from ReplyToActivity(). - - * SendToConversation(conversationId) - will append the activity to the end - of the conversation - - according to the timestamp or semantics of the channel. - - * ReplyToActivity(conversationId,ActivityId) - adds the activity as a - reply to another activity, - - if the channel supports it. If the channel does not support nested - replies, ReplyToActivity - - falls back to SendToConversation. - - - Use ReplyToActivity when replying to a specific activity in the - conversation. - - - Use SendToConversation in all other cases. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendToConversation(conversationId: string, activity: - Partial, options?: RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activity - type: Partial<Activity> - description: Activity to send - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - sendToConversation(string, Partial, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.sendToConversation_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendToConversation(conversationId: string, activity: - Partial, options: RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activity - type: Partial<Activity> - description: Activity to send - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: >- - sendToConversation(string, Partial, - ServiceCallback) - uid: botframework-connector.Conversations.sendToConversation_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendToConversation(conversationId: string, activity: - Partial, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activity - type: Partial<Activity> - description: Activity to send - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: 'updateActivity(string, string, Partial, RequestOptionsBase)' - uid: botframework-connector.Conversations.updateActivity - package: botframework-connector - summary: >- - Edit an existing activity. - - Some channels allow you to edit an existing activity to reflect the new - state of a bot - - conversation. - - - For example, you can remove buttons after someone has clicked "Approve" - button. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateActivity(conversationId: string, activityId: string, - activity: Partial, options?: RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId to update - - id: activity - type: Partial<Activity> - description: replacement Activity - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - updateActivity(string, string, Partial, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.updateActivity_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateActivity(conversationId: string, activityId: string, - activity: Partial, options: RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId to update - - id: activity - type: Partial<Activity> - description: replacement Activity - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: >- - updateActivity(string, string, Partial, - ServiceCallback) - uid: botframework-connector.Conversations.updateActivity_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateActivity(conversationId: string, activityId: string, - activity: Partial, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: activityId - type: string - description: activityId to update - - id: activity - type: Partial<Activity> - description: replacement Activity - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: 'uploadAttachment(string, AttachmentData, RequestOptionsBase)' - uid: botframework-connector.Conversations.uploadAttachment - package: botframework-connector - summary: >- - Upload an attachment directly into a channel's blob storage. - - This is useful because it allows you to store data in a compliant store - when dealing with - - enterprises. - - - The response is a ResourceResponse which contains an AttachmentId which is - suitable for using - - with the attachments API. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function uploadAttachment(conversationId: string, attachmentUpload: - AttachmentData, options?: RequestOptionsBase): - Promise - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: attachmentUpload - type: AttachmentData - description: Attachment data - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: >- - Promise<> - - name: >- - uploadAttachment(string, AttachmentData, RequestOptionsBase, - ServiceCallback) - uid: botframework-connector.Conversations.uploadAttachment_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function uploadAttachment(conversationId: string, attachmentUpload: - AttachmentData, options: RequestOptionsBase, callback: - ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: attachmentUpload - type: AttachmentData - description: Attachment data - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback - - name: >- - uploadAttachment(string, AttachmentData, - ServiceCallback) - uid: botframework-connector.Conversations.uploadAttachment_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function uploadAttachment(conversationId: string, attachmentUpload: - AttachmentData, callback: ServiceCallback) - parameters: - - id: conversationId - type: string - description: Conversation ID - - id: attachmentUpload - type: AttachmentData - description: Attachment data - - id: callback - type: ServiceCallback<ResourceResponse> - description: | - The callback diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsCreateConversationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsCreateConversationResponse.yml deleted file mode 100644 index e6f659d8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsCreateConversationResponse.yml +++ /dev/null @@ -1,17 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsCreateConversationResponse -uid: botframework-connector.ConversationsCreateConversationResponse -package: botframework-connector -summary: Contains response data for the createConversation operation. -fullName: ConversationsCreateConversationResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: > - type ConversationsCreateConversationResponse = ConversationResourceResponse & - { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ConversationResourceResponse, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetActivityMembersResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetActivityMembersResponse.yml deleted file mode 100644 index 399c9191..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetActivityMembersResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsGetActivityMembersResponse -uid: botframework-connector.ConversationsGetActivityMembersResponse -package: botframework-connector -summary: Contains response data for the getActivityMembers operation. -fullName: ConversationsGetActivityMembersResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsGetActivityMembersResponse = Array & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ChannelAccount[], - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMemberResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMemberResponse.yml deleted file mode 100644 index 989759ba..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMemberResponse.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsGetConversationMemberResponse -uid: botframework-connector.ConversationsGetConversationMemberResponse -package: botframework-connector -summary: Contains response data for the getConversationMember operation. -fullName: ConversationsGetConversationMemberResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsGetConversationMemberResponse = ChannelAccount & { - _response: HttpResponse & { bodyAsText: string, parsedBody: ChannelAccount }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMembersResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMembersResponse.yml deleted file mode 100644 index ea546a74..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationMembersResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsGetConversationMembersResponse -uid: botframework-connector.ConversationsGetConversationMembersResponse -package: botframework-connector -summary: Contains response data for the getConversationMembers operation. -fullName: ConversationsGetConversationMembersResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsGetConversationMembersResponse = Array & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ChannelAccount[], - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersOptionalParams.yml index bc331a90..09a9b004 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: ConversationsGetConversationPagedMembersOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -16,7 +15,6 @@ properties: summary: Continuation Token fullName: continuationToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'continuationToken: string' @@ -30,7 +28,6 @@ properties: summary: Suggested page size fullName: pageSize remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pageSize: number' @@ -42,33 +39,31 @@ inheritedProperties: uid: >- botframework-connector.ConversationsGetConversationPagedMembersOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: >- botframework-connector.ConversationsGetConversationPagedMembersOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: >- @@ -77,7 +72,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -92,7 +86,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -100,6 +93,40 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.ConversationsGetConversationPagedMembersOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.ConversationsGetConversationPagedMembersOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: >- botframework-connector.ConversationsGetConversationPagedMembersOptionalParams.timeout @@ -107,9 +134,10 @@ inheritedProperties: summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -117,4 +145,18 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: >- + botframework-connector.ConversationsGetConversationPagedMembersOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersResponse.yml deleted file mode 100644 index e2f58c19..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationPagedMembersResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsGetConversationPagedMembersResponse -uid: botframework-connector.ConversationsGetConversationPagedMembersResponse -package: botframework-connector -summary: Contains response data for the getConversationPagedMembers operation. -fullName: ConversationsGetConversationPagedMembersResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsGetConversationPagedMembersResponse = PagedMembersResult & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: PagedMembersResult, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsOptionalParams.yml deleted file mode 100644 index 0256f166..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsOptionalParams.yml +++ /dev/null @@ -1,105 +0,0 @@ -### YamlMime:TSType -name: ConversationsGetConversationsOptionalParams -uid: botframework-connector.ConversationsGetConversationsOptionalParams -package: botframework-connector -summary: Optional Parameters. -fullName: ConversationsGetConversationsOptionalParams -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: continuationToken - uid: >- - botframework-connector.ConversationsGetConversationsOptionalParams.continuationToken - package: botframework-connector - summary: skip or continuation token - fullName: continuationToken - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'continuationToken: string' - return: - description: '' - type: string -inheritedProperties: - - name: abortSignal - uid: >- - botframework-connector.ConversationsGetConversationsOptionalParams.abortSignal - package: botframework-connector - summary: The signal which can be used to abort requests. - fullName: abortSignal - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'abortSignal?: AbortSignalLike' - return: - description: '' - type: AbortSignalLike - inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - - name: customHeaders - uid: >- - botframework-connector.ConversationsGetConversationsOptionalParams.customHeaders - package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. - fullName: customHeaders - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'customHeaders?: [key: string]: string' - return: - description: '' - type: '[key: string]\: string' - inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - - name: onDownloadProgress - uid: >- - botframework-connector.ConversationsGetConversationsOptionalParams.onDownloadProgress - package: botframework-connector - summary: Callback which fires upon download progress. - fullName: onDownloadProgress - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' - return: - description: '' - type: '(progress: TransferProgressEvent) => void' - inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress - - name: onUploadProgress - uid: >- - botframework-connector.ConversationsGetConversationsOptionalParams.onUploadProgress - package: botframework-connector - summary: Callback which fires upon upload progress. - fullName: onUploadProgress - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' - return: - description: '' - type: '(progress: TransferProgressEvent) => void' - inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress - - name: timeout - uid: botframework-connector.ConversationsGetConversationsOptionalParams.timeout - package: botframework-connector - summary: >- - The number of milliseconds a request can take before automatically being - terminated. - fullName: timeout - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'timeout?: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsResponse.yml deleted file mode 100644 index 9914aa2d..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsGetConversationsResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsGetConversationsResponse -uid: botframework-connector.ConversationsGetConversationsResponse -package: botframework-connector -summary: Contains response data for the getConversations operation. -fullName: ConversationsGetConversationsResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsGetConversationsResponse = ConversationsResult & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ConversationsResult, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsReplyToActivityResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsReplyToActivityResponse.yml deleted file mode 100644 index 53d83abc..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsReplyToActivityResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsReplyToActivityResponse -uid: botframework-connector.ConversationsReplyToActivityResponse -package: botframework-connector -summary: Contains response data for the replyToActivity operation. -fullName: ConversationsReplyToActivityResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsReplyToActivityResponse = ResourceResponse & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ResourceResponse, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendConversationHistoryResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendConversationHistoryResponse.yml deleted file mode 100644 index ef2a1fd4..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendConversationHistoryResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsSendConversationHistoryResponse -uid: botframework-connector.ConversationsSendConversationHistoryResponse -package: botframework-connector -summary: Contains response data for the sendConversationHistory operation. -fullName: ConversationsSendConversationHistoryResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsSendConversationHistoryResponse = ResourceResponse & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ResourceResponse, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendToConversationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendToConversationResponse.yml deleted file mode 100644 index 6a8bedc9..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsSendToConversationResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsSendToConversationResponse -uid: botframework-connector.ConversationsSendToConversationResponse -package: botframework-connector -summary: Contains response data for the sendToConversation operation. -fullName: ConversationsSendToConversationResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsSendToConversationResponse = ResourceResponse & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ResourceResponse, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUpdateActivityResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUpdateActivityResponse.yml deleted file mode 100644 index 1ffda149..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUpdateActivityResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsUpdateActivityResponse -uid: botframework-connector.ConversationsUpdateActivityResponse -package: botframework-connector -summary: Contains response data for the updateActivity operation. -fullName: ConversationsUpdateActivityResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsUpdateActivityResponse = ResourceResponse & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ResourceResponse, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUploadAttachmentResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUploadAttachmentResponse.yml deleted file mode 100644 index 9b8a6c70..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ConversationsUploadAttachmentResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationsUploadAttachmentResponse -uid: botframework-connector.ConversationsUploadAttachmentResponse -package: botframework-connector -summary: Contains response data for the uploadAttachment operation. -fullName: ConversationsUploadAttachmentResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConversationsUploadAttachmentResponse = ResourceResponse & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ResourceResponse, - }, - } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorApiClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorApiClient.yml index 5c97b139..2ae5b2c6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorApiClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorApiClient.yml @@ -5,18 +5,16 @@ package: botframework-connector summary: The purpose of this class is to emulate an api client. fullName: EmulatorApiClient remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'emulateOAuthCards(AppCredentials, string, boolean)' + - name: emulateOAuthCards(AppCredentials, string, boolean) uid: botframework-connector.EmulatorApiClient.emulateOAuthCards package: botframework-connector summary: OAuth card emulation. remarks: >- If the emulation fails, an error containing the status code from the server is thrown. - isPreview: false isDeprecated: false syntax: content: >- @@ -25,7 +23,9 @@ methods: parameters: - id: credentials type: - description: '(xref:botframework-connector.AppCredentials) for OAuth.' + description: >- + [AppCredentials](xref:botframework-connector.AppCredentials) for + OAuth. - id: emulatorUrl type: string description: The URL of the emulator. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorValidation.yml index 146b7fce..23f3682f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorValidation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EmulatorValidation.yml @@ -17,7 +17,6 @@ functions: A token issued by the Bot Framework will FAIL this check. Only Emulator tokens will pass. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +29,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: channelService type: string description: >- @@ -50,14 +49,13 @@ functions: package: botframework-connector summary: Determines if a given Auth header is from the Bot Framework Emulator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isTokenFromEmulator(authHeader: string): boolean' parameters: - id: authHeader type: string - description: 'Bearer Token, in the "Bearer [Long String]" Format.' + description: Bearer Token, in the "Bearer [Long String]" Format. return: - description: 'True, if the token was issued by the Emulator. Otherwise, false.' + description: True, if the token was issued by the Emulator. Otherwise, false. type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EndorsementsValidator.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EndorsementsValidator.yml index ec4bfb3f..6d560d62 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EndorsementsValidator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EndorsementsValidator.yml @@ -5,11 +5,10 @@ package: botframework-connector summary: Contains helper methods for verifying JWT endorsements. fullName: EndorsementsValidator remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'validate(string, string[])' + - name: validate(string, string[]) uid: botframework-connector.EndorsementsValidator.validate package: botframework-connector summary: >- @@ -22,7 +21,6 @@ methods: says "webchat" and the jwt token endorsement MUST match that. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -35,7 +33,7 @@ methods: The channel name, typically extracted from the activity.ChannelId field, that to which the Activity is affinitized. - id: endorsements - type: 'string[]' + type: string[] description: >- Whoever signed the JWT token is permitted to send activities only for diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EnterpriseChannelValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EnterpriseChannelValidation.yml index 3e84d2db..8bf9aa3f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/EnterpriseChannelValidation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/EnterpriseChannelValidation.yml @@ -17,7 +17,6 @@ functions: A token issued by the Bot Framework emulator will FAIL this check. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +29,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: channelId type: string description: The ID of the channel to validate. @@ -57,7 +56,6 @@ functions: A token issued by the Bot Framework emulator will FAIL this check. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -70,7 +68,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: serviceUrl type: string description: The ServiceUrl Claim value that must match in the identity. @@ -85,12 +83,11 @@ functions: return: description: A valid ClaimsIdentity. type: Promise<> - - name: 'validateIdentity(ClaimsIdentity, ICredentialProvider)' + - name: validateIdentity(ClaimsIdentity, ICredentialProvider) uid: botframework-connector.EnterpriseChannelValidation.validateIdentity package: botframework-connector summary: Validate the ClaimsIdentity to ensure it came from the channel service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -102,7 +99,7 @@ functions: description: The identity to validate - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. return: description: A valid ClaimsIdentity. type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorModel.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorModel.yml index e1b39445..fc306e90 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorModel.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorModel.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: ErrorModel remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: content: 'code?: string' @@ -28,20 +26,18 @@ properties: summary: '' fullName: innerHttpError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'innerHttpError?: InnerHttpError' return: description: '' - type: + type: - name: message uid: botframework-connector.ErrorModel.message package: botframework-connector summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorResponse.yml index 326c8280..538d4fd8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ErrorResponse.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: ErrorResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'error?: ErrorModel' return: description: '' - type: + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/GovernmentChannelValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/GovernmentChannelValidation.yml index 81e30c93..35071c77 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/GovernmentChannelValidation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/GovernmentChannelValidation.yml @@ -17,7 +17,6 @@ functions: A token issued by the Bot Framework emulator will FAIL this check. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +29,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: channelId type: string description: The ID of the channel to validate. @@ -52,7 +51,6 @@ functions: A token issued by the Bot Framework emulator will FAIL this check. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -65,7 +63,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]"' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: serviceUrl type: string description: The ServiceUrl Claim value that must match in the identity. @@ -75,12 +73,11 @@ functions: return: description: A valid ClaimsIdentity. type: Promise<> - - name: 'validateIdentity(ClaimsIdentity, ICredentialProvider)' + - name: validateIdentity(ClaimsIdentity, ICredentialProvider) uid: botframework-connector.GovernmentChannelValidation.validateIdentity package: botframework-connector summary: Validate the ClaimsIdentity to ensure it came from the channel service. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -92,7 +89,7 @@ functions: description: The identity to validate - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. return: description: A valid ClaimsIdentity. type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ICredentialProvider.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ICredentialProvider.yml index eed618f8..ef7260b4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ICredentialProvider.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ICredentialProvider.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: ICredentialProvider remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: >- Use `ConfigurationBotFrameworkAuthentication` instead to configure @@ -31,40 +30,40 @@ methods: - name: getAppPassword(string) uid: botframework-connector.ICredentialProvider.getAppPassword package: botframework-connector - summary: > + summary: >- Get the app password for a given bot appId, if it is not a valid appId, return Null + This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getAppPassword(appId: string): Promise' + content: 'function getAppPassword(appId: string): Promise' parameters: - id: appId type: string description: bot appid return: description: password or null for invalid appid - type: Promise<string | null> + type: Promise<null | string> - name: isAuthenticationDisabled() uid: botframework-connector.ICredentialProvider.isAuthenticationDisabled package: botframework-connector - summary: > + summary: >- Checks if bot authentication is disabled. Return true if bot authentication is disabled. + This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAuthenticationDisabled(): Promise' @@ -74,15 +73,15 @@ methods: - name: isValidAppId(string) uid: botframework-connector.ICredentialProvider.isValidAppId package: botframework-connector - summary: > + summary: >- Validate AppId. + This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidAppId(appId: string): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/IJwtTokenProviderFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/IJwtTokenProviderFactory.yml index 5b29f684..68f96185 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/IJwtTokenProviderFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/IJwtTokenProviderFactory.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: IJwtTokenProviderFactory remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -15,7 +14,6 @@ methods: package: botframework-connector summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,4 +25,4 @@ methods: description: '' return: description: '' - type: DefaultAzureCredential + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/IOpenIdMetadataKey.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/IOpenIdMetadataKey.yml deleted file mode 100644 index 5b0c71ca..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/IOpenIdMetadataKey.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: IOpenIdMetadataKey -uid: botframework-connector.IOpenIdMetadataKey -package: botframework-connector -summary: '' -fullName: IOpenIdMetadataKey -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: endorsements - uid: botframework-connector.IOpenIdMetadataKey.endorsements - package: botframework-connector - summary: '' - fullName: endorsements - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'endorsements?: string[]' - return: - description: '' - type: 'string[]' - - name: key - uid: botframework-connector.IOpenIdMetadataKey.key - package: botframework-connector - summary: '' - fullName: key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/InnerHttpError.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/InnerHttpError.yml index 5316d6cc..09c8ea60 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/InnerHttpError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/InnerHttpError.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: InnerHttpError remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: any' @@ -28,7 +26,6 @@ properties: summary: '' fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenExtractor.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenExtractor.yml deleted file mode 100644 index d2f4767a..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenExtractor.yml +++ /dev/null @@ -1,128 +0,0 @@ -### YamlMime:TSType -name: JwtTokenExtractor -uid: botframework-connector.JwtTokenExtractor -package: botframework-connector -summary: >- - A JWT token processing class that gets identity information and performs - security token validation. -fullName: JwtTokenExtractor -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'JwtTokenExtractor(VerifyOptions, string, string[])' - uid: botframework-connector.JwtTokenExtractor.constructor - package: botframework-connector - summary: >- - Initializes a new instance of the - [JwtTokenExtractor](xref:botframework-connector.JwtTokenExtractor) class. - Extracts relevant data from JWT Tokens. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new JwtTokenExtractor(tokenValidationParameters: VerifyOptions, - metadataUrl: string, allowedSigningAlgorithms: string[]) - parameters: - - id: tokenValidationParameters - type: VerifyOptions - description: Token validation parameters. - - id: metadataUrl - type: string - description: Metadata Url. - - id: allowedSigningAlgorithms - type: 'string[]' - description: | - Allowed signing algorithms. -properties: - - name: openIdMetadata - uid: botframework-connector.JwtTokenExtractor.openIdMetadata - package: botframework-connector - summary: '' - fullName: openIdMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'openIdMetadata: OpenIdMetadata' - return: - description: '' - type: - - name: tokenValidationParameters - uid: botframework-connector.JwtTokenExtractor.tokenValidationParameters - package: botframework-connector - summary: '' - fullName: tokenValidationParameters - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tokenValidationParameters: VerifyOptions' - return: - description: '' - type: VerifyOptions -methods: - - name: 'getIdentity(string, string, string, string[])' - uid: botframework-connector.JwtTokenExtractor.getIdentity - package: botframework-connector - summary: Gets the claims identity associated with a request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getIdentity(scheme: string, parameter: string, channelId: - string, requiredEndorsements?: string[]): Promise - parameters: - - id: scheme - type: string - description: The associated scheme. - - id: parameter - type: string - description: The token. - - id: channelId - type: string - description: The Id of the channel being validated in the original request. - - id: requiredEndorsements - type: 'string[]' - description: The required JWT endorsements. - return: - description: >- - A `Promise` representation for either a - [ClaimsIdentity](botframework-connector:module.ClaimsIdentity) or - `null`. - type: >- - Promise< | - null> - - name: 'getIdentityFromAuthHeader(string, string, string[])' - uid: botframework-connector.JwtTokenExtractor.getIdentityFromAuthHeader - package: botframework-connector - summary: Gets the claims identity associated with a request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getIdentityFromAuthHeader(authorizationHeader: string, - channelId: string, requiredEndorsements?: string[]): - Promise - parameters: - - id: authorizationHeader - type: string - description: 'The raw HTTP header in the format: "Bearer [longString]".' - - id: channelId - type: string - description: The Id of the channel being validated in the original request. - - id: requiredEndorsements - type: 'string[]' - description: The required JWT endorsements. - return: - description: >- - A `Promise` representation for either a - [ClaimsIdentity](botframework-connector:module.ClaimsIdentity) or - `null`. - type: >- - Promise< | - null> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenProviderFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenProviderFactory.yml index 41d27025..ea4017c7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenProviderFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenProviderFactory.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: JwtTokenProviderFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -15,7 +14,6 @@ methods: package: botframework-connector summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,4 +25,4 @@ methods: description: '' return: description: '' - type: DefaultAzureCredential + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenValidation.yml index 0b324bee..5703613c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenValidation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/JwtTokenValidation.yml @@ -14,7 +14,6 @@ functions: Authenticates the request and sets the service url in the set of trusted urls. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,28 +29,27 @@ functions: description: The Bearer token included as part of the request - id: credentials type: - description: 'The set of valid credentials, such as the Bot Application ID' + description: The set of valid credentials, such as the Bot Application ID - id: channelService type: string description: The channel service - id: authConfig type: - description: 'Optional, the auth config' + description: Optional, the auth config return: description: Promise with ClaimsIdentity for the request. type: Promise<> - - name: 'getAppIdFromClaims(Claim[])' + - name: getAppIdFromClaims(Claim[]) uid: botframework-connector.JwtTokenValidation.getAppIdFromClaims package: botframework-connector summary: Gets the AppId from a claims list. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAppIdFromClaims(claims: Claim[]): string' parameters: - id: claims - type: '[]' + type: [] description: An object containing claims types and their values. return: description: the app ID @@ -61,7 +59,6 @@ functions: package: botframework-connector summary: Determine whether or not a channel service is government remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isGovernment(channelService: string): boolean' @@ -79,7 +76,6 @@ functions: Internal helper to check if the token has the shape we expect "Bearer [big long string]". remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidTokenFormat(authHeader: string): boolean' @@ -88,7 +84,7 @@ functions: type: string description: A string containing the token header. return: - description: 'True if the token is valid, false if not.' + description: True if the token is valid, false if not. type: boolean - name: >- validateAuthHeader(string, ICredentialProvider, string, string, string, @@ -97,7 +93,6 @@ functions: package: botframework-connector summary: Validate an auth header. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAppCredentials.yml index 377ffbd9..c67deb30 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAppCredentials.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAppCredentials.yml @@ -5,16 +5,14 @@ package: botframework-connector summary: Managed Service Identity auth implementation. fullName: ManagedIdentityAppCredentials remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ManagedIdentityAppCredentials(string, string, IJwtTokenProviderFactory)' + - name: ManagedIdentityAppCredentials(string, string, IJwtTokenProviderFactory) uid: botframework-connector.ManagedIdentityAppCredentials.constructor package: botframework-connector summary: Managed Identity for AAD credentials auth and caching. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,18 +27,14 @@ constructors: description: The scope for the token. - id: tokenProviderFactory type: - description: | - The JWT token provider factory to use. + description: The JWT token provider factory to use. properties: - name: oAuthEndpoint uid: botframework-connector.ManagedIdentityAppCredentials.oAuthEndpoint package: botframework-connector - summary: |- - Gets the OAuth endpoint to use. - Sets the OAuth endpoint to use. + summary: Gets the OAuth endpoint to use. fullName: oAuthEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthEndpoint @@ -50,12 +44,9 @@ properties: - name: oAuthScope uid: botframework-connector.ManagedIdentityAppCredentials.oAuthScope package: botframework-connector - summary: |- - Gets the OAuth scope to use. - Sets the OAuth scope to use. + summary: Gets the OAuth scope to use. fullName: oAuthScope remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthScope @@ -69,7 +60,6 @@ inheritedProperties: summary: '' fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -85,7 +75,6 @@ inheritedProperties: summary: '' fullName: tokenCacheKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenCacheKey: string' @@ -100,8 +89,7 @@ inheritedMethods: uid: botframework-connector.ManagedIdentityAppCredentials.getToken package: botframework-connector summary: Gets an OAuth access token. - remarks: 'If the promise is successful, the result contains the access token string.' - isPreview: false + remarks: If the promise is successful, the result contains the access token string. isDeprecated: false syntax: content: 'function getToken(forceRefresh?: boolean): Promise' @@ -122,7 +110,6 @@ inheritedMethods: package: botframework-connector summary: Checks if the service url is for a trusted host or not. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -142,21 +129,20 @@ inheritedMethods: package: botframework-connector summary: Apply the credentials to the HTTP request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function signRequest(webResource: WebResource): Promise' parameters: - id: webResource - type: WebResource + type: description: The WebResource HTTP request. return: description: A Promise representing the asynchronous operation. - type: Promise<WebResource> + type: Promise<> inheritanceDescription: >- Inherited From [AppCredentials.signRequest](xref:botframework-connector.AppCredentials.signRequest) - - name: 'trustServiceUrl(string, Date)' + - name: trustServiceUrl(string, Date) uid: botframework-connector.ManagedIdentityAppCredentials.trustServiceUrl package: botframework-connector summary: >- @@ -165,7 +151,6 @@ inheritedMethods: If expiration time is not provided, the expiration date will be current (utc) date + 1 day. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAuthenticator.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAuthenticator.yml index 43cf057e..f2e372ba 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAuthenticator.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityAuthenticator.yml @@ -5,16 +5,14 @@ package: botframework-connector summary: Abstraction to acquire tokens from a Managed Service Identity. fullName: ManagedIdentityAuthenticator remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ManagedIdentityAuthenticator(string, string, IJwtTokenProviderFactory)' + - name: ManagedIdentityAuthenticator(string, string, IJwtTokenProviderFactory) uid: botframework-connector.ManagedIdentityAuthenticator.constructor package: botframework-connector summary: Initializes a new instance of the ManagedIdentityAuthenticator class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -29,15 +27,13 @@ constructors: description: Resource for which to acquire the token. - id: tokenProviderFactory type: - description: | - The JWT token provider factory to use. + description: The JWT token provider factory to use. methods: - name: getToken() uid: botframework-connector.ManagedIdentityAuthenticator.getToken package: botframework-connector summary: Acquires the security token. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getToken(): Promise' @@ -46,4 +42,4 @@ methods: A promise with the `AccessToken` provided by the [IJwtTokenProviderFactory](xref:botframework-connector.IJwtTokenProviderFactory) class. - type: Promise<AccessToken> + type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityServiceClientCredentialsFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityServiceClientCredentialsFactory.yml index 9b7d80ce..4ed3bbf3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityServiceClientCredentialsFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ManagedIdentityServiceClientCredentialsFactory.yml @@ -8,7 +8,6 @@ summary: >- abstract class. fullName: ManagedIdentityServiceClientCredentialsFactory remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -22,7 +21,6 @@ constructors: Initializes a new instance of the ManagedIdentityServiceClientCredentialsFactory class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,16 +32,14 @@ constructors: description: Client ID for the managed identity assigned to the bot. - id: tokenProviderFactory type: - description: | - The JWT token provider factory to use. + description: The JWT token provider factory to use. methods: - - name: 'createCredentials(string, string)' + - name: createCredentials(string, string) uid: >- botframework-connector.ManagedIdentityServiceClientCredentialsFactory.createCredentials package: botframework-connector - summary: '' + summary: A factory method for creating ServiceClientCredentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -52,41 +48,47 @@ methods: parameters: - id: appId type: string - description: '' + description: The appId. - id: audience type: string - description: '' + description: The audience. return: - description: '' - type: Promise<ServiceClientCredentials> + description: >- + A + [ServiceClientCredentials](xref:botframework-connector.ServiceClientCredentials). + type: >- + Promise<> - name: isAuthenticationDisabled() uid: >- botframework-connector.ManagedIdentityServiceClientCredentialsFactory.isAuthenticationDisabled package: botframework-connector - summary: '' + summary: Checks whether bot authentication is disabled. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAuthenticationDisabled(): Promise' return: - description: '' + description: >- + If bot authentication is disabled, the result is true; otherwise, + false. type: Promise<boolean> - name: isValidAppId(string) uid: >- botframework-connector.ManagedIdentityServiceClientCredentialsFactory.isValidAppId package: botframework-connector - summary: '' + summary: Validates an app ID. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidAppId(appId: string): Promise' parameters: - id: appId type: string - description: '' + description: The app ID to validate. return: - description: '' + description: >- + The result is true if `appId` is valid for the controller; otherwise, + false. type: Promise<boolean> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftAppCredentials.yml index 5e160552..f6a1c9ac 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftAppCredentials.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftAppCredentials.yml @@ -5,11 +5,10 @@ package: botframework-connector summary: MicrosoftAppCredentials auth implementation fullName: MicrosoftAppCredentials remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MicrosoftAppCredentials(string, string, string, string)' + - name: MicrosoftAppCredentials(string, string, string, string) uid: botframework-connector.MicrosoftAppCredentials.constructor package: botframework-connector summary: >- @@ -17,7 +16,6 @@ constructors: [MicrosoftAppCredentials](xref:botframework-connector.MicrosoftAppCredentials) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,11 +30,16 @@ constructors: description: The Microsoft app password. - id: channelAuthTenant type: string - description: Optional. The oauth token tenant. + description: >- + Tenant ID of the Azure AD tenant where the bot is created. + * Required for SingleTenant app types. + * Optional for MultiTenant app types. **Note**: '_botframework.com_' is the default tenant when no value is provided. + + More information: + https://learn.microsoft.com/en-us/security/zero-trust/develop/identity-supported-account-types. - id: oAuthScope type: string - description: | - Optional. The scope for the token. + description: Optional. The scope for the token. properties: - name: appPassword uid: botframework-connector.MicrosoftAppCredentials.appPassword @@ -44,7 +47,6 @@ properties: summary: '' fullName: appPassword remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appPassword: string' @@ -57,7 +59,6 @@ properties: summary: An empty set of credentials. fullName: Empty remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Empty: MicrosoftAppCredentials' @@ -67,12 +68,9 @@ properties: - name: oAuthEndpoint uid: botframework-connector.MicrosoftAppCredentials.oAuthEndpoint package: botframework-connector - summary: |- - Gets the OAuth endpoint to use. - Sets the OAuth endpoint to use. + summary: Gets the OAuth endpoint to use. fullName: oAuthEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthEndpoint @@ -82,12 +80,9 @@ properties: - name: oAuthScope uid: botframework-connector.MicrosoftAppCredentials.oAuthScope package: botframework-connector - summary: |- - Gets the OAuth scope to use. - Sets the OAuth scope to use. + summary: Gets the OAuth scope to use. fullName: oAuthScope remarks: '' - isPreview: false isDeprecated: false syntax: content: string oAuthScope @@ -101,7 +96,6 @@ inheritedProperties: summary: '' fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appId: string' @@ -117,7 +111,6 @@ inheritedProperties: summary: '' fullName: tokenCacheKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenCacheKey: string' @@ -128,33 +121,11 @@ inheritedProperties: Inherited From [AppCredentials.tokenCacheKey](xref:botframework-connector.AppCredentials.tokenCacheKey) inheritedMethods: - - name: getToken(boolean) - uid: botframework-connector.MicrosoftAppCredentials.getToken - package: botframework-connector - summary: Gets an OAuth access token. - remarks: 'If the promise is successful, the result contains the access token string.' - isPreview: false - isDeprecated: false - syntax: - content: 'function getToken(forceRefresh?: boolean): Promise' - parameters: - - id: forceRefresh - type: boolean - description: |- - True to force a refresh of the token; or false to get - a cached token if it exists. - return: - description: A Promise that represents the work queued to execute. - type: Promise<string> - inheritanceDescription: >- - Inherited From - [AppCredentials.getToken](xref:botframework-connector.AppCredentials.getToken) - name: isTrustedServiceUrl(string) uid: botframework-connector.MicrosoftAppCredentials.isTrustedServiceUrl package: botframework-connector summary: Checks if the service url is for a trusted host or not. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -174,21 +145,20 @@ inheritedMethods: package: botframework-connector summary: Apply the credentials to the HTTP request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function signRequest(webResource: WebResource): Promise' parameters: - id: webResource - type: WebResource + type: description: The WebResource HTTP request. return: description: A Promise representing the asynchronous operation. - type: Promise<WebResource> + type: Promise<> inheritanceDescription: >- Inherited From [AppCredentials.signRequest](xref:botframework-connector.AppCredentials.signRequest) - - name: 'trustServiceUrl(string, Date)' + - name: trustServiceUrl(string, Date) uid: botframework-connector.MicrosoftAppCredentials.trustServiceUrl package: botframework-connector summary: >- @@ -197,7 +167,6 @@ inheritedMethods: If expiration time is not provided, the expiration date will be current (utc) date + 1 day. remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -212,4 +181,22 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AppCredentials.trustServiceUrl](xref:botframework-connector.AppCredentials.trustServiceUrl) +methods: + - name: getToken(boolean) + uid: botframework-connector.MicrosoftAppCredentials.getToken + package: botframework-connector + summary: Gets an OAuth access token. + remarks: If the promise is successful, the result contains the access token string. + isDeprecated: false + syntax: + content: 'function getToken(forceRefresh?: boolean): Promise' + parameters: + - id: forceRefresh + type: boolean + description: |- + True to force a refresh of the token; or false to get + a cached token if it exists. + return: + description: A Promise that represents the work queued to execute. + type: Promise<string> extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftGovernmentAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftGovernmentAppCredentials.yml new file mode 100644 index 00000000..aba961b5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MicrosoftGovernmentAppCredentials.yml @@ -0,0 +1,202 @@ +### YamlMime:TSType +name: MicrosoftGovernmentAppCredentials +uid: botframework-connector.MicrosoftGovernmentAppCredentials +package: botframework-connector +summary: MicrosoftGovermentAppCredentials auth implementation +fullName: MicrosoftGovernmentAppCredentials +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MicrosoftGovernmentAppCredentials(string, string, string, string) + uid: botframework-connector.MicrosoftGovernmentAppCredentials.constructor + package: botframework-connector + summary: >- + Initializes a new instance of the + [MicrosoftGovernmentAppCredentials](xref:botframework-connector.MicrosoftGovernmentAppCredentials) + class. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MicrosoftGovernmentAppCredentials(appId: string, appPassword: + string, channelAuthTenant?: string, oAuthScope?: string) + parameters: + - id: appId + type: string + description: The Microsoft app ID. + - id: appPassword + type: string + description: The Microsoft app password. + - id: channelAuthTenant + type: string + description: Optional. The oauth token tenant. + - id: oAuthScope + type: string + description: Optional. The scope for the token. +properties: + - name: appPassword + uid: botframework-connector.MicrosoftGovernmentAppCredentials.appPassword + package: botframework-connector + summary: '' + fullName: appPassword + remarks: '' + isDeprecated: false + syntax: + content: 'appPassword: string' + return: + description: '' + type: string + - name: oAuthEndpoint + uid: botframework-connector.MicrosoftGovernmentAppCredentials.oAuthEndpoint + package: botframework-connector + summary: Gets the OAuth endpoint to use. + fullName: oAuthEndpoint + remarks: '' + isDeprecated: false + syntax: + content: string oAuthEndpoint + return: + description: The OAuthEndpoint to use. + type: string + - name: oAuthScope + uid: botframework-connector.MicrosoftGovernmentAppCredentials.oAuthScope + package: botframework-connector + summary: Gets the OAuth scope to use. + fullName: oAuthScope + remarks: '' + isDeprecated: false + syntax: + content: string oAuthScope + return: + description: The OAuth scope to use. + type: string +inheritedProperties: + - name: appId + uid: botframework-connector.MicrosoftGovernmentAppCredentials.appId + package: botframework-connector + summary: '' + fullName: appId + remarks: '' + isDeprecated: false + syntax: + content: 'appId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.appId](xref:botframework-connector.MicrosoftAppCredentials.appId) + - name: Empty + uid: botframework-connector.MicrosoftGovernmentAppCredentials.Empty + package: botframework-connector + summary: An empty set of credentials. + fullName: Empty + remarks: '' + isDeprecated: false + syntax: + content: 'static Empty: MicrosoftAppCredentials' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.Empty](xref:botframework-connector.MicrosoftAppCredentials.Empty) + - name: tokenCacheKey + uid: botframework-connector.MicrosoftGovernmentAppCredentials.tokenCacheKey + package: botframework-connector + summary: '' + fullName: tokenCacheKey + remarks: '' + isDeprecated: false + syntax: + content: 'tokenCacheKey: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.tokenCacheKey](xref:botframework-connector.MicrosoftAppCredentials.tokenCacheKey) +inheritedMethods: + - name: getToken(boolean) + uid: botframework-connector.MicrosoftGovernmentAppCredentials.getToken + package: botframework-connector + summary: Gets an OAuth access token. + remarks: If the promise is successful, the result contains the access token string. + isDeprecated: false + syntax: + content: 'function getToken(forceRefresh?: boolean): Promise' + parameters: + - id: forceRefresh + type: boolean + description: |- + True to force a refresh of the token; or false to get + a cached token if it exists. + return: + description: A Promise that represents the work queued to execute. + type: Promise<string> + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.getToken](xref:botframework-connector.MicrosoftAppCredentials.getToken) + - name: isTrustedServiceUrl(string) + uid: >- + botframework-connector.MicrosoftGovernmentAppCredentials.isTrustedServiceUrl + package: botframework-connector + summary: Checks if the service url is for a trusted host or not. + remarks: '' + isDeprecated: true + customDeprecatedMessage: '' + syntax: + content: 'static function isTrustedServiceUrl(serviceUrl: string): boolean' + parameters: + - id: serviceUrl + type: string + description: The service url + return: + description: True if the host of the service url is trusted; False otherwise. + type: boolean + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.isTrustedServiceUrl](xref:botframework-connector.MicrosoftAppCredentials.isTrustedServiceUrl) + - name: signRequest(WebResource) + uid: botframework-connector.MicrosoftGovernmentAppCredentials.signRequest + package: botframework-connector + summary: Apply the credentials to the HTTP request. + remarks: '' + isDeprecated: false + syntax: + content: 'function signRequest(webResource: WebResource): Promise' + parameters: + - id: webResource + type: + description: The WebResource HTTP request. + return: + description: A Promise representing the asynchronous operation. + type: Promise<> + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.signRequest](xref:botframework-connector.MicrosoftAppCredentials.signRequest) + - name: trustServiceUrl(string, Date) + uid: botframework-connector.MicrosoftGovernmentAppCredentials.trustServiceUrl + package: botframework-connector + summary: >- + Adds the host of service url to trusted hosts. + + If expiration time is not provided, the expiration date will be current + (utc) date + 1 day. + remarks: '' + isDeprecated: true + customDeprecatedMessage: '' + syntax: + content: 'static function trustServiceUrl(serviceUrl: string, expiration?: Date)' + parameters: + - id: serviceUrl + type: string + description: The service url + - id: expiration + type: Date + description: '' + inheritanceDescription: >- + Inherited From + [MicrosoftAppCredentials.trustServiceUrl](xref:botframework-connector.MicrosoftAppCredentials.trustServiceUrl) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalAppCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalAppCredentials.yml new file mode 100644 index 00000000..646c1123 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalAppCredentials.yml @@ -0,0 +1,237 @@ +### YamlMime:TSType +name: MsalAppCredentials +uid: botframework-connector.MsalAppCredentials +package: botframework-connector +summary: >- + An implementation of AppCredentials that uses @azure/msal-node to fetch + tokens. +fullName: MsalAppCredentials +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MsalAppCredentials(ConfidentialClientApplication, string, string, string) + uid: botframework-connector.MsalAppCredentials.constructor + package: botframework-connector + summary: >- + Create an MsalAppCredentials instance using a confidential client + application. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalAppCredentials(clientApplication: ConfidentialClientApplication, + appId: string, authority: string, scope: string) + parameters: + - id: clientApplication + type: + description: An @azure/msal-node ConfidentialClientApplication instance. + - id: appId + type: string + description: The application ID. + - id: authority + type: string + description: The authority to use for fetching tokens + - id: scope + type: string + description: The oauth scope to use when fetching tokens. + - name: MsalAppCredentials(string, Certificate, string, string) + uid: botframework-connector.MsalAppCredentials.constructor_2 + package: botframework-connector + summary: >- + Create an MsalAppCredentials instance using a confidential client + application. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalAppCredentials(appId: string, certificate: Certificate, + authority: string, scope: string) + parameters: + - id: appId + type: string + description: The application ID. + - id: certificate + type: Certificate + description: The client certificate details. + - id: authority + type: string + description: The authority to use for fetching tokens + - id: scope + type: string + description: The oauth scope to use when fetching tokens. + - name: MsalAppCredentials(string, string, string, string) + uid: botframework-connector.MsalAppCredentials.constructor_1 + package: botframework-connector + summary: >- + Create an MsalAppCredentials instance using a confidential client + application. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalAppCredentials(appId: string, appPassword: string, authority: + string, scope: string) + parameters: + - id: appId + type: string + description: The application ID. + - id: appPassword + type: string + description: The application password. + - id: authority + type: string + description: The authority to use for fetching tokens + - id: scope + type: string + description: The oauth scope to use when fetching tokens. +properties: + - name: Empty + uid: botframework-connector.MsalAppCredentials.Empty + package: botframework-connector + summary: A reference used for Empty auth scenarios + fullName: Empty + remarks: '' + isDeprecated: false + syntax: + content: 'static Empty: MsalAppCredentials' + return: + description: '' + type: + - name: oAuthEndpoint + uid: botframework-connector.MsalAppCredentials.oAuthEndpoint + package: botframework-connector + summary: Gets the OAuth endpoint to use. + fullName: oAuthEndpoint + remarks: '' + isDeprecated: false + syntax: + content: string oAuthEndpoint + return: + description: The OAuthEndpoint to use. + type: string + - name: oAuthScope + uid: botframework-connector.MsalAppCredentials.oAuthScope + package: botframework-connector + summary: Gets the OAuth scope to use. + fullName: oAuthScope + remarks: '' + isDeprecated: false + syntax: + content: string oAuthScope + return: + description: The OAuth scope to use. + type: string +inheritedProperties: + - name: appId + uid: botframework-connector.MsalAppCredentials.appId + package: botframework-connector + summary: '' + fullName: appId + remarks: '' + isDeprecated: false + syntax: + content: 'appId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AppCredentials.appId](xref:botframework-connector.AppCredentials.appId) + - name: tokenCacheKey + uid: botframework-connector.MsalAppCredentials.tokenCacheKey + package: botframework-connector + summary: '' + fullName: tokenCacheKey + remarks: '' + isDeprecated: false + syntax: + content: 'tokenCacheKey: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AppCredentials.tokenCacheKey](xref:botframework-connector.AppCredentials.tokenCacheKey) +inheritedMethods: + - name: getToken(boolean) + uid: botframework-connector.MsalAppCredentials.getToken + package: botframework-connector + summary: Gets an OAuth access token. + remarks: If the promise is successful, the result contains the access token string. + isDeprecated: false + syntax: + content: 'function getToken(forceRefresh?: boolean): Promise' + parameters: + - id: forceRefresh + type: boolean + description: |- + True to force a refresh of the token; or false to get + a cached token if it exists. + return: + description: A Promise that represents the work queued to execute. + type: Promise<string> + inheritanceDescription: >- + Inherited From + [AppCredentials.getToken](xref:botframework-connector.AppCredentials.getToken) + - name: isTrustedServiceUrl(string) + uid: botframework-connector.MsalAppCredentials.isTrustedServiceUrl + package: botframework-connector + summary: Checks if the service url is for a trusted host or not. + remarks: '' + isDeprecated: true + customDeprecatedMessage: '' + syntax: + content: 'static function isTrustedServiceUrl(serviceUrl: string): boolean' + parameters: + - id: serviceUrl + type: string + description: The service url + return: + description: True if the host of the service url is trusted; False otherwise. + type: boolean + inheritanceDescription: >- + Inherited From + [AppCredentials.isTrustedServiceUrl](xref:botframework-connector.AppCredentials.isTrustedServiceUrl) + - name: signRequest(WebResource) + uid: botframework-connector.MsalAppCredentials.signRequest + package: botframework-connector + summary: Apply the credentials to the HTTP request. + remarks: '' + isDeprecated: false + syntax: + content: 'function signRequest(webResource: WebResource): Promise' + parameters: + - id: webResource + type: + description: The WebResource HTTP request. + return: + description: A Promise representing the asynchronous operation. + type: Promise<> + inheritanceDescription: >- + Inherited From + [AppCredentials.signRequest](xref:botframework-connector.AppCredentials.signRequest) + - name: trustServiceUrl(string, Date) + uid: botframework-connector.MsalAppCredentials.trustServiceUrl + package: botframework-connector + summary: >- + Adds the host of service url to trusted hosts. + + If expiration time is not provided, the expiration date will be current + (utc) date + 1 day. + remarks: '' + isDeprecated: true + customDeprecatedMessage: '' + syntax: + content: 'static function trustServiceUrl(serviceUrl: string, expiration?: Date)' + parameters: + - id: serviceUrl + type: string + description: The service url + - id: expiration + type: Date + description: '' + inheritanceDescription: >- + Inherited From + [AppCredentials.trustServiceUrl](xref:botframework-connector.AppCredentials.trustServiceUrl) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalServiceClientCredentialsFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalServiceClientCredentialsFactory.yml new file mode 100644 index 00000000..3c954c9e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/MsalServiceClientCredentialsFactory.yml @@ -0,0 +1,97 @@ +### YamlMime:TSType +name: MsalServiceClientCredentialsFactory +uid: botframework-connector.MsalServiceClientCredentialsFactory +package: botframework-connector +summary: >- + An implementation of ServiceClientCredentialsFactory that generates + MsalAppCredentials +fullName: MsalServiceClientCredentialsFactory +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MsalServiceClientCredentialsFactory(string, ConfidentialClientApplication) + uid: botframework-connector.MsalServiceClientCredentialsFactory.constructor + package: botframework-connector + summary: >- + Create an MsalServiceClientCredentialsFactory instance using runtime + configuration and an + + `@azure/msal-node` `ConfidentialClientApplication`. + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalServiceClientCredentialsFactory(appId: string, + clientApplication: ConfidentialClientApplication) + parameters: + - id: appId + type: string + description: App ID for validation. + - id: clientApplication + type: + description: An `@azure/msal-node` `ConfidentialClientApplication` instance. +methods: + - name: createCredentials(string, string, string, boolean) + uid: >- + botframework-connector.MsalServiceClientCredentialsFactory.createCredentials + package: botframework-connector + summary: A factory method for creating ServiceClientCredentials. + remarks: '' + isDeprecated: false + syntax: + content: >- + function createCredentials(appId: string, audience: string, + loginEndpoint: string, _validateAuthority: boolean): + Promise + parameters: + - id: appId + type: string + description: The appId. + - id: audience + type: string + description: The audience. + - id: loginEndpoint + type: string + description: The login url. + - id: _validateAuthority + type: boolean + description: The validate authority value to use. + return: + description: >- + A + [ServiceClientCredentials](xref:botframework-connector.ServiceClientCredentials). + type: >- + Promise<> + - name: isAuthenticationDisabled() + uid: >- + botframework-connector.MsalServiceClientCredentialsFactory.isAuthenticationDisabled + package: botframework-connector + summary: Checks whether bot authentication is disabled. + remarks: '' + isDeprecated: false + syntax: + content: 'function isAuthenticationDisabled(): Promise' + return: + description: >- + If bot authentication is disabled, the result is true; otherwise, + false. + type: Promise<boolean> + - name: isValidAppId(string) + uid: botframework-connector.MsalServiceClientCredentialsFactory.isValidAppId + package: botframework-connector + summary: Validates an app ID. + remarks: '' + isDeprecated: false + syntax: + content: 'function isValidAppId(appId: string): Promise' + parameters: + - id: appId + type: string + description: The app ID to validate. + return: + description: >- + The result is true if `appId` is valid for the controller; otherwise, + false. + type: Promise<boolean> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/OpenIdMetadata.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/OpenIdMetadata.yml deleted file mode 100644 index e02694ea..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/OpenIdMetadata.yml +++ /dev/null @@ -1,49 +0,0 @@ -### YamlMime:TSType -name: OpenIdMetadata -uid: botframework-connector.OpenIdMetadata -package: botframework-connector -summary: Class in charge of manage OpenId metadata. -fullName: OpenIdMetadata -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: OpenIdMetadata(string) - uid: botframework-connector.OpenIdMetadata.constructor - package: botframework-connector - summary: >- - Initializes a new instance of the - [OpenIdMetadata](xref:botframework-connector.OpenIdMetadata) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new OpenIdMetadata(url: string)' - parameters: - - id: url - type: string - description: | - Metadata Url. -methods: - - name: getKey(string) - uid: botframework-connector.OpenIdMetadata.getKey - package: botframework-connector - summary: Gets the Signing key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKey(keyId: string): Promise' - parameters: - - id: keyId - type: string - description: The key ID to search for. - return: - description: >- - A `Promise` representation for either a - [IOpenIdMetadataKey](botframework-connector:module.IOpenIdMetadataKey) - or `null`. - type: >- - Promise< | - null> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ParameterizedBotFrameworkAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ParameterizedBotFrameworkAuthentication.yml deleted file mode 100644 index 1653cd43..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ParameterizedBotFrameworkAuthentication.yml +++ /dev/null @@ -1,220 +0,0 @@ -### YamlMime:TSType -name: ParameterizedBotFrameworkAuthentication -uid: botframework-connector.ParameterizedBotFrameworkAuthentication -package: botframework-connector -summary: '' -fullName: ParameterizedBotFrameworkAuthentication -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - ParameterizedBotFrameworkAuthentication(boolean, string, string, string, - string, string, string, string, ServiceClientCredentialsFactory, - AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => - Promise, ConnectorClientOptions) - uid: botframework-connector.ParameterizedBotFrameworkAuthentication.constructor - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ParameterizedBotFrameworkAuthentication(validateAuthority: boolean, - toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, - toBotFromChannelTokenIssuer: string, oAuthUrl: string, - toBotFromChannelOpenIdMetadataUrl: string, - toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, - credentialsFactory: ServiceClientCredentialsFactory, authConfiguration: - AuthenticationConfiguration, botFrameworkClientFetch?: (input: - RequestInfo, init?: RequestInit) => Promise, - connectorClientOptions?: ConnectorClientOptions) - parameters: - - id: validateAuthority - type: boolean - description: The validate authority value to use. - - id: toChannelFromBotLoginUrl - type: string - description: The to Channel from bot login url. - - id: toChannelFromBotOAuthScope - type: string - description: The to Channel from bot oauth scope. - - id: toBotFromChannelTokenIssuer - type: string - description: The to bot from Channel Token Issuer. - - id: oAuthUrl - type: string - description: The OAuth url. - - id: toBotFromChannelOpenIdMetadataUrl - type: string - description: The to bot from Channel Open Id Metadata url. - - id: toBotFromEmulatorOpenIdMetadataUrl - type: string - description: The to bot from Emulator Open Id Metadata url. - - id: callerId - type: string - description: >- - The callerId set on an authenticated - [Activities](xref:botframework-schema.Activity). - - id: credentialsFactory - type: >- - - description: >- - The - [ServiceClientCredentialsFactory](xref:botframework-connector.ServiceClientCredentialsFactory) - to use to create credentials. - - id: authConfiguration - type: - description: >- - The - [AuthenticationConfiguration](xref:botframework-connector.AuthenticationConfiguration) - to use. - - id: botFrameworkClientFetch - type: >- - (input: RequestInfo, init?: RequestInit) => - Promise<Response> - description: The fetch to use in BotFrameworkClient. - - id: connectorClientOptions - type: - description: > - The - [ConnectorClientOptions](xref:botframework-connector.ConnectorClientOptions) - to use when creating ConnectorClients. -methods: - - name: authenticateChannelRequest(string) - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.authenticateChannelRequest - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function authenticateChannelRequest(authHeader: string): - Promise - parameters: - - id: authHeader - type: string - description: The http auth header received in the skill request. - return: - description: The identity validation result. - type: Promise<> - - name: 'authenticateRequest(Activity, string)' - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.authenticateRequest - package: botframework-connector - summary: Validate Bot Framework Protocol requests. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function authenticateRequest(activity: Activity, authHeader: string): - Promise - parameters: - - id: activity - type: Activity - description: The inbound Activity. - - id: authHeader - type: string - description: The http auth header received in the skill request. - return: - description: Promise with AuthenticateRequestResult. - type: >- - Promise<> - - name: 'authenticateStreamingRequest(string, string)' - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.authenticateStreamingRequest - package: botframework-connector - summary: Validate Bot Framework Protocol requests. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function authenticateStreamingRequest(authHeader: string, - channelIdHeader: string): Promise - parameters: - - id: authHeader - type: string - description: The http auth header received in the skill request. - - id: channelIdHeader - type: string - description: The channel Id HTTP header. - return: - description: Promise with AuthenticateRequestResult. - type: >- - Promise<> - - name: createBotFrameworkClient() - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.createBotFrameworkClient - package: botframework-connector - summary: Creates a BotFrameworkClient used for calling Skills. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function createBotFrameworkClient(): BotFrameworkClient' - return: - description: A BotFrameworkClient instance to call Skills. - type: - - name: createConnectorFactory(ClaimsIdentity) - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.createConnectorFactory - package: botframework-connector - summary: >- - Creates a ConnectorFactory that can be used to create ConnectorClients - that can use credentials from this particular Cloud Environment. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createConnectorFactory(claimsIdentity: ClaimsIdentity): - ConnectorFactory - parameters: - - id: claimsIdentity - type: - description: The inbound Activity's ClaimsIdentity. - return: - description: A ConnectorFactory. - type: - - name: createUserTokenClient(ClaimsIdentity) - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.createUserTokenClient - package: botframework-connector - summary: Creates the appropriate UserTokenClient instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createUserTokenClient(claimsIdentity: ClaimsIdentity): - Promise - parameters: - - id: claimsIdentity - type: - description: The inbound Activity's ClaimsIdentity. - return: - description: Promise with UserTokenClient instance. - type: Promise<> - - name: getOriginatingAudience() - uid: >- - botframework-connector.ParameterizedBotFrameworkAuthentication.getOriginatingAudience - package: botframework-connector - summary: Gets the originating audience from Bot OAuth scope. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getOriginatingAudience(): string' - return: - description: The originating audience. - type: string -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/PasswordServiceClientCredentialFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/PasswordServiceClientCredentialFactory.yml index 7836e007..366a24d0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/PasswordServiceClientCredentialFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/PasswordServiceClientCredentialFactory.yml @@ -8,11 +8,10 @@ summary: >- interface. fullName: PasswordServiceClientCredentialFactory remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'PasswordServiceClientCredentialFactory(string, string)' + - name: PasswordServiceClientCredentialFactory(string, string) uid: botframework-connector.PasswordServiceClientCredentialFactory.constructor package: botframework-connector summary: >- @@ -20,7 +19,6 @@ constructors: [PasswordServiceClientCredentialFactory](xref:botframework-connector.PasswordServiceClientCredentialFactory) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,9 +30,8 @@ constructors: description: The app ID. - id: password type: string - description: | - The app password. - - name: 'PasswordServiceClientCredentialFactory(string, string, string)' + description: The app password. + - name: PasswordServiceClientCredentialFactory(string, string, string) uid: >- botframework-connector.PasswordServiceClientCredentialFactory.constructor_1 package: botframework-connector @@ -43,7 +40,6 @@ constructors: [PasswordServiceClientCredentialFactory](xref:botframework-connector.PasswordServiceClientCredentialFactory) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -55,12 +51,16 @@ constructors: description: The app ID. - id: password type: string - description: | - The app password. + description: The app password. - id: tenantId type: string - description: | + description: >- Tenant ID of the Azure AD tenant where the bot is created. + * Required for SingleTenant app types. + * Optional for MultiTenant app types. **Note**: '_botframework.com_' is the default tenant when no value is provided. + + More information: + https://learn.microsoft.com/en-us/security/zero-trust/develop/identity-supported-account-types. properties: - name: appId uid: botframework-connector.PasswordServiceClientCredentialFactory.appId @@ -68,47 +68,43 @@ properties: summary: The app ID for this credential. fullName: appId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'appId: string | null' + content: 'appId: null | string' return: description: '' - type: string | null + type: null | string - name: password uid: botframework-connector.PasswordServiceClientCredentialFactory.password package: botframework-connector summary: The app password for this credential. fullName: password remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'password: string | null' + content: 'password: null | string' return: description: '' - type: string | null + type: null | string - name: tenantId uid: botframework-connector.PasswordServiceClientCredentialFactory.tenantId package: botframework-connector summary: The tenant ID of the Azure AD tenant where the bot is created. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'tenantId: string | null' + content: 'tenantId: null | string' return: description: '' - type: string | null + type: null | string methods: - - name: 'createCredentials(string, string, string, boolean)' + - name: createCredentials(string, string, string, boolean) uid: >- botframework-connector.PasswordServiceClientCredentialFactory.createCredentials package: botframework-connector summary: A factory method for creating ServiceClientCredentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,14 +126,15 @@ methods: description: The validate authority value to use. return: description: A Promise representing the result of the operation. - type: Promise<ServiceClientCredentials> + type: >- + Promise<> - name: isAuthenticationDisabled() uid: >- botframework-connector.PasswordServiceClientCredentialFactory.isAuthenticationDisabled package: botframework-connector summary: Checks whether bot authentication is disabled. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAuthenticationDisabled(): Promise' @@ -149,7 +146,6 @@ methods: package: botframework-connector summary: Validates an app ID. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidAppId(appId?: string): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ReadReceiptInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ReadReceiptInfo.yml index 4d866597..3b090331 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ReadReceiptInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ReadReceiptInfo.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: General information about a read receipt. fullName: ReadReceiptInfo remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,15 +13,13 @@ constructors: package: botframework-connector summary: Initializes a new instance of the ReadReceiptInfo class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ReadReceiptInfo(lastReadMessageId?: string)' parameters: - id: lastReadMessageId type: string - description: | - Optional. The id of the last read message. + description: Optional. The id of the last read message. properties: - name: lastReadMessageId uid: botframework-connector.ReadReceiptInfo.lastReadMessageId @@ -30,7 +27,6 @@ properties: summary: The id of the last read message. fullName: lastReadMessageId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'lastReadMessageId: string' @@ -47,7 +43,6 @@ methods: If the compareMessageId is less than or equal to the lastReadMessageId, then the message has been read. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isMessageRead(compareMessageId: string): boolean' @@ -60,7 +55,7 @@ methods: True if the compareMessageId is less than or equal to the lastReadMessageId. type: boolean - - name: 'isMessageRead(string, string)' + - name: isMessageRead(string, string) uid: botframework-connector.ReadReceiptInfo.isMessageRead package: botframework-connector summary: >- @@ -72,7 +67,6 @@ methods: the lastReadMessageId, then the message has been read. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentials.yml new file mode 100644 index 00000000..76f97824 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentials.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: ServiceClientCredentials +uid: botframework-connector.ServiceClientCredentials +package: botframework-connector +summary: >- + Represents an object or class with a `signRequest` method which will sign + outgoing requests (for example, by setting the `Authorization` header). +fullName: ServiceClientCredentials +remarks: '' +isDeprecated: false +type: interface +methods: + - name: signRequest(WebResourceLike) + uid: botframework-connector.ServiceClientCredentials.signRequest + package: botframework-connector + summary: Signs a request with the Authentication header. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signRequest(webResource: WebResourceLike): + Promise + parameters: + - id: webResource + type: + description: The WebResourceLike/request to be signed. + return: + description: The signed request object; + type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentialsFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentialsFactory.yml index 268e1411..2523e535 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentialsFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ServiceClientCredentialsFactory.yml @@ -10,20 +10,18 @@ summary: >- calls. fullName: ServiceClientCredentialsFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'createCredentials(string, string | undefined, string, boolean)' + - name: createCredentials(string, undefined | string, string, boolean) uid: botframework-connector.ServiceClientCredentialsFactory.createCredentials package: botframework-connector summary: A factory method for creating ServiceClientCredentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function createCredentials(appId: string, audience: string | undefined, + function createCredentials(appId: string, audience: undefined | string, loginEndpoint: string, validateAuthority: boolean): Promise parameters: @@ -31,7 +29,7 @@ methods: type: string description: The appId. - id: audience - type: string | undefined + type: undefined | string description: The audience. - id: loginEndpoint type: string @@ -43,14 +41,15 @@ methods: description: >- A [ServiceClientCredentials](xref:botframework-connector.ServiceClientCredentials). - type: Promise<ServiceClientCredentials> + type: >- + Promise<> - name: isAuthenticationDisabled() uid: >- botframework-connector.ServiceClientCredentialsFactory.isAuthenticationDisabled package: botframework-connector summary: Checks whether bot authentication is disabled. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAuthenticationDisabled(): Promise' @@ -64,7 +63,6 @@ methods: package: botframework-connector summary: Validates an app ID. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidAppId(appId: string): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/SignInUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/SignInUrlResponse.yml new file mode 100644 index 00000000..f5f63253 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/SignInUrlResponse.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SignInUrlResponse +uid: botframework-connector.SignInUrlResponse +package: botframework-connector +summary: '' +fullName: SignInUrlResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: signInLink + uid: botframework-connector.SignInUrlResponse.signInLink + package: botframework-connector + summary: '' + fullName: signInLink + remarks: '' + isDeprecated: false + syntax: + content: 'signInLink?: string' + return: + description: '' + type: string + - name: tokenExchangeResource + uid: botframework-connector.SignInUrlResponse.tokenExchangeResource + package: botframework-connector + summary: '' + fullName: tokenExchangeResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenExchangeResource?: TokenExchangeResource' + return: + description: '' + type: TokenExchangeResource + - name: tokenPostResource + uid: botframework-connector.SignInUrlResponse.tokenPostResource + package: botframework-connector + summary: '' + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource?: TokenPostResource' + return: + description: '' + type: TokenPostResource diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/SimpleCredentialProvider.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/SimpleCredentialProvider.yml index a758ae57..cb232f5c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/SimpleCredentialProvider.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/SimpleCredentialProvider.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: SimpleCredentialProvider remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: >- Use `ConfigurationBotFrameworkAuthentication` instead to configure @@ -16,7 +15,7 @@ customDeprecatedMessage: >- interface. type: class constructors: - - name: 'SimpleCredentialProvider(string, string)' + - name: SimpleCredentialProvider(string, string) uid: botframework-connector.SimpleCredentialProvider.constructor package: botframework-connector summary: >- @@ -24,7 +23,6 @@ constructors: [SimpleCredentialProvider](xref:botframework-connector.SimpleCredentialProvider) class with the provided credentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SimpleCredentialProvider(appId: string, appPassword: string)' @@ -34,46 +32,45 @@ constructors: description: The app ID. - id: appPassword type: string - description: | - The app password. + description: The app password. methods: - name: getAppPassword(string) uid: botframework-connector.SimpleCredentialProvider.getAppPassword package: botframework-connector - summary: > + summary: >- Get the app password for a given bot appId, if it is not a valid appId, return Null + This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getAppPassword(appId: string): Promise' + content: 'function getAppPassword(appId: string): Promise' parameters: - id: appId type: string description: bot appid return: description: password or null for invalid appid - type: Promise<string | null> + type: Promise<null | string> - name: isAuthenticationDisabled() uid: botframework-connector.SimpleCredentialProvider.isAuthenticationDisabled package: botframework-connector - summary: > + summary: >- Checks if bot authentication is disabled. Return true if bot authentication is disabled. + This method is async to enable custom implementations that may need to call out to serviced to validate the appId / password pair. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAuthenticationDisabled(): Promise' @@ -83,15 +80,15 @@ methods: - name: isValidAppId(string) uid: botframework-connector.SimpleCredentialProvider.isValidAppId package: botframework-connector - summary: > + summary: >- Validate AppId. + This method is async to enable custom implementations that may need to call out to service to validate the appId / password pair. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isValidAppId(appId: string): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/SkillValidation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/SkillValidation.yml index 2bfb2b51..8f1669cb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/SkillValidation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/SkillValidation.yml @@ -14,7 +14,6 @@ functions: Validates that the incoming Auth Header is a token sent from a bot to a skill or from a skill to a bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,7 +26,7 @@ functions: description: 'The raw HTTP header in the format: "Bearer [longString]".' - id: credentials type: - description: 'The user defined set of valid credentials, such as the AppId.' + description: The user defined set of valid credentials, such as the AppId. - id: channelService type: string description: >- @@ -49,7 +48,6 @@ functions: Creates a set of claims that represent an anonymous skill. Useful for testing bots locally in the emulator remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createAnonymousSkillClaim(): ClaimsIdentity' @@ -62,7 +60,7 @@ functions: [AuthenticationConstants.AnonymousSkillAppId](xref.botframework-connector.AuthenticationConstants) claim. type: - - name: 'isSkillClaim(Claim[])' + - name: isSkillClaim(Claim[]) uid: botframework-connector.SkillValidation.isSkillClaim package: botframework-connector summary: Checks if the given object of claims represents a skill. @@ -75,16 +73,15 @@ functions: The audience claim should be a guid, indicating that it is from another bot/skill. - isPreview: false isDeprecated: false syntax: content: 'function isSkillClaim(claims: Claim[]): boolean' parameters: - id: claims - type: '[]' + type: [] description: An object of claims. return: - description: 'True if the object of claims is a skill claim, false if is not.' + description: True if the object of claims is a skill claim, false if is not. type: boolean - name: isSkillToken(string) uid: botframework-connector.SkillValidation.isSkillToken @@ -93,14 +90,13 @@ functions: Determines if a given Auth header is from a skill to bot or bot to skill request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isSkillToken(authHeader: string): boolean' parameters: - id: authHeader type: string - description: 'Bearer Token, in the "Bearer [Long String]" Format.' + description: Bearer Token, in the "Bearer [Long String]" Format. return: description: >- True, if the token was issued for a skill to bot communication. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/StatusCode.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/StatusCode.yml index a8562893..1aa2644b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/StatusCode.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/StatusCode.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: StatusCode remarks: '' -isPreview: false isDeprecated: false syntax: | type StatusCode = number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Teams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/Teams.yml index 9c5d4677..3a0ff3ab 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/Teams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/Teams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: Class representing a Teams. fullName: Teams remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,37 +13,60 @@ constructors: package: botframework-connector summary: Create a Teams. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new Teams(client: TeamsConnectorClientContext)' parameters: - id: client type: - description: | - Reference to the service client. + description: Reference to the service client. methods: - - name: 'fetchChannelList(string, RequestOptionsBase)' + - name: cancelOperation(string, RequestOptionsBase) + uid: botframework-connector.Teams.cancelOperation + package: botframework-connector + summary: Cancel an operation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function cancelOperation(operationId: string, options?: + RequestOptionsBase): Promise + parameters: + - id: operationId + type: string + description: The id of the operation to cancel. + - id: options + type: + description: The optional parameters. + return: + description: Promise with CancelOperationResponse. + type: >- + Promise<> + - name: fetchChannelList(string, RequestOptionsBase) uid: botframework-connector.Teams.fetchChannelList package: botframework-connector summary: Fetches channel list for a given team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function fetchChannelList(teamId: string, options?: RequestOptionsBase): - Promise + Promise parameters: - id: teamId type: string description: Team Id. - id: options - type: RequestOptionsBase + type: description: Optional. The options object to be used in every request. return: description: A `Promise`. - type: Promise<> + type: >- + Promise<> - name: >- fetchChannelList(string, RequestOptionsBase, ServiceCallback) @@ -52,7 +74,6 @@ methods: package: botframework-connector summary: Fetches channel list for a given team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -63,18 +84,18 @@ methods: type: string description: Team Id. - id: options - type: RequestOptionsBase + type: description: The options object to be used in every request. - id: callback - type: ServiceCallback<ConversationList> - description: | - The callback. - - name: 'fetchChannelList(string, ServiceCallback)' + type: >- + <ConversationList> + description: The callback. + - name: fetchChannelList(string, ServiceCallback) uid: botframework-connector.Teams.fetchChannelList_1 package: botframework-connector summary: Fetches channel list for a given team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -85,9 +106,10 @@ methods: type: string description: Team Id. - id: callback - type: ServiceCallback<ConversationList> - description: | - The callback. + type: >- + <ConversationList> + description: The callback. - name: >- fetchMeetingInfo(string, RequestOptionsBase | ServiceCallback) @@ -95,23 +117,27 @@ methods: package: botframework-connector summary: Fetch meeting information. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function fetchMeetingInfo(meetingId: string, options?: RequestOptionsBase | ServiceCallback): - Promise + Promise parameters: - id: meetingId type: string - description: 'Meeting Id, encoded as a BASE64 string.' + description: Meeting Id, encoded as a BASE64 string. - id: options - type: RequestOptionsBase | ServiceCallback<TeamDetails> - description: '' + type: >- + | <TeamDetails> + description: The optional parameters return: description: Promise - type: Promise<> + type: >- + Promise<> - name: >- fetchMeetingInfo(string, RequestOptionsBase | ServiceCallback, ServiceCallback) @@ -119,7 +145,6 @@ methods: package: botframework-connector summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -129,20 +154,22 @@ methods: parameters: - id: meetingId type: string - description: 'Meeting Id, encoded as a BASE64 string.' + description: Meeting Id, encoded as a BASE64 string. - id: options - type: RequestOptionsBase | ServiceCallback<TeamDetails> + type: >- + | <TeamDetails> description: The optional parameters - id: callback - type: ServiceCallback<TeamsMeetingInfo> - description: | - The callback - - name: 'fetchMeetingInfo(string, ServiceCallback)' + type: >- + <TeamsMeetingInfo> + description: The callback + - name: fetchMeetingInfo(string, ServiceCallback) uid: botframework-connector.Teams.fetchMeetingInfo_1 package: botframework-connector summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -151,11 +178,12 @@ methods: parameters: - id: meetingId type: string - description: 'Meeting Id, encoded as a BASE64 string.' + description: Meeting Id, encoded as a BASE64 string. - id: callback - type: ServiceCallback<TeamsMeetingInfo> - description: | - The callback + type: >- + <TeamsMeetingInfo> + description: The callback - name: >- fetchMeetingParticipant(string, string, ServiceCallback) @@ -163,7 +191,6 @@ methods: package: botframework-connector summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -177,9 +204,10 @@ methods: type: string description: Participant Id - id: callback - type: ServiceCallback<TeamsMeetingParticipant> - description: | - The callback + type: >- + <TeamsMeetingParticipant> + description: The callback - name: >- fetchMeetingParticipant(string, string, TeamsFetchMeetingParticipantOptionalParams) @@ -187,13 +215,12 @@ methods: package: botframework-connector summary: Fetch a meeting participant remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function fetchMeetingParticipant(meetingId: string, participantId: string, options?: TeamsFetchMeetingParticipantOptionalParams): - Promise + Promise parameters: - id: meetingId type: string @@ -204,13 +231,14 @@ methods: - id: options type: >- - description: '' + description: The optional parameters return: description: Promise type: >- - Promise<> - name: >- fetchMeetingParticipant(string, string, @@ -220,7 +248,6 @@ methods: package: botframework-connector summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -237,40 +264,42 @@ methods: - id: options type: >- description: The optional parameters - id: callback - type: ServiceCallback<TeamsMeetingParticipant> - description: | - The callback - - name: 'fetchTeamDetails(string, RequestOptionsBase)' + type: >- + <TeamsMeetingParticipant> + description: The callback + - name: fetchTeamDetails(string, RequestOptionsBase) uid: botframework-connector.Teams.fetchTeamDetails package: botframework-connector summary: Fetches details related to a team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function fetchTeamDetails(teamId: string, options?: RequestOptionsBase): - Promise + Promise parameters: - id: teamId type: string description: Team Id. - id: options - type: RequestOptionsBase + type: description: Optional. The options object to be used in every request. return: description: A `Promise`. - type: Promise<> - - name: 'fetchTeamDetails(string, RequestOptionsBase, ServiceCallback)' + type: >- + Promise<> + - name: fetchTeamDetails(string, RequestOptionsBase, ServiceCallback) uid: botframework-connector.Teams.fetchTeamDetails_2 package: botframework-connector summary: Fetches details related to a team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -281,18 +310,16 @@ methods: type: string description: Team Id. - id: options - type: RequestOptionsBase + type: description: The options object to be used in every request. - id: callback - type: ServiceCallback<TeamDetails> - description: | - The callback. - - name: 'fetchTeamDetails(string, ServiceCallback)' + type: <TeamDetails> + description: The callback. + - name: fetchTeamDetails(string, ServiceCallback) uid: botframework-connector.Teams.fetchTeamDetails_1 package: botframework-connector summary: Fetches details related to a team. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -303,6 +330,300 @@ methods: type: string description: Team Id. - id: callback - type: ServiceCallback<TeamDetails> - description: | - The callback. + type: <TeamDetails> + description: The callback. + - name: >- + getOperationFailedEntries(string, RequestOptionsBase, + ServiceCallback) + uid: botframework-connector.Teams.getOperationFailedEntries + package: botframework-connector + summary: Get the failed entries of an operation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getOperationFailedEntries(operationId: string, options?: + RequestOptionsBase, callback?: + ServiceCallback): + Promise + parameters: + - id: operationId + type: string + description: The operationId to get the failed entries of. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <BatchFailedEntriesResponse> + description: The callback. + return: + description: Promise with BatchFailedEntriesResponse. + type: >- + Promise<> + - name: >- + getOperationState(string, RequestOptionsBase, + ServiceCallback) + uid: botframework-connector.Teams.getOperationState + package: botframework-connector + summary: Get the state of an operation. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getOperationState(operationId: string, options?: + RequestOptionsBase, callback?: + ServiceCallback): + Promise + parameters: + - id: operationId + type: string + description: The operationId to get the state of. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <BatchOperationStateResponse> + description: The callback. + return: + description: Promise with BatchOperationStateResponse. + type: >- + Promise<> + - name: >- + sendMeetingNotification(string, TargetedMeetingNotification, + RequestOptionsBase) + uid: botframework-connector.Teams.sendMeetingNotification + package: botframework-connector + summary: Send meeting notification. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMeetingNotification(meetingId: string, notification: + TargetedMeetingNotification, options?: RequestOptionsBase): + Promise + parameters: + - id: meetingId + type: string + description: Meeting Id. + - id: notification + type: TargetedMeetingNotification + description: The content and configuration for the notification to send. + - id: options + type: + description: The optional parameters. + return: + description: '' + type: >- + Promise<> + - name: >- + sendMeetingNotification(string, TargetedMeetingNotification, + RequestOptionsBase, ServiceCallback) + uid: botframework-connector.Teams.sendMeetingNotification_2 + package: botframework-connector + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMeetingNotification(meetingId: string, notification: + TargetedMeetingNotification, options: RequestOptionsBase, callback: + ServiceCallback) + parameters: + - id: meetingId + type: string + description: Meeting Id. + - id: notification + type: TargetedMeetingNotification + description: The content and configuration for the notification to send. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <MeetingNotificationResponse> + description: The callback. + - name: >- + sendMeetingNotification(string, TargetedMeetingNotification, + ServiceCallback) + uid: botframework-connector.Teams.sendMeetingNotification_1 + package: botframework-connector + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMeetingNotification(meetingId: string, notification: + TargetedMeetingNotification, callback: + ServiceCallback) + parameters: + - id: meetingId + type: string + description: Meeting Id. + - id: notification + type: TargetedMeetingNotification + description: The content and configuration for the notification to send. + - id: callback + type: >- + <MeetingNotificationResponse> + description: The callback. + - name: >- + sendMessageToAllUsersInTeam(Activity, string, string, RequestOptionsBase, + ServiceCallback) + uid: botframework-connector.Teams.sendMessageToAllUsersInTeam + package: botframework-connector + summary: Send message to all users belonging to a team. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMessageToAllUsersInTeam(activity: Activity, tenantId: + string, teamId: string, options?: RequestOptionsBase, callback?: + ServiceCallback): + Promise + parameters: + - id: activity + type: Activity + description: The activity to send. + - id: tenantId + type: string + description: The tenant Id. + - id: teamId + type: string + description: The id of the recipient Team. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <BatchOperationResponse> + description: The callback. + return: + description: Promise with TeamsBatchOperationResponse. + type: >- + Promise<> + - name: >- + sendMessageToAllUsersInTenant(Activity, string, RequestOptionsBase, + ServiceCallback) + uid: botframework-connector.Teams.sendMessageToAllUsersInTenant + package: botframework-connector + summary: Send message to all users belonging to a tenant. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMessageToAllUsersInTenant(activity: Activity, tenantId: + string, options?: RequestOptionsBase, callback?: + ServiceCallback): + Promise + parameters: + - id: activity + type: Activity + description: The activity to send. + - id: tenantId + type: string + description: The id of the recipient Tenant. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <BatchOperationResponse> + description: The callback. + return: + description: Promise with TeamsBatchOperationResponse. + type: >- + Promise<> + - name: >- + sendMessageToListOfChannels(Activity, string, TeamsMember[], + RequestOptionsBase, ServiceCallback) + uid: botframework-connector.Teams.sendMessageToListOfChannels + package: botframework-connector + summary: Send message to a list of channels. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMessageToListOfChannels(activity: Activity, tenantId: + string, members: TeamsMember[], options?: RequestOptionsBase, callback?: + ServiceCallback): + Promise + parameters: + - id: activity + type: Activity + description: The activity to send. + - id: tenantId + type: string + description: The tenant Id. + - id: members + type: TeamsMember[] + description: The list of channels. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <BatchOperationResponse> + description: The callback. + return: + description: Promise with TeamsBatchOperationResponse. + type: >- + Promise<> + - name: >- + sendMessageToListOfUsers(Activity, string, TeamsMember[], + RequestOptionsBase, ServiceCallback) + uid: botframework-connector.Teams.sendMessageToListOfUsers + package: botframework-connector + summary: Send message to a list of users. + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendMessageToListOfUsers(activity: Activity, tenantId: string, + members: TeamsMember[], options?: RequestOptionsBase, callback?: + ServiceCallback): + Promise + parameters: + - id: activity + type: Activity + description: The activity to send. + - id: tenantId + type: string + description: The tenant Id. + - id: members + type: TeamsMember[] + description: The list of members. + - id: options + type: + description: The optional parameters. + - id: callback + type: >- + <BatchOperationResponse> + description: The callback. + return: + description: Promise with TeamsBatchOperationResponse. + type: >- + Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsBatchOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsBatchOperationResponse.yml new file mode 100644 index 00000000..69a07ed2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsBatchOperationResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TeamsBatchOperationResponse +uid: botframework-connector.TeamsBatchOperationResponse +package: botframework-connector +summary: Contains response data for the Teams batch operations. +fullName: TeamsBatchOperationResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsBatchOperationResponse = BatchOperationResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: BatchOperationResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClient.yml index a57d3a93..a4863c49 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClient.yml @@ -2,10 +2,17 @@ name: TeamsConnectorClient uid: botframework-connector.TeamsConnectorClient package: botframework-connector -summary: '' +summary: >- + The Bot Connector REST API extension for Microsoft Teams allows your + + bot to perform extended operations on the Microsoft Teams channel + + configured in the [Bot Framework Developer + Portal](https://dev.botframework.com). + + The Connector service uses industry-standard REST and JSON over HTTPS. fullName: TeamsConnectorClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +23,6 @@ constructors: package: botframework-connector summary: Initializes a new instance of the TeamsConnectorClient class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -24,13 +30,16 @@ constructors: options?: TeamsConnectorClientOptions) parameters: - id: credentials - type: ServiceClientCredentials + type: description: >- Subscription credentials which uniquely identify client subscription. - id: options - type: - description: '' + type: >- + + description: The parameter options properties: - name: teams uid: botframework-connector.TeamsConnectorClient.teams @@ -38,7 +47,6 @@ properties: summary: '' fullName: teams remarks: '' - isPreview: false isDeprecated: false syntax: content: 'teams: Teams' @@ -52,13 +60,12 @@ inheritedProperties: summary: '' fullName: credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentials: ServiceClientCredentials' return: description: '' - type: ServiceClientCredentials + type: inheritanceDescription: >- Inherited From [TeamsConnectorClientContext.credentials](xref:botframework-connector.TeamsConnectorClientContext.credentials) @@ -70,7 +77,6 @@ inheritedMethods: package: botframework-connector summary: Send an HTTP request that is populated using the provided OperationSpec. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -79,27 +85,27 @@ inheritedMethods: Promise parameters: - id: operationArguments - type: OperationArguments + type: description: >- The arguments that the HTTP request's templated values will be populated from. - id: operationSpec - type: OperationSpec + type: description: The OperationSpec to use to populate the httpRequest. - id: callback - type: ServiceCallback<any> - description: | - The callback to call when the response is received. + type: <any> + description: The callback to call when the response is received. return: description: '' - type: Promise<RestResponse> - inheritanceDescription: Inherited From ServiceClient.sendOperationRequest + type: Promise<> + inheritanceDescription: >- + Inherited From + [TeamsConnectorClientContext.sendOperationRequest](xref:botframework-connector.TeamsConnectorClientContext.sendOperationRequest) - name: sendRequest(RequestPrepareOptions | WebResourceLike) uid: botframework-connector.TeamsConnectorClient.sendRequest package: botframework-connector summary: Send the provided httpRequest. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -107,10 +113,14 @@ inheritedMethods: Promise parameters: - id: options - type: RequestPrepareOptions | WebResourceLike + type: >- + | description: '' return: description: '' - type: Promise<HttpOperationResponse> - inheritanceDescription: Inherited From ServiceClient.sendRequest + type: Promise<> + inheritanceDescription: >- + Inherited From + [TeamsConnectorClientContext.sendRequest](xref:botframework-connector.TeamsConnectorClientContext.sendRequest) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientContext.yml index d4893da6..26c6bf32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientContext.yml @@ -13,7 +13,6 @@ summary: >- The Connector service uses industry-standard REST and JSON over HTTPS. fullName: TeamsConnectorClientContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -24,7 +23,6 @@ constructors: package: botframework-connector summary: Initializes a new instance of the TeamsConnectorClientContext class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,13 +30,16 @@ constructors: options?: TeamsConnectorClientOptions) parameters: - id: credentials - type: ServiceClientCredentials + type: description: >- Subscription credentials which uniquely identify client subscription. - id: options - type: - description: '' + type: >- + + description: The parameter options properties: - name: credentials uid: botframework-connector.TeamsConnectorClientContext.credentials @@ -46,13 +47,12 @@ properties: summary: '' fullName: credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentials: ServiceClientCredentials' return: description: '' - type: ServiceClientCredentials + type: inheritedMethods: - name: >- sendOperationRequest(OperationArguments, OperationSpec, @@ -61,7 +61,6 @@ inheritedMethods: package: botframework-connector summary: Send an HTTP request that is populated using the provided OperationSpec. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -70,27 +69,25 @@ inheritedMethods: Promise parameters: - id: operationArguments - type: OperationArguments + type: description: >- The arguments that the HTTP request's templated values will be populated from. - id: operationSpec - type: OperationSpec + type: description: The OperationSpec to use to populate the httpRequest. - id: callback - type: ServiceCallback<any> - description: | - The callback to call when the response is received. + type: <any> + description: The callback to call when the response is received. return: description: '' - type: Promise<RestResponse> + type: Promise<> inheritanceDescription: Inherited From ServiceClient.sendOperationRequest - name: sendRequest(RequestPrepareOptions | WebResourceLike) uid: botframework-connector.TeamsConnectorClientContext.sendRequest package: botframework-connector summary: Send the provided httpRequest. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -98,10 +95,12 @@ inheritedMethods: Promise parameters: - id: options - type: RequestPrepareOptions | WebResourceLike + type: >- + | description: '' return: description: '' - type: Promise<HttpOperationResponse> + type: Promise<> inheritanceDescription: Inherited From ServiceClient.sendRequest -extends: ServiceClient +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientOptions.yml index c42b0620..6cc47b36 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorClientOptions.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: TeamsConnectorClientOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: baseUri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'baseUri?: string' @@ -23,22 +21,6 @@ properties: description: '' type: string inheritedProperties: - - name: agentSettings - uid: botframework-connector.TeamsConnectorClientOptions.agentSettings - package: botframework-connector - summary: >- - HTTP and HTTPS agents which will be used for every HTTP request (Node.js - only). - fullName: agentSettings - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'agentSettings?: AgentSettings' - return: - description: '' - type: AgentSettings - inheritanceDescription: Inherited From ServiceClientOptions.agentSettings - name: clientRequestIdHeaderName uid: >- botframework-connector.TeamsConnectorClientOptions.clientRequestIdHeaderName @@ -51,7 +33,6 @@ inheritedProperties: the request ID. fullName: clientRequestIdHeaderName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientRequestIdHeaderName?: string' @@ -59,6 +40,19 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From ServiceClientOptions.clientRequestIdHeaderName + - name: credentialScopes + uid: botframework-connector.TeamsConnectorClientOptions.credentialScopes + package: botframework-connector + summary: If specified, will be used to build the BearerTokenAuthenticationPolicy. + fullName: credentialScopes + remarks: '' + isDeprecated: false + syntax: + content: 'credentialScopes?: string | string[]' + return: + description: '' + type: string | string[] + inheritanceDescription: Inherited From ServiceClientOptions.credentialScopes - name: deserializationContentTypes uid: >- botframework-connector.TeamsConnectorClientOptions.deserializationContentTypes @@ -66,13 +60,12 @@ inheritedProperties: summary: The content-types that will be associated with JSON or XML serialization. fullName: deserializationContentTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'deserializationContentTypes?: DeserializationContentTypes' return: description: '' - type: DeserializationContentTypes + type: inheritanceDescription: Inherited From ServiceClientOptions.deserializationContentTypes - name: generateClientRequestIdHeader uid: >- @@ -83,7 +76,6 @@ inheritedProperties: request. fullName: generateClientRequestIdHeader remarks: '' - isPreview: false isDeprecated: false syntax: content: 'generateClientRequestIdHeader?: boolean' @@ -97,13 +89,12 @@ inheritedProperties: summary: The HttpClient that will be used to send HTTP requests. fullName: httpClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpClient?: HttpClient' return: description: '' - type: HttpClient + type: inheritanceDescription: Inherited From ServiceClientOptions.httpClient - name: httpPipelineLogger uid: botframework-connector.TeamsConnectorClientOptions.httpPipelineLogger @@ -113,21 +104,19 @@ inheritedProperties: the HTTP pipeline. fullName: httpPipelineLogger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpPipelineLogger?: HttpPipelineLogger' return: description: '' - type: HttpPipelineLogger + type: inheritanceDescription: Inherited From ServiceClientOptions.httpPipelineLogger - name: noRetryPolicy uid: botframework-connector.TeamsConnectorClientOptions.noRetryPolicy package: botframework-connector - summary: 'If set to true, turn off the default retry policy.' + summary: If set to true, turn off the default retry policy. fullName: noRetryPolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noRetryPolicy?: boolean' @@ -141,28 +130,13 @@ inheritedProperties: summary: Proxy settings which will be used for every HTTP request (Node.js only). fullName: proxySettings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'proxySettings?: ProxySettings' return: description: '' - type: ProxySettings + type: inheritanceDescription: Inherited From ServiceClientOptions.proxySettings - - name: redirectOptions - uid: botframework-connector.TeamsConnectorClientOptions.redirectOptions - package: botframework-connector - summary: Options for how redirect responses are handled. - fullName: redirectOptions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectOptions?: RedirectOptions' - return: - description: '' - type: RedirectOptions - inheritanceDescription: Inherited From ServiceClientOptions.redirectOptions - name: requestPolicyFactories uid: botframework-connector.TeamsConnectorClientOptions.requestPolicyFactories package: botframework-connector @@ -176,7 +150,6 @@ inheritedProperties: the requestPolicyFactories that will be used. fullName: requestPolicyFactories remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -186,8 +159,9 @@ inheritedProperties: return: description: '' type: >- - RequestPolicyFactory[] | (defaultRequestPolicyFactories: - RequestPolicyFactory[]) => void | RequestPolicyFactory[] + [] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] inheritanceDescription: Inherited From ServiceClientOptions.requestPolicyFactories - name: rpRegistrationRetryTimeout uid: >- @@ -198,7 +172,6 @@ inheritedProperties: Default value is 30. fullName: rpRegistrationRetryTimeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rpRegistrationRetryTimeout?: number' @@ -217,7 +190,6 @@ inheritedProperties: that will be used. fullName: userAgent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAgent?: string | (defaultUserAgent: string) => string' @@ -233,12 +205,11 @@ inheritedProperties: If this is not specified, then "User-Agent" will be used when running on Node.js and - "x-ms-command-name" will + "x-ms-useragent" will be used when running in a browser. fullName: userAgentHeaderName remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -259,7 +230,6 @@ inheritedProperties: for more information. fullName: withCredentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'withCredentials?: boolean' @@ -267,4 +237,4 @@ inheritedProperties: description: '' type: boolean inheritanceDescription: Inherited From ServiceClientOptions.withCredentials -extends: ServiceClientOptions +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorMappers.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorMappers.yml new file mode 100644 index 00000000..30383004 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorMappers.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: botframework-connector.TeamsConnectorMappers +name: TeamsConnectorMappers +type: module +package: botframework-connector +summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchFailedEntriesResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchFailedEntriesResponse.yml new file mode 100644 index 00000000..037d8caa --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchFailedEntriesResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: BatchBatchFailedEntriesResponse +uid: botframework-connector.TeamsConnectorModels.BatchBatchFailedEntriesResponse +package: botframework-connector +summary: Contains response data for the Teams batch failed entries. +fullName: BatchBatchFailedEntriesResponse +remarks: '' +isDeprecated: false +syntax: | + type BatchBatchFailedEntriesResponse = BatchFailedEntriesResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: BatchFailedEntriesResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchOperationStateResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchOperationStateResponse.yml new file mode 100644 index 00000000..be65bd62 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.BatchBatchOperationStateResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: BatchBatchOperationStateResponse +uid: botframework-connector.TeamsConnectorModels.BatchBatchOperationStateResponse +package: botframework-connector +summary: Contains response data for the Teams batch operation state. +fullName: BatchBatchOperationStateResponse +remarks: '' +isDeprecated: false +syntax: | + type BatchBatchOperationStateResponse = BatchOperationStateResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: BatchOperationStateResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.CancelOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.CancelOperationResponse.yml new file mode 100644 index 00000000..0b075809 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.CancelOperationResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: CancelOperationResponse +uid: botframework-connector.TeamsConnectorModels.CancelOperationResponse +package: botframework-connector +summary: Contains response data for the Teams batch cancel operation. +fullName: CancelOperationResponse +remarks: '' +isDeprecated: false +syntax: | + type CancelOperationResponse = { + _response: HttpResponse & { bodyAsText: string; parsedBody: {} } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.yml new file mode 100644 index 00000000..e114e719 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: ConversationsGetConversationPagedMembersOptionalParams +uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams +package: botframework-connector +summary: '' +fullName: ConversationsGetConversationPagedMembersOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.continuationToken + package: botframework-connector + summary: Continuation Token + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: pageSize + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.pageSize + package: botframework-connector + summary: Suggested page size + fullName: pageSize + remarks: '' + isDeprecated: false + syntax: + content: 'pageSize: number' + return: + description: '' + type: number +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsBatchOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsBatchOperationResponse.yml new file mode 100644 index 00000000..74bd8153 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsBatchOperationResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TeamsBatchOperationResponse +uid: botframework-connector.TeamsConnectorModels.TeamsBatchOperationResponse +package: botframework-connector +summary: Contains response data for the Teams batch operations. +fullName: TeamsBatchOperationResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsBatchOperationResponse = BatchOperationResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: BatchOperationResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsConnectorClientOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsConnectorClientOptions.yml new file mode 100644 index 00000000..8b52293f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsConnectorClientOptions.yml @@ -0,0 +1,250 @@ +### YamlMime:TSType +name: TeamsConnectorClientOptions +uid: botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions +package: botframework-connector +summary: '' +fullName: TeamsConnectorClientOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: baseUri + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.baseUri + package: botframework-connector + summary: '' + fullName: baseUri + remarks: '' + isDeprecated: false + syntax: + content: 'baseUri?: string' + return: + description: '' + type: string +inheritedProperties: + - name: clientRequestIdHeaderName + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.clientRequestIdHeaderName + package: botframework-connector + summary: >- + If specified, a GenerateRequestIdPolicy will be added to the HTTP pipeline + that will add a + + header to all outgoing requests with this header name and a random UUID as + the request ID. + fullName: clientRequestIdHeaderName + remarks: '' + isDeprecated: false + syntax: + content: 'clientRequestIdHeaderName?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ServiceClientOptions.clientRequestIdHeaderName + - name: credentialScopes + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.credentialScopes + package: botframework-connector + summary: If specified, will be used to build the BearerTokenAuthenticationPolicy. + fullName: credentialScopes + remarks: '' + isDeprecated: false + syntax: + content: 'credentialScopes?: string | string[]' + return: + description: '' + type: string | string[] + inheritanceDescription: Inherited From ServiceClientOptions.credentialScopes + - name: deserializationContentTypes + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.deserializationContentTypes + package: botframework-connector + summary: The content-types that will be associated with JSON or XML serialization. + fullName: deserializationContentTypes + remarks: '' + isDeprecated: false + syntax: + content: 'deserializationContentTypes?: DeserializationContentTypes' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.deserializationContentTypes + - name: generateClientRequestIdHeader + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.generateClientRequestIdHeader + package: botframework-connector + summary: >- + Whether or not to generate a client request ID header for each HTTP + request. + fullName: generateClientRequestIdHeader + remarks: '' + isDeprecated: false + syntax: + content: 'generateClientRequestIdHeader?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ServiceClientOptions.generateClientRequestIdHeader + - name: httpClient + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.httpClient + package: botframework-connector + summary: The HttpClient that will be used to send HTTP requests. + fullName: httpClient + remarks: '' + isDeprecated: false + syntax: + content: 'httpClient?: HttpClient' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.httpClient + - name: httpPipelineLogger + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.httpPipelineLogger + package: botframework-connector + summary: >- + The HttpPipelineLogger that can be used to debug RequestPolicies within + the HTTP pipeline. + fullName: httpPipelineLogger + remarks: '' + isDeprecated: false + syntax: + content: 'httpPipelineLogger?: HttpPipelineLogger' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.httpPipelineLogger + - name: noRetryPolicy + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.noRetryPolicy + package: botframework-connector + summary: If set to true, turn off the default retry policy. + fullName: noRetryPolicy + remarks: '' + isDeprecated: false + syntax: + content: 'noRetryPolicy?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ServiceClientOptions.noRetryPolicy + - name: proxySettings + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.proxySettings + package: botframework-connector + summary: Proxy settings which will be used for every HTTP request (Node.js only). + fullName: proxySettings + remarks: '' + isDeprecated: false + syntax: + content: 'proxySettings?: ProxySettings' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.proxySettings + - name: requestPolicyFactories + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.requestPolicyFactories + package: botframework-connector + summary: >- + An array of factories which get called to create the RequestPolicy + pipeline used to send a HTTP + + request on the wire, or a function that takes in the + defaultRequestPolicyFactories and returns + + the requestPolicyFactories that will be used. + fullName: requestPolicyFactories + remarks: '' + isDeprecated: false + syntax: + content: >- + requestPolicyFactories?: RequestPolicyFactory[] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] + return: + description: '' + type: >- + [] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] + inheritanceDescription: Inherited From ServiceClientOptions.requestPolicyFactories + - name: rpRegistrationRetryTimeout + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.rpRegistrationRetryTimeout + package: botframework-connector + summary: >- + Gets or sets the retry timeout in seconds for AutomaticRPRegistration. + Default value is 30. + fullName: rpRegistrationRetryTimeout + remarks: '' + isDeprecated: false + syntax: + content: 'rpRegistrationRetryTimeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ServiceClientOptions.rpRegistrationRetryTimeout + - name: userAgent + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.userAgent + package: botframework-connector + summary: >- + The string to be set to the telemetry header while sending the request, or + a function that + + takes in the default user-agent string and returns the user-agent string + that will be used. + fullName: userAgent + remarks: '' + isDeprecated: false + syntax: + content: 'userAgent?: string | (defaultUserAgent: string) => string' + return: + description: '' + type: 'string | (defaultUserAgent: string) => string' + inheritanceDescription: Inherited From ServiceClientOptions.userAgent + - name: userAgentHeaderName + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.userAgentHeaderName + package: botframework-connector + summary: >- + The header name to use for the telemetry header while sending the request. + If this is not + + specified, then "User-Agent" will be used when running on Node.js and + "x-ms-useragent" will + + be used when running in a browser. + fullName: userAgentHeaderName + remarks: '' + isDeprecated: false + syntax: + content: >- + userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => + string + return: + description: '' + type: 'string | (defaultUserAgentHeaderName: string) => string' + inheritanceDescription: Inherited From ServiceClientOptions.userAgentHeaderName + - name: withCredentials + uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions.withCredentials + package: botframework-connector + summary: >- + Whether to include credentials in CORS requests in the browser. + + See + https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials + for more information. + fullName: withCredentials + remarks: '' + isDeprecated: false + syntax: + content: 'withCredentials?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ServiceClientOptions.withCredentials +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchChannelListResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchChannelListResponse.yml new file mode 100644 index 00000000..86284516 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchChannelListResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: TeamsFetchChannelListResponse +uid: botframework-connector.TeamsConnectorModels.TeamsFetchChannelListResponse +package: botframework-connector +summary: Contains response data for the fetchChannelList operation. +fullName: TeamsFetchChannelListResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsFetchChannelListResponse = ConversationList & { + _response: HttpResponse & { bodyAsText: string; parsedBody: ConversationList } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.yml new file mode 100644 index 00000000..2b509689 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.yml @@ -0,0 +1,150 @@ +### YamlMime:TSType +name: TeamsFetchMeetingParticipantOptionalParams +uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams +package: botframework-connector +summary: '' +fullName: TeamsFetchMeetingParticipantOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: tenantId + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.tenantId + package: botframework-connector + summary: '' + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantResponse.yml new file mode 100644 index 00000000..993c20cd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchMeetingParticipantResponse.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: TeamsFetchMeetingParticipantResponse +uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantResponse +package: botframework-connector +summary: Contains response data for the fetchMeetingParticipant operation. +fullName: TeamsFetchMeetingParticipantResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsFetchMeetingParticipantResponse = TeamsMeetingParticipant & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: TeamsMeetingParticipant + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchTeamDetailsResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchTeamDetailsResponse.yml new file mode 100644 index 00000000..ee7beac1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsFetchTeamDetailsResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: TeamsFetchTeamDetailsResponse +uid: botframework-connector.TeamsConnectorModels.TeamsFetchTeamDetailsResponse +package: botframework-connector +summary: Contains response data for the fetchTeamDetails operation. +fullName: TeamsFetchTeamDetailsResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsFetchTeamDetailsResponse = TeamDetails & { + _response: HttpResponse & { bodyAsText: string; parsedBody: TeamDetails } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingInfoResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingInfoResponse.yml new file mode 100644 index 00000000..09c051dc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingInfoResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TeamsMeetingInfoResponse +uid: botframework-connector.TeamsConnectorModels.TeamsMeetingInfoResponse +package: botframework-connector +summary: Contains response data for the fetchMeetingInfo operation. +fullName: TeamsMeetingInfoResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsMeetingInfoResponse = MeetingInfo & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: TeamsMeetingParticipant + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingNotificationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingNotificationResponse.yml new file mode 100644 index 00000000..7a6ea7e9 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.TeamsMeetingNotificationResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TeamsMeetingNotificationResponse +uid: botframework-connector.TeamsConnectorModels.TeamsMeetingNotificationResponse +package: botframework-connector +summary: Contains response data for the sendMeetingNotification operation. +fullName: TeamsMeetingNotificationResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsMeetingNotificationResponse = MeetingNotificationResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: MeetingNotificationResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.yml new file mode 100644 index 00000000..9c90da39 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsConnectorModels.yml @@ -0,0 +1,23 @@ +### YamlMime:TSPackage +uid: botframework-connector.TeamsConnectorModels +name: TeamsConnectorModels +summary: '' +type: module +typeAliases: + - botframework-connector.TeamsConnectorModels.BatchBatchFailedEntriesResponse + - botframework-connector.TeamsConnectorModels.BatchBatchOperationStateResponse + - botframework-connector.TeamsConnectorModels.CancelOperationResponse + - botframework-connector.TeamsConnectorModels.TeamsBatchOperationResponse + - botframework-connector.TeamsConnectorModels.TeamsFetchChannelListResponse + - >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantResponse + - botframework-connector.TeamsConnectorModels.TeamsFetchTeamDetailsResponse + - botframework-connector.TeamsConnectorModels.TeamsMeetingInfoResponse + - botframework-connector.TeamsConnectorModels.TeamsMeetingNotificationResponse +interfaces: + - >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams + - botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions + - >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams +package: botframework-connector diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchChannelListResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchChannelListResponse.yml index a7992e13..c2fc5716 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchChannelListResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchChannelListResponse.yml @@ -5,12 +5,8 @@ package: botframework-connector summary: Contains response data for the fetchChannelList operation. fullName: TeamsFetchChannelListResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type TeamsFetchChannelListResponse = ConversationList & { - _response: HttpResponse & { - bodyAsText: string, - parsedBody: ConversationList, - }, + _response: HttpResponse & { bodyAsText: string; parsedBody: ConversationList } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantOptionalParams.yml index 8c346a20..81f6c4d0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: TeamsFetchMeetingParticipantOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId?: string' @@ -27,33 +25,31 @@ inheritedProperties: uid: >- botframework-connector.TeamsFetchMeetingParticipantOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: >- botframework-connector.TeamsFetchMeetingParticipantOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: >- @@ -62,7 +58,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -77,7 +72,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -85,15 +79,50 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TeamsFetchMeetingParticipantOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TeamsFetchMeetingParticipantOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.TeamsFetchMeetingParticipantOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -101,4 +130,18 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: >- + botframework-connector.TeamsFetchMeetingParticipantOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantResponse.yml index 2afadf87..8916db64 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchMeetingParticipantResponse.yml @@ -5,12 +5,11 @@ package: botframework-connector summary: Contains response data for the fetchMeetingParticipant operation. fullName: TeamsFetchMeetingParticipantResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type TeamsFetchMeetingParticipantResponse = TeamsMeetingParticipant & { _response: HttpResponse & { - bodyAsText: string, - parsedBody: TeamsMeetingParticipant, - }, + bodyAsText: string + parsedBody: TeamsMeetingParticipant + } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchTeamDetailsResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchTeamDetailsResponse.yml index ec288537..9bee8aad 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchTeamDetailsResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsFetchTeamDetailsResponse.yml @@ -5,9 +5,8 @@ package: botframework-connector summary: Contains response data for the fetchTeamDetails operation. fullName: TeamsFetchTeamDetailsResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type TeamsFetchTeamDetailsResponse = TeamDetails & { - _response: HttpResponse & { bodyAsText: string, parsedBody: TeamDetails }, + _response: HttpResponse & { bodyAsText: string; parsedBody: TeamDetails } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingInfoResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingInfoResponse.yml index 02f3caf1..cb0a3496 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingInfoResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingInfoResponse.yml @@ -5,12 +5,11 @@ package: botframework-connector summary: Contains response data for the fetchMeetingInfo operation. fullName: TeamsMeetingInfoResponse remarks: '' -isPreview: false isDeprecated: false syntax: | - type TeamsMeetingInfoResponse = TeamsMeetingInfo & { + type TeamsMeetingInfoResponse = MeetingInfo & { _response: HttpResponse & { - bodyAsText: string, - parsedBody: TeamsMeetingParticipant, - }, + bodyAsText: string + parsedBody: TeamsMeetingParticipant + } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingNotificationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingNotificationResponse.yml new file mode 100644 index 00000000..f441a165 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TeamsMeetingNotificationResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TeamsMeetingNotificationResponse +uid: botframework-connector.TeamsMeetingNotificationResponse +package: botframework-connector +summary: Contains response data for the sendMeetingNotification operation. +fullName: TeamsMeetingNotificationResponse +remarks: '' +isDeprecated: false +syntax: | + type TeamsMeetingNotificationResponse = MeetingNotificationResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: MeetingNotificationResponse | {} + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClient.yml index f2f3ba8e..ad5f5a91 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClient.yml @@ -5,16 +5,14 @@ package: botframework-connector summary: '' fullName: TokenApiClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TokenApiClient(ServiceClientCredentials, TokenApiClientOptions)' + - name: TokenApiClient(ServiceClientCredentials, TokenApiClientOptions) uid: botframework-connector.TokenApiClient.constructor package: botframework-connector summary: Initializes a new instance of the TokenApiClient class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -22,13 +20,15 @@ constructors: TokenApiClientOptions) parameters: - id: credentials - type: ServiceClientCredentials + type: description: >- Subscription credentials which uniquely identify client subscription. - id: options - type: - description: '' + type: >- + + description: The parameter options properties: - name: botSignIn uid: botframework-connector.TokenApiClient.botSignIn @@ -36,26 +36,24 @@ properties: summary: '' fullName: botSignIn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botSignIn: BotSignIn' return: description: '' - type: + type: BotSignIn - name: userToken uid: botframework-connector.TokenApiClient.userToken package: botframework-connector summary: '' fullName: userToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userToken: UserToken' return: description: '' - type: + type: UserToken inheritedProperties: - name: credentials uid: botframework-connector.TokenApiClient.credentials @@ -63,16 +61,13 @@ inheritedProperties: summary: '' fullName: credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentials: ServiceClientCredentials' return: description: '' - type: ServiceClientCredentials - inheritanceDescription: >- - Inherited From - [TokenApiClientContext.credentials](xref:botframework-connector.TokenApiClientContext.credentials) + type: + inheritanceDescription: Inherited From TokenApiClientContext.credentials inheritedMethods: - name: >- sendOperationRequest(OperationArguments, OperationSpec, @@ -81,7 +76,6 @@ inheritedMethods: package: botframework-connector summary: Send an HTTP request that is populated using the provided OperationSpec. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -90,27 +84,25 @@ inheritedMethods: Promise parameters: - id: operationArguments - type: OperationArguments + type: description: >- The arguments that the HTTP request's templated values will be populated from. - id: operationSpec - type: OperationSpec + type: description: The OperationSpec to use to populate the httpRequest. - id: callback - type: ServiceCallback<any> - description: | - The callback to call when the response is received. + type: <any> + description: The callback to call when the response is received. return: description: '' - type: Promise<RestResponse> - inheritanceDescription: Inherited From ServiceClient.sendOperationRequest + type: Promise<> + inheritanceDescription: Inherited From TokenApiClientContext.sendOperationRequest - name: sendRequest(RequestPrepareOptions | WebResourceLike) uid: botframework-connector.TokenApiClient.sendRequest package: botframework-connector summary: Send the provided httpRequest. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,10 +110,12 @@ inheritedMethods: Promise parameters: - id: options - type: RequestPrepareOptions | WebResourceLike + type: >- + | description: '' return: description: '' - type: Promise<HttpOperationResponse> - inheritanceDescription: Inherited From ServiceClient.sendRequest -extends: + type: Promise<> + inheritanceDescription: Inherited From TokenApiClientContext.sendRequest +extends: TokenApiClientContext diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientContext.yml deleted file mode 100644 index 2003fa86..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientContext.yml +++ /dev/null @@ -1,97 +0,0 @@ -### YamlMime:TSType -name: TokenApiClientContext -uid: botframework-connector.TokenApiClientContext -package: botframework-connector -summary: '' -fullName: TokenApiClientContext -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'TokenApiClientContext(ServiceClientCredentials, TokenApiClientOptions)' - uid: botframework-connector.TokenApiClientContext.constructor - package: botframework-connector - summary: Initializes a new instance of the TokenApiClientContext class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new TokenApiClientContext(credentials: ServiceClientCredentials, - options?: TokenApiClientOptions) - parameters: - - id: credentials - type: ServiceClientCredentials - description: >- - Subscription credentials which uniquely identify client - subscription. - - id: options - type: - description: '' -properties: - - name: credentials - uid: botframework-connector.TokenApiClientContext.credentials - package: botframework-connector - summary: '' - fullName: credentials - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'credentials: ServiceClientCredentials' - return: - description: '' - type: ServiceClientCredentials -inheritedMethods: - - name: >- - sendOperationRequest(OperationArguments, OperationSpec, - ServiceCallback) - uid: botframework-connector.TokenApiClientContext.sendOperationRequest - package: botframework-connector - summary: Send an HTTP request that is populated using the provided OperationSpec. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendOperationRequest(operationArguments: OperationArguments, - operationSpec: OperationSpec, callback?: ServiceCallback): - Promise - parameters: - - id: operationArguments - type: OperationArguments - description: >- - The arguments that the HTTP request's templated values will be - populated from. - - id: operationSpec - type: OperationSpec - description: The OperationSpec to use to populate the httpRequest. - - id: callback - type: ServiceCallback<any> - description: | - The callback to call when the response is received. - return: - description: '' - type: Promise<RestResponse> - inheritanceDescription: Inherited From ServiceClient.sendOperationRequest - - name: sendRequest(RequestPrepareOptions | WebResourceLike) - uid: botframework-connector.TokenApiClientContext.sendRequest - package: botframework-connector - summary: Send the provided httpRequest. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendRequest(options: RequestPrepareOptions | WebResourceLike): - Promise - parameters: - - id: options - type: RequestPrepareOptions | WebResourceLike - description: '' - return: - description: '' - type: Promise<HttpOperationResponse> - inheritanceDescription: Inherited From ServiceClient.sendRequest -extends: ServiceClient diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientOptions.yml index ecf78597..a372debe 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiClientOptions.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: TokenApiClientOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: baseUri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'baseUri?: string' @@ -23,22 +21,6 @@ properties: description: '' type: string inheritedProperties: - - name: agentSettings - uid: botframework-connector.TokenApiClientOptions.agentSettings - package: botframework-connector - summary: >- - HTTP and HTTPS agents which will be used for every HTTP request (Node.js - only). - fullName: agentSettings - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'agentSettings?: AgentSettings' - return: - description: '' - type: AgentSettings - inheritanceDescription: Inherited From ServiceClientOptions.agentSettings - name: clientRequestIdHeaderName uid: botframework-connector.TokenApiClientOptions.clientRequestIdHeaderName package: botframework-connector @@ -50,7 +32,6 @@ inheritedProperties: the request ID. fullName: clientRequestIdHeaderName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientRequestIdHeaderName?: string' @@ -58,19 +39,31 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From ServiceClientOptions.clientRequestIdHeaderName + - name: credentialScopes + uid: botframework-connector.TokenApiClientOptions.credentialScopes + package: botframework-connector + summary: If specified, will be used to build the BearerTokenAuthenticationPolicy. + fullName: credentialScopes + remarks: '' + isDeprecated: false + syntax: + content: 'credentialScopes?: string | string[]' + return: + description: '' + type: string | string[] + inheritanceDescription: Inherited From ServiceClientOptions.credentialScopes - name: deserializationContentTypes uid: botframework-connector.TokenApiClientOptions.deserializationContentTypes package: botframework-connector summary: The content-types that will be associated with JSON or XML serialization. fullName: deserializationContentTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'deserializationContentTypes?: DeserializationContentTypes' return: description: '' - type: DeserializationContentTypes + type: inheritanceDescription: Inherited From ServiceClientOptions.deserializationContentTypes - name: generateClientRequestIdHeader uid: botframework-connector.TokenApiClientOptions.generateClientRequestIdHeader @@ -80,7 +73,6 @@ inheritedProperties: request. fullName: generateClientRequestIdHeader remarks: '' - isPreview: false isDeprecated: false syntax: content: 'generateClientRequestIdHeader?: boolean' @@ -94,13 +86,12 @@ inheritedProperties: summary: The HttpClient that will be used to send HTTP requests. fullName: httpClient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpClient?: HttpClient' return: description: '' - type: HttpClient + type: inheritanceDescription: Inherited From ServiceClientOptions.httpClient - name: httpPipelineLogger uid: botframework-connector.TokenApiClientOptions.httpPipelineLogger @@ -110,21 +101,19 @@ inheritedProperties: the HTTP pipeline. fullName: httpPipelineLogger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpPipelineLogger?: HttpPipelineLogger' return: description: '' - type: HttpPipelineLogger + type: inheritanceDescription: Inherited From ServiceClientOptions.httpPipelineLogger - name: noRetryPolicy uid: botframework-connector.TokenApiClientOptions.noRetryPolicy package: botframework-connector - summary: 'If set to true, turn off the default retry policy.' + summary: If set to true, turn off the default retry policy. fullName: noRetryPolicy remarks: '' - isPreview: false isDeprecated: false syntax: content: 'noRetryPolicy?: boolean' @@ -138,28 +127,13 @@ inheritedProperties: summary: Proxy settings which will be used for every HTTP request (Node.js only). fullName: proxySettings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'proxySettings?: ProxySettings' return: description: '' - type: ProxySettings + type: inheritanceDescription: Inherited From ServiceClientOptions.proxySettings - - name: redirectOptions - uid: botframework-connector.TokenApiClientOptions.redirectOptions - package: botframework-connector - summary: Options for how redirect responses are handled. - fullName: redirectOptions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'redirectOptions?: RedirectOptions' - return: - description: '' - type: RedirectOptions - inheritanceDescription: Inherited From ServiceClientOptions.redirectOptions - name: requestPolicyFactories uid: botframework-connector.TokenApiClientOptions.requestPolicyFactories package: botframework-connector @@ -173,7 +147,6 @@ inheritedProperties: the requestPolicyFactories that will be used. fullName: requestPolicyFactories remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -183,8 +156,9 @@ inheritedProperties: return: description: '' type: >- - RequestPolicyFactory[] | (defaultRequestPolicyFactories: - RequestPolicyFactory[]) => void | RequestPolicyFactory[] + [] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] inheritanceDescription: Inherited From ServiceClientOptions.requestPolicyFactories - name: rpRegistrationRetryTimeout uid: botframework-connector.TokenApiClientOptions.rpRegistrationRetryTimeout @@ -194,7 +168,6 @@ inheritedProperties: Default value is 30. fullName: rpRegistrationRetryTimeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rpRegistrationRetryTimeout?: number' @@ -213,7 +186,6 @@ inheritedProperties: that will be used. fullName: userAgent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAgent?: string | (defaultUserAgent: string) => string' @@ -229,12 +201,11 @@ inheritedProperties: If this is not specified, then "User-Agent" will be used when running on Node.js and - "x-ms-command-name" will + "x-ms-useragent" will be used when running in a browser. fullName: userAgentHeaderName remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -255,7 +226,6 @@ inheritedProperties: for more information. fullName: withCredentials remarks: '' - isPreview: false isDeprecated: false syntax: content: 'withCredentials?: boolean' @@ -263,4 +233,4 @@ inheritedProperties: description: '' type: boolean inheritanceDescription: Inherited From ServiceClientOptions.withCredentials -extends: ServiceClientOptions +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.AadResourceUrls.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.AadResourceUrls.yml new file mode 100644 index 00000000..cf62e487 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.AadResourceUrls.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: AadResourceUrls +uid: botframework-connector.TokenApiModels.AadResourceUrls +package: botframework-connector +summary: '' +fullName: AadResourceUrls +remarks: '' +isDeprecated: false +type: interface +properties: + - name: resourceUrls + uid: botframework-connector.TokenApiModels.AadResourceUrls.resourceUrls + package: botframework-connector + summary: '' + fullName: resourceUrls + remarks: '' + isDeprecated: false + syntax: + content: 'resourceUrls?: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceOptionalParams.yml new file mode 100644 index 00000000..2106245d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceOptionalParams.yml @@ -0,0 +1,175 @@ +### YamlMime:TSType +name: BotSignInGetSignInResourceOptionalParams +uid: botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams +package: botframework-connector +summary: '' +fullName: BotSignInGetSignInResourceOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: codeChallenge + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.codeChallenge + package: botframework-connector + summary: '' + fullName: codeChallenge + remarks: '' + isDeprecated: false + syntax: + content: 'codeChallenge?: string' + return: + description: '' + type: string + - name: emulatorUrl + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.emulatorUrl + package: botframework-connector + summary: '' + fullName: emulatorUrl + remarks: '' + isDeprecated: false + syntax: + content: 'emulatorUrl?: string' + return: + description: '' + type: string + - name: finalRedirect + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.finalRedirect + package: botframework-connector + summary: '' + fullName: finalRedirect + remarks: '' + isDeprecated: false + syntax: + content: 'finalRedirect?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceResponse.yml new file mode 100644 index 00000000..161bfb00 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInResourceResponse.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: BotSignInGetSignInResourceResponse +uid: botframework-connector.TokenApiModels.BotSignInGetSignInResourceResponse +package: botframework-connector +summary: Contains response data for the getSignInResource operation. +fullName: BotSignInGetSignInResourceResponse +remarks: '' +isDeprecated: false +syntax: | + type BotSignInGetSignInResourceResponse = SignInUrlResponse & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: SignInUrlResponse + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlOptionalParams.yml new file mode 100644 index 00000000..07cd1ce2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlOptionalParams.yml @@ -0,0 +1,175 @@ +### YamlMime:TSType +name: BotSignInGetSignInUrlOptionalParams +uid: botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams +package: botframework-connector +summary: '' +fullName: BotSignInGetSignInUrlOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: codeChallenge + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.codeChallenge + package: botframework-connector + summary: '' + fullName: codeChallenge + remarks: '' + isDeprecated: false + syntax: + content: 'codeChallenge?: string' + return: + description: '' + type: string + - name: emulatorUrl + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.emulatorUrl + package: botframework-connector + summary: '' + fullName: emulatorUrl + remarks: '' + isDeprecated: false + syntax: + content: 'emulatorUrl?: string' + return: + description: '' + type: string + - name: finalRedirect + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.finalRedirect + package: botframework-connector + summary: '' + fullName: finalRedirect + remarks: '' + isDeprecated: false + syntax: + content: 'finalRedirect?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlResponse.yml new file mode 100644 index 00000000..e07c0fb7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.BotSignInGetSignInUrlResponse.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: BotSignInGetSignInUrlResponse +uid: botframework-connector.TokenApiModels.BotSignInGetSignInUrlResponse +package: botframework-connector +summary: Contains response data for the getSignInUrl operation. +fullName: BotSignInGetSignInUrlResponse +remarks: '' +isDeprecated: false +syntax: | + type BotSignInGetSignInUrlResponse = { + _response: HttpResponse & { bodyAsText: string; parsedBody: string } + body: string + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorModel.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorModel.yml new file mode 100644 index 00000000..1d5b048c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorModel.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ErrorModel +uid: botframework-connector.TokenApiModels.ErrorModel +package: botframework-connector +summary: '' +fullName: ErrorModel +remarks: '' +isDeprecated: false +type: interface +properties: + - name: code + uid: botframework-connector.TokenApiModels.ErrorModel.code + package: botframework-connector + summary: '' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string + - name: innerHttpError + uid: botframework-connector.TokenApiModels.ErrorModel.innerHttpError + package: botframework-connector + summary: '' + fullName: innerHttpError + remarks: '' + isDeprecated: false + syntax: + content: 'innerHttpError?: InnerHttpError' + return: + description: '' + type: + - name: message + uid: botframework-connector.TokenApiModels.ErrorModel.message + package: botframework-connector + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorResponse.yml new file mode 100644 index 00000000..81de3cc1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.ErrorResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: ErrorResponse +uid: botframework-connector.TokenApiModels.ErrorResponse +package: botframework-connector +summary: '' +fullName: ErrorResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: error + uid: botframework-connector.TokenApiModels.ErrorResponse.error + package: botframework-connector + summary: '' + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error?: ErrorModel' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.InnerHttpError.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.InnerHttpError.yml new file mode 100644 index 00000000..5dc5f7f8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.InnerHttpError.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: InnerHttpError +uid: botframework-connector.TokenApiModels.InnerHttpError +package: botframework-connector +summary: '' +fullName: InnerHttpError +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botframework-connector.TokenApiModels.InnerHttpError.body + package: botframework-connector + summary: '' + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body?: any' + return: + description: '' + type: any + - name: statusCode + uid: botframework-connector.TokenApiModels.InnerHttpError.statusCode + package: botframework-connector + summary: '' + fullName: statusCode + remarks: '' + isDeprecated: false + syntax: + content: 'statusCode?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.TokenApiClientOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.TokenApiClientOptions.yml new file mode 100644 index 00000000..234d4eaf --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.TokenApiClientOptions.yml @@ -0,0 +1,245 @@ +### YamlMime:TSType +name: TokenApiClientOptions +uid: botframework-connector.TokenApiModels.TokenApiClientOptions +package: botframework-connector +summary: '' +fullName: TokenApiClientOptions +remarks: '' +isDeprecated: false +type: interface +properties: + - name: baseUri + uid: botframework-connector.TokenApiModels.TokenApiClientOptions.baseUri + package: botframework-connector + summary: '' + fullName: baseUri + remarks: '' + isDeprecated: false + syntax: + content: 'baseUri?: string' + return: + description: '' + type: string +inheritedProperties: + - name: clientRequestIdHeaderName + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.clientRequestIdHeaderName + package: botframework-connector + summary: >- + If specified, a GenerateRequestIdPolicy will be added to the HTTP pipeline + that will add a + + header to all outgoing requests with this header name and a random UUID as + the request ID. + fullName: clientRequestIdHeaderName + remarks: '' + isDeprecated: false + syntax: + content: 'clientRequestIdHeaderName?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From ServiceClientOptions.clientRequestIdHeaderName + - name: credentialScopes + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.credentialScopes + package: botframework-connector + summary: If specified, will be used to build the BearerTokenAuthenticationPolicy. + fullName: credentialScopes + remarks: '' + isDeprecated: false + syntax: + content: 'credentialScopes?: string | string[]' + return: + description: '' + type: string | string[] + inheritanceDescription: Inherited From ServiceClientOptions.credentialScopes + - name: deserializationContentTypes + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.deserializationContentTypes + package: botframework-connector + summary: The content-types that will be associated with JSON or XML serialization. + fullName: deserializationContentTypes + remarks: '' + isDeprecated: false + syntax: + content: 'deserializationContentTypes?: DeserializationContentTypes' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.deserializationContentTypes + - name: generateClientRequestIdHeader + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.generateClientRequestIdHeader + package: botframework-connector + summary: >- + Whether or not to generate a client request ID header for each HTTP + request. + fullName: generateClientRequestIdHeader + remarks: '' + isDeprecated: false + syntax: + content: 'generateClientRequestIdHeader?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ServiceClientOptions.generateClientRequestIdHeader + - name: httpClient + uid: botframework-connector.TokenApiModels.TokenApiClientOptions.httpClient + package: botframework-connector + summary: The HttpClient that will be used to send HTTP requests. + fullName: httpClient + remarks: '' + isDeprecated: false + syntax: + content: 'httpClient?: HttpClient' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.httpClient + - name: httpPipelineLogger + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.httpPipelineLogger + package: botframework-connector + summary: >- + The HttpPipelineLogger that can be used to debug RequestPolicies within + the HTTP pipeline. + fullName: httpPipelineLogger + remarks: '' + isDeprecated: false + syntax: + content: 'httpPipelineLogger?: HttpPipelineLogger' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.httpPipelineLogger + - name: noRetryPolicy + uid: botframework-connector.TokenApiModels.TokenApiClientOptions.noRetryPolicy + package: botframework-connector + summary: If set to true, turn off the default retry policy. + fullName: noRetryPolicy + remarks: '' + isDeprecated: false + syntax: + content: 'noRetryPolicy?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ServiceClientOptions.noRetryPolicy + - name: proxySettings + uid: botframework-connector.TokenApiModels.TokenApiClientOptions.proxySettings + package: botframework-connector + summary: Proxy settings which will be used for every HTTP request (Node.js only). + fullName: proxySettings + remarks: '' + isDeprecated: false + syntax: + content: 'proxySettings?: ProxySettings' + return: + description: '' + type: + inheritanceDescription: Inherited From ServiceClientOptions.proxySettings + - name: requestPolicyFactories + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.requestPolicyFactories + package: botframework-connector + summary: >- + An array of factories which get called to create the RequestPolicy + pipeline used to send a HTTP + + request on the wire, or a function that takes in the + defaultRequestPolicyFactories and returns + + the requestPolicyFactories that will be used. + fullName: requestPolicyFactories + remarks: '' + isDeprecated: false + syntax: + content: >- + requestPolicyFactories?: RequestPolicyFactory[] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] + return: + description: '' + type: >- + [] | + (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | + RequestPolicyFactory[] + inheritanceDescription: Inherited From ServiceClientOptions.requestPolicyFactories + - name: rpRegistrationRetryTimeout + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.rpRegistrationRetryTimeout + package: botframework-connector + summary: >- + Gets or sets the retry timeout in seconds for AutomaticRPRegistration. + Default value is 30. + fullName: rpRegistrationRetryTimeout + remarks: '' + isDeprecated: false + syntax: + content: 'rpRegistrationRetryTimeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From ServiceClientOptions.rpRegistrationRetryTimeout + - name: userAgent + uid: botframework-connector.TokenApiModels.TokenApiClientOptions.userAgent + package: botframework-connector + summary: >- + The string to be set to the telemetry header while sending the request, or + a function that + + takes in the default user-agent string and returns the user-agent string + that will be used. + fullName: userAgent + remarks: '' + isDeprecated: false + syntax: + content: 'userAgent?: string | (defaultUserAgent: string) => string' + return: + description: '' + type: 'string | (defaultUserAgent: string) => string' + inheritanceDescription: Inherited From ServiceClientOptions.userAgent + - name: userAgentHeaderName + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.userAgentHeaderName + package: botframework-connector + summary: >- + The header name to use for the telemetry header while sending the request. + If this is not + + specified, then "User-Agent" will be used when running on Node.js and + "x-ms-useragent" will + + be used when running in a browser. + fullName: userAgentHeaderName + remarks: '' + isDeprecated: false + syntax: + content: >- + userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => + string + return: + description: '' + type: 'string | (defaultUserAgentHeaderName: string) => string' + inheritanceDescription: Inherited From ServiceClientOptions.userAgentHeaderName + - name: withCredentials + uid: >- + botframework-connector.TokenApiModels.TokenApiClientOptions.withCredentials + package: botframework-connector + summary: >- + Whether to include credentials in CORS requests in the browser. + + See + https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials + for more information. + fullName: withCredentials + remarks: '' + isDeprecated: false + syntax: + content: 'withCredentials?: boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From ServiceClientOptions.withCredentials +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenExchangeAsyncResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenExchangeAsyncResponse.yml new file mode 100644 index 00000000..2c554acc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenExchangeAsyncResponse.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: UserTokenExchangeAsyncResponse +uid: botframework-connector.TokenApiModels.UserTokenExchangeAsyncResponse +package: botframework-connector +summary: Contains response data for the exchangeAsync operation. +fullName: UserTokenExchangeAsyncResponse +remarks: '' +isDeprecated: false +syntax: | + type UserTokenExchangeAsyncResponse = { + _response: HttpResponse & { bodyAsText: string; parsedBody: any } + body: any + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensOptionalParams.yml new file mode 100644 index 00000000..360be1ad --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensOptionalParams.yml @@ -0,0 +1,149 @@ +### YamlMime:TSType +name: UserTokenGetAadTokensOptionalParams +uid: botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams +package: botframework-connector +summary: '' +fullName: UserTokenGetAadTokensOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.channelId + package: botframework-connector + summary: '' + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensResponse.yml new file mode 100644 index 00000000..fb7e79be --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetAadTokensResponse.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: UserTokenGetAadTokensResponse +uid: botframework-connector.TokenApiModels.UserTokenGetAadTokensResponse +package: botframework-connector +summary: Contains response data for the getAadTokens operation. +fullName: UserTokenGetAadTokensResponse +remarks: '' +isDeprecated: false +syntax: | + type UserTokenGetAadTokensResponse = { + [propertyName: string]: TokenResponse + } & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: { [propertyName: string]: TokenResponse } + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenOptionalParams.yml new file mode 100644 index 00000000..198cdcc7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenOptionalParams.yml @@ -0,0 +1,161 @@ +### YamlMime:TSType +name: UserTokenGetTokenOptionalParams +uid: botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams +package: botframework-connector +summary: '' +fullName: UserTokenGetTokenOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.channelId + package: botframework-connector + summary: '' + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string + - name: code + uid: botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.code + package: botframework-connector + summary: '' + fullName: code + remarks: '' + isDeprecated: false + syntax: + content: 'code?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenResponse.yml new file mode 100644 index 00000000..adbed763 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: UserTokenGetTokenResponse +uid: botframework-connector.TokenApiModels.UserTokenGetTokenResponse +package: botframework-connector +summary: Contains response data for the getToken operation. +fullName: UserTokenGetTokenResponse +remarks: '' +isDeprecated: false +syntax: | + type UserTokenGetTokenResponse = TokenResponse & { + _response: HttpResponse & { bodyAsText: string; parsedBody: TokenResponse } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusOptionalParams.yml new file mode 100644 index 00000000..f5deb919 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusOptionalParams.yml @@ -0,0 +1,162 @@ +### YamlMime:TSType +name: UserTokenGetTokenStatusOptionalParams +uid: botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams +package: botframework-connector +summary: '' +fullName: UserTokenGetTokenStatusOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.channelId + package: botframework-connector + summary: '' + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string + - name: include + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.include + package: botframework-connector + summary: '' + fullName: include + remarks: '' + isDeprecated: false + syntax: + content: 'include?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusResponse.yml new file mode 100644 index 00000000..4b003168 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenGetTokenStatusResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: UserTokenGetTokenStatusResponse +uid: botframework-connector.TokenApiModels.UserTokenGetTokenStatusResponse +package: botframework-connector +summary: Contains response data for the getTokenStatus operation. +fullName: UserTokenGetTokenStatusResponse +remarks: '' +isDeprecated: false +syntax: | + type UserTokenGetTokenStatusResponse = TokenStatus[] & { + _response: HttpResponse & { bodyAsText: string; parsedBody: TokenStatus[] } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutOptionalParams.yml new file mode 100644 index 00000000..46e567d0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutOptionalParams.yml @@ -0,0 +1,162 @@ +### YamlMime:TSType +name: UserTokenSignOutOptionalParams +uid: botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams +package: botframework-connector +summary: '' +fullName: UserTokenSignOutOptionalParams +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelId + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.channelId + package: botframework-connector + summary: '' + fullName: channelId + remarks: '' + isDeprecated: false + syntax: + content: 'channelId?: string' + return: + description: '' + type: string + - name: connectionName + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.connectionName + package: botframework-connector + summary: '' + fullName: connectionName + remarks: '' + isDeprecated: false + syntax: + content: 'connectionName?: string' + return: + description: '' + type: string +inheritedProperties: + - name: abortSignal + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.abortSignal + package: botframework-connector + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. + fullName: abortSignal + remarks: '' + isDeprecated: false + syntax: + content: 'abortSignal?: AbortSignalLike' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.abortSignal + - name: customHeaders + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.customHeaders + package: botframework-connector + summary: will be applied before the request is sent. + fullName: customHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'customHeaders?: {[key: string]: string}' + return: + description: '' + type: '{[key: string]: string}' + inheritanceDescription: Inherited From RequestOptionsBase.customHeaders + - name: onDownloadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.onDownloadProgress + package: botframework-connector + summary: Callback which fires upon download progress. + fullName: onDownloadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onDownloadProgress + - name: onUploadProgress + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.onUploadProgress + package: botframework-connector + summary: Callback which fires upon upload progress. + fullName: onUploadProgress + remarks: '' + isDeprecated: false + syntax: + content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' + return: + description: '' + type: '(progress: TransferProgressEvent) => void' + inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize + - name: timeout + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.timeout + package: botframework-connector + summary: >- + The number of milliseconds a request can take before automatically being + terminated. + + If the request is terminated, an `AbortError` is thrown. + fullName: timeout + remarks: '' + isDeprecated: false + syntax: + content: 'timeout?: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From RequestOptionsBase.timeout + - name: tracingContext + uid: >- + botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutResponse.yml new file mode 100644 index 00000000..704b288c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.UserTokenSignOutResponse.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: UserTokenSignOutResponse +uid: botframework-connector.TokenApiModels.UserTokenSignOutResponse +package: botframework-connector +summary: Contains response data for the signOut operation. +fullName: UserTokenSignOutResponse +remarks: '' +isDeprecated: false +syntax: | + type UserTokenSignOutResponse = { + _response: HttpResponse & { bodyAsText: string; parsedBody: any } + body: any + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.yml new file mode 100644 index 00000000..60d5e054 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenApiModels.yml @@ -0,0 +1,27 @@ +### YamlMime:TSPackage +uid: botframework-connector.TokenApiModels +name: TokenApiModels +summary: '' +type: module +interfaces: + - botframework-connector.TokenApiModels.AadResourceUrls + - >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams + - botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams + - botframework-connector.TokenApiModels.ErrorModel + - botframework-connector.TokenApiModels.ErrorResponse + - botframework-connector.TokenApiModels.InnerHttpError + - botframework-connector.TokenApiModels.TokenApiClientOptions + - botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams + - botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams + - botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams + - botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams +typeAliases: + - botframework-connector.TokenApiModels.BotSignInGetSignInResourceResponse + - botframework-connector.TokenApiModels.BotSignInGetSignInUrlResponse + - botframework-connector.TokenApiModels.UserTokenExchangeAsyncResponse + - botframework-connector.TokenApiModels.UserTokenGetAadTokensResponse + - botframework-connector.TokenApiModels.UserTokenGetTokenResponse + - botframework-connector.TokenApiModels.UserTokenGetTokenStatusResponse + - botframework-connector.TokenApiModels.UserTokenSignOutResponse +package: botframework-connector diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenCredentials.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenCredentials.yml new file mode 100644 index 00000000..81da29e1 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenCredentials.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: TokenCredentials +uid: botframework-connector.TokenCredentials +package: botframework-connector +summary: >- + A credentials object that uses a token string and a authorzation scheme to + authenticate. +fullName: TokenCredentials +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TokenCredentials(string, string) + uid: botframework-connector.TokenCredentials.constructor + package: botframework-connector + summary: Creates a new TokenCredentials object. + remarks: '' + isDeprecated: false + syntax: + content: 'new TokenCredentials(token: string, authorizationScheme?: string)' + parameters: + - id: token + type: string + description: The token. + - id: authorizationScheme + type: string + description: The authorization scheme. +properties: + - name: authorizationScheme + uid: botframework-connector.TokenCredentials.authorizationScheme + package: botframework-connector + summary: '' + fullName: authorizationScheme + remarks: '' + isDeprecated: false + syntax: + content: 'authorizationScheme: string' + return: + description: '' + type: string + - name: token + uid: botframework-connector.TokenCredentials.token + package: botframework-connector + summary: '' + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token: string' + return: + description: '' + type: string +methods: + - name: signRequest(WebResourceLike) + uid: botframework-connector.TokenCredentials.signRequest + package: botframework-connector + summary: Signs a request with the Authentication header. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signRequest(webResource: WebResourceLike): + Promise + parameters: + - id: webResource + type: + description: The WebResourceLike to be signed. + return: + description: The signed request object. + type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenExchangeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenExchangeRequest.yml new file mode 100644 index 00000000..811ab446 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenExchangeRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TokenExchangeRequest +uid: botframework-connector.TokenExchangeRequest +package: botframework-connector +summary: '' +fullName: TokenExchangeRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: token + uid: botframework-connector.TokenExchangeRequest.token + package: botframework-connector + summary: '' + fullName: token + remarks: '' + isDeprecated: false + syntax: + content: 'token?: string' + return: + description: '' + type: string + - name: uri + uid: botframework-connector.TokenExchangeRequest.uri + package: botframework-connector + summary: '' + fullName: uri + remarks: '' + isDeprecated: false + syntax: + content: 'uri?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenStatus.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenStatus.yml new file mode 100644 index 00000000..3cfd9af4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/TokenStatus.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: TokenStatus +uid: botframework-connector.TokenStatus +package: botframework-connector +summary: The status of a particular token. +fullName: TokenStatus +remarks: '' +isDeprecated: false +syntax: | + type TokenStatus = { + channelId: string + connectionName: string + hasToken: boolean + serviceProviderDisplayName: string + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserToken.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserToken.yml deleted file mode 100644 index 8da7ed87..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserToken.yml +++ /dev/null @@ -1,432 +0,0 @@ -### YamlMime:TSType -name: UserToken -uid: botframework-connector.UserToken -package: botframework-connector -summary: Class representing a UserToken. -fullName: UserToken -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UserToken(TokenApiClientContext) - uid: botframework-connector.UserToken.constructor - package: botframework-connector - summary: Create a UserToken. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new UserToken(client: TokenApiClientContext)' - parameters: - - id: client - type: - description: | - Reference to the service client. -methods: - - name: >- - exchangeAsync(string, string, string, TokenExchangeRequest, - RequestOptionsBase) - uid: botframework-connector.UserToken.exchangeAsync - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function exchangeAsync(userId: string, connectionName: string, - channelId: string, exchangeRequest: TokenExchangeRequest, options?: - RequestOptionsBase): Promise - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: channelId - type: string - description: '' - - id: exchangeRequest - type: TokenExchangeRequest - description: '' - - id: options - type: RequestOptionsBase - description: '' - return: - description: Promise - type: Promise<> - - name: >- - exchangeAsync(string, string, string, TokenExchangeRequest, - RequestOptionsBase, ServiceCallback) - uid: botframework-connector.UserToken.exchangeAsync_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function exchangeAsync(userId: string, connectionName: string, - channelId: string, exchangeRequest: TokenExchangeRequest, options: - RequestOptionsBase, callback: ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: channelId - type: string - description: '' - - id: exchangeRequest - type: TokenExchangeRequest - description: '' - - id: options - type: RequestOptionsBase - description: The optional parameters - - id: callback - type: ServiceCallback<any> - description: | - The callback - - name: >- - exchangeAsync(string, string, string, TokenExchangeRequest, - ServiceCallback) - uid: botframework-connector.UserToken.exchangeAsync_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function exchangeAsync(userId: string, connectionName: string, - channelId: string, exchangeRequest: TokenExchangeRequest, callback: - ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: channelId - type: string - description: '' - - id: exchangeRequest - type: TokenExchangeRequest - description: '' - - id: callback - type: ServiceCallback<any> - description: | - The callback - - name: >- - getAadTokens(string, string, AadResourceUrls, ServiceCallback<[key: - string]: TokenResponse>) - uid: botframework-connector.UserToken.getAadTokens_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAadTokens(userId: string, connectionName: string, - aadResourceUrls: AadResourceUrls, callback: ServiceCallback<[key: - string]: TokenResponse>) - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: aadResourceUrls - type: - description: '' - - id: callback - type: 'ServiceCallback<[key: string]: TokenResponse>' - description: | - The callback - - name: >- - getAadTokens(string, string, AadResourceUrls, - UserTokenGetAadTokensOptionalParams) - uid: botframework-connector.UserToken.getAadTokens - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAadTokens(userId: string, connectionName: string, - aadResourceUrls: AadResourceUrls, options?: - UserTokenGetAadTokensOptionalParams): - Promise - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: aadResourceUrls - type: - description: '' - - id: options - type: >- - - description: '' - return: - description: Promise - type: Promise<> - - name: >- - getAadTokens(string, string, AadResourceUrls, - UserTokenGetAadTokensOptionalParams, ServiceCallback<[key: string]: - TokenResponse>) - uid: botframework-connector.UserToken.getAadTokens_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAadTokens(userId: string, connectionName: string, - aadResourceUrls: AadResourceUrls, options: - UserTokenGetAadTokensOptionalParams, callback: ServiceCallback<[key: - string]: TokenResponse>) - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: aadResourceUrls - type: - description: '' - - id: options - type: >- - - description: The optional parameters - - id: callback - type: 'ServiceCallback<[key: string]: TokenResponse>' - description: | - The callback - - name: 'getToken(string, string, ServiceCallback)' - uid: botframework-connector.UserToken.getToken_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getToken(userId: string, connectionName: string, callback: - ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: callback - type: ServiceCallback<TokenResponse> - description: | - The callback - - name: 'getToken(string, string, UserTokenGetTokenOptionalParams)' - uid: botframework-connector.UserToken.getToken - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getToken(userId: string, connectionName: string, options?: - UserTokenGetTokenOptionalParams): - Promise - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: options - type: >- - - description: '' - return: - description: Promise - type: Promise<> - - name: >- - getToken(string, string, UserTokenGetTokenOptionalParams, - ServiceCallback) - uid: botframework-connector.UserToken.getToken_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getToken(userId: string, connectionName: string, options: - UserTokenGetTokenOptionalParams, callback: - ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: connectionName - type: string - description: '' - - id: options - type: >- - - description: The optional parameters - - id: callback - type: ServiceCallback<TokenResponse> - description: | - The callback - - name: 'getTokenStatus(string, ServiceCallback)' - uid: botframework-connector.UserToken.getTokenStatus_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getTokenStatus(userId: string, callback: - ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: callback - type: 'ServiceCallback<TokenStatus[]>' - description: | - The callback - - name: 'getTokenStatus(string, UserTokenGetTokenStatusOptionalParams)' - uid: botframework-connector.UserToken.getTokenStatus - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getTokenStatus(userId: string, options?: - UserTokenGetTokenStatusOptionalParams): - Promise - parameters: - - id: userId - type: string - description: '' - - id: options - type: >- - - description: '' - return: - description: Promise - type: Promise<> - - name: >- - getTokenStatus(string, UserTokenGetTokenStatusOptionalParams, - ServiceCallback) - uid: botframework-connector.UserToken.getTokenStatus_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getTokenStatus(userId: string, options: - UserTokenGetTokenStatusOptionalParams, callback: - ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: options - type: >- - - description: The optional parameters - - id: callback - type: 'ServiceCallback<TokenStatus[]>' - description: | - The callback - - name: 'signOut(string, ServiceCallback)' - uid: botframework-connector.UserToken.signOut_1 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function signOut(userId: string, callback: ServiceCallback)' - parameters: - - id: userId - type: string - description: '' - - id: callback - type: ServiceCallback<any> - description: | - The callback - - name: 'signOut(string, UserTokenSignOutOptionalParams)' - uid: botframework-connector.UserToken.signOut - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signOut(userId: string, options?: - UserTokenSignOutOptionalParams): - Promise - parameters: - - id: userId - type: string - description: '' - - id: options - type: - description: '' - return: - description: Promise - type: Promise<> - - name: 'signOut(string, UserTokenSignOutOptionalParams, ServiceCallback)' - uid: botframework-connector.UserToken.signOut_2 - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signOut(userId: string, options: - UserTokenSignOutOptionalParams, callback: ServiceCallback) - parameters: - - id: userId - type: string - description: '' - - id: options - type: - description: The optional parameters - - id: callback - type: ServiceCallback<any> - description: | - The callback diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClient.yml index d2d55326..5f72b3ef 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClient.yml @@ -5,16 +5,14 @@ package: botframework-connector summary: Client for access user token service. fullName: UserTokenClient remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'exchangeToken(string, string, string, TokenExchangeRequest)' + - name: exchangeToken(string, string, string, TokenExchangeRequest) uid: botframework-connector.UserTokenClient.exchangeToken package: botframework-connector summary: Performs a token exchange operation such as for single sign-on. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,21 +30,20 @@ methods: type: string description: The channel Id that will be associated with the token. - id: exchangeRequest - type: TokenExchangeRequest + type: description: >- The exchange request details, either a token to exchange or a uri to exchange. return: - description: 'A [TokenResponse](xref:botframework-schema.TokenResponse) object.' + description: A [TokenResponse](xref:botframework-schema.TokenResponse) object. type: Promise<TokenResponse> - - name: 'getAadTokens(string, string, string[], string)' + - name: getAadTokens(string, string, string[], string) uid: botframework-connector.UserTokenClient.getAadTokens package: botframework-connector summary: >- Retrieves Azure Active Directory tokens for particular resources on a configured connection. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -61,7 +58,7 @@ methods: type: string description: Name of the auth connection to use. - id: resourceUrls - type: 'string[]' + type: string[] description: The list of resource URLs to retrieve tokens for. - id: channelId type: string @@ -70,15 +67,14 @@ methods: description: >- A Dictionary of resourceUrls to the corresponding [TokenResponse](xref:botframework-schema.TokenResponse). - type: 'Promise<Record<string, TokenResponse>>' - - name: 'getSignInResource(string, Activity, string)' + type: Promise<Record<string, TokenResponse>> + - name: getSignInResource(string, Activity, string) uid: botframework-connector.UserTokenClient.getSignInResource package: botframework-connector summary: >- Get the raw signin link to be sent to the user for signin for a connection name. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -97,16 +93,15 @@ methods: type: string description: The final URL that the OAuth flow will redirect to. return: - description: 'A [SignInUrlResponse](xref:botframework-schema.SignInUrlResponse).' - type: Promise<SignInUrlResponse> - - name: 'getTokenStatus(string, string, string)' + description: A [SignInUrlResponse](xref:botframework-schema.SignInUrlResponse). + type: Promise<> + - name: getTokenStatus(string, string, string) uid: botframework-connector.UserTokenClient.getTokenStatus package: botframework-connector summary: >- Retrieves the token status for each configured connection for the given user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -123,14 +118,13 @@ methods: type: string description: The includeFilter. return: - description: 'A list of [TokenStatus](xref:botframework-schema.TokenStatus) objects.' - type: 'Promise<TokenStatus[]>' - - name: 'getUserToken(string, string, string, string)' + description: A list of [TokenStatus](xref:botframework-schema.TokenStatus) objects. + type: Promise<[]> + - name: getUserToken(string, string, string, string) uid: botframework-connector.UserTokenClient.getUserToken package: botframework-connector summary: Attempts to retrieve the token for a user that's in a login flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -150,14 +144,13 @@ methods: type: string description: (Optional) Optional user entered code to validate. return: - description: 'A [TokenResponse](xref:botframework-schema.TokenResponse) object.' + description: A [TokenResponse](xref:botframework-schema.TokenResponse) object. type: Promise<TokenResponse> - - name: 'signOutUser(string, string, string)' + - name: signOutUser(string, string, string) uid: botframework-connector.UserTokenClient.signOutUser package: botframework-connector summary: Signs the user out with the token server. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -172,8 +165,7 @@ methods: description: Name of the auth connection to use. - id: channelId type: string - description: | - The channel Id that will be associated with the token. + description: The channel Id that will be associated with the token. return: description: '' type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClientImpl.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClientImpl.yml deleted file mode 100644 index 9a6dc125..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenClientImpl.yml +++ /dev/null @@ -1,209 +0,0 @@ -### YamlMime:TSType -name: UserTokenClientImpl -uid: botframework-connector.UserTokenClientImpl -package: botframework-connector -summary: '' -fullName: UserTokenClientImpl -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - UserTokenClientImpl(string, ServiceClientCredentials, string, - ConnectorClientOptions) - uid: botframework-connector.UserTokenClientImpl.constructor - package: botframework-connector - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new UserTokenClientImpl(appId: string, credentials: - ServiceClientCredentials, oauthEndpoint: string, - connectorClientOptions?: ConnectorClientOptions) - parameters: - - id: appId - type: string - description: The appId. - - id: credentials - type: ServiceClientCredentials - description: AppCredentials for OAuth. - - id: oauthEndpoint - type: string - description: The OAuth API endpoint. - - id: connectorClientOptions - type: - description: | - A ConnectorClientOptions object. -methods: - - name: 'exchangeToken(string, string, string, TokenExchangeRequest)' - uid: botframework-connector.UserTokenClientImpl.exchangeToken - package: botframework-connector - summary: Performs a token exchange operation such as for single sign-on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function exchangeToken(userId: string, connectionName: string, - channelId: string, exchangeRequest: TokenExchangeRequest): - Promise - parameters: - - id: userId - type: string - description: The user id that will be associated with the token. - - id: connectionName - type: string - description: Name of the auth connection to use. - - id: channelId - type: string - description: The channel Id that will be associated with the token. - - id: exchangeRequest - type: TokenExchangeRequest - description: >- - The exchange request details, either a token to exchange or a uri to - exchange. - return: - description: A promise representing the result of the operation. - type: Promise<TokenResponse> - - name: 'getAadTokens(string, string, string[], string)' - uid: botframework-connector.UserTokenClientImpl.getAadTokens - package: botframework-connector - summary: >- - Retrieves Azure Active Directory tokens for particular resources on a - configured connection. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAadTokens(userId: string, connectionName: string, - resourceUrls: string[], channelId: string): Promise> - parameters: - - id: userId - type: string - description: The user id that will be associated with the token. - - id: connectionName - type: string - description: Name of the auth connection to use. - - id: resourceUrls - type: 'string[]' - description: The list of resource URLs to retrieve tokens for. - - id: channelId - type: string - description: The channel Id that will be associated with the token. - return: - description: >- - A promise of Dictionary of resourceUrl to the corresponding - TokenResponse. - type: 'Promise<Record<string, TokenResponse>>' - - name: 'getSignInResource(string, Activity, string)' - uid: botframework-connector.UserTokenClientImpl.getSignInResource - package: botframework-connector - summary: >- - Asynchronously Get the raw signin resource to be sent to the user for - signin. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getSignInResource(connectionName: string, activity: Activity, - finalRedirect: string): Promise - parameters: - - id: connectionName - type: string - description: Name of the auth connection to use. - - id: activity - type: Activity - description: The Activity from which to derive the token exchange state. - - id: finalRedirect - type: string - description: The final URL that the OAuth flow will redirect to. - return: - description: >- - The [SignInUrlResponse](xref:botframework-schema.SignInUrlResponse) - resource. - type: Promise<SignInUrlResponse> - - name: 'getTokenStatus(string, string, string)' - uid: botframework-connector.UserTokenClientImpl.getTokenStatus - package: botframework-connector - summary: >- - Retrieves the token status for each configured connection for the given - user. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getTokenStatus(userId: string, channelId: string, - includeFilter: string): Promise - parameters: - - id: userId - type: string - description: The user id that will be associated with the token. - - id: channelId - type: string - description: The channel Id that will be associated with the token. - - id: includeFilter - type: string - description: The includeFilter. - return: - description: A promise with an Array of the Token Status. - type: 'Promise<TokenStatus[]>' - - name: 'getUserToken(string, string, string, string)' - uid: botframework-connector.UserTokenClientImpl.getUserToken - package: botframework-connector - summary: Attempts to retrieve the token for a user that's in a login flow. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getUserToken(userId: string, connectionName: string, channelId: - string, magicCode: string): Promise - parameters: - - id: userId - type: string - description: The user id that will be associated with the token. - - id: connectionName - type: string - description: Name of the auth connection to use. - - id: channelId - type: string - description: The channel Id that will be associated with the token. - - id: magicCode - type: string - description: (Optional) Optional user entered code to validate. - return: - description: The token Response. - type: Promise<TokenResponse> - - name: 'signOutUser(string, string, string)' - uid: botframework-connector.UserTokenClientImpl.signOutUser - package: botframework-connector - summary: Signs the user out with the token server. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signOutUser(userId: string, connectionName: string, channelId: - string): Promise - parameters: - - id: userId - type: string - description: The user id that will be associated with the token. - - id: connectionName - type: string - description: Name of the auth connection to use. - - id: channelId - type: string - description: | - The channel Id that will be associated with the token. - return: - description: '' - type: Promise<void> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenExchangeAsyncResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenExchangeAsyncResponse.yml index 619de351..dad3caf8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenExchangeAsyncResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenExchangeAsyncResponse.yml @@ -5,10 +5,9 @@ package: botframework-connector summary: Contains response data for the exchangeAsync operation. fullName: UserTokenExchangeAsyncResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type UserTokenExchangeAsyncResponse = { - _response: HttpResponse & { bodyAsText: string, parsedBody: any }, - body: any, + _response: HttpResponse & { bodyAsText: string; parsedBody: any } + body: any } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensOptionalParams.yml index d5acf977..ffddd262 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: UserTokenGetAadTokensOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId?: string' @@ -26,32 +24,30 @@ inheritedProperties: - name: abortSignal uid: botframework-connector.UserTokenGetAadTokensOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: botframework-connector.UserTokenGetAadTokensOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: >- @@ -60,7 +56,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -75,7 +70,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -83,15 +77,50 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.UserTokenGetAadTokensOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.UserTokenGetAadTokensOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.UserTokenGetAadTokensOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -99,4 +128,17 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: botframework-connector.UserTokenGetAadTokensOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensResponse.yml index 24ec2d90..8e8a401d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetAadTokensResponse.yml @@ -5,9 +5,13 @@ package: botframework-connector summary: Contains response data for the getAadTokens operation. fullName: UserTokenGetAadTokensResponse remarks: '' -isPreview: false isDeprecated: false -syntax: >- - type UserTokenGetAadTokensResponse = [key: string]: TokenResponse & { - _response: HttpResponse & { bodyAsText: string, parsedBody: [key: string]: - TokenResponse } } +syntax: | + type UserTokenGetAadTokensResponse = { + [propertyName: string]: TokenResponse + } & { + _response: HttpResponse & { + bodyAsText: string + parsedBody: { [propertyName: string]: TokenResponse } + } + } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenOptionalParams.yml index 9bbed01f..4c4f5d72 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: UserTokenGetTokenOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: content: 'code?: string' @@ -39,32 +36,30 @@ inheritedProperties: - name: abortSignal uid: botframework-connector.UserTokenGetTokenOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: botframework-connector.UserTokenGetTokenOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: botframework-connector.UserTokenGetTokenOptionalParams.onDownloadProgress @@ -72,7 +67,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -86,7 +80,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -94,15 +87,48 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: botframework-connector.UserTokenGetTokenOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: botframework-connector.UserTokenGetTokenOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.UserTokenGetTokenOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -110,4 +136,17 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: botframework-connector.UserTokenGetTokenOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenResponse.yml index ae95a14e..b706ecd6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenResponse.yml @@ -5,9 +5,8 @@ package: botframework-connector summary: Contains response data for the getToken operation. fullName: UserTokenGetTokenResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type UserTokenGetTokenResponse = TokenResponse & { - _response: HttpResponse & { bodyAsText: string, parsedBody: TokenResponse }, + _response: HttpResponse & { bodyAsText: string; parsedBody: TokenResponse } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusOptionalParams.yml index 3b923355..883088fc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: UserTokenGetTokenStatusOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: include remarks: '' - isPreview: false isDeprecated: false syntax: content: 'include?: string' @@ -39,32 +36,30 @@ inheritedProperties: - name: abortSignal uid: botframework-connector.UserTokenGetTokenStatusOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: botframework-connector.UserTokenGetTokenStatusOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: >- @@ -73,7 +68,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -88,7 +82,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -96,15 +89,50 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: >- + botframework-connector.UserTokenGetTokenStatusOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: >- + botframework-connector.UserTokenGetTokenStatusOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.UserTokenGetTokenStatusOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -112,4 +140,18 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: >- + botframework-connector.UserTokenGetTokenStatusOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusResponse.yml index 23471d65..9d776044 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenGetTokenStatusResponse.yml @@ -5,9 +5,8 @@ package: botframework-connector summary: Contains response data for the getTokenStatus operation. fullName: UserTokenGetTokenStatusResponse remarks: '' -isPreview: false isDeprecated: false syntax: | - type UserTokenGetTokenStatusResponse = Array & { - _response: HttpResponse & { bodyAsText: string, parsedBody: TokenStatus[] }, + type UserTokenGetTokenStatusResponse = TokenStatus[] & { + _response: HttpResponse & { bodyAsText: string; parsedBody: TokenStatus[] } } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutOptionalParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutOptionalParams.yml index 1d48a932..b702ae41 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutOptionalParams.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutOptionalParams.yml @@ -5,7 +5,6 @@ package: botframework-connector summary: '' fullName: UserTokenSignOutOptionalParams remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName?: string' @@ -39,32 +36,30 @@ inheritedProperties: - name: abortSignal uid: botframework-connector.UserTokenSignOutOptionalParams.abortSignal package: botframework-connector - summary: The signal which can be used to abort requests. + summary: >- + Signal of an abort controller. Can be used to abort both sending a network + request and waiting for a response. fullName: abortSignal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'abortSignal?: AbortSignalLike' return: description: '' - type: AbortSignalLike + type: inheritanceDescription: Inherited From RequestOptionsBase.abortSignal - name: customHeaders uid: botframework-connector.UserTokenSignOutOptionalParams.customHeaders package: botframework-connector - summary: |- - {object} [customHeaders] User defined custom request headers that - will be applied before the request is sent. + summary: will be applied before the request is sent. fullName: customHeaders remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'customHeaders?: [key: string]: string' + content: 'customHeaders?: {[key: string]: string}' return: description: '' - type: '[key: string]\: string' + type: '{[key: string]: string}' inheritanceDescription: Inherited From RequestOptionsBase.customHeaders - name: onDownloadProgress uid: botframework-connector.UserTokenSignOutOptionalParams.onDownloadProgress @@ -72,7 +67,6 @@ inheritedProperties: summary: Callback which fires upon download progress. fullName: onDownloadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void' @@ -86,7 +80,6 @@ inheritedProperties: summary: Callback which fires upon upload progress. fullName: onUploadProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onUploadProgress?: (progress: TransferProgressEvent) => void' @@ -94,15 +87,48 @@ inheritedProperties: description: '' type: '(progress: TransferProgressEvent) => void' inheritanceDescription: Inherited From RequestOptionsBase.onUploadProgress + - name: serializerOptions + uid: botframework-connector.UserTokenSignOutOptionalParams.serializerOptions + package: botframework-connector + summary: Options to override XML parsing/building behavior. + fullName: serializerOptions + remarks: '' + isDeprecated: false + syntax: + content: 'serializerOptions?: SerializerOptions' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.serializerOptions + - name: shouldDeserialize + uid: botframework-connector.UserTokenSignOutOptionalParams.shouldDeserialize + package: botframework-connector + summary: >- + Whether or not the HttpOperationResponse should be deserialized. If this + is undefined, then the + + HttpOperationResponse should be deserialized. + fullName: shouldDeserialize + remarks: '' + isDeprecated: false + syntax: + content: >- + shouldDeserialize?: boolean | (response: HttpOperationResponse) => + boolean + return: + description: '' + type: 'boolean | (response: HttpOperationResponse) => boolean' + inheritanceDescription: Inherited From RequestOptionsBase.shouldDeserialize - name: timeout uid: botframework-connector.UserTokenSignOutOptionalParams.timeout package: botframework-connector summary: >- The number of milliseconds a request can take before automatically being terminated. + + If the request is terminated, an `AbortError` is thrown. fullName: timeout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timeout?: number' @@ -110,4 +136,17 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From RequestOptionsBase.timeout -extends: RequestOptionsBase + - name: tracingContext + uid: botframework-connector.UserTokenSignOutOptionalParams.tracingContext + package: botframework-connector + summary: 'Tracing: Context used when creating spans.' + fullName: tracingContext + remarks: '' + isDeprecated: false + syntax: + content: 'tracingContext?: Context' + return: + description: '' + type: + inheritanceDescription: Inherited From RequestOptionsBase.tracingContext +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutResponse.yml index bb7016c4..aa5cb545 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/UserTokenSignOutResponse.yml @@ -5,10 +5,9 @@ package: botframework-connector summary: Contains response data for the signOut operation. fullName: UserTokenSignOutResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type UserTokenSignOutResponse = { - _response: HttpResponse & { bodyAsText: string, parsedBody: any }, - body: any, + _response: HttpResponse & { bodyAsText: string; parsedBody: any } + body: any } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ValidateClaims.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ValidateClaims.yml index 6b381d9d..85ded8bc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/ValidateClaims.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/ValidateClaims.yml @@ -7,7 +7,6 @@ summary: >- validation fails. fullName: ValidateClaims remarks: '' -isPreview: false isDeprecated: false syntax: | type ValidateClaims = (claims: Claim[]) => Promise diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-connector/index.yml b/botbuilder-typescript/docs-ref-autogen/botframework-connector/index.yml index 46aca2ee..b1cdc776 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-connector/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-connector/index.yml @@ -3,111 +3,159 @@ uid: botframework-connector name: botframework-connector summary: '' type: package -functions: - - name: 'allowedCallersClaimsValidator(string[])' - uid: botframework-connector.allowedCallersClaimsValidator - package: botframework-connector - summary: Create an allowe callers claims validator - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function allowedCallersClaimsValidator(allowedCallers: string[]): - ValidateClaims - parameters: - - id: allowedCallers - type: 'string[]' - description: allowed callers of skill - return: - description: claims validator function - type: -classes: - - botframework-connector.AppCredentials - - botframework-connector.AuthenticationConfiguration - - botframework-connector.AuthenticationError - - botframework-connector.BotFrameworkAuthentication - - botframework-connector.BotFrameworkAuthenticationFactory - - botframework-connector.BotFrameworkClientImpl - - botframework-connector.CertificateAppCredentials - - botframework-connector.ClaimsIdentity - - botframework-connector.ConnectorFactory - - botframework-connector.ConnectorFactoryImpl - - botframework-connector.SimpleCredentialProvider - - botframework-connector.EndorsementsValidator - - botframework-connector.JwtTokenExtractor - - botframework-connector.JwtTokenProviderFactory - - botframework-connector.ManagedIdentityAppCredentials - - botframework-connector.ManagedIdentityAuthenticator - - botframework-connector.ManagedIdentityServiceClientCredentialsFactory - - botframework-connector.MicrosoftAppCredentials - - botframework-connector.OpenIdMetadata - - botframework-connector.ParameterizedBotFrameworkAuthentication - - botframework-connector.PasswordServiceClientCredentialFactory - - botframework-connector.ServiceClientCredentialsFactory - - botframework-connector.UserTokenClient - - botframework-connector.UserTokenClientImpl - - botframework-connector.ConnectorClient - - botframework-connector.ConnectorClientContext - - botframework-connector.Attachments - - botframework-connector.Conversations - - botframework-connector.EmulatorApiClient - - botframework-connector.Teams - - botframework-connector.ReadReceiptInfo - - botframework-connector.TeamsConnectorClient - - botframework-connector.TeamsConnectorClientContext - - botframework-connector.BotSignIn - - botframework-connector.UserToken - - botframework-connector.TokenApiClient - - botframework-connector.TokenApiClientContext typeAliases: + - botframework-connector.TeamsConnectorModels.BatchBatchFailedEntriesResponse + - botframework-connector.TeamsConnectorModels.BatchBatchOperationStateResponse + - botframework-connector.TeamsConnectorModels.CancelOperationResponse + - botframework-connector.TeamsConnectorModels.TeamsBatchOperationResponse + - botframework-connector.TeamsConnectorModels.TeamsFetchChannelListResponse + - >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantResponse + - botframework-connector.TeamsConnectorModels.TeamsFetchTeamDetailsResponse + - botframework-connector.TeamsConnectorModels.TeamsMeetingInfoResponse + - botframework-connector.TeamsConnectorModels.TeamsMeetingNotificationResponse + - botframework-connector.TokenApiModels.BotSignInGetSignInResourceResponse + - botframework-connector.TokenApiModels.BotSignInGetSignInUrlResponse + - botframework-connector.TokenApiModels.UserTokenExchangeAsyncResponse + - botframework-connector.TokenApiModels.UserTokenGetAadTokensResponse + - botframework-connector.TokenApiModels.UserTokenGetTokenResponse + - botframework-connector.TokenApiModels.UserTokenGetTokenStatusResponse + - botframework-connector.TokenApiModels.UserTokenSignOutResponse - botframework-connector.AuthenticateRequestResult - - botframework-connector.ValidateClaims + - botframework-connector.BatchBatchFailedEntriesResponse + - botframework-connector.BatchBatchOperationStateResponse + - botframework-connector.BotSignInGetSignInResourceResponse + - botframework-connector.BotSignInGetSignInUrlResponse + - botframework-connector.CancelOperationResponse - botframework-connector.StatusCode - - botframework-connector.AttachmentsGetAttachmentInfoResponse - - botframework-connector.AttachmentsGetAttachmentResponse - - botframework-connector.ConversationsCreateConversationResponse - - botframework-connector.ConversationsGetActivityMembersResponse - - botframework-connector.ConversationsGetConversationMemberResponse - - botframework-connector.ConversationsGetConversationMembersResponse - - botframework-connector.ConversationsGetConversationPagedMembersResponse - - botframework-connector.ConversationsGetConversationsResponse - - botframework-connector.ConversationsReplyToActivityResponse - - botframework-connector.ConversationsSendConversationHistoryResponse - - botframework-connector.ConversationsSendToConversationResponse - - botframework-connector.ConversationsUpdateActivityResponse - - botframework-connector.ConversationsUploadAttachmentResponse + - botframework-connector.TeamsBatchOperationResponse - botframework-connector.TeamsFetchChannelListResponse - botframework-connector.TeamsFetchMeetingParticipantResponse - botframework-connector.TeamsFetchTeamDetailsResponse - botframework-connector.TeamsMeetingInfoResponse - - botframework-connector.BotSignInGetSignInResourceResponse - - botframework-connector.BotSignInGetSignInUrlResponse + - botframework-connector.TeamsMeetingNotificationResponse + - botframework-connector.TokenStatus - botframework-connector.UserTokenExchangeAsyncResponse - botframework-connector.UserTokenGetAadTokensResponse - botframework-connector.UserTokenGetTokenResponse - botframework-connector.UserTokenGetTokenStatusResponse - botframework-connector.UserTokenSignOutResponse + - botframework-connector.ValidateClaims interfaces: - - botframework-connector.Claim - - botframework-connector.ICredentialProvider - - botframework-connector.IJwtTokenProviderFactory - - botframework-connector.IOpenIdMetadataKey - - botframework-connector.ConnectorClientOptions - >- - botframework-connector.ConversationsGetConversationPagedMembersOptionalParams - - botframework-connector.ConversationsGetConversationsOptionalParams - - botframework-connector.BotFrameworkClient - - botframework-connector.TeamsConnectorClientOptions - - botframework-connector.TeamsFetchMeetingParticipantOptionalParams + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams + - botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions + - >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams + - botframework-connector.TokenApiModels.AadResourceUrls + - >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams + - botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams + - botframework-connector.TokenApiModels.ErrorModel + - botframework-connector.TokenApiModels.ErrorResponse + - botframework-connector.TokenApiModels.InnerHttpError + - botframework-connector.TokenApiModels.TokenApiClientOptions + - botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams + - botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams + - botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams + - botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams - botframework-connector.AadResourceUrls + - botframework-connector.AuthenticatorResult + - botframework-connector.BotFrameworkClient - botframework-connector.BotSignInGetSignInResourceOptionalParams - botframework-connector.BotSignInGetSignInUrlOptionalParams + - botframework-connector.Claim + - botframework-connector.ConnectorClientOptions + - >- + botframework-connector.ConversationsGetConversationPagedMembersOptionalParams - botframework-connector.ErrorModel - botframework-connector.ErrorResponse + - botframework-connector.ICredentialProvider + - botframework-connector.IJwtTokenProviderFactory - botframework-connector.InnerHttpError + - botframework-connector.ServiceClientCredentials + - botframework-connector.SignInUrlResponse + - botframework-connector.TeamsConnectorClientOptions + - botframework-connector.TeamsFetchMeetingParticipantOptionalParams - botframework-connector.TokenApiClientOptions + - botframework-connector.TokenExchangeRequest - botframework-connector.UserTokenGetAadTokensOptionalParams - botframework-connector.UserTokenGetTokenOptionalParams - botframework-connector.UserTokenGetTokenStatusOptionalParams - botframework-connector.UserTokenSignOutOptionalParams +classes: + - botframework-connector.AppCredentials + - botframework-connector.AuthenticationConfiguration + - botframework-connector.AuthenticationError + - botframework-connector.BotFrameworkAuthentication + - botframework-connector.BotFrameworkAuthenticationFactory + - botframework-connector.CertificateAppCredentials + - botframework-connector.CertificateServiceClientCredentialsFactory + - botframework-connector.ClaimsIdentity + - botframework-connector.ConnectorClient + - botframework-connector.ConnectorFactory + - botframework-connector.EmulatorApiClient + - botframework-connector.EndorsementsValidator + - botframework-connector.JwtTokenProviderFactory + - botframework-connector.ManagedIdentityAppCredentials + - botframework-connector.ManagedIdentityAuthenticator + - botframework-connector.ManagedIdentityServiceClientCredentialsFactory + - botframework-connector.MicrosoftAppCredentials + - botframework-connector.MicrosoftGovernmentAppCredentials + - botframework-connector.MsalAppCredentials + - botframework-connector.MsalServiceClientCredentialsFactory + - botframework-connector.PasswordServiceClientCredentialFactory + - botframework-connector.ReadReceiptInfo + - botframework-connector.ServiceClientCredentialsFactory + - botframework-connector.SimpleCredentialProvider + - botframework-connector.Teams + - botframework-connector.TeamsConnectorClient + - botframework-connector.TeamsConnectorClientContext + - botframework-connector.TokenApiClient + - botframework-connector.TokenCredentials + - botframework-connector.UserTokenClient +functions: + - name: allowedCallersClaimsValidator(string[]) + uid: botframework-connector.allowedCallersClaimsValidator + package: botframework-connector + summary: Create an allowe callers claims validator + remarks: '' + isDeprecated: false + syntax: + content: >- + function allowedCallersClaimsValidator(allowedCallers: string[]): + ValidateClaims + parameters: + - id: allowedCallers + type: string[] + description: allowed callers of skill + return: + description: claims validator function + type: + - name: 'retryAction((n: number) => Promise, number, number)' + uid: botframework-connector.retryAction + package: botframework-connector + summary: >- + Retry a given promise with gradually increasing delay when the HTTP status + code received is 429(Too Many Requests). + remarks: '' + isDeprecated: false + syntax: + content: >- + function retryAction(promise: (n: number) => Promise, maxRetries: + number, initialDelay?: number): Promise + parameters: + - id: promise + type: '(n: number) => Promise<T>' + description: a function that returns a promise to retry. + - id: maxRetries + type: number + description: the maximum number of times to retry. + - id: initialDelay + type: number + description: the initial value to delay before retrying (in milliseconds). + return: + description: >- + a promise resolving to the result of the promise from the promise + generating function, or undefined. + type: Promise<T | undefined> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceCardSize.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceCardSize.yml new file mode 100644 index 00000000..bb32a64f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceCardSize.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: AceCardSize +uid: botframework-schema.AceCardSize +package: botframework-schema +summary: SharePoint ACE Card Size +fullName: AceCardSize +remarks: '' +isDeprecated: false +syntax: | + type AceCardSize = "Medium" | "Large" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceData.yml new file mode 100644 index 00000000..1f87199a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceData.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: AceData +uid: botframework-schema.AceData +package: botframework-schema +summary: SharePoint ACE Data object +fullName: AceData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardSize + uid: botframework-schema.AceData.cardSize + package: botframework-schema + summary: The card size. + fullName: cardSize + remarks: '' + isDeprecated: false + syntax: + content: 'cardSize: AceCardSize' + return: + description: '' + type: + - name: dataVersion + uid: botframework-schema.AceData.dataVersion + package: botframework-schema + summary: >- + The value of this property is stored in the serialized data of the + Adaptive Card Extension. + + It can be used to manage versioning of the Adaptive Card Extension. + fullName: dataVersion + remarks: >- + - although there is no restriction on the format of this property, it is + recommended to use semantic versioning. + isDeprecated: false + syntax: + content: 'dataVersion: string' + return: + description: '' + type: string + - name: description + uid: botframework-schema.AceData.description + package: botframework-schema + summary: The description of the ACE. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description: string' + return: + description: '' + type: string + - name: iconProperty + uid: botframework-schema.AceData.iconProperty + package: botframework-schema + summary: The icon of the ACE. + fullName: iconProperty + remarks: '' + isDeprecated: false + syntax: + content: 'iconProperty: string' + return: + description: '' + type: string + - name: id + uid: botframework-schema.AceData.id + package: botframework-schema + summary: The unique id (Guid) of the ACE. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string + - name: isVisible + uid: botframework-schema.AceData.isVisible + package: botframework-schema + summary: |- + The visibility of the Adaptive Card Extension. + true if not specified. + fullName: isVisible + remarks: '' + isDeprecated: false + syntax: + content: 'isVisible?: boolean' + return: + description: '' + type: boolean + - name: properties + uid: botframework-schema.AceData.properties + package: botframework-schema + summary: The properties of the ACE. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties: any' + return: + description: '' + type: any + - name: title + uid: botframework-schema.AceData.title + package: botframework-schema + summary: The title of the ACE. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceRequest.yml new file mode 100644 index 00000000..d44513e6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AceRequest.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: AceRequest +uid: botframework-schema.AceRequest +package: botframework-schema +summary: ACE invoke request payload. +fullName: AceRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botframework-schema.AceRequest.data + package: botframework-schema + summary: User ACE request data. Free payload with key-value pairs. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data?: any' + return: + description: '' + type: any + - name: properties + uid: botframework-schema.AceRequest.properties + package: botframework-schema + summary: ACE properties data. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Action.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Action.yml index b540bfad..11b21590 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Action.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Action.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'accept', 'decline' fullName: Action remarks: '' -isPreview: false isDeprecated: false syntax: | type Action = "accept" | "decline" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActionTypes.yml index 4db88ce9..b523b8bc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActionTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActionTypes.yml @@ -11,7 +11,6 @@ summary: >- 'downloadFile', 'signin', 'call', messageBack', 'openApp' fullName: ActionTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Call diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Activity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Activity.yml index 76ab4de6..4b9590bf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Activity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Activity.yml @@ -7,7 +7,6 @@ summary: >- protocol. fullName: Activity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -21,7 +20,6 @@ properties: sender's contact list. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action?: string' @@ -38,26 +36,24 @@ properties: 'carousel' fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'attachmentLayout?: AttachmentLayoutTypes | string' + content: 'attachmentLayout?: string' return: description: '' - type: | string + type: string - name: attachments uid: botframework-schema.Activity.attachments package: botframework-schema summary: Attachments fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: Attachment[]' return: description: '' - type: '[]' + type: [] - name: callerId uid: botframework-schema.Activity.callerId package: botframework-schema @@ -71,7 +67,6 @@ properties: the identity of the callers (e.g. tokens). fullName: callerId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'callerId: string' @@ -84,7 +79,6 @@ properties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -97,7 +91,6 @@ properties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -117,20 +110,18 @@ properties: 'botIssuedInvalidMessage', 'channelFailed' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'code?: EndOfConversationCodes | string' + content: 'code?: string' return: description: '' - type: | string + type: string - name: conversation uid: botframework-schema.Activity.conversation package: botframework-schema summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -148,26 +139,24 @@ properties: 'notification', 'expectReplies', 'ephemeral' fullName: deliveryMode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'deliveryMode?: DeliveryModes | string' + content: 'deliveryMode?: string' return: description: '' - type: | string + type: string - name: entities uid: botframework-schema.Activity.entities package: botframework-schema summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] - name: expiration uid: botframework-schema.Activity.expiration package: botframework-schema @@ -178,7 +167,6 @@ properties: presented to the recipient. fullName: expiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiration?: Date' @@ -191,7 +179,6 @@ properties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -204,7 +191,6 @@ properties: summary: Indicates whether the prior history of the channel is disclosed. fullName: historyDisclosed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'historyDisclosed?: boolean' @@ -217,7 +203,6 @@ properties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -232,13 +217,12 @@ properties: 'high' fullName: importance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'importance?: ActivityImportance | string' + content: 'importance?: string' return: description: '' - type: | string + type: string - name: inputHint uid: botframework-schema.Activity.inputHint package: botframework-schema @@ -251,20 +235,18 @@ properties: values include: 'acceptingInput', 'ignoringInput', 'expectingInput' fullName: inputHint remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inputHint?: InputHints | string' + content: 'inputHint?: string' return: description: '' - type: | string + type: string - name: label uid: botframework-schema.Activity.label package: botframework-schema summary: A descriptive label for the activity. fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label: string' @@ -279,13 +261,12 @@ properties: should listen for fullName: listenFor remarks: '' - isPreview: false isDeprecated: false syntax: content: 'listenFor: string[]' return: description: '' - type: 'string[]' + type: string[] - name: locale uid: botframework-schema.Activity.locale package: botframework-schema @@ -303,7 +284,6 @@ properties: The locale name can also correspond to a valid BCP-47 language tag. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -320,7 +300,6 @@ properties: For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -337,7 +316,6 @@ properties: For example, America/Los_Angeles. fullName: localTimezone remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimezone: string' @@ -350,72 +328,66 @@ properties: summary: The collection of members added to the conversation. fullName: membersAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersAdded?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] - name: membersRemoved uid: botframework-schema.Activity.membersRemoved package: botframework-schema summary: The collection of members removed from the conversation. fullName: membersRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersRemoved?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] - name: name uid: botframework-schema.Activity.name package: botframework-schema summary: The name of the operation associated with an invoke or event activity. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'name?: ActivityEventNames | string' + content: 'name?: string' return: description: '' - type: | string + type: string - name: reactionsAdded uid: botframework-schema.Activity.reactionsAdded package: botframework-schema summary: The collection of reactions added to the conversation. fullName: reactionsAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionsAdded?: MessageReaction[]' return: description: '' - type: '[]' + type: [] - name: reactionsRemoved uid: botframework-schema.Activity.reactionsRemoved package: botframework-schema summary: The collection of reactions removed from the conversation. fullName: reactionsRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionsRemoved?: MessageReaction[]' return: description: '' - type: '[]' + type: [] - name: recipient uid: botframework-schema.Activity.recipient package: botframework-schema summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -428,7 +400,6 @@ properties: summary: A reference to another conversation or activity. fullName: relatesTo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'relatesTo?: ConversationReference' @@ -441,7 +412,6 @@ properties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -454,7 +424,6 @@ properties: summary: An optional programmatic action accompanying this request fullName: semanticAction remarks: '' - isPreview: false isDeprecated: false syntax: content: 'semanticAction?: SemanticAction' @@ -469,7 +438,6 @@ properties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -482,7 +450,6 @@ properties: summary: The text to speak. fullName: speak remarks: '' - isPreview: false isDeprecated: false syntax: content: 'speak?: string' @@ -495,7 +462,6 @@ properties: summary: The suggested actions for the activity. fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: SuggestedActions' @@ -508,7 +474,6 @@ properties: summary: The text to display if the channel cannot render cards. fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' @@ -521,7 +486,6 @@ properties: summary: The text content of the message. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -536,13 +500,12 @@ properties: 'markdown', 'plain', 'xml' fullName: textFormat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'textFormat?: TextFormatTypes | string' + content: 'textFormat?: string' return: description: '' - type: | string + type: string - name: textHighlights uid: botframework-schema.Activity.textHighlights package: botframework-schema @@ -551,13 +514,12 @@ properties: ReplyToId value. fullName: textHighlights remarks: '' - isPreview: false isDeprecated: false syntax: content: 'textHighlights?: TextHighlight[]' return: description: '' - type: '[]' + type: [] - name: timestamp uid: botframework-schema.Activity.timestamp package: botframework-schema @@ -566,7 +528,6 @@ properties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -579,7 +540,6 @@ properties: summary: The updated topic name of the conversation. fullName: topicName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'topicName?: string' @@ -602,20 +562,18 @@ properties: 'trace', 'handoff' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string - name: value uid: botframework-schema.Activity.value package: botframework-schema summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -628,7 +586,6 @@ properties: summary: The type of the activity's value object. fullName: valueType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'valueType: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEventNames.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEventNames.yml index 63ed2026..d5e7abb1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEventNames.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEventNames.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'continueConversation', 'createConversation' fullName: ActivityEventNames remarks: '' -isPreview: false isDeprecated: false fields: - name: ContinueConversation diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEx.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEx.yml index 43b5cd75..9737d2ff 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEx.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityEx.yml @@ -12,7 +12,6 @@ functions: Returns the source activity as an ICommandActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,7 +33,6 @@ functions: Returns the source activity as an ICommandResultActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -56,7 +54,6 @@ functions: Returns the source activity as an IContactRelationUpdateActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -78,7 +75,6 @@ functions: Returns the source activity as an IConversationUpdateActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -100,7 +96,6 @@ functions: Returns the source activity as an IEndOfConversationActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -122,7 +117,6 @@ functions: Returns the source activity as an IEventActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -142,7 +136,6 @@ functions: Returns the source activity as an IHandoffActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -162,7 +155,6 @@ functions: Returns the source activity as an IInstallationUpdateActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -184,7 +176,6 @@ functions: Returns the source activity as an IInvokeActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -204,7 +195,6 @@ functions: Returns the source activity as an IMessageActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -224,7 +214,6 @@ functions: Returns the source activity as an IMessageDeleteActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -246,7 +235,6 @@ functions: Returns the source activity as an IMessageReactionActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -268,7 +256,6 @@ functions: Returns the source activity as an IMessageUpdateActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -290,7 +277,6 @@ functions: Returns the source activity as an ISuggestionActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -310,7 +296,6 @@ functions: Returns the source activity as an ITraceActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -330,7 +315,6 @@ functions: Returns the source activity as an ITypingActivity object; or null, if this is not that type of activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -348,7 +332,6 @@ functions: package: botframework-schema summary: Creates an Activity as an IContactRelationUpdateActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -364,7 +347,6 @@ functions: package: botframework-schema summary: Creates an Activity as an IConversationUpdateActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -380,7 +362,6 @@ functions: package: botframework-schema summary: Creates an Activity as an IEndOfConversationActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -396,7 +377,6 @@ functions: package: botframework-schema summary: Creates an Activity as an IEventActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createEventActivity(): Partial' @@ -408,7 +388,6 @@ functions: package: botframework-schema summary: Creates an Activity as an IHandoffActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createHandoffActivity(): Partial' @@ -420,7 +399,6 @@ functions: package: botframework-schema summary: Creates an Activity as an IInvokeActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createInvokeActivity(): Partial' @@ -432,19 +410,17 @@ functions: package: botframework-schema summary: Creates an Activity as an IMessageActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createMessageActivity(): Partial' return: description: The new message activity. type: Partial<> - - name: 'createReply(Activity, string, string)' + - name: createReply(Activity, string, string) uid: botframework-schema.ActivityEx.createReply package: botframework-schema summary: Creates a new message activity as a response to this activity. remarks: The new activity sets up routing information based on this activity. - isPreview: false isDeprecated: false syntax: content: >- @@ -459,16 +435,15 @@ functions: description: The text of the reply. - id: locale type: string - description: The language code for the @param text . + description: The language code for the return: description: The new message activity. type: - - name: 'createTrace(Activity, string, unknown, string, string)' + - name: createTrace(Activity, string, unknown, string, string) uid: botframework-schema.ActivityEx.createTrace package: botframework-schema summary: Creates a new trace activity based on the source activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -483,24 +458,21 @@ functions: description: The name of the trace operation to create. - id: value type: unknown - description: 'Optional, the content for this trace operation.' + description: Optional, the content for this trace operation. - id: valueType type: string - description: >- - Optional, identifier for the format of the @param value . Default is - the name of type of the @param value . + description: Optional, identifier for the format of the - id: label type: string - description: 'Optional, a descriptive label for this trace operation.' + description: Optional, a descriptive label for this trace operation. return: description: The new trace activity. type: - - name: 'createTraceActivity(string, string, unknown, string)' + - name: createTraceActivity(string, string, unknown, string) uid: botframework-schema.ActivityEx.createTraceActivity package: botframework-schema summary: Creates an Activity as an ITraceActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -512,15 +484,13 @@ functions: description: The name of the trace operation to create. - id: valueType type: string - description: >- - Optional, identifier for the format of the @param value . Default is - the name of type of the @param value . + description: Optional, identifier for the format of the - id: value type: unknown - description: 'Optional, the content for this trace operation.' + description: . Default is the name of type of the - id: label type: string - description: 'Optional, a descriptive label for this trace operation.' + description: Optional, a descriptive label for this trace operation. return: description: The new trace activity. type: Partial<> @@ -529,7 +499,6 @@ functions: package: botframework-schema summary: Creates an Activity as an ITypingActivity object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createTypingActivity(): Partial' @@ -541,7 +510,6 @@ functions: package: botframework-schema summary: Creates an Activity from conversation reference as it is posted to bot. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -561,7 +529,6 @@ functions: package: botframework-schema summary: Creates a ConversationReference based on the source activity. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -583,12 +550,10 @@ functions: Resolves the mentions from the entities of the source activity. See cref="entities" . - See cref="mention" . remarks: >- This method is only intended for use with a message activity, where the Activity Type is set to Message. - isPreview: false isDeprecated: false syntax: content: 'function getMentions(source: Partial): Mention[]' @@ -597,8 +562,8 @@ functions: type: Partial<> description: The source activity. return: - description: 'The array of mentions; or an empty array, if none are found.' - type: '[]' + description: The array of mentions; or an empty array, if none are found. + type: [] - name: hasContent(Partial) uid: botframework-schema.ActivityEx.hasContent package: botframework-schema @@ -606,7 +571,6 @@ functions: remarks: >- This method is only intended for use with a message activity, where the Activity Type is set to Message. - isPreview: false isDeprecated: false syntax: content: 'function hasContent(source: Partial): boolean' @@ -615,14 +579,13 @@ functions: type: Partial<> description: The source activity. return: - description: 'True, if this activity has any content to send; otherwise, false.' + description: True, if this activity has any content to send; otherwise, false. type: boolean - - name: 'isActivity(Partial, string)' + - name: isActivity(Partial, string) uid: botframework-schema.ActivityEx.isActivity package: botframework-schema summary: Indicates whether this activity is of a specified activity type. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -654,7 +617,6 @@ functions: (2) Channels that send messages via streaming have a ServiceUrl that does not begin with http/https. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isFromStreamingConnection(source: Partial): boolean' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImageType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImageType.yml index 8541b6a8..f64051f8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImageType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImageType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'avatar', 'article' fullName: ActivityImageType remarks: '' -isPreview: false isDeprecated: false syntax: | type ActivityImageType = "avatar" | "article" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImportance.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImportance.yml index 62a91c89..268e42c1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImportance.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityImportance.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'low', 'normal', 'high' fullName: ActivityImportance remarks: '' -isPreview: false isDeprecated: false fields: - name: High diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTimestamps.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTimestamps.yml index 4eed1e07..55e2315a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTimestamps.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTimestamps.yml @@ -12,7 +12,6 @@ summary: >- Date objects are UTC, timezone offset values are lost. fullName: ActivityTimestamps remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -22,7 +21,6 @@ properties: summary: '' fullName: rawExpiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rawExpiration?: string' @@ -35,7 +33,6 @@ properties: summary: '' fullName: rawLocalTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rawLocalTimestamp?: string' @@ -48,7 +45,6 @@ properties: summary: '' fullName: rawTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rawTimestamp?: string' @@ -66,7 +62,6 @@ inheritedProperties: sender's contact list. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action?: string' @@ -86,13 +81,12 @@ inheritedProperties: 'carousel' fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'attachmentLayout?: AttachmentLayoutTypes | string' + content: 'attachmentLayout?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.attachmentLayout](xref:botframework-schema.Activity.attachmentLayout) @@ -102,13 +96,12 @@ inheritedProperties: summary: Attachments fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: Attachment[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.attachments](xref:botframework-schema.Activity.attachments) @@ -125,7 +118,6 @@ inheritedProperties: the identity of the callers (e.g. tokens). fullName: callerId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'callerId: string' @@ -141,7 +133,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -157,7 +148,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -180,13 +170,12 @@ inheritedProperties: 'botIssuedInvalidMessage', 'channelFailed' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'code?: EndOfConversationCodes | string' + content: 'code?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.code](xref:botframework-schema.Activity.code) @@ -196,7 +185,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -217,13 +205,12 @@ inheritedProperties: 'notification', 'expectReplies', 'ephemeral' fullName: deliveryMode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'deliveryMode?: DeliveryModes | string' + content: 'deliveryMode?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.deliveryMode](xref:botframework-schema.Activity.deliveryMode) @@ -233,13 +220,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.entities](xref:botframework-schema.Activity.entities) @@ -253,7 +239,6 @@ inheritedProperties: presented to the recipient. fullName: expiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiration?: Date' @@ -269,7 +254,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -285,7 +269,6 @@ inheritedProperties: summary: Indicates whether the prior history of the channel is disclosed. fullName: historyDisclosed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'historyDisclosed?: boolean' @@ -301,14 +284,13 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' return: description: '' type: string - inheritanceDescription: 'Inherited From [Activity.id](xref:botframework-schema.Activity.id)' + inheritanceDescription: Inherited From [Activity.id](xref:botframework-schema.Activity.id) - name: importance uid: botframework-schema.ActivityTimestamps.importance package: botframework-schema @@ -317,13 +299,12 @@ inheritedProperties: 'high' fullName: importance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'importance?: ActivityImportance | string' + content: 'importance?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.importance](xref:botframework-schema.Activity.importance) @@ -339,13 +320,12 @@ inheritedProperties: values include: 'acceptingInput', 'ignoringInput', 'expectingInput' fullName: inputHint remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inputHint?: InputHints | string' + content: 'inputHint?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.inputHint](xref:botframework-schema.Activity.inputHint) @@ -355,7 +335,6 @@ inheritedProperties: summary: A descriptive label for the activity. fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label: string' @@ -373,13 +352,12 @@ inheritedProperties: should listen for fullName: listenFor remarks: '' - isPreview: false isDeprecated: false syntax: content: 'listenFor: string[]' return: description: '' - type: 'string[]' + type: string[] inheritanceDescription: >- Inherited From [Activity.listenFor](xref:botframework-schema.Activity.listenFor) @@ -400,7 +378,6 @@ inheritedProperties: The locale name can also correspond to a valid BCP-47 language tag. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -420,7 +397,6 @@ inheritedProperties: For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -440,7 +416,6 @@ inheritedProperties: For example, America/Los_Angeles. fullName: localTimezone remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimezone: string' @@ -456,13 +431,12 @@ inheritedProperties: summary: The collection of members added to the conversation. fullName: membersAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersAdded?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.membersAdded](xref:botframework-schema.Activity.membersAdded) @@ -472,13 +446,12 @@ inheritedProperties: summary: The collection of members removed from the conversation. fullName: membersRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersRemoved?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.membersRemoved](xref:botframework-schema.Activity.membersRemoved) @@ -488,13 +461,12 @@ inheritedProperties: summary: The name of the operation associated with an invoke or event activity. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'name?: ActivityEventNames | string' + content: 'name?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.name](xref:botframework-schema.Activity.name) @@ -504,13 +476,12 @@ inheritedProperties: summary: The collection of reactions added to the conversation. fullName: reactionsAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionsAdded?: MessageReaction[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.reactionsAdded](xref:botframework-schema.Activity.reactionsAdded) @@ -520,13 +491,12 @@ inheritedProperties: summary: The collection of reactions removed from the conversation. fullName: reactionsRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionsRemoved?: MessageReaction[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.reactionsRemoved](xref:botframework-schema.Activity.reactionsRemoved) @@ -536,7 +506,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -552,7 +521,6 @@ inheritedProperties: summary: A reference to another conversation or activity. fullName: relatesTo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'relatesTo?: ConversationReference' @@ -568,7 +536,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -584,7 +551,6 @@ inheritedProperties: summary: An optional programmatic action accompanying this request fullName: semanticAction remarks: '' - isPreview: false isDeprecated: false syntax: content: 'semanticAction?: SemanticAction' @@ -602,7 +568,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -618,7 +583,6 @@ inheritedProperties: summary: The text to speak. fullName: speak remarks: '' - isPreview: false isDeprecated: false syntax: content: 'speak?: string' @@ -634,7 +598,6 @@ inheritedProperties: summary: The suggested actions for the activity. fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: SuggestedActions' @@ -650,7 +613,6 @@ inheritedProperties: summary: The text to display if the channel cannot render cards. fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' @@ -666,7 +628,6 @@ inheritedProperties: summary: The text content of the message. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -684,13 +645,12 @@ inheritedProperties: 'markdown', 'plain', 'xml' fullName: textFormat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'textFormat?: TextFormatTypes | string' + content: 'textFormat?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.textFormat](xref:botframework-schema.Activity.textFormat) @@ -702,13 +662,12 @@ inheritedProperties: ReplyToId value. fullName: textHighlights remarks: '' - isPreview: false isDeprecated: false syntax: content: 'textHighlights?: TextHighlight[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [Activity.textHighlights](xref:botframework-schema.Activity.textHighlights) @@ -720,7 +679,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -736,7 +694,6 @@ inheritedProperties: summary: The updated topic name of the conversation. fullName: topicName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'topicName?: string' @@ -762,13 +719,12 @@ inheritedProperties: 'trace', 'handoff' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [Activity.type](xref:botframework-schema.Activity.type) @@ -778,7 +734,6 @@ inheritedProperties: summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -794,7 +749,6 @@ inheritedProperties: summary: The type of the activity's value object. fullName: valueType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'valueType: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTypes.yml index 77bab331..27eaa09a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ActivityTypes.yml @@ -14,7 +14,6 @@ summary: >- 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' fullName: ActivityTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Command diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardAuthentication.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardAuthentication.yml index bd78181b..4c11503f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardAuthentication.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardAuthentication.yml @@ -9,7 +9,6 @@ summary: >- activity with Name of 'adaptiveCard/action'. fullName: AdaptiveCardAuthentication remarks: '' -isPreview: false isDeprecated: false type: interface inheritedProperties: @@ -19,7 +18,6 @@ inheritedProperties: summary: The connection name. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: string' @@ -35,7 +33,6 @@ inheritedProperties: summary: The id from the OAuthCard. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -51,7 +48,6 @@ inheritedProperties: summary: The user token that can be exchanged. fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: content: 'token: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeAction.yml index 67399ddf..c02871da 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeAction.yml @@ -7,7 +7,6 @@ summary: |- activity with Name of 'adaptiveCard/action'. fullName: AdaptiveCardInvokeAction remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,20 +16,18 @@ properties: summary: The Data of this adaptive card action invoke. fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data: Record' return: description: '' - type: 'Record<string, unknown>' + type: Record<string, unknown> - name: id uid: botframework-schema.AdaptiveCardInvokeAction.id package: botframework-schema summary: The id of this Adaptive Card Invoke Action. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -43,7 +40,6 @@ properties: summary: The Type of this Adaptive Card Invoke Action. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -56,7 +52,6 @@ properties: summary: The Verb of this adaptive card action invoke. fullName: verb remarks: '' - isPreview: false isDeprecated: false syntax: content: 'verb: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeResponse.yml index 7eca411b..98ad3609 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeResponse.yml @@ -9,7 +9,6 @@ summary: >- Name of 'adaptiveCard/action'. fullName: AdaptiveCardInvokeResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: summary: The Card Action response status code. fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode: number' @@ -32,7 +30,6 @@ properties: summary: The type of this response. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -45,10 +42,9 @@ properties: summary: The json response object. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: Record' return: description: '' - type: 'Record<string, unknown>' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeValue.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeValue.yml index 0a5e69e1..1b5c53b9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AdaptiveCardInvokeValue.yml @@ -9,7 +9,6 @@ summary: >- Name of 'adaptiveCard/action'. fullName: AdaptiveCardInvokeValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -24,7 +23,6 @@ properties: this adaptive card invoke action value. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action: AdaptiveCardInvokeAction' @@ -41,7 +39,6 @@ properties: for this adaptive card invoke action value. fullName: authentication remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authentication: AdaptiveCardAuthentication' @@ -54,7 +51,6 @@ properties: summary: The 'state' or magic code for an OAuth flow. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AnimationCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AnimationCard.yml index 28d8ab3b..4e0f1ae0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AnimationCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AnimationCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: 'An animation card (Ex: gif or short video clip)' fullName: AnimationCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: "4:3" fullName: aspect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aspect: string' @@ -27,10 +25,9 @@ properties: - name: autoloop uid: botframework-schema.AnimationCard.autoloop package: botframework-schema - summary: 'Should the client loop playback at end of content (default:true)' + summary: Should the client loop playback at end of content (default:true) fullName: autoloop remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autoloop: boolean' @@ -45,7 +42,6 @@ properties: (default:true) fullName: autostart remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autostart: boolean' @@ -58,13 +54,12 @@ properties: summary: Actions on this card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: duration uid: botframework-schema.AnimationCard.duration package: botframework-schema @@ -75,7 +70,6 @@ properties: Formatted as an ISO 8601 Duration field. fullName: duration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'duration: string' @@ -88,7 +82,6 @@ properties: summary: Thumbnail placeholder fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image: ThumbnailUrl' @@ -105,20 +98,18 @@ properties: alternative format of the same content. fullName: media remarks: '' - isPreview: false isDeprecated: false syntax: content: 'media: MediaUrl[]' return: description: '' - type: '[]' + type: [] - name: shareable uid: botframework-schema.AnimationCard.shareable package: botframework-schema - summary: 'This content may be shared with others (default:true)' + summary: This content may be shared with others (default:true) fullName: shareable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shareable: boolean' @@ -131,7 +122,6 @@ properties: summary: Subtitle of this card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -144,7 +134,6 @@ properties: summary: Text of this card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -157,7 +146,6 @@ properties: summary: Title of this card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -170,7 +158,6 @@ properties: summary: Supplementary parameter for this card fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AppBasedLinkQuery.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AppBasedLinkQuery.yml index 8d33909d..37861fb3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AppBasedLinkQuery.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AppBasedLinkQuery.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: AppBasedLinkQuery remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: state uid: botframework-schema.AppBasedLinkQuery.state package: botframework-schema - summary: '' + summary: State is the magic code for OAuth Flow fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state?: string' @@ -25,10 +23,9 @@ properties: - name: url uid: botframework-schema.AppBasedLinkQuery.url package: botframework-schema - summary: '' + summary: Url queried by user fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ApplicationIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ApplicationIdentityType.yml index 420067d8..c95fd2b9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ApplicationIdentityType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ApplicationIdentityType.yml @@ -9,7 +9,6 @@ summary: >- 'office365Connector', 'webhook' fullName: ApplicationIdentityType remarks: '' -isPreview: false isDeprecated: false syntax: | type ApplicationIdentityType = diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Attachment.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Attachment.yml index 778506d4..fb535560 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Attachment.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Attachment.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: An attachment within an activity fullName: Attachment remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Embedded content fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content?: any' @@ -28,7 +26,6 @@ properties: summary: mimetype/Contenttype for the file fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType: string' @@ -41,7 +38,6 @@ properties: summary: Content Url fullName: contentUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentUrl?: string' @@ -54,7 +50,6 @@ properties: summary: (OPTIONAL) The name of the attachment fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -67,7 +62,6 @@ properties: summary: (OPTIONAL) Thumbnail associated with attachment fullName: thumbnailUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'thumbnailUrl?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentData.yml index bbd502cd..22bc2c68 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentData.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Attachment data fullName: AttachmentData remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Name of the attachment fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: Attachment content fullName: originalBase64 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'originalBase64: Uint8Array' @@ -41,7 +38,6 @@ properties: summary: Attachment thumbnail fullName: thumbnailBase64 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'thumbnailBase64: Uint8Array' @@ -54,7 +50,6 @@ properties: summary: Content-Type of the attachment fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentInfo.yml index d5e8bcb4..1cb70a0a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentInfo.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Metadata for an attachment fullName: AttachmentInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Name of the attachment fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: ContentType of the attachment fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -41,10 +38,9 @@ properties: summary: attachment views fullName: views remarks: '' - isPreview: false isDeprecated: false syntax: content: 'views: AttachmentView[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayout.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayout.yml index 16355d07..5f7d75e8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayout.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayout.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'list', 'grid' fullName: AttachmentLayout remarks: '' -isPreview: false isDeprecated: false syntax: | type AttachmentLayout = "list" | "grid" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayoutTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayoutTypes.yml index fab6630d..2203fcc9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayoutTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentLayoutTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'list', 'carousel' fullName: AttachmentLayoutTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Carousel diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentView.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentView.yml index 6cbf567b..0e7b26ed 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentView.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AttachmentView.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Attachment View name and size fullName: AttachmentView remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Size of the attachment fullName: size remarks: '' - isPreview: false isDeprecated: false syntax: content: 'size: number' @@ -28,7 +26,6 @@ properties: summary: Id of the attachment fullName: viewId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'viewId: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AudioCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AudioCard.yml index fc1ffefc..869e2968 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/AudioCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/AudioCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Audio card fullName: AudioCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: "4:3" fullName: aspect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aspect: string' @@ -27,10 +25,9 @@ properties: - name: autoloop uid: botframework-schema.AudioCard.autoloop package: botframework-schema - summary: 'Should the client loop playback at end of content (default:true)' + summary: Should the client loop playback at end of content (default:true) fullName: autoloop remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autoloop: boolean' @@ -45,7 +42,6 @@ properties: (default:true) fullName: autostart remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autostart: boolean' @@ -58,13 +54,12 @@ properties: summary: Actions on this card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: duration uid: botframework-schema.AudioCard.duration package: botframework-schema @@ -75,7 +70,6 @@ properties: Formatted as an ISO 8601 Duration field. fullName: duration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'duration: string' @@ -88,7 +82,6 @@ properties: summary: Thumbnail placeholder fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image: ThumbnailUrl' @@ -105,20 +98,18 @@ properties: alternative format of the same content. fullName: media remarks: '' - isPreview: false isDeprecated: false syntax: content: 'media: MediaUrl[]' return: description: '' - type: '[]' + type: [] - name: shareable uid: botframework-schema.AudioCard.shareable package: botframework-schema - summary: 'This content may be shared with others (default:true)' + summary: This content may be shared with others (default:true) fullName: shareable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shareable: boolean' @@ -131,7 +122,6 @@ properties: summary: Subtitle of this card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -144,7 +134,6 @@ properties: summary: Text of this card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -157,7 +146,6 @@ properties: summary: Title of this card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -170,7 +158,6 @@ properties: summary: Supplementary parameter for this card fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardComponent.yml new file mode 100644 index 00000000..98f8e79e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardComponent.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: BaseCardComponent +uid: botframework-schema.BaseCardComponent +package: botframework-schema +summary: Base Adaptive Card Extension card view component. +fullName: BaseCardComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botframework-schema.BaseCardComponent.componentName + package: botframework-schema + summary: |- + Unique component name. + For example, "textInput" + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: CardComponentName' + return: + description: '' + type: + - name: id + uid: botframework-schema.BaseCardComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardViewParameters.yml new file mode 100644 index 00000000..32626bff --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseCardViewParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: BaseCardViewParameters +uid: botframework-schema.BaseCardViewParameters +package: botframework-schema +summary: Base parameters for the card view. +fullName: BaseCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cardBar + uid: botframework-schema.BaseCardViewParameters.cardBar + package: botframework-schema + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseHandleActionResponse.yml new file mode 100644 index 00000000..e152920a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BaseHandleActionResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: BaseHandleActionResponse +uid: botframework-schema.BaseHandleActionResponse +package: botframework-schema +summary: The base handle action response. +fullName: BaseHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botframework-schema.BaseHandleActionResponse.renderArguments + package: botframework-schema + summary: The render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments?: CardViewResponse | QuickViewResponse' + return: + description: '' + type: >- + | + - name: responseType + uid: botframework-schema.BaseHandleActionResponse.responseType + package: botframework-schema + summary: The type of the view in the handle action response. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: ViewResponseType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BasicCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BasicCard.yml index 420ab268..1b0ea980 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BasicCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BasicCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A basic card fullName: BasicCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,33 +14,30 @@ properties: summary: Set of actions applicable to the current card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: images uid: botframework-schema.BasicCard.images package: botframework-schema summary: Array of images for the card fullName: images remarks: '' - isPreview: false isDeprecated: false syntax: content: 'images: CardImage[]' return: description: '' - type: '[]' + type: [] - name: subtitle uid: botframework-schema.BasicCard.subtitle package: botframework-schema summary: Subtitle of the card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -54,7 +50,6 @@ properties: summary: This action will be activated when user taps on the card itself fullName: tap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tap: CardAction' @@ -67,7 +62,6 @@ properties: summary: Text for the card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -80,7 +74,6 @@ properties: summary: Title of the card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntriesResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntriesResponse.yml new file mode 100644 index 00000000..f3bcc31e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntriesResponse.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BatchFailedEntriesResponse +uid: botframework-schema.BatchFailedEntriesResponse +package: botframework-schema +summary: '' +fullName: BatchFailedEntriesResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: continuationToken + uid: botframework-schema.BatchFailedEntriesResponse.continuationToken + package: botframework-schema + summary: The continuation token for paginated results. + fullName: continuationToken + remarks: '' + isDeprecated: false + syntax: + content: 'continuationToken: string' + return: + description: '' + type: string + - name: failedEntryResponses + uid: botframework-schema.BatchFailedEntriesResponse.failedEntryResponses + package: botframework-schema + summary: The list of failed entries result of a batch operation. + fullName: failedEntryResponses + remarks: '' + isDeprecated: false + syntax: + content: 'failedEntryResponses: BatchFailedEntry[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntry.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntry.yml new file mode 100644 index 00000000..18086b1f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchFailedEntry.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BatchFailedEntry +uid: botframework-schema.BatchFailedEntry +package: botframework-schema +summary: '' +fullName: BatchFailedEntry +remarks: '' +isDeprecated: false +type: interface +properties: + - name: error + uid: botframework-schema.BatchFailedEntry.error + package: botframework-schema + summary: The error of the failed entry. + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: string' + return: + description: '' + type: string + - name: id + uid: botframework-schema.BatchFailedEntry.id + package: botframework-schema + summary: The id of the failed entry. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationRequest.yml new file mode 100644 index 00000000..fd49dbc8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationRequest.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: BatchOperationRequest +uid: botframework-schema.BatchOperationRequest +package: botframework-schema +summary: '' +fullName: BatchOperationRequest +remarks: '' +isDeprecated: false +type: interface +properties: + - name: activity + uid: botframework-schema.BatchOperationRequest.activity + package: botframework-schema + summary: The activity of the request. + fullName: activity + remarks: '' + isDeprecated: false + syntax: + content: 'activity: Activity' + return: + description: '' + type: + - name: members + uid: botframework-schema.BatchOperationRequest.members + package: botframework-schema + summary: The list of members. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members?: TeamsMember[]' + return: + description: '' + type: [] + - name: teamId + uid: botframework-schema.BatchOperationRequest.teamId + package: botframework-schema + summary: The id of the team. + fullName: teamId + remarks: '' + isDeprecated: false + syntax: + content: 'teamId?: string' + return: + description: '' + type: string + - name: tenantId + uid: botframework-schema.BatchOperationRequest.tenantId + package: botframework-schema + summary: The id of the Teams tenant. + fullName: tenantId + remarks: '' + isDeprecated: false + syntax: + content: 'tenantId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationResponse.yml new file mode 100644 index 00000000..6ec4b14e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: BatchOperationResponse +uid: botframework-schema.BatchOperationResponse +package: botframework-schema +summary: '' +fullName: BatchOperationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: operationId + uid: botframework-schema.BatchOperationResponse.operationId + package: botframework-schema + summary: The id of the operation executed. + fullName: operationId + remarks: '' + isDeprecated: false + syntax: + content: 'operationId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationStateResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationStateResponse.yml new file mode 100644 index 00000000..41458830 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BatchOperationStateResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: BatchOperationStateResponse +uid: botframework-schema.BatchOperationStateResponse +package: botframework-schema +summary: '' +fullName: BatchOperationStateResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: retryAfter + uid: botframework-schema.BatchOperationStateResponse.retryAfter + package: botframework-schema + summary: The datetime value to retry the operation. + fullName: retryAfter + remarks: '' + isDeprecated: false + syntax: + content: 'retryAfter?: Date' + return: + description: '' + type: Date + - name: state + uid: botframework-schema.BatchOperationStateResponse.state + package: botframework-schema + summary: The state of the operation. + fullName: state + remarks: '' + isDeprecated: false + syntax: + content: 'state: string' + return: + description: '' + type: string + - name: statusMap + uid: botframework-schema.BatchOperationStateResponse.statusMap + package: botframework-schema + summary: The status map for processed operations. + fullName: statusMap + remarks: '' + isDeprecated: false + syntax: + content: 'statusMap: Record' + return: + description: '' + type: Record<number, number> + - name: totalEntriesCount + uid: botframework-schema.BatchOperationStateResponse.totalEntriesCount + package: botframework-schema + summary: The number of entries. + fullName: totalEntriesCount + remarks: '' + isDeprecated: false + syntax: + content: 'totalEntriesCount: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuth.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuth.yml new file mode 100644 index 00000000..ab35374e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuth.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: BotConfigAuth +uid: botframework-schema.BotConfigAuth +package: botframework-schema +summary: '' +fullName: BotConfigAuth +remarks: '' +isDeprecated: false +type: interface +properties: + - name: suggestedActions + uid: botframework-schema.BotConfigAuth.suggestedActions + package: botframework-schema + summary: SuggestedActions for the Bot Config Auth + fullName: suggestedActions + remarks: '' + isDeprecated: false + syntax: + content: 'suggestedActions?: SuggestedActions' + return: + description: '' + type: + - name: type + uid: botframework-schema.BotConfigAuth.type + package: botframework-schema + summary: Type of the Bot Config Auth + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "auth"' + return: + description: '' + type: '"auth"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuthType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuthType.yml new file mode 100644 index 00000000..d063d976 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotConfigAuthType.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: BotConfigAuthType +uid: botframework-schema.BotConfigAuthType +package: botframework-schema +summary: |- + Defines possible values for BotConfigAuth type. + Possible values include: "auth" +fullName: BotConfigAuthType +remarks: '' +isDeprecated: false +syntax: | + type BotConfigAuthType = "auth" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewActionType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewActionType.yml index 4a996bb3..86e57078 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewActionType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewActionType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'edit', 'send' fullName: BotMessagePreviewActionType remarks: '' -isPreview: false isDeprecated: false syntax: | type BotMessagePreviewActionType = "edit" | "send" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewType.yml index bbe83f22..ebb30405 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/BotMessagePreviewType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'message', 'continue' fullName: BotMessagePreviewType remarks: '' -isPreview: false isDeprecated: false syntax: | type BotMessagePreviewType = "message" | "continue" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CacheInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CacheInfo.yml index 4c79b353..e1918d92 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CacheInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CacheInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: CacheInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: cacheDuration uid: botframework-schema.CacheInfo.cacheDuration package: botframework-schema - summary: '' + summary: The time in seconds for which the cached object should remain in the cache fullName: cacheDuration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cacheDuration?: number' @@ -25,10 +23,9 @@ properties: - name: cacheType uid: botframework-schema.CacheInfo.cacheType package: botframework-schema - summary: '' + summary: The type of cache for this object. fullName: cacheType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cacheType?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CallerIdConstants.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CallerIdConstants.yml index 1a1714f4..065e8118 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CallerIdConstants.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CallerIdConstants.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Constants used to populate the Activity.callerId property. fullName: CallerIdConstants remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: remarks: >- This prefix will be followed by the Azure Active Directory App ID of the bot that initiated the call. - isPreview: false isDeprecated: false syntax: content: 'static BotToBotPrefix: string' @@ -30,7 +28,6 @@ properties: summary: The caller ID for any Bot Framework channel. fullName: PublicAzureChannel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static PublicAzureChannel: string' @@ -43,7 +40,6 @@ properties: summary: The caller ID for any Bot Framework US Government cloud channel. fullName: USGovChannel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static USGovChannel: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardAction.yml index fa1455c5..c9461050 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardAction.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A clickable action fullName: CardAction remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Channel-specific data associated with this action fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -28,7 +26,6 @@ properties: summary: (Optional) text to display in the chat feed if the button is clicked fullName: displayText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayText?: string' @@ -38,10 +35,9 @@ properties: - name: image uid: botframework-schema.CardAction.image package: botframework-schema - summary: 'Image URL which will appear on the button, next to text label' + summary: Image URL which will appear on the button, next to text label fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image?: string' @@ -54,7 +50,6 @@ properties: summary: Alternate image text to be used in place of the `image` field fullName: imageAltText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'imageAltText?: string' @@ -67,7 +62,6 @@ properties: summary: Text for this action fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -80,7 +74,6 @@ properties: summary: Text description which appears on the button fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -100,13 +93,12 @@ properties: messageBack', 'openApp' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActionTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string - name: value uid: botframework-schema.CardAction.value package: botframework-schema @@ -115,7 +107,6 @@ properties: the ActionType fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardBarComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardBarComponent.yml new file mode 100644 index 00000000..90c77378 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardBarComponent.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: CardBarComponent +uid: botframework-schema.CardBarComponent +package: botframework-schema +summary: Adaptive Card Extension Card view title area (card bar) component +fullName: CardBarComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botframework-schema.CardBarComponent.componentName + package: botframework-schema + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "cardBar"' + return: + description: '' + type: '"cardBar"' + - name: icon + uid: botframework-schema.CardBarComponent.icon + package: botframework-schema + summary: The icon to display. + fullName: icon + remarks: '' + isDeprecated: false + syntax: + content: 'icon?: CardImage' + return: + description: '' + type: CardImage + - name: title + uid: botframework-schema.CardBarComponent.title + package: botframework-schema + summary: The title to display. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botframework-schema.CardBarComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botframework-schema.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonBase.yml new file mode 100644 index 00000000..ad6f39c5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonBase.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: CardButtonBase +uid: botframework-schema.CardButtonBase +package: botframework-schema +summary: >- + Base properties for the buttons used in different Adaptive Card Extension card + view components, such as Text Input, Search Box and Card Button. +fullName: CardButtonBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: action + uid: botframework-schema.CardButtonBase.action + package: botframework-schema + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + - name: id + uid: botframework-schema.CardButtonBase.id + package: botframework-schema + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonComponent.yml new file mode 100644 index 00000000..b918183d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardButtonComponent.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: CardButtonComponent +uid: botframework-schema.CardButtonComponent +package: botframework-schema +summary: Adaptive Card Extension Card button component. +fullName: CardButtonComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botframework-schema.CardButtonComponent.componentName + package: botframework-schema + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "cardButton"' + return: + description: '' + type: '"cardButton"' + - name: style + uid: botframework-schema.CardButtonComponent.style + package: botframework-schema + summary: Controls the style of the button. + fullName: style + remarks: '' + isDeprecated: false + syntax: + content: 'style?: "default" | "positive"' + return: + description: '' + type: '"default" | "positive"' + - name: title + uid: botframework-schema.CardButtonComponent.title + package: botframework-schema + summary: Text displayed on the button. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botframework-schema.CardButtonComponent.action + package: botframework-schema + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botframework-schema.CardButtonBase.action) + - name: id + uid: botframework-schema.CardButtonComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botframework-schema.CardButtonBase.id) +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardComponentName.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardComponentName.yml new file mode 100644 index 00000000..71869174 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardComponentName.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: CardComponentName +uid: botframework-schema.CardComponentName +package: botframework-schema +summary: Names of the components allowed in a card view. +fullName: CardComponentName +remarks: '' +isDeprecated: false +syntax: | + type CardComponentName = + | "text" + | "cardButton" + | "cardBar" + | "textInput" + | "searchBox" + | "searchFooter" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardImage.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardImage.yml index 28fdb31d..273a56b3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardImage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardImage.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: An image on a card fullName: CardImage remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Image description intended for screen readers fullName: alt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alt?: string' @@ -28,7 +26,6 @@ properties: summary: Action assigned to specific Attachment fullName: tap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tap?: CardAction' @@ -41,7 +38,6 @@ properties: summary: URL thumbnail image for major content property fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchBoxComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchBoxComponent.yml new file mode 100644 index 00000000..eaa75cd7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchBoxComponent.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: CardSearchBoxComponent +uid: botframework-schema.CardSearchBoxComponent +package: botframework-schema +summary: >- + Adaptive Card Extension Search box component. Represents a search box rendered + in the card view. +fullName: CardSearchBoxComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: button + uid: botframework-schema.CardSearchBoxComponent.button + package: botframework-schema + summary: Button displayed on the search box. + fullName: button + remarks: '' + isDeprecated: false + syntax: + content: 'button: ICardSearchBoxButton' + return: + description: '' + type: + - name: componentName + uid: botframework-schema.CardSearchBoxComponent.componentName + package: botframework-schema + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "searchBox"' + return: + description: '' + type: '"searchBox"' + - name: defaultValue + uid: botframework-schema.CardSearchBoxComponent.defaultValue + package: botframework-schema + summary: Default value to display. + fullName: defaultValue + remarks: '' + isDeprecated: false + syntax: + content: 'defaultValue?: string' + return: + description: '' + type: string + - name: placeholder + uid: botframework-schema.CardSearchBoxComponent.placeholder + package: botframework-schema + summary: Placeholder text to display. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botframework-schema.CardSearchBoxComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botframework-schema.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchFooterComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchFooterComponent.yml new file mode 100644 index 00000000..28ca9b49 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardSearchFooterComponent.yml @@ -0,0 +1,105 @@ +### YamlMime:TSType +name: CardSearchFooterComponent +uid: botframework-schema.CardSearchFooterComponent +package: botframework-schema +summary: >- + Adaptive Card Extension Search footer component. Represents a container with + an image (in the shape of a circle) and text. +fullName: CardSearchFooterComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botframework-schema.CardSearchFooterComponent.componentName + package: botframework-schema + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "searchFooter"' + return: + description: '' + type: '"searchFooter"' + - name: imageInitials + uid: botframework-schema.CardSearchFooterComponent.imageInitials + package: botframework-schema + summary: The initials to display in the image area when there is no image. + fullName: imageInitials + remarks: '' + isDeprecated: false + syntax: + content: 'imageInitials?: string' + return: + description: '' + type: string + - name: imageUrl + uid: botframework-schema.CardSearchFooterComponent.imageUrl + package: botframework-schema + summary: >- + Url to the image to use, should be a square aspect ratio and big enough to + fit in the image area. + fullName: imageUrl + remarks: '' + isDeprecated: false + syntax: + content: 'imageUrl?: string' + return: + description: '' + type: string + - name: onSelection + uid: botframework-schema.CardSearchFooterComponent.onSelection + package: botframework-schema + summary: Action to invoke when the footer is selected. + fullName: onSelection + remarks: '' + isDeprecated: false + syntax: + content: 'onSelection?: CardAction' + return: + description: '' + type: CardAction + - name: text + uid: botframework-schema.CardSearchFooterComponent.text + package: botframework-schema + summary: >- + Primary text to display. For example, name of the person for people + search. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: title + uid: botframework-schema.CardSearchFooterComponent.title + package: botframework-schema + summary: Title text to display. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botframework-schema.CardSearchFooterComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botframework-schema.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextComponent.yml new file mode 100644 index 00000000..40cd6394 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextComponent.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: CardTextComponent +uid: botframework-schema.CardTextComponent +package: botframework-schema +summary: >- + Adaptive Card Extension Text component. Represents a text block rendered in + the card view. +fullName: CardTextComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: componentName + uid: botframework-schema.CardTextComponent.componentName + package: botframework-schema + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "text"' + return: + description: '' + type: '"text"' + - name: text + uid: botframework-schema.CardTextComponent.text + package: botframework-schema + summary: Text to display. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botframework-schema.CardTextComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botframework-schema.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextInputComponent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextInputComponent.yml new file mode 100644 index 00000000..a215c2a4 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardTextInputComponent.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: CardTextInputComponent +uid: botframework-schema.CardTextInputComponent +package: botframework-schema +summary: Adaptive Card Extension Text input component. +fullName: CardTextInputComponent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.CardTextInputComponent.ariaLabel + package: botframework-schema + summary: Aria label for the text field. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: button + uid: botframework-schema.CardTextInputComponent.button + package: botframework-schema + summary: Optional button to display. + fullName: button + remarks: '' + isDeprecated: false + syntax: + content: 'button?: ICardTextInputIconButton | ICardTextInputTitleButton' + return: + description: '' + type: >- + | + - name: componentName + uid: botframework-schema.CardTextInputComponent.componentName + package: botframework-schema + summary: Unique component name. + fullName: componentName + remarks: '' + isDeprecated: false + syntax: + content: 'componentName: "textInput"' + return: + description: '' + type: '"textInput"' + - name: defaultValue + uid: botframework-schema.CardTextInputComponent.defaultValue + package: botframework-schema + summary: Default value to display. + fullName: defaultValue + remarks: '' + isDeprecated: false + syntax: + content: 'defaultValue?: string' + return: + description: '' + type: string + - name: iconAfter + uid: botframework-schema.CardTextInputComponent.iconAfter + package: botframework-schema + summary: >- + Properties for an optional icon, displayed in the right end of the text + input. + fullName: iconAfter + remarks: '' + isDeprecated: false + syntax: + content: 'iconAfter?: CardImage' + return: + description: '' + type: CardImage + - name: iconBefore + uid: botframework-schema.CardTextInputComponent.iconBefore + package: botframework-schema + summary: >- + Properties for an optional icon, displayed in the left end of the text + input. + fullName: iconBefore + remarks: '' + isDeprecated: false + syntax: + content: 'iconBefore?: CardImage' + return: + description: '' + type: CardImage + - name: placeholder + uid: botframework-schema.CardTextInputComponent.placeholder + package: botframework-schema + summary: Placeholder text to display. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string +inheritedProperties: + - name: id + uid: botframework-schema.CardTextInputComponent.id + package: botframework-schema + summary: Optional unique identifier of the component's instance. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseCardComponent.id](xref:botframework-schema.BaseCardComponent.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewActionsFooterParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewActionsFooterParameters.yml new file mode 100644 index 00000000..5bbb0cfe --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewActionsFooterParameters.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: CardViewActionsFooterParameters +uid: botframework-schema.CardViewActionsFooterParameters +package: botframework-schema +summary: The actions-only footer parameters for the card view. +fullName: CardViewActionsFooterParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewActionsFooterParameters = + | [CardButtonComponent] + | [CardButtonComponent, CardButtonComponent] + | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewFooterParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewFooterParameters.yml new file mode 100644 index 00000000..cc70c585 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewFooterParameters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: CardViewFooterParameters +uid: botframework-schema.CardViewFooterParameters +package: botframework-schema +summary: >- + The footer parameters for the card view. Can contain either 0 to 2 buttons or + a single text input. +fullName: CardViewFooterParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewFooterParameters = + | CardViewActionsFooterParameters + | [CardTextInputComponent] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewHandleActionResponse.yml new file mode 100644 index 00000000..0ad104e7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: CardViewHandleActionResponse +uid: botframework-schema.CardViewHandleActionResponse +package: botframework-schema +summary: The handle action response for card view. +fullName: CardViewHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botframework-schema.CardViewHandleActionResponse.renderArguments + package: botframework-schema + summary: Card view render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments: CardViewResponse' + return: + description: '' + type: + - name: responseType + uid: botframework-schema.CardViewHandleActionResponse.responseType + package: botframework-schema + summary: Card view. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "Card"' + return: + description: '' + type: '"Card"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewParameters.yml new file mode 100644 index 00000000..4d7ce4ad --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewParameters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: CardViewParameters +uid: botframework-schema.CardViewParameters +package: botframework-schema +summary: Card View Parameters. +fullName: CardViewParameters +remarks: '' +isDeprecated: false +syntax: | + type CardViewParameters = + | TextCardViewParameters + | TextInputCardViewParameters + | SearchCardViewParameters + | SignInCardViewParameters diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewResponse.yml new file mode 100644 index 00000000..321d75ba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CardViewResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: CardViewResponse +uid: botframework-schema.CardViewResponse +package: botframework-schema +summary: SharePoint ACE Card view response payload. +fullName: CardViewResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: aceData + uid: botframework-schema.CardViewResponse.aceData + package: botframework-schema + summary: The ACE data. + fullName: aceData + remarks: '' + isDeprecated: false + syntax: + content: 'aceData: AceData' + return: + description: '' + type: + - name: cardViewParameters + uid: botframework-schema.CardViewResponse.cardViewParameters + package: botframework-schema + summary: The card view parameters. + fullName: cardViewParameters + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewParameters: CardViewParameters' + return: + description: '' + type: + - name: onCardSelection + uid: botframework-schema.CardViewResponse.onCardSelection + package: botframework-schema + summary: The on card selection action. + fullName: onCardSelection + remarks: '' + isDeprecated: false + syntax: + content: 'onCardSelection?: OnCardSelectionAction' + return: + description: '' + type: + - name: viewId + uid: botframework-schema.CardViewResponse.viewId + package: botframework-schema + summary: The view id. + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelAccount.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelAccount.yml index d23df92c..39583ba9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelAccount.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelAccount.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Channel account information needed to route a message fullName: ChannelAccount remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: This account's object ID within Azure Active Directory (AAD) fullName: aadObjectId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aadObjectId?: string' @@ -25,14 +23,9 @@ properties: - name: id uid: botframework-schema.ChannelAccount.id package: botframework-schema - summary: >- - Channel id for the user or bot on this channel (Example: joe@smith.com, or - @joesmith or - - 123456) + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -45,13 +38,24 @@ properties: summary: Display friendly name fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string + - name: properties + uid: botframework-schema.ChannelAccount.properties + package: botframework-schema + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any - name: role uid: botframework-schema.ChannelAccount.role package: botframework-schema @@ -62,10 +66,9 @@ properties: 'user', 'bot', 'skill' fullName: role remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'role?: RoleTypes | string' + content: 'role?: string' return: description: '' - type: | string + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelInfo.yml index c1ba6227..e1ff76e5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ChannelInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: ChannelInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: id uid: botframework-schema.ChannelInfo.id package: botframework-schema - summary: '' + summary: Unique identifier representing a channel fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -25,10 +23,9 @@ properties: - name: name uid: botframework-schema.ChannelInfo.name package: botframework-schema - summary: '' + summary: Name of the channel fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -38,10 +35,9 @@ properties: - name: type uid: botframework-schema.ChannelInfo.type package: botframework-schema - summary: '' + summary: The type of the channel. Valid values are standard, shared and private. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Channels.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Channels.yml index bd583e26..12314f4b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Channels.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Channels.yml @@ -14,7 +14,6 @@ summary: >- 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' fullName: Channels remarks: '' -isPreview: false isDeprecated: false fields: - name: Alexa diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandContext.yml index e9462108..d9964378 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandContext.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'message', 'compose', 'commandbox' fullName: CommandContext remarks: '' -isPreview: false isDeprecated: false syntax: | type CommandContext = "message" | "compose" | "commandbox" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandResultValue.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandResultValue.yml index e5af0f7f..a6664c94 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandResultValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandResultValue.yml @@ -13,7 +13,6 @@ summary: >- complete. fullName: CommandResultValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -23,7 +22,6 @@ properties: summary: ID of the command. fullName: commandId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'commandId: string' @@ -40,7 +38,6 @@ properties: as defined by the name. The value of the data field is a complex type. fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data?: T' @@ -50,10 +47,9 @@ properties: - name: error uid: botframework-schema.CommandResultValue.error package: botframework-schema - summary: 'The optional error, if the command result indicates a failure.' + summary: The optional error, if the command result indicates a failure. fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'error?: Error' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandValue.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandValue.yml index 1057a077..f4db1ce9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/CommandValue.yml @@ -9,7 +9,6 @@ summary: >- activity name. fullName: CommandValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: summary: ID of the command. fullName: commandId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'commandId: string' @@ -36,7 +34,6 @@ properties: as defined by the name. The value of the data field is a complex type. fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data?: T' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponse.yml new file mode 100644 index 00000000..7eebbc15 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponse.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: ConfigResponse +uid: botframework-schema.ConfigResponse +package: botframework-schema +summary: '' +fullName: ConfigResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: cacheInfo + uid: botframework-schema.ConfigResponse.cacheInfo + package: botframework-schema + summary: >- + The data of the ConfigResponse cache, including cache type and cache + duration. + fullName: cacheInfo + remarks: '' + isDeprecated: false + syntax: + content: 'cacheInfo?: CacheInfo' + return: + description: '' + type: + - name: config + uid: botframework-schema.ConfigResponse.config + package: botframework-schema + summary: The ConfigResponse config of BotConfigAuth or TaskModuleResponse + fullName: config + remarks: '' + isDeprecated: false + syntax: + content: 'config: ConfigResponseConfig' + return: + description: '' + type: + - name: responseType + uid: botframework-schema.ConfigResponse.responseType + package: botframework-schema + summary: The type of response 'config'. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "config"' + return: + description: '' + type: '"config"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponseConfig.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponseConfig.yml new file mode 100644 index 00000000..628f440f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfigResponseConfig.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ConfigResponseConfig +uid: botframework-schema.ConfigResponseConfig +package: botframework-schema +summary: '' +fullName: ConfigResponseConfig +remarks: '' +isDeprecated: false +syntax: | + type ConfigResponseConfig = BotConfigAuth | TaskModuleResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfirmationDialog.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfirmationDialog.yml new file mode 100644 index 00000000..2db400b2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConfirmationDialog.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: ConfirmationDialog +uid: botframework-schema.ConfirmationDialog +package: botframework-schema +summary: >- + SharePoint Confirmation Dialog option that is passed through `Submit` Action + is executed. +fullName: ConfirmationDialog +remarks: '' +isDeprecated: false +type: interface +properties: + - name: message + uid: botframework-schema.ConfirmationDialog.message + package: botframework-schema + summary: Dialog message. + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + - name: title + uid: botframework-schema.ConfirmationDialog.title + package: botframework-schema + summary: Dialog title. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContactRelationUpdateActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContactRelationUpdateActionTypes.yml index 5f9fc436..5196761a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContactRelationUpdateActionTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContactRelationUpdateActionTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'add', 'remove' fullName: ContactRelationUpdateActionTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Add diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContentType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContentType.yml index a938cd7e..d2b545b3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContentType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ContentType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'html', 'text' fullName: ContentType remarks: '' -isPreview: false isDeprecated: false syntax: | type ContentType = "html" | "text" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationAccount.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationAccount.yml index 721eac92..accdfa9c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationAccount.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationAccount.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Channel account information for a conversation fullName: ConversationAccount remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: This account's object ID within Azure Active Directory (AAD) fullName: aadObjectId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aadObjectId?: string' @@ -30,7 +28,6 @@ properties: between conversation types fullName: conversationType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationType: string' @@ -40,14 +37,9 @@ properties: - name: id uid: botframework-schema.ConversationAccount.id package: botframework-schema - summary: >- - Channel id for the user or bot on this channel (Example: joe@smith.com, or - @joesmith or - - 123456) + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -64,7 +56,6 @@ properties: activity was generated fullName: isGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isGroup: boolean' @@ -77,7 +68,6 @@ properties: summary: Display friendly name fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -90,7 +80,6 @@ properties: summary: Custom properties object (optional) fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'properties?: any' @@ -107,7 +96,6 @@ properties: 'user', 'bot' fullName: role remarks: '' - isPreview: false isDeprecated: false syntax: content: 'role?: RoleTypes' @@ -120,7 +108,6 @@ properties: summary: This conversation's tenant ID fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationIdentityType.yml index 2babaa43..5652967a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationIdentityType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationIdentityType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'team', 'channel' fullName: ConversationIdentityType remarks: '' -isPreview: false isDeprecated: false syntax: | type ConversationIdentityType = "team" | "channel" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationList.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationList.yml index 6cb7b7b3..9cd3f0a9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationList.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationList.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: ConversationList remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: '' fullName: conversations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversations?: ChannelInfo[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationMembers.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationMembers.yml index 51fad344..468ecd62 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationMembers.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationMembers.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Conversation and its members fullName: ConversationMembers remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Conversation ID fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -28,10 +26,9 @@ properties: summary: List of members in this conversation fullName: members remarks: '' - isPreview: false isDeprecated: false syntax: content: 'members: ChannelAccount[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationParameters.yml index 3b5d01f5..ee9e8479 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationParameters.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationParameters.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Parameters for creating a new conversation fullName: ConversationParameters remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: conversation fullName: activity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activity: Activity' @@ -32,7 +30,6 @@ properties: summary: The bot address for this conversation fullName: bot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bot: ChannelAccount' @@ -45,7 +42,6 @@ properties: summary: Channel specific payload for creating the conversation fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData: any' @@ -58,7 +54,6 @@ properties: summary: IsGroup fullName: isGroup remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isGroup: boolean' @@ -71,20 +66,18 @@ properties: summary: Members to add to the conversation fullName: members remarks: '' - isPreview: false isDeprecated: false syntax: content: 'members?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] - name: tenantId uid: botframework-schema.ConversationParameters.tenantId package: botframework-schema summary: (Optional) The tenant ID in which the conversation should be created fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId?: string' @@ -97,7 +90,6 @@ properties: summary: (Optional) Topic of the conversation (if supported by the channel) fullName: topicName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'topicName?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationReference.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationReference.yml index 04e851fb..32de0dbf 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationReference.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationReference.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: An object relating to a particular point in a conversation fullName: ConversationReference remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: (Optional) ID of the activity to refer to fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId?: string' @@ -28,7 +26,6 @@ properties: summary: Bot participating in this conversation fullName: bot remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bot: ChannelAccount' @@ -41,7 +38,6 @@ properties: summary: Channel ID fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -54,7 +50,6 @@ properties: summary: Conversation reference fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -72,7 +67,6 @@ properties: The locale name can also correspond to a valid BCP-47 language tag. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -87,7 +81,6 @@ properties: may be performed fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -100,7 +93,6 @@ properties: summary: (Optional) User participating in this conversation fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: ChannelAccount' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationResourceResponse.yml index 1b3622a1..367a7dd4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationResourceResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationResourceResponse.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A response containing a resource fullName: ConversationResourceResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: ID of the Activity (if sent) fullName: activityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityId: string' @@ -28,7 +26,6 @@ properties: summary: Id of the resource fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -43,7 +40,6 @@ properties: performed fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationsResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationsResult.yml index d8e1e9cc..5996d055 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationsResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ConversationsResult.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Conversations result fullName: ConversationsResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Paging token fullName: continuationToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'continuationToken: string' @@ -28,10 +26,9 @@ properties: summary: List of conversations fullName: conversations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversations: ConversationMembers[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/DeliveryModes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/DeliveryModes.yml index aea93b80..08b31ae6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/DeliveryModes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/DeliveryModes.yml @@ -9,7 +9,6 @@ summary: >- 'ephemeral' fullName: DeliveryModes remarks: '' -isPreview: false isDeprecated: false fields: - name: Ephemeral diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/DropDownOptionType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/DropDownOptionType.yml new file mode 100644 index 00000000..19a965d3 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/DropDownOptionType.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: DropDownOptionType +uid: botframework-schema.DropDownOptionType +package: botframework-schema +summary: SharePoint property pane drop down option type. +fullName: DropDownOptionType +remarks: '' +isDeprecated: false +fields: + - name: Normal + uid: botframework-schema.DropDownOptionType.Normal + package: botframework-schema + summary: Render a normal option. + numericValue: 0 + - name: Divider + uid: botframework-schema.DropDownOptionType.Divider + package: botframework-schema + summary: Render a divider. + numericValue: 1 + - name: Header + uid: botframework-schema.DropDownOptionType.Header + package: botframework-schema + summary: Render a header. + numericValue: 2 diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/EndOfConversationCodes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/EndOfConversationCodes.yml index 4bc21fde..322a12e2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/EndOfConversationCodes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/EndOfConversationCodes.yml @@ -11,7 +11,6 @@ summary: >- 'botIssuedInvalidMessage', 'channelFailed' fullName: EndOfConversationCodes remarks: '' -isPreview: false isDeprecated: false fields: - name: BotIssuedInvalidMessage diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Entity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Entity.yml index 3ec779fc..6f5587b8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Entity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Entity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Metadata object pertaining to an activity fullName: Entity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Type of this entity (RFC 3987 IRI) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorModel.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorModel.yml index 73107a6c..e3b46bde 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorModel.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorModel.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Object representing error information fullName: ErrorModel remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Error code fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: content: 'code: string' @@ -28,7 +26,6 @@ properties: summary: Error from inner http call fullName: innerHttpError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'innerHttpError: InnerHttpError' @@ -41,7 +38,6 @@ properties: summary: Error message fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorResponse.yml index 109dab63..26e7e001 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ErrorResponse.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: An HTTP API response fullName: ErrorResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Error message fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'error: ErrorModel' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardAction.yml new file mode 100644 index 00000000..26849e82 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: ExecuteCardAction +uid: botframework-schema.ExecuteCardAction +package: botframework-schema +summary: SharePoint `Action.Execute` event. +fullName: ExecuteCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botframework-schema.ExecuteCardAction.parameters + package: botframework-schema + summary: Parameters passed to the Execute event handler + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: ExecuteCardParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.ExecuteCardAction.type + package: botframework-schema + summary: Indicates this is an Execute button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "Execute"' + return: + description: '' + type: '"Execute"' + - name: verb + uid: botframework-schema.ExecuteCardAction.verb + package: botframework-schema + summary: Verb associated with this action + fullName: verb + remarks: '' + isDeprecated: false + syntax: + content: 'verb?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardParameters.yml new file mode 100644 index 00000000..3aa2a043 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExecuteCardParameters.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: ExecuteCardParameters +uid: botframework-schema.ExecuteCardParameters +package: botframework-schema +summary: Parameters for SharePoint Action.Execute card action. +fullName: ExecuteCardParameters +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExpectedReplies.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExpectedReplies.yml index 6827a378..bbcd21b2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExpectedReplies.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExpectedReplies.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Expected Replies in response to DeliveryModes.ExpectReplies fullName: ExpectedReplies remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: A collection of Activities that conforms to the ExpectedReplies schema. fullName: activities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activities: Activity[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkActionParameters.yml new file mode 100644 index 00000000..b141a3f5 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkActionParameters.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ExternalLinkActionParameters +uid: botframework-schema.ExternalLinkActionParameters +package: botframework-schema +summary: Parameters for opening an external link. +fullName: ExternalLinkActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isTeamsDeepLink + uid: botframework-schema.ExternalLinkActionParameters.isTeamsDeepLink + package: botframework-schema + summary: Indicates whether this is a Teams Deep Link. + fullName: isTeamsDeepLink + remarks: '' + isDeprecated: false + syntax: + content: 'isTeamsDeepLink?: boolean' + return: + description: '' + type: boolean + - name: target + uid: botframework-schema.ExternalLinkActionParameters.target + package: botframework-schema + summary: The URL of the link. + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkCardAction.yml new file mode 100644 index 00000000..0a6254d8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ExternalLinkCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ExternalLinkCardAction +uid: botframework-schema.ExternalLinkCardAction +package: botframework-schema +summary: SharePoint ExternalLink action. +fullName: ExternalLinkCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botframework-schema.ExternalLinkCardAction.parameters + package: botframework-schema + summary: Parameters for the external link. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: ExternalLinkActionParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.ExternalLinkCardAction.type + package: botframework-schema + summary: Indicates this is an external link button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "ExternalLink"' + return: + description: '' + type: '"ExternalLink"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Fact.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Fact.yml index fb40ef96..acd07269 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Fact.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Fact.yml @@ -12,7 +12,6 @@ summary: >- for developer to specify style information. fullName: Fact remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -22,7 +21,6 @@ properties: summary: The key for this Fact fullName: key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'key: string' @@ -35,7 +33,6 @@ properties: summary: The value for this Fact fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FieldType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FieldType.yml new file mode 100644 index 00000000..845e94cb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FieldType.yml @@ -0,0 +1,54 @@ +### YamlMime:TSEnum +name: FieldType +uid: botframework-schema.FieldType +package: botframework-schema +summary: SharePoint property pane group field type. +fullName: FieldType +remarks: '' +isDeprecated: false +fields: + - name: CheckBox + uid: botframework-schema.FieldType.CheckBox + package: botframework-schema + summary: Checkbox field. + numericValue: 2 + - name: TextField + uid: botframework-schema.FieldType.TextField + package: botframework-schema + summary: Text field. + numericValue: 3 + - name: Toggle + uid: botframework-schema.FieldType.Toggle + package: botframework-schema + summary: Toggle field. + numericValue: 5 + - name: Dropdown + uid: botframework-schema.FieldType.Dropdown + package: botframework-schema + summary: Dropdown field. + numericValue: 6 + - name: Label + uid: botframework-schema.FieldType.Label + package: botframework-schema + summary: Label field. + numericValue: 7 + - name: Slider + uid: botframework-schema.FieldType.Slider + package: botframework-schema + summary: Slider field. + numericValue: 8 + - name: ChoiceGroup + uid: botframework-schema.FieldType.ChoiceGroup + package: botframework-schema + summary: Choice Group field. + numericValue: 10 + - name: HorizontalRule + uid: botframework-schema.FieldType.HorizontalRule + package: botframework-schema + summary: Horizontal Rule field. + numericValue: 12 + - name: Link + uid: botframework-schema.FieldType.Link + package: botframework-schema + summary: Link field. + numericValue: 13 diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCard.yml index a5557f2b..8e4bbee6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCard.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: FileConsentCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: acceptContext uid: botframework-schema.FileConsentCard.acceptContext package: botframework-schema - summary: '' + summary: Context sent back to the Bot if user fullName: acceptContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'acceptContext?: any' @@ -25,10 +23,9 @@ properties: - name: declineContext uid: botframework-schema.FileConsentCard.declineContext package: botframework-schema - summary: '' + summary: Context sent back to the Bot if user fullName: declineContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'declineContext?: any' @@ -38,10 +35,9 @@ properties: - name: description uid: botframework-schema.FileConsentCard.description package: botframework-schema - summary: '' + summary: File description. fullName: description remarks: '' - isPreview: false isDeprecated: false syntax: content: 'description?: string' @@ -51,10 +47,9 @@ properties: - name: sizeInBytes uid: botframework-schema.FileConsentCard.sizeInBytes package: botframework-schema - summary: '' + summary: Size of the file to be uploaded in Bytes. fullName: sizeInBytes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sizeInBytes?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCardResponse.yml index 8f3fa38a..b045d915 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCardResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileConsentCardResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: FileConsentCardResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: action uid: botframework-schema.FileConsentCardResponse.action package: botframework-schema - summary: '' + summary: The action the user took. Possible values fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action?: Action' @@ -25,10 +23,9 @@ properties: - name: context uid: botframework-schema.FileConsentCardResponse.context package: botframework-schema - summary: '' + summary: The context associated with the action. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: any' @@ -38,10 +35,9 @@ properties: - name: uploadInfo uid: botframework-schema.FileConsentCardResponse.uploadInfo package: botframework-schema - summary: '' + summary: If the user accepted the file, fullName: uploadInfo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uploadInfo?: FileUploadInfo' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfo.yml index d531c0ce..e2c9a445 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: FileDownloadInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: downloadUrl uid: botframework-schema.FileDownloadInfo.downloadUrl package: botframework-schema - summary: '' + summary: File download url. fullName: downloadUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'downloadUrl?: string' @@ -25,10 +23,9 @@ properties: - name: etag uid: botframework-schema.FileDownloadInfo.etag package: botframework-schema - summary: '' + summary: ETag for the file. fullName: etag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'etag?: any' @@ -38,10 +35,9 @@ properties: - name: fileType uid: botframework-schema.FileDownloadInfo.fileType package: botframework-schema - summary: '' + summary: Type of file. fullName: fileType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fileType?: string' @@ -51,10 +47,9 @@ properties: - name: uniqueId uid: botframework-schema.FileDownloadInfo.uniqueId package: botframework-schema - summary: '' + summary: Unique Id for the file. fullName: uniqueId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uniqueId?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfoAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfoAttachment.yml index 8f2d5842..486d2cad 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfoAttachment.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileDownloadInfoAttachment.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: FileDownloadInfoAttachment remarks: '' -isPreview: false isDeprecated: false syntax: | type FileDownloadInfoAttachment = TeamsAttachment diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileInfoCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileInfoCard.yml index 0cb42f64..d96844b5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileInfoCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileInfoCard.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: FileInfoCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: etag uid: botframework-schema.FileInfoCard.etag package: botframework-schema - summary: '' + summary: ETag for the file. fullName: etag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'etag?: any' @@ -25,10 +23,9 @@ properties: - name: fileType uid: botframework-schema.FileInfoCard.fileType package: botframework-schema - summary: '' + summary: Type of file. fullName: fileType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fileType?: string' @@ -38,10 +35,9 @@ properties: - name: uniqueId uid: botframework-schema.FileInfoCard.uniqueId package: botframework-schema - summary: '' + summary: Unique Id for the file. fullName: uniqueId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uniqueId?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileUploadInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileUploadInfo.yml index 62e044fa..352e1c21 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileUploadInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FileUploadInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: FileUploadInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: contentUrl uid: botframework-schema.FileUploadInfo.contentUrl package: botframework-schema - summary: '' + summary: URL to file. fullName: contentUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentUrl?: string' @@ -25,10 +23,9 @@ properties: - name: fileType uid: botframework-schema.FileUploadInfo.fileType package: botframework-schema - summary: '' + summary: Type of the file. fullName: fileType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fileType?: string' @@ -38,10 +35,9 @@ properties: - name: name uid: botframework-schema.FileUploadInfo.name package: botframework-schema - summary: '' + summary: Name of the file. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -51,10 +47,9 @@ properties: - name: uniqueId uid: botframework-schema.FileUploadInfo.uniqueId package: botframework-schema - summary: '' + summary: ID that uniquely identifies the file. fullName: uniqueId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uniqueId?: string' @@ -64,10 +59,9 @@ properties: - name: uploadUrl uid: botframework-schema.FileUploadInfo.uploadUrl package: botframework-schema - summary: '' + summary: URL to an upload session that the bot can use fullName: uploadUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uploadUrl?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/FocusParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FocusParameters.yml new file mode 100644 index 00000000..5d3954e7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/FocusParameters.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: FocusParameters +uid: botframework-schema.FocusParameters +package: botframework-schema +summary: >- + Interface to give third party developers the capability to determine which + element should recieve focus, when, and how often content should be read. +fullName: FocusParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLive + uid: botframework-schema.FocusParameters.ariaLive + package: botframework-schema + summary: >- + Sets the accessibility reading of the contents within the focus target. + + Polite - Content in the target's subtree is read when the user is idle. + + Assertive - Disrupts any announcement in favor of the changed contents + within the target's subtree. + + Off - The screen reader will not read contents within the target's + subtree. + fullName: ariaLive + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLive?: "polite" | "assertive" | "off"' + return: + description: '' + type: '"polite" | "assertive" | "off"' + - name: focusTarget + uid: botframework-schema.FocusParameters.focusTarget + package: botframework-schema + summary: >- + Sets the default focus on the DOM. Developers pass in the id of a unique + element that is to attain focus within a quick view. + + If the `focusTarget` is not defined then the root element is selected. + fullName: focusTarget + remarks: '' + isDeprecated: false + syntax: + content: 'focusTarget?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/GeoCoordinates.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GeoCoordinates.yml index d1b6fcf8..a4d340ab 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/GeoCoordinates.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GeoCoordinates.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: 'GeoCoordinates (entity type: "https://schema.org/GeoCoordinates")' fullName: GeoCoordinates remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: 84](https://en.wikipedia.org/wiki/World_Geodetic_System) fullName: elevation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'elevation: number' @@ -32,7 +30,6 @@ properties: 84](https://en.wikipedia.org/wiki/World_Geodetic_System) fullName: latitude remarks: '' - isPreview: false isDeprecated: false syntax: content: 'latitude: number' @@ -47,7 +44,6 @@ properties: 84](https://en.wikipedia.org/wiki/World_Geodetic_System) fullName: longitude remarks: '' - isPreview: false isDeprecated: false syntax: content: 'longitude: number' @@ -60,7 +56,6 @@ properties: summary: The name of the thing fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -73,7 +68,6 @@ properties: summary: The type of the thing fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationActionParameters.yml new file mode 100644 index 00000000..9b74aba0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationActionParameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: GetLocationActionParameters +uid: botframework-schema.GetLocationActionParameters +package: botframework-schema +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.GetLocation + action. +fullName: GetLocationActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: chooseLocationOnMap + uid: botframework-schema.GetLocationActionParameters.chooseLocationOnMap + package: botframework-schema + summary: |- + If true, allow the user to choose a location by opening a map. + Otherwise, get the current location. + fullName: chooseLocationOnMap + remarks: '' + isDeprecated: false + syntax: + content: 'chooseLocationOnMap?: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationCardAction.yml new file mode 100644 index 00000000..2561fe3f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetLocationCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: GetLocationCardAction +uid: botframework-schema.GetLocationCardAction +package: botframework-schema +summary: SharePoint `VivaAction.GetLocation` event. +fullName: GetLocationCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botframework-schema.GetLocationCardAction.parameters + package: botframework-schema + summary: Parameters that can be supplied with the Viva Get Location Action. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: GetLocationActionParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.GetLocationCardAction.type + package: botframework-schema + summary: Indicates this is a Viva Select Location button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.GetLocation"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetPropertyPaneConfigurationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetPropertyPaneConfigurationResponse.yml new file mode 100644 index 00000000..d1176b32 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/GetPropertyPaneConfigurationResponse.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: GetPropertyPaneConfigurationResponse +uid: botframework-schema.GetPropertyPaneConfigurationResponse +package: botframework-schema +summary: SharePoint ACE get property pane configuration response. +fullName: GetPropertyPaneConfigurationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: currentPage + uid: botframework-schema.GetPropertyPaneConfigurationResponse.currentPage + package: botframework-schema + summary: Current page number. + fullName: currentPage + remarks: '' + isDeprecated: false + syntax: + content: 'currentPage: number' + return: + description: '' + type: number + - name: loadingIndicatorDelayTime + uid: >- + botframework-schema.GetPropertyPaneConfigurationResponse.loadingIndicatorDelayTime + package: botframework-schema + summary: Loading indicator delay time. + fullName: loadingIndicatorDelayTime + remarks: '' + isDeprecated: false + syntax: + content: 'loadingIndicatorDelayTime: number' + return: + description: '' + type: number + - name: pages + uid: botframework-schema.GetPropertyPaneConfigurationResponse.pages + package: botframework-schema + summary: Property pane pages. + fullName: pages + remarks: '' + isDeprecated: false + syntax: + content: 'pages: PropertyPanePage[]' + return: + description: '' + type: [] + - name: showLoadingIndicator + uid: >- + botframework-schema.GetPropertyPaneConfigurationResponse.showLoadingIndicator + package: botframework-schema + summary: >- + Value indicating whether to show loading indicator on top of the property + pane. + fullName: showLoadingIndicator + remarks: '' + isDeprecated: false + syntax: + content: 'showLoadingIndicator: boolean' + return: + description: '' + type: boolean diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/HandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/HandleActionResponse.yml new file mode 100644 index 00000000..fcecb751 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/HandleActionResponse.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: HandleActionResponse +uid: botframework-schema.HandleActionResponse +package: botframework-schema +summary: The handle action response. +fullName: HandleActionResponse +remarks: '' +isDeprecated: false +syntax: | + type HandleActionResponse = + | CardViewHandleActionResponse + | QuickViewHandleActionResponse + | NoOpHandleActionResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/HeroCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/HeroCard.yml index 42a0ff56..66eb3b69 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/HeroCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/HeroCard.yml @@ -2,10 +2,9 @@ name: HeroCard uid: botframework-schema.HeroCard package: botframework-schema -summary: 'A Hero card (card with a single, large image)' +summary: A Hero card (card with a single, large image) fullName: HeroCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,33 +14,30 @@ properties: summary: Set of actions applicable to the current card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: images uid: botframework-schema.HeroCard.images package: botframework-schema summary: Array of images for the card fullName: images remarks: '' - isPreview: false isDeprecated: false syntax: content: 'images: CardImage[]' return: description: '' - type: '[]' + type: [] - name: subtitle uid: botframework-schema.HeroCard.subtitle package: botframework-schema summary: Subtitle of the card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -54,7 +50,6 @@ properties: summary: This action will be activated when user taps on the card itself fullName: tap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tap: CardAction' @@ -67,7 +62,6 @@ properties: summary: Text for the card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -80,7 +74,6 @@ properties: summary: Title of the card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IActivity.yml index 4817dd4a..4e9658a9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -28,7 +26,6 @@ properties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -41,7 +38,6 @@ properties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -54,20 +50,18 @@ properties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] - name: from uid: botframework-schema.IActivity.from package: botframework-schema summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -80,7 +74,6 @@ properties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -90,14 +83,14 @@ properties: - name: localTimestamp uid: botframework-schema.IActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -110,7 +103,6 @@ properties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -123,7 +115,6 @@ properties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -138,7 +129,6 @@ properties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -153,7 +143,6 @@ properties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -166,10 +155,9 @@ properties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardSearchBoxButton.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardSearchBoxButton.yml new file mode 100644 index 00000000..1dda7ea7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardSearchBoxButton.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: ICardSearchBoxButton +uid: botframework-schema.ICardSearchBoxButton +package: botframework-schema +summary: Search box button properties. +fullName: ICardSearchBoxButton +remarks: '' +isDeprecated: false +type: interface +inheritedProperties: + - name: action + uid: botframework-schema.ICardSearchBoxButton.action + package: botframework-schema + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botframework-schema.CardButtonBase.action) + - name: id + uid: botframework-schema.ICardSearchBoxButton.id + package: botframework-schema + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botframework-schema.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputIconButton.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputIconButton.yml new file mode 100644 index 00000000..2ccb1011 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputIconButton.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: ICardTextInputIconButton +uid: botframework-schema.ICardTextInputIconButton +package: botframework-schema +summary: Text input icon button. +fullName: ICardTextInputIconButton +remarks: '' +isDeprecated: false +type: interface +properties: + - name: icon + uid: botframework-schema.ICardTextInputIconButton.icon + package: botframework-schema + summary: Properties for the icon displayed on the button. + fullName: icon + remarks: '' + isDeprecated: false + syntax: + content: 'icon: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: action + uid: botframework-schema.ICardTextInputIconButton.action + package: botframework-schema + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botframework-schema.CardButtonBase.action) + - name: id + uid: botframework-schema.ICardTextInputIconButton.id + package: botframework-schema + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botframework-schema.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputTitleButton.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputTitleButton.yml new file mode 100644 index 00000000..f9e1dffe --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICardTextInputTitleButton.yml @@ -0,0 +1,54 @@ +### YamlMime:TSType +name: ICardTextInputTitleButton +uid: botframework-schema.ICardTextInputTitleButton +package: botframework-schema +summary: Text input title button. +fullName: ICardTextInputTitleButton +remarks: '' +isDeprecated: false +type: interface +properties: + - name: title + uid: botframework-schema.ICardTextInputTitleButton.title + package: botframework-schema + summary: Text displayed on the button. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string +inheritedProperties: + - name: action + uid: botframework-schema.ICardTextInputTitleButton.action + package: botframework-schema + summary: The type of the button. + fullName: action + remarks: '' + isDeprecated: false + syntax: + content: 'action: CardAction' + return: + description: '' + type: CardAction + inheritanceDescription: >- + Inherited From + [CardButtonBase.action](xref:botframework-schema.CardButtonBase.action) + - name: id + uid: botframework-schema.ICardTextInputTitleButton.id + package: botframework-schema + summary: Unique Id of the button. + fullName: id + remarks: '' + isDeprecated: false + syntax: + content: 'id?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [CardButtonBase.id](xref:botframework-schema.CardButtonBase.id) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandActivity.yml index ad649ee6..8a12972d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Asynchronous external command. fullName: ICommandActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The name of the event. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: The value for this command. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: CommandValue' @@ -42,7 +39,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -58,7 +54,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -74,7 +69,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -90,13 +84,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -106,7 +99,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -122,7 +114,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -135,14 +126,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.ICommandActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -158,7 +149,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -174,7 +164,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -192,7 +181,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -210,7 +198,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -226,13 +213,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandResultActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandResultActivity.yml index 7944e202..f9cd2168 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandResultActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ICommandResultActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Asynchronous external command result. fullName: ICommandResultActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: CommandResultValue' @@ -42,7 +39,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -58,7 +54,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -74,7 +69,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -90,13 +84,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -106,7 +99,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -122,7 +114,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -135,14 +126,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.ICommandResultActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -158,7 +149,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -174,7 +164,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -192,7 +181,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -210,7 +198,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -226,13 +213,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IContactRelationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IContactRelationUpdateActivity.yml index e9013fec..810f1d4f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IContactRelationUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IContactRelationUpdateActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IContactRelationUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: sender's contact list. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action?: string' @@ -33,7 +31,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -49,7 +46,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -65,7 +61,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -81,13 +76,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -97,7 +91,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -113,7 +106,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -126,14 +118,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IContactRelationUpdateActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -149,7 +141,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -165,7 +156,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -183,7 +173,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -201,7 +190,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -217,13 +205,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IConversationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IConversationUpdateActivity.yml index a70e91c6..72bf3865 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IConversationUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IConversationUpdateActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IConversationUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Indicates whether the prior history of the channel is disclosed. fullName: historyDisclosed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'historyDisclosed?: boolean' @@ -28,33 +26,30 @@ properties: summary: The collection of members added to the conversation. fullName: membersAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersAdded?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] - name: membersRemoved uid: botframework-schema.IConversationUpdateActivity.membersRemoved package: botframework-schema summary: The collection of members removed from the conversation. fullName: membersRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'membersRemoved?: ChannelAccount[]' return: description: '' - type: '[]' + type: [] - name: topicName uid: botframework-schema.IConversationUpdateActivity.topicName package: botframework-schema summary: The updated topic name of the conversation. fullName: topicName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'topicName?: string' @@ -68,7 +63,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -84,7 +78,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -100,7 +93,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -116,13 +108,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -132,7 +123,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -148,7 +138,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -161,14 +150,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IConversationUpdateActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -184,7 +173,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -200,7 +188,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -218,7 +205,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -236,7 +222,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -252,13 +237,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEndOfConversationActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEndOfConversationActivity.yml index d0824ac8..dc722879 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEndOfConversationActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEndOfConversationActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IEndOfConversationActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -22,20 +21,18 @@ properties: 'botIssuedInvalidMessage', 'channelFailed' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'code?: EndOfConversationCodes | string' + content: 'code?: string' return: description: '' - type: | string + type: string - name: text uid: botframework-schema.IEndOfConversationActivity.text package: botframework-schema summary: The text content of the message. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -49,7 +46,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -65,7 +61,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -81,7 +76,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -97,13 +91,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -113,7 +106,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -129,7 +121,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -142,14 +133,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IEndOfConversationActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -165,7 +156,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -181,7 +171,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -199,7 +188,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -217,7 +205,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -233,13 +220,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEventActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEventActivity.yml index 97fd1fa5..44afecf8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEventActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IEventActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IEventActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The name of the operation associated with an invoke or event activity. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -28,7 +26,6 @@ properties: summary: A reference to another conversation or activity. fullName: relatesTo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'relatesTo?: ConversationReference' @@ -41,7 +38,6 @@ properties: summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -55,7 +51,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -71,7 +66,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -87,7 +81,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -103,13 +96,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -119,7 +111,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -135,7 +126,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -148,14 +138,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IEventActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -171,7 +161,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -187,7 +176,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -205,7 +193,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -223,7 +210,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -239,13 +225,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IHandoffActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IHandoffActivity.yml index fa0ca3e2..a1e26ec9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IHandoffActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IHandoffActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IHandoffActivity remarks: '' -isPreview: false isDeprecated: false syntax: | type IHandoffActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInstallationUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInstallationUpdateActivity.yml index a3df131f..13b6523f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInstallationUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInstallationUpdateActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IInstallationUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: sender's contact list. fullName: action remarks: '' - isPreview: false isDeprecated: false syntax: content: 'action?: string' @@ -33,7 +31,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -49,7 +46,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -65,7 +61,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -81,13 +76,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -97,7 +91,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -113,7 +106,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -126,14 +118,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IInstallationUpdateActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -149,7 +141,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -165,7 +156,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -183,7 +173,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -201,7 +190,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -217,13 +205,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInvokeActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInvokeActivity.yml index 915bd0a4..ab04914e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInvokeActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IInvokeActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IInvokeActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The name of the operation associated with an invoke or event activity. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -28,7 +26,6 @@ properties: summary: A reference to another conversation or activity. fullName: relatesTo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'relatesTo?: ConversationReference' @@ -41,7 +38,6 @@ properties: summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -55,7 +51,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -71,7 +66,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -87,7 +81,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -103,13 +96,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -119,7 +111,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -135,7 +126,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -148,14 +138,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IInvokeActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -171,7 +161,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -187,7 +176,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -205,7 +193,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -223,7 +210,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -239,13 +225,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageActivity.yml index 1b67eee2..a16f6e56 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IMessageActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,26 +18,24 @@ properties: 'carousel' fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'attachmentLayout?: AttachmentLayoutTypes | string' + content: 'attachmentLayout?: string' return: description: '' - type: | string + type: string - name: attachments uid: botframework-schema.IMessageActivity.attachments package: botframework-schema summary: Attachments fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: Attachment[]' return: description: '' - type: '[]' + type: [] - name: deliveryMode uid: botframework-schema.IMessageActivity.deliveryMode package: botframework-schema @@ -50,13 +47,12 @@ properties: 'notification' fullName: deliveryMode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'deliveryMode?: DeliveryModes | string' + content: 'deliveryMode?: string' return: description: '' - type: | string + type: string - name: expiration uid: botframework-schema.IMessageActivity.expiration package: botframework-schema @@ -67,7 +63,6 @@ properties: presented to the recipient. fullName: expiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiration?: Date' @@ -82,13 +77,12 @@ properties: 'high' fullName: importance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'importance?: ActivityImportance | string' + content: 'importance?: string' return: description: '' - type: | string + type: string - name: inputHint uid: botframework-schema.IMessageActivity.inputHint package: botframework-schema @@ -101,13 +95,12 @@ properties: values include: 'acceptingInput', 'ignoringInput', 'expectingInput' fullName: inputHint remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inputHint?: InputHints | string' + content: 'inputHint?: string' return: description: '' - type: | string + type: string - name: locale uid: botframework-schema.IMessageActivity.locale package: botframework-schema @@ -125,7 +118,6 @@ properties: The locale name can also correspond to a valid BCP-47 language tag. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -138,7 +130,6 @@ properties: summary: The text to speak. fullName: speak remarks: '' - isPreview: false isDeprecated: false syntax: content: 'speak?: string' @@ -151,7 +142,6 @@ properties: summary: The suggested actions for the activity. fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: SuggestedActions' @@ -164,7 +154,6 @@ properties: summary: The text to display if the channel cannot render cards. fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' @@ -177,7 +166,6 @@ properties: summary: The text content of the message. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -192,20 +180,18 @@ properties: 'markdown', 'plain', 'xml' fullName: textFormat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'textFormat?: TextFormatTypes | string' + content: 'textFormat?: string' return: description: '' - type: | string + type: string - name: value uid: botframework-schema.IMessageActivity.value package: botframework-schema summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -219,7 +205,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -235,7 +220,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -251,7 +235,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -267,13 +250,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -283,7 +265,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -299,7 +280,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -312,14 +292,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IMessageActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -335,7 +315,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -351,7 +330,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -369,7 +347,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -387,7 +364,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -403,13 +379,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageDeleteActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageDeleteActivity.yml index 7d333074..20ddcc92 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageDeleteActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageDeleteActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IMessageDeleteActivity remarks: '' -isPreview: false isDeprecated: false syntax: | type IMessageDeleteActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageReactionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageReactionActivity.yml index 77ca1ff7..bd73e116 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageReactionActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageReactionActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IMessageReactionActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,26 +14,24 @@ properties: summary: The collection of reactions added to the conversation. fullName: reactionsAdded remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionsAdded?: MessageReaction[]' return: description: '' - type: '[]' + type: [] - name: reactionsRemoved uid: botframework-schema.IMessageReactionActivity.reactionsRemoved package: botframework-schema summary: The collection of reactions removed from the conversation. fullName: reactionsRemoved remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionsRemoved?: MessageReaction[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: channelData uid: botframework-schema.IMessageReactionActivity.channelData @@ -42,7 +39,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -58,7 +54,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -74,7 +69,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -90,13 +84,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -106,7 +99,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -122,7 +114,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -135,14 +126,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IMessageReactionActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -158,7 +149,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -174,7 +164,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -192,7 +181,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -210,7 +198,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -226,13 +213,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageUpdateActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageUpdateActivity.yml index 3b1d74d3..ff893595 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageUpdateActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IMessageUpdateActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IMessageUpdateActivity remarks: '' -isPreview: false isDeprecated: false type: interface inheritedProperties: @@ -19,13 +18,12 @@ inheritedProperties: 'carousel' fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'attachmentLayout?: AttachmentLayoutTypes | string' + content: 'attachmentLayout?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.attachmentLayout](xref:botframework-schema.IMessageActivity.attachmentLayout) @@ -35,13 +33,12 @@ inheritedProperties: summary: Attachments fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: Attachment[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IMessageActivity.attachments](xref:botframework-schema.IMessageActivity.attachments) @@ -51,7 +48,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -67,7 +63,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -83,7 +78,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -104,13 +98,12 @@ inheritedProperties: 'notification' fullName: deliveryMode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'deliveryMode?: DeliveryModes | string' + content: 'deliveryMode?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.deliveryMode](xref:botframework-schema.IMessageActivity.deliveryMode) @@ -120,13 +113,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -140,7 +132,6 @@ inheritedProperties: presented to the recipient. fullName: expiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiration?: Date' @@ -156,7 +147,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -172,7 +162,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -190,13 +179,12 @@ inheritedProperties: 'high' fullName: importance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'importance?: ActivityImportance | string' + content: 'importance?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.importance](xref:botframework-schema.IMessageActivity.importance) @@ -212,13 +200,12 @@ inheritedProperties: values include: 'acceptingInput', 'ignoringInput', 'expectingInput' fullName: inputHint remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inputHint?: InputHints | string' + content: 'inputHint?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.inputHint](xref:botframework-schema.IMessageActivity.inputHint) @@ -239,7 +226,6 @@ inheritedProperties: The locale name can also correspond to a valid BCP-47 language tag. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -252,14 +238,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.IMessageUpdateActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -275,7 +261,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -291,7 +276,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -309,7 +293,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -325,7 +308,6 @@ inheritedProperties: summary: The text to speak. fullName: speak remarks: '' - isPreview: false isDeprecated: false syntax: content: 'speak?: string' @@ -341,7 +323,6 @@ inheritedProperties: summary: The suggested actions for the activity. fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: SuggestedActions' @@ -357,7 +338,6 @@ inheritedProperties: summary: The text to display if the channel cannot render cards. fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' @@ -373,7 +353,6 @@ inheritedProperties: summary: The text content of the message. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -391,13 +370,12 @@ inheritedProperties: 'markdown', 'plain', 'xml' fullName: textFormat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'textFormat?: TextFormatTypes | string' + content: 'textFormat?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.textFormat](xref:botframework-schema.IMessageActivity.textFormat) @@ -409,7 +387,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -425,13 +402,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) @@ -441,7 +417,6 @@ inheritedProperties: summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -451,4 +426,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [IMessageActivity.value](xref:botframework-schema.IMessageActivity.value) -extends: +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IStatusCodeError.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IStatusCodeError.yml index b4ea1ef2..ded0b328 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/IStatusCodeError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/IStatusCodeError.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: IStatusCodeError remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode: StatusCodes' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ISuggestionActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ISuggestionActivity.yml index 914cbc2f..ba159b8e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ISuggestionActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ISuggestionActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: ISuggestionActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,13 +16,12 @@ properties: ReplyToId value. fullName: textHighlights remarks: '' - isPreview: false isDeprecated: false syntax: content: 'textHighlights?: TextHighlight[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: attachmentLayout uid: botframework-schema.ISuggestionActivity.attachmentLayout @@ -35,13 +33,12 @@ inheritedProperties: 'carousel' fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'attachmentLayout?: AttachmentLayoutTypes | string' + content: 'attachmentLayout?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.attachmentLayout](xref:botframework-schema.IMessageActivity.attachmentLayout) @@ -51,13 +48,12 @@ inheritedProperties: summary: Attachments fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: Attachment[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IMessageActivity.attachments](xref:botframework-schema.IMessageActivity.attachments) @@ -67,7 +63,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -83,7 +78,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -99,7 +93,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -120,13 +113,12 @@ inheritedProperties: 'notification' fullName: deliveryMode remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'deliveryMode?: DeliveryModes | string' + content: 'deliveryMode?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.deliveryMode](xref:botframework-schema.IMessageActivity.deliveryMode) @@ -136,13 +128,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -156,7 +147,6 @@ inheritedProperties: presented to the recipient. fullName: expiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiration?: Date' @@ -172,7 +162,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -188,7 +177,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -206,13 +194,12 @@ inheritedProperties: 'high' fullName: importance remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'importance?: ActivityImportance | string' + content: 'importance?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.importance](xref:botframework-schema.IMessageActivity.importance) @@ -228,13 +215,12 @@ inheritedProperties: values include: 'acceptingInput', 'ignoringInput', 'expectingInput' fullName: inputHint remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'inputHint?: InputHints | string' + content: 'inputHint?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.inputHint](xref:botframework-schema.IMessageActivity.inputHint) @@ -255,7 +241,6 @@ inheritedProperties: The locale name can also correspond to a valid BCP-47 language tag. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -268,14 +253,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.ISuggestionActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -291,7 +276,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -307,7 +291,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -325,7 +308,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -341,7 +323,6 @@ inheritedProperties: summary: The text to speak. fullName: speak remarks: '' - isPreview: false isDeprecated: false syntax: content: 'speak?: string' @@ -357,7 +338,6 @@ inheritedProperties: summary: The suggested actions for the activity. fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: SuggestedActions' @@ -373,7 +353,6 @@ inheritedProperties: summary: The text to display if the channel cannot render cards. fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' @@ -389,7 +368,6 @@ inheritedProperties: summary: The text content of the message. fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -407,13 +385,12 @@ inheritedProperties: 'markdown', 'plain', 'xml' fullName: textFormat remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'textFormat?: TextFormatTypes | string' + content: 'textFormat?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IMessageActivity.textFormat](xref:botframework-schema.IMessageActivity.textFormat) @@ -425,7 +402,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -441,13 +417,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) @@ -457,7 +432,6 @@ inheritedProperties: summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -467,4 +441,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [IMessageActivity.value](xref:botframework-schema.IMessageActivity.value) -extends: +extends: >- + , diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITraceActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITraceActivity.yml index 01af860e..55e2b0d4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITraceActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITraceActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: ITraceActivity remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: A descriptive label for the activity. fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label: string' @@ -28,7 +26,6 @@ properties: summary: The name of the operation associated with an invoke or event activity. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -41,7 +38,6 @@ properties: summary: A reference to another conversation or activity. fullName: relatesTo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'relatesTo?: ConversationReference' @@ -54,7 +50,6 @@ properties: summary: A value that is associated with the activity. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' @@ -67,7 +62,6 @@ properties: summary: The type of the activity's value object. fullName: valueType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'valueType: string' @@ -81,7 +75,6 @@ inheritedProperties: summary: Contains channel-specific content. fullName: channelData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelData?: any' @@ -97,7 +90,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the channel. Set by the channel. fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId: string' @@ -113,7 +105,6 @@ inheritedProperties: summary: Identifies the conversation to which the activity belongs. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -129,13 +120,12 @@ inheritedProperties: summary: Represents the entities that were mentioned in the message. fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'entities?: Entity[]' return: description: '' - type: '[]' + type: [] inheritanceDescription: >- Inherited From [IActivity.entities](xref:botframework-schema.IActivity.entities) @@ -145,7 +135,6 @@ inheritedProperties: summary: Identifies the sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from: ChannelAccount' @@ -161,7 +150,6 @@ inheritedProperties: summary: Contains an ID that uniquely identifies the activity on the channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -174,14 +162,14 @@ inheritedProperties: - name: localTimestamp uid: botframework-schema.ITraceActivity.localTimestamp package: botframework-schema - summary: > + summary: >- Contains the local date and time of the message, expressed in ISO-8601 format. + For example, 2016-09-23T13:07:49.4714686-07:00. fullName: localTimestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localTimestamp?: Date' @@ -197,7 +185,6 @@ inheritedProperties: summary: Identifies the recipient of the message. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: ChannelAccount' @@ -213,7 +200,6 @@ inheritedProperties: summary: Contains the ID of the message to which this message is a reply. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -231,7 +217,6 @@ inheritedProperties: channel. fullName: serviceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serviceUrl: string' @@ -249,7 +234,6 @@ inheritedProperties: ISO-8601 format. fullName: timestamp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'timestamp?: Date' @@ -265,13 +249,12 @@ inheritedProperties: summary: Contains the activity type 'iActivity' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: ActivityTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [IActivity.type](xref:botframework-schema.IActivity.type) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITypingActivity.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITypingActivity.yml index 075287cf..71619d11 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITypingActivity.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ITypingActivity.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: ITypingActivity remarks: '' -isPreview: false isDeprecated: false syntax: | type ITypingActivity = IActivity diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Importance.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Importance.yml index 9290f1a2..c401df17 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Importance.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Importance.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'normal', 'high', 'urgent' fullName: Importance remarks: '' -isPreview: false isDeprecated: false syntax: | type Importance = "normal" | "high" | "urgent" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InnerHttpError.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InnerHttpError.yml index 095dd213..4a7d50f7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InnerHttpError.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InnerHttpError.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Object representing inner http error fullName: InnerHttpError remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Body from failed request fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body: any' @@ -28,7 +26,6 @@ properties: summary: HttpStatusCode from failed request fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InputHints.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InputHints.yml index ca27c123..661ee87d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InputHints.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InputHints.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput' fullName: InputHints remarks: '' -isPreview: false isDeprecated: false fields: - name: AcceptingInput diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InstallationUpdateActionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InstallationUpdateActionTypes.yml index 10b5095c..5533ea4f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InstallationUpdateActionTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InstallationUpdateActionTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'add', 'remove' fullName: InstallationUpdateActionTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Add diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InvokeResponse.yml index 5779d3a5..cc2ee6a6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/InvokeResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/InvokeResponse.yml @@ -2,14 +2,14 @@ name: InvokeResponse uid: botframework-schema.InvokeResponse package: botframework-schema -summary: > +summary: >- Represents a response returned by a bot when it receives an `invoke` activity. + This interface supports the framework and is not intended to be called directly for your code. fullName: InvokeResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +19,6 @@ properties: summary: Optional. The body of the response. fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: T' @@ -32,7 +31,6 @@ properties: summary: The HTTP status code of the response. fullName: status remarks: '' - isPreview: false isDeprecated: false syntax: content: 'status: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Location.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Location.yml new file mode 100644 index 00000000..2d190b99 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Location.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: Location +uid: botframework-schema.Location +package: botframework-schema +summary: Interface for location coordinates +fullName: Location +remarks: '' +isDeprecated: false +type: interface +properties: + - name: accuracy + uid: botframework-schema.Location.accuracy + package: botframework-schema + summary: Accuracy of the location. + fullName: accuracy + remarks: '' + isDeprecated: false + syntax: + content: 'accuracy?: number' + return: + description: '' + type: number + - name: latitude + uid: botframework-schema.Location.latitude + package: botframework-schema + summary: Latitude of the location. + fullName: latitude + remarks: '' + isDeprecated: false + syntax: + content: 'latitude: number' + return: + description: '' + type: number + - name: longitude + uid: botframework-schema.Location.longitude + package: botframework-schema + summary: Longitude of the location. + fullName: longitude + remarks: '' + isDeprecated: false + syntax: + content: 'longitude: number' + return: + description: '' + type: number + - name: timestamp + uid: botframework-schema.Location.timestamp + package: botframework-schema + summary: Timestamp in ISO milliseconds since epoch. + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp?: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaCard.yml index 32a39e93..50ddfc40 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Media card fullName: MediaCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: "4:3" fullName: aspect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aspect: string' @@ -27,10 +25,9 @@ properties: - name: autoloop uid: botframework-schema.MediaCard.autoloop package: botframework-schema - summary: 'Should the client loop playback at end of content (default:true)' + summary: Should the client loop playback at end of content (default:true) fullName: autoloop remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autoloop: boolean' @@ -45,7 +42,6 @@ properties: (default:true) fullName: autostart remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autostart: boolean' @@ -58,13 +54,12 @@ properties: summary: Actions on this card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: duration uid: botframework-schema.MediaCard.duration package: botframework-schema @@ -75,7 +70,6 @@ properties: Formatted as an ISO 8601 Duration field. fullName: duration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'duration: string' @@ -88,7 +82,6 @@ properties: summary: Thumbnail placeholder fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image: ThumbnailUrl' @@ -105,20 +98,18 @@ properties: alternative format of the same content. fullName: media remarks: '' - isPreview: false isDeprecated: false syntax: content: 'media: MediaUrl[]' return: description: '' - type: '[]' + type: [] - name: shareable uid: botframework-schema.MediaCard.shareable package: botframework-schema - summary: 'This content may be shared with others (default:true)' + summary: This content may be shared with others (default:true) fullName: shareable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shareable: boolean' @@ -131,7 +122,6 @@ properties: summary: Subtitle of this card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -144,7 +134,6 @@ properties: summary: Text of this card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -157,7 +146,6 @@ properties: summary: Title of this card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -170,7 +158,6 @@ properties: summary: Supplementary parameter for this card fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaEventValue.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaEventValue.yml index 40ea203a..e6d9e241 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaEventValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaEventValue.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Supplementary parameter for media events fullName: MediaEventValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: originated this event fullName: cardValue remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cardValue: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaType.yml new file mode 100644 index 00000000..812d1eb7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaType.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: MediaType +uid: botframework-schema.MediaType +package: botframework-schema +summary: Enum value to specify the type of media for VivaAction.SelectMedia action. +fullName: MediaType +remarks: '' +isDeprecated: false +fields: + - name: Image + uid: botframework-schema.MediaType.Image + package: botframework-schema + summary: '' + numericValue: 1 + - name: Audio + uid: botframework-schema.MediaType.Audio + package: botframework-schema + summary: '' + numericValue: 4 + - name: Document + uid: botframework-schema.MediaType.Document + package: botframework-schema + summary: '' + numericValue: 8 diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaUrl.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaUrl.yml index 4f4af4d5..c6f21d64 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaUrl.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MediaUrl.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Media URL fullName: MediaUrl remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: objects from each other fullName: profile remarks: '' - isPreview: false isDeprecated: false syntax: content: 'profile?: string' @@ -30,7 +28,6 @@ properties: summary: Url for the media fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Meeting.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Meeting.yml index a2b4d368..ad6bced1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Meeting.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Meeting.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: Meeting remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: inMeeting uid: botframework-schema.Meeting.inMeeting package: botframework-schema - summary: '' + summary: Indicates if the participant is in the meeting. fullName: inMeeting remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inMeeting?: boolean' @@ -25,10 +23,9 @@ properties: - name: role uid: botframework-schema.Meeting.role package: botframework-schema - summary: '' + summary: Meeting role of the user. fullName: role remarks: '' - isPreview: false isDeprecated: false syntax: content: 'role?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetails.yml index a674096d..6ab30a32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetails.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetails.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MeetingDetails remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: msGraphResourceId uid: botframework-schema.MeetingDetails.msGraphResourceId package: botframework-schema - summary: '' + summary: The MsGraphResourceId, used specifically for MS Graph API calls. fullName: msGraphResourceId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'msGraphResourceId: string' @@ -25,10 +23,9 @@ properties: - name: scheduledEndTime uid: botframework-schema.MeetingDetails.scheduledEndTime package: botframework-schema - summary: '' + summary: The meeting's scheduled end time, in UTC. fullName: scheduledEndTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'scheduledEndTime?: Date' @@ -38,10 +35,9 @@ properties: - name: scheduledStartTime uid: botframework-schema.MeetingDetails.scheduledStartTime package: botframework-schema - summary: '' + summary: The meeting's scheduled start time, in UTC. fullName: scheduledStartTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'scheduledStartTime?: Date' @@ -51,10 +47,9 @@ properties: - name: type uid: botframework-schema.MeetingDetails.type package: botframework-schema - summary: '' + summary: The meeting's type. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -65,49 +60,40 @@ inheritedProperties: - name: id uid: botframework-schema.MeetingDetails.id package: botframework-schema - summary: '' + summary: The meeting's Id, encoded as a BASE64 string. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [MeetingDetailsBase.id](xref:botframework-schema.MeetingDetailsBase.id) + inheritanceDescription: Inherited From MeetingDetailsBase.id - name: joinUrl uid: botframework-schema.MeetingDetails.joinUrl package: botframework-schema - summary: '' + summary: The URL used to join the meeting. fullName: joinUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'joinUrl: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [MeetingDetailsBase.joinUrl](xref:botframework-schema.MeetingDetailsBase.joinUrl) + inheritanceDescription: Inherited From MeetingDetailsBase.joinUrl - name: title uid: botframework-schema.MeetingDetails.title package: botframework-schema - summary: '' + summary: The title of the meeting. fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [MeetingDetailsBase.title](xref:botframework-schema.MeetingDetailsBase.title) -extends: + inheritanceDescription: Inherited From MeetingDetailsBase.title +extends: MeetingDetailsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetailsBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetailsBase.yml deleted file mode 100644 index 62de4911..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingDetailsBase.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: MeetingDetailsBase -uid: botframework-schema.MeetingDetailsBase -package: botframework-schema -summary: '' -fullName: MeetingDetailsBase -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: id - uid: botframework-schema.MeetingDetailsBase.id - package: botframework-schema - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - - name: joinUrl - uid: botframework-schema.MeetingDetailsBase.joinUrl - package: botframework-schema - summary: '' - fullName: joinUrl - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'joinUrl: string' - return: - description: '' - type: string - - name: title - uid: botframework-schema.MeetingDetailsBase.title - package: botframework-schema - summary: '' - fullName: title - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'title: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEndEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEndEventDetails.yml index afdbfd33..a02cbd5a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEndEventDetails.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEndEventDetails.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MeetingEndEventDetails remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: endTime uid: botframework-schema.MeetingEndEventDetails.endTime package: botframework-schema - summary: '' + summary: Timestamp for meeting end, in UTC. fullName: endTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endTime: Date' @@ -26,10 +24,9 @@ inheritedProperties: - name: id uid: botframework-schema.MeetingEndEventDetails.id package: botframework-schema - summary: '' + summary: The meeting's Id, encoded as a BASE64 string. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -38,14 +35,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MeetingDetailsBase.id](xref:botframework-schema.MeetingDetailsBase.id) + [MeetingEventDetails.id](xref:botframework-schema.MeetingEventDetails.id) - name: joinUrl uid: botframework-schema.MeetingEndEventDetails.joinUrl package: botframework-schema - summary: '' + summary: The URL used to join the meeting. fullName: joinUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'joinUrl: string' @@ -54,14 +50,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MeetingDetailsBase.joinUrl](xref:botframework-schema.MeetingDetailsBase.joinUrl) + [MeetingEventDetails.joinUrl](xref:botframework-schema.MeetingEventDetails.joinUrl) - name: meetingType uid: botframework-schema.MeetingEndEventDetails.meetingType package: botframework-schema - summary: '' + summary: The meeting's type. fullName: meetingType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'meetingType: string' @@ -74,10 +69,9 @@ inheritedProperties: - name: title uid: botframework-schema.MeetingEndEventDetails.title package: botframework-schema - summary: '' + summary: The title of the meeting. fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -86,5 +80,5 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MeetingDetailsBase.title](xref:botframework-schema.MeetingDetailsBase.title) + [MeetingEventDetails.title](xref:botframework-schema.MeetingEventDetails.title) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEventDetails.yml index 3da3e0ab..7548c5e2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEventDetails.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingEventDetails.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MeetingEventDetails remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: meetingType uid: botframework-schema.MeetingEventDetails.meetingType package: botframework-schema - summary: '' + summary: The meeting's type. fullName: meetingType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'meetingType: string' @@ -26,49 +24,40 @@ inheritedProperties: - name: id uid: botframework-schema.MeetingEventDetails.id package: botframework-schema - summary: '' + summary: The meeting's Id, encoded as a BASE64 string. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [MeetingDetailsBase.id](xref:botframework-schema.MeetingDetailsBase.id) + inheritanceDescription: Inherited From MeetingDetailsBase.id - name: joinUrl uid: botframework-schema.MeetingEventDetails.joinUrl package: botframework-schema - summary: '' + summary: The URL used to join the meeting. fullName: joinUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'joinUrl: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [MeetingDetailsBase.joinUrl](xref:botframework-schema.MeetingDetailsBase.joinUrl) + inheritanceDescription: Inherited From MeetingDetailsBase.joinUrl - name: title uid: botframework-schema.MeetingEventDetails.title package: botframework-schema - summary: '' + summary: The title of the meeting. fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [MeetingDetailsBase.title](xref:botframework-schema.MeetingDetailsBase.title) -extends: + inheritanceDescription: Inherited From MeetingDetailsBase.title +extends: MeetingDetailsBase diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingInfo.yml index 72fe80a8..07807e58 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MeetingInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: conversation uid: botframework-schema.MeetingInfo.conversation package: botframework-schema - summary: '' + summary: The Conversation Account for the meeting. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation: ConversationAccount' @@ -25,10 +23,9 @@ properties: - name: details uid: botframework-schema.MeetingInfo.details package: botframework-schema - summary: '' + summary: The specific details of a Teams meeting. fullName: details remarks: '' - isPreview: false isDeprecated: false syntax: content: 'details: MeetingDetails' @@ -38,10 +35,9 @@ properties: - name: organizer uid: botframework-schema.MeetingInfo.organizer package: botframework-schema - summary: '' + summary: The organizer's user information. fullName: organizer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'organizer: TeamsChannelAccount' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotification.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotification.yml new file mode 100644 index 00000000..af472172 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotification.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MeetingNotification +uid: botframework-schema.MeetingNotification +package: botframework-schema +summary: '' +fullName: MeetingNotification +remarks: '' +isDeprecated: false +syntax: | + type MeetingNotification = TargetedMeetingNotification diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationBase.yml new file mode 100644 index 00000000..bb81d038 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationBase.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MeetingNotificationBase +uid: botframework-schema.MeetingNotificationBase +package: botframework-schema +summary: '' +fullName: MeetingNotificationBase +remarks: '' +isDeprecated: false +type: interface +properties: + - name: type + uid: botframework-schema.MeetingNotificationBase.type + package: botframework-schema + summary: The type of meeting notification. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: string' + return: + description: '' + type: string + - name: value + uid: botframework-schema.MeetingNotificationBase.value + package: botframework-schema + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: T' + return: + description: '' + type: T diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationChannelData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationChannelData.yml new file mode 100644 index 00000000..346045b6 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationChannelData.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MeetingNotificationChannelData +uid: botframework-schema.MeetingNotificationChannelData +package: botframework-schema +summary: '' +fullName: MeetingNotificationChannelData +remarks: '' +isDeprecated: false +type: interface +properties: + - name: onBehalfOf + uid: botframework-schema.MeetingNotificationChannelData.onBehalfOf + package: botframework-schema + summary: The user that the bot is sending the notification on behalfOf, if any. + fullName: onBehalfOf + remarks: '' + isDeprecated: false + syntax: + content: 'onBehalfOf?: OnBehalfOf[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationRecipientFailureInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationRecipientFailureInfo.yml new file mode 100644 index 00000000..1c5cd1cd --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationRecipientFailureInfo.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: MeetingNotificationRecipientFailureInfo +uid: botframework-schema.MeetingNotificationRecipientFailureInfo +package: botframework-schema +summary: '' +fullName: MeetingNotificationRecipientFailureInfo +remarks: '' +isDeprecated: false +type: interface +properties: + - name: errorCode + uid: botframework-schema.MeetingNotificationRecipientFailureInfo.errorCode + package: botframework-schema + summary: The error code. + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: failureReason + uid: botframework-schema.MeetingNotificationRecipientFailureInfo.failureReason + package: botframework-schema + summary: >- + The reason for which the meetings notification could not be sent to the + recipient. + fullName: failureReason + remarks: '' + isDeprecated: false + syntax: + content: 'failureReason: string' + return: + description: '' + type: string + - name: recipientMri + uid: botframework-schema.MeetingNotificationRecipientFailureInfo.recipientMri + package: botframework-schema + summary: The targeted recipient's MRI. + fullName: recipientMri + remarks: '' + isDeprecated: false + syntax: + content: 'recipientMri: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationResponse.yml new file mode 100644 index 00000000..8ff3ee06 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingNotificationResponse.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: MeetingNotificationResponse +uid: botframework-schema.MeetingNotificationResponse +package: botframework-schema +summary: '' +fullName: MeetingNotificationResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: recipientsFailureInfo + uid: botframework-schema.MeetingNotificationResponse.recipientsFailureInfo + package: botframework-schema + summary: >- + The list of recipients that failed to recieve the sent meetings + notification. + fullName: recipientsFailureInfo + remarks: '' + isDeprecated: false + syntax: + content: 'recipientsFailureInfo?: MeetingNotificationRecipientFailureInfo[]' + return: + description: '' + type: >- + [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingParticipantsEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingParticipantsEventDetails.yml new file mode 100644 index 00000000..8ec6f95c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingParticipantsEventDetails.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: MeetingParticipantsEventDetails +uid: botframework-schema.MeetingParticipantsEventDetails +package: botframework-schema +summary: '' +fullName: MeetingParticipantsEventDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: members + uid: botframework-schema.MeetingParticipantsEventDetails.members + package: botframework-schema + summary: The participants info. + fullName: members + remarks: '' + isDeprecated: false + syntax: + content: 'members: TeamsMeetingMember[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStageSurface.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStageSurface.yml new file mode 100644 index 00000000..8855950e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStageSurface.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: MeetingStageSurface +uid: botframework-schema.MeetingStageSurface +package: botframework-schema +summary: '' +fullName: MeetingStageSurface +remarks: '' +isDeprecated: false +type: interface +properties: + - name: content + uid: botframework-schema.MeetingStageSurface.content + package: botframework-schema + summary: The content to display in the meeting notification. + fullName: content + remarks: '' + isDeprecated: false + syntax: + content: 'content: T' + return: + description: '' + type: T + - name: contentType + uid: botframework-schema.MeetingStageSurface.contentType + package: botframework-schema + summary: The content type. + fullName: contentType + remarks: '' + isDeprecated: false + syntax: + content: 'contentType: "task"' + return: + description: '' + type: '"task"' + - name: surface + uid: botframework-schema.MeetingStageSurface.surface + package: botframework-schema + summary: The surface type. + fullName: surface + remarks: '' + isDeprecated: false + syntax: + content: 'surface: "meetingStage"' + return: + description: '' + type: '"meetingStage"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStartEventDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStartEventDetails.yml index 399f47e2..ce889db2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStartEventDetails.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingStartEventDetails.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MeetingStartEventDetails remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: startTime uid: botframework-schema.MeetingStartEventDetails.startTime package: botframework-schema - summary: '' + summary: Timestamp for meeting start, in UTC. fullName: startTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'startTime: Date' @@ -26,10 +24,9 @@ inheritedProperties: - name: id uid: botframework-schema.MeetingStartEventDetails.id package: botframework-schema - summary: '' + summary: The meeting's Id, encoded as a BASE64 string. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -38,14 +35,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MeetingDetailsBase.id](xref:botframework-schema.MeetingDetailsBase.id) + [MeetingEventDetails.id](xref:botframework-schema.MeetingEventDetails.id) - name: joinUrl uid: botframework-schema.MeetingStartEventDetails.joinUrl package: botframework-schema - summary: '' + summary: The URL used to join the meeting. fullName: joinUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'joinUrl: string' @@ -54,14 +50,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MeetingDetailsBase.joinUrl](xref:botframework-schema.MeetingDetailsBase.joinUrl) + [MeetingEventDetails.joinUrl](xref:botframework-schema.MeetingEventDetails.joinUrl) - name: meetingType uid: botframework-schema.MeetingStartEventDetails.meetingType package: botframework-schema - summary: '' + summary: The meeting's type. fullName: meetingType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'meetingType: string' @@ -74,10 +69,9 @@ inheritedProperties: - name: title uid: botframework-schema.MeetingStartEventDetails.title package: botframework-schema - summary: '' + summary: The title of the meeting. fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -86,5 +80,5 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [MeetingDetailsBase.title](xref:botframework-schema.MeetingDetailsBase.title) + [MeetingEventDetails.title](xref:botframework-schema.MeetingEventDetails.title) extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingSurface.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingSurface.yml new file mode 100644 index 00000000..65a1aeab --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingSurface.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MeetingSurface +uid: botframework-schema.MeetingSurface +package: botframework-schema +summary: '' +fullName: MeetingSurface +remarks: '' +isDeprecated: false +syntax: | + type MeetingSurface = MeetingStageSurface | MeetingTabIconSurface diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingTabIconSurface.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingTabIconSurface.yml new file mode 100644 index 00000000..71c69325 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MeetingTabIconSurface.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: MeetingTabIconSurface +uid: botframework-schema.MeetingTabIconSurface +package: botframework-schema +summary: '' +fullName: MeetingTabIconSurface +remarks: '' +isDeprecated: false +type: interface +properties: + - name: surface + uid: botframework-schema.MeetingTabIconSurface.surface + package: botframework-schema + summary: The surface type. + fullName: surface + remarks: '' + isDeprecated: false + syntax: + content: 'surface: "meetingTabIcon"' + return: + description: '' + type: '"meetingTabIcon"' + - name: tabEntityId + uid: botframework-schema.MeetingTabIconSurface.tabEntityId + package: botframework-schema + summary: The tab entity ID. + fullName: tabEntityId + remarks: '' + isDeprecated: false + syntax: + content: 'tabEntityId?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Mention.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Mention.yml index d0b53d9b..c528543a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Mention.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Mention.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: 'Mention information (entity type: "mention")' fullName: Mention remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The mentioned user fullName: mentioned remarks: '' - isPreview: false isDeprecated: false syntax: content: 'mentioned: ChannelAccount' @@ -28,7 +26,6 @@ properties: summary: Sub Text which represents the mention (can be null or empty) fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -41,7 +38,6 @@ properties: summary: Type of this entity (RFC 3987 IRI) fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayload.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayload.yml index ebe00b0e..74603b32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayload.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayload.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayload remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: attachmentLayout uid: botframework-schema.MessageActionsPayload.attachmentLayout package: botframework-schema - summary: '' + summary: How the attachment(s) are displayed in fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachmentLayout?: string' @@ -25,23 +23,21 @@ properties: - name: attachments uid: botframework-schema.MessageActionsPayload.attachments package: botframework-schema - summary: '' + summary: Attachments in fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: MessageActionsPayloadAttachment[]' return: description: '' - type: '[]' + type: [] - name: body uid: botframework-schema.MessageActionsPayload.body package: botframework-schema - summary: '' + summary: Plaintext/HTML representation fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: MessageActionsPayloadBody' @@ -51,10 +47,9 @@ properties: - name: createdDateTime uid: botframework-schema.MessageActionsPayload.createdDateTime package: botframework-schema - summary: '' + summary: Timestamp of when the message was fullName: createdDateTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'createdDateTime?: string' @@ -64,10 +59,9 @@ properties: - name: deleted uid: botframework-schema.MessageActionsPayload.deleted package: botframework-schema - summary: '' + summary: Indicates whether a message has been soft fullName: deleted remarks: '' - isPreview: false isDeprecated: false syntax: content: 'deleted?: boolean' @@ -77,10 +71,9 @@ properties: - name: from uid: botframework-schema.MessageActionsPayload.from package: botframework-schema - summary: '' + summary: Sender of the message. fullName: from remarks: '' - isPreview: false isDeprecated: false syntax: content: 'from?: MessageActionsPayloadFrom' @@ -90,10 +83,9 @@ properties: - name: id uid: botframework-schema.MessageActionsPayload.id package: botframework-schema - summary: '' + summary: Unique id of the message. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -103,10 +95,9 @@ properties: - name: importance uid: botframework-schema.MessageActionsPayload.importance package: botframework-schema - summary: '' + summary: The importance of the message. Possible fullName: importance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'importance?: Importance' @@ -116,10 +107,9 @@ properties: - name: lastModifiedDateTime uid: botframework-schema.MessageActionsPayload.lastModifiedDateTime package: botframework-schema - summary: '' + summary: Timestamp of when the message was fullName: lastModifiedDateTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'lastModifiedDateTime?: string' @@ -129,10 +119,9 @@ properties: - name: linkToMessage uid: botframework-schema.MessageActionsPayload.linkToMessage package: botframework-schema - summary: '' + summary: Link back to the message. fullName: linkToMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'linkToMessage?: string' @@ -142,10 +131,9 @@ properties: - name: locale uid: botframework-schema.MessageActionsPayload.locale package: botframework-schema - summary: '' + summary: Locale of the message set by the client. fullName: locale remarks: '' - isPreview: false isDeprecated: false syntax: content: 'locale?: string' @@ -155,49 +143,45 @@ properties: - name: mentions uid: botframework-schema.MessageActionsPayload.mentions package: botframework-schema - summary: '' + summary: List of entities fullName: mentions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'mentions?: MessageActionsPayloadMention[]' return: description: '' - type: '[]' + type: [] - name: messageType uid: botframework-schema.MessageActionsPayload.messageType package: botframework-schema - summary: '' + summary: Type of message - automatically set to fullName: messageType remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'messageType?: MessageType' + content: 'messageType?: "message"' return: description: '' - type: + type: '"message"' - name: reactions uid: botframework-schema.MessageActionsPayload.reactions package: botframework-schema - summary: '' + summary: Reactions for the fullName: reactions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactions?: MessageActionsPayloadReaction[]' return: description: '' - type: '[]' + type: [] - name: replyToId uid: botframework-schema.MessageActionsPayload.replyToId package: botframework-schema - summary: '' + summary: Id of the parent/root message of the thread. fullName: replyToId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'replyToId?: string' @@ -207,10 +191,9 @@ properties: - name: subject uid: botframework-schema.MessageActionsPayload.subject package: botframework-schema - summary: '' + summary: Subject line of the message. fullName: subject remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subject?: string' @@ -220,10 +203,9 @@ properties: - name: summary uid: botframework-schema.MessageActionsPayload.summary package: botframework-schema - summary: '' + summary: Summary text of the message that could be used fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadApp.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadApp.yml index 25e1afc5..9fa4f009 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadApp.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadApp.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadApp remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: applicationIdentityType uid: botframework-schema.MessageActionsPayloadApp.applicationIdentityType package: botframework-schema - summary: '' + summary: The type of fullName: applicationIdentityType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationIdentityType?: ApplicationIdentityType' @@ -25,10 +23,9 @@ properties: - name: displayName uid: botframework-schema.MessageActionsPayloadApp.displayName package: botframework-schema - summary: '' + summary: The plaintext display name of the fullName: displayName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayName?: string' @@ -38,10 +35,9 @@ properties: - name: id uid: botframework-schema.MessageActionsPayloadApp.id package: botframework-schema - summary: '' + summary: The id of the application. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadAttachment.yml index bdba7710..5a23c478 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadAttachment.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadAttachment.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadAttachment remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: content uid: botframework-schema.MessageActionsPayloadAttachment.content package: botframework-schema - summary: '' + summary: The content of the attachment, in case of a code fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content?: any' @@ -25,10 +23,9 @@ properties: - name: contentType uid: botframework-schema.MessageActionsPayloadAttachment.contentType package: botframework-schema - summary: '' + summary: The type of the attachment. fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType?: string' @@ -38,10 +35,9 @@ properties: - name: contentUrl uid: botframework-schema.MessageActionsPayloadAttachment.contentUrl package: botframework-schema - summary: '' + summary: The url of the attachment, in case of a fullName: contentUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentUrl?: string' @@ -51,10 +47,9 @@ properties: - name: id uid: botframework-schema.MessageActionsPayloadAttachment.id package: botframework-schema - summary: '' + summary: The id of the attachment. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -64,10 +59,9 @@ properties: - name: name uid: botframework-schema.MessageActionsPayloadAttachment.name package: botframework-schema - summary: '' + summary: The plaintext display name of the attachment. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -77,10 +71,9 @@ properties: - name: thumbnailUrl uid: botframework-schema.MessageActionsPayloadAttachment.thumbnailUrl package: botframework-schema - summary: '' + summary: The url of a thumbnail image that might be fullName: thumbnailUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'thumbnailUrl?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadBody.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadBody.yml index 25fbbeda..c6307485 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadBody.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadBody.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadBody remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: content uid: botframework-schema.MessageActionsPayloadBody.content package: botframework-schema - summary: '' + summary: The content of the body. fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content?: string' @@ -25,23 +23,21 @@ properties: - name: contentType uid: botframework-schema.MessageActionsPayloadBody.contentType package: botframework-schema - summary: '' + summary: Type of the content. Possible values fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType?: ContentType' return: description: '' - type: ContentType + type: - name: textContent uid: botframework-schema.MessageActionsPayloadBody.textContent package: botframework-schema - summary: '' + summary: The text content of the body after fullName: textContent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'textContent?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadConversation.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadConversation.yml index 02020ff3..ede9fbb4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadConversation.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadConversation.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadConversation remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -13,10 +12,9 @@ properties: uid: >- botframework-schema.MessageActionsPayloadConversation.conversationIdentityType package: botframework-schema - summary: '' + summary: The type of fullName: conversationIdentityType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversationIdentityType?: ConversationIdentityType' @@ -26,10 +24,9 @@ properties: - name: displayName uid: botframework-schema.MessageActionsPayloadConversation.displayName package: botframework-schema - summary: '' + summary: The plaintext display name of the team or fullName: displayName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayName?: string' @@ -39,10 +36,9 @@ properties: - name: id uid: botframework-schema.MessageActionsPayloadConversation.id package: botframework-schema - summary: '' + summary: The id of the team or channel. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadFrom.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadFrom.yml index 9bc88495..daec2f6a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadFrom.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadFrom.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadFrom remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: application uid: botframework-schema.MessageActionsPayloadFrom.application package: botframework-schema - summary: '' + summary: Represents details of the fullName: application remarks: '' - isPreview: false isDeprecated: false syntax: content: 'application?: MessageActionsPayloadApp' @@ -25,10 +23,9 @@ properties: - name: conversation uid: botframework-schema.MessageActionsPayloadFrom.conversation package: botframework-schema - summary: '' + summary: Represents fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation?: MessageActionsPayloadConversation' @@ -38,10 +35,9 @@ properties: - name: user uid: botframework-schema.MessageActionsPayloadFrom.user package: botframework-schema - summary: '' + summary: Represents details of the user. fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: MessageActionsPayloadUser' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadMention.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadMention.yml index a8ac3732..eb926ef2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadMention.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadMention.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadMention remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: id uid: botframework-schema.MessageActionsPayloadMention.id package: botframework-schema - summary: '' + summary: The id of the mentioned entity. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: number' @@ -25,10 +23,9 @@ properties: - name: mentioned uid: botframework-schema.MessageActionsPayloadMention.mentioned package: botframework-schema - summary: '' + summary: Provides more details on fullName: mentioned remarks: '' - isPreview: false isDeprecated: false syntax: content: 'mentioned?: MessageActionsPayloadFrom' @@ -38,10 +35,9 @@ properties: - name: mentionText uid: botframework-schema.MessageActionsPayloadMention.mentionText package: botframework-schema - summary: '' + summary: The plaintext display name of the mentioned fullName: mentionText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'mentionText?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadReaction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadReaction.yml index 1362f0e2..67427331 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadReaction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadReaction.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadReaction remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: createdDateTime uid: botframework-schema.MessageActionsPayloadReaction.createdDateTime package: botframework-schema - summary: '' + summary: Timestamp of when the user reacted to fullName: createdDateTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'createdDateTime?: string' @@ -25,10 +23,9 @@ properties: - name: reactionType uid: botframework-schema.MessageActionsPayloadReaction.reactionType package: botframework-schema - summary: '' + summary: The type of reaction given to the fullName: reactionType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'reactionType?: ReactionType' @@ -38,10 +35,9 @@ properties: - name: user uid: botframework-schema.MessageActionsPayloadReaction.user package: botframework-schema - summary: '' + summary: The user with which the fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: MessageActionsPayloadFrom' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadUser.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadUser.yml index 7757798d..8194e432 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadUser.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageActionsPayloadUser.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessageActionsPayloadUser remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: displayName uid: botframework-schema.MessageActionsPayloadUser.displayName package: botframework-schema - summary: '' + summary: The plaintext display name of the user. fullName: displayName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayName?: string' @@ -25,10 +23,9 @@ properties: - name: id uid: botframework-schema.MessageActionsPayloadUser.id package: botframework-schema - summary: '' + summary: The id of the user. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -38,10 +35,9 @@ properties: - name: userIdentityType uid: botframework-schema.MessageActionsPayloadUser.userIdentityType package: botframework-schema - summary: '' + summary: The identity type of the fullName: userIdentityType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userIdentityType?: UserIdentityType' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReaction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReaction.yml index 0d35b068..d547b7bc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReaction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReaction.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Message reaction object fullName: MessageReaction remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: 'Message reaction type. Possible values include: ''like'', ''plusOne''' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type: MessageReactionTypes | string' + content: 'type: string' return: description: '' - type: | string + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReactionTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReactionTypes.yml index 0dc03c55..7792654a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReactionTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageReactionTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'like', 'plusOne' fullName: MessageReactionTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Like diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageType.yml index 34054a12..90cc82f8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessageType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'message' fullName: MessageType remarks: '' -isPreview: false isDeprecated: false syntax: | type MessageType = "message" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAction.yml index eba48727..57d1325b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAction.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: MessagingExtensionAction remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: '' fullName: botActivityPreview remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botActivityPreview?: Activity[]' return: description: '' - type: '[]' + type: [] - name: botMessagePreviewAction uid: botframework-schema.MessagingExtensionAction.botMessagePreviewAction package: botframework-schema - summary: '' + summary: Bot message fullName: botMessagePreviewAction remarks: '' - isPreview: false isDeprecated: false syntax: content: 'botMessagePreviewAction?: BotMessagePreviewActionType' @@ -38,10 +35,9 @@ properties: - name: commandContext uid: botframework-schema.MessagingExtensionAction.commandContext package: botframework-schema - summary: '' + summary: The context from which the fullName: commandContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'commandContext?: CommandContext' @@ -51,10 +47,9 @@ properties: - name: commandId uid: botframework-schema.MessagingExtensionAction.commandId package: botframework-schema - summary: '' + summary: Id of the command assigned by Bot fullName: commandId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'commandId?: string' @@ -64,10 +59,9 @@ properties: - name: messagePayload uid: botframework-schema.MessagingExtensionAction.messagePayload package: botframework-schema - summary: '' + summary: Message content sent as fullName: messagePayload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'messagePayload?: MessageActionsPayload' @@ -78,10 +72,9 @@ inheritedProperties: - name: context uid: botframework-schema.MessagingExtensionAction.context package: botframework-schema - summary: '' + summary: Current user context, i.e., fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: TaskModuleRequestContext' @@ -94,10 +87,9 @@ inheritedProperties: - name: data uid: botframework-schema.MessagingExtensionAction.data package: botframework-schema - summary: '' + summary: User input data. Free payload with key-value pairs. fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data?: any' @@ -110,10 +102,9 @@ inheritedProperties: - name: tabContext uid: botframework-schema.MessagingExtensionAction.tabContext package: botframework-schema - summary: '' + summary: Tab request context. fullName: tabContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tabContext?: TabEntityContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionActionResponse.yml index 23310d63..8ecbbb73 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionActionResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionActionResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessagingExtensionActionResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: cacheInfo uid: botframework-schema.MessagingExtensionActionResponse.cacheInfo package: botframework-schema - summary: '' + summary: The cache info for this response fullName: cacheInfo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cacheInfo?: CacheInfo' @@ -28,7 +26,6 @@ properties: summary: '' fullName: composeExtension remarks: '' - isPreview: false isDeprecated: false syntax: content: 'composeExtension?: MessagingExtensionResult' @@ -38,10 +35,9 @@ properties: - name: task uid: botframework-schema.MessagingExtensionActionResponse.task package: botframework-schema - summary: '' + summary: The JSON for the response to fullName: task remarks: '' - isPreview: false isDeprecated: false syntax: content: 'task?: TaskModuleContinueResponse | TaskModuleMessageResponse' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAttachment.yml index 5de0c15d..07e699dd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAttachment.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionAttachment.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: MessagingExtensionAttachment remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: preview remarks: '' - isPreview: false isDeprecated: false syntax: content: 'preview?: Attachment' @@ -29,7 +27,6 @@ inheritedProperties: summary: Embedded content fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content?: any' @@ -45,7 +42,6 @@ inheritedProperties: summary: mimetype/Contenttype for the file fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType: string' @@ -61,7 +57,6 @@ inheritedProperties: summary: Content Url fullName: contentUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentUrl?: string' @@ -77,7 +72,6 @@ inheritedProperties: summary: (OPTIONAL) The name of the attachment fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -93,7 +87,6 @@ inheritedProperties: summary: (OPTIONAL) Thumbnail associated with attachment fullName: thumbnailUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'thumbnailUrl?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionParameter.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionParameter.yml index ed22d560..bfa8be68 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionParameter.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionParameter.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessagingExtensionParameter remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: name uid: botframework-schema.MessagingExtensionParameter.name package: botframework-schema - summary: '' + summary: Name of the parameter fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -25,10 +23,9 @@ properties: - name: value uid: botframework-schema.MessagingExtensionParameter.value package: botframework-schema - summary: '' + summary: Value of the parameter fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQuery.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQuery.yml index 50f57c82..cfb391d1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQuery.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQuery.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessagingExtensionQuery remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: commandId uid: botframework-schema.MessagingExtensionQuery.commandId package: botframework-schema - summary: '' + summary: Id of the command assigned by Bot fullName: commandId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'commandId?: string' @@ -25,23 +23,21 @@ properties: - name: parameters uid: botframework-schema.MessagingExtensionQuery.parameters package: botframework-schema - summary: '' + summary: Parameters for the fullName: parameters remarks: '' - isPreview: false isDeprecated: false syntax: content: 'parameters?: MessagingExtensionParameter[]' return: description: '' - type: '[]' + type: [] - name: queryOptions uid: botframework-schema.MessagingExtensionQuery.queryOptions package: botframework-schema summary: '' fullName: queryOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'queryOptions?: MessagingExtensionQueryOptions' @@ -51,10 +47,9 @@ properties: - name: state uid: botframework-schema.MessagingExtensionQuery.state package: botframework-schema - summary: '' + summary: State parameter passed back to the bot after fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQueryOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQueryOptions.yml index 56adf021..854e09fc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQueryOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionQueryOptions.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessagingExtensionQueryOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: count uid: botframework-schema.MessagingExtensionQueryOptions.count package: botframework-schema - summary: '' + summary: Number of entities to fetch fullName: count remarks: '' - isPreview: false isDeprecated: false syntax: content: 'count?: number' @@ -25,10 +23,9 @@ properties: - name: skip uid: botframework-schema.MessagingExtensionQueryOptions.skip package: botframework-schema - summary: '' + summary: Number of entities to skip fullName: skip remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skip?: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResponse.yml index add1890a..e2feba33 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessagingExtensionResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: cacheInfo uid: botframework-schema.MessagingExtensionResponse.cacheInfo package: botframework-schema - summary: '' + summary: The cache info for this response fullName: cacheInfo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cacheInfo?: CacheInfo' @@ -28,7 +26,6 @@ properties: summary: '' fullName: composeExtension remarks: '' - isPreview: false isDeprecated: false syntax: content: 'composeExtension?: MessagingExtensionResult' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResult.yml index b4862e97..ae3ad6b6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResult.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: MessagingExtensionResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: activityPreview uid: botframework-schema.MessagingExtensionResult.activityPreview package: botframework-schema - summary: '' + summary: (Only when type is botMessagePreview) fullName: activityPreview remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityPreview?: Activity' @@ -25,10 +23,9 @@ properties: - name: attachmentLayout uid: botframework-schema.MessagingExtensionResult.attachmentLayout package: botframework-schema - summary: '' + summary: Hint for how to deal with fullName: attachmentLayout remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachmentLayout?: AttachmentLayout' @@ -38,23 +35,21 @@ properties: - name: attachments uid: botframework-schema.MessagingExtensionResult.attachments package: botframework-schema - summary: '' + summary: (Only when type is fullName: attachments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'attachments?: MessagingExtensionAttachment[]' return: description: '' - type: '[]' + type: [] - name: suggestedActions uid: botframework-schema.MessagingExtensionResult.suggestedActions package: botframework-schema summary: '' fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: MessagingExtensionSuggestedAction' @@ -64,10 +59,9 @@ properties: - name: text uid: botframework-schema.MessagingExtensionResult.text package: botframework-schema - summary: '' + summary: (Only when type is message) Text fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -77,10 +71,9 @@ properties: - name: type uid: botframework-schema.MessagingExtensionResult.type package: botframework-schema - summary: '' + summary: 'The type of the result. Possible values include:' fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: MessagingExtensionResultType' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResultType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResultType.yml index 84e167ff..a8d0c7ca 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResultType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionResultType.yml @@ -9,7 +9,6 @@ summary: >- 'botMessagePreview', 'silentAuth'. fullName: MessagingExtensionResultType remarks: '' -isPreview: false isDeprecated: false syntax: | type MessagingExtensionResultType = diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionSuggestedAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionSuggestedAction.yml index a98ddb6f..63557c40 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionSuggestedAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MessagingExtensionSuggestedAction.yml @@ -5,20 +5,18 @@ package: botframework-schema summary: '' fullName: MessagingExtensionSuggestedAction remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: actions uid: botframework-schema.MessagingExtensionSuggestedAction.actions package: botframework-schema - summary: '' + summary: Actions fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actions?: CardAction[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MicrosoftPayMethodData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MicrosoftPayMethodData.yml index b68287cc..c759ecaa 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/MicrosoftPayMethodData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/MicrosoftPayMethodData.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: W3C Payment Method Data for Microsoft Pay fullName: MicrosoftPayMethodData remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Microsoft Pay Merchant ID fullName: merchantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'merchantId: string' @@ -26,26 +24,24 @@ properties: - name: supportedNetworks uid: botframework-schema.MicrosoftPayMethodData.supportedNetworks package: botframework-schema - summary: 'Supported payment networks (e.g., "visa" and "mastercard")' + summary: Supported payment networks (e.g., "visa" and "mastercard") fullName: supportedNetworks remarks: '' - isPreview: false isDeprecated: false syntax: content: 'supportedNetworks: string[]' return: description: '' - type: 'string[]' + type: string[] - name: supportedTypes uid: botframework-schema.MicrosoftPayMethodData.supportedTypes package: botframework-schema - summary: 'Supported payment types (e.g., "credit")' + summary: Supported payment types (e.g., "credit") fullName: supportedTypes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'supportedTypes: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/NoOpHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/NoOpHandleActionResponse.yml new file mode 100644 index 00000000..d84b4b73 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/NoOpHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: NoOpHandleActionResponse +uid: botframework-schema.NoOpHandleActionResponse +package: botframework-schema +summary: The handle action response for no op. +fullName: NoOpHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botframework-schema.NoOpHandleActionResponse.renderArguments + package: botframework-schema + summary: No op doesn't have render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments?: undefined' + return: + description: '' + type: undefined + - name: responseType + uid: botframework-schema.NoOpHandleActionResponse.responseType + package: botframework-schema + summary: No op. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "NoOp"' + return: + description: '' + type: '"NoOp"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/NotificationInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/NotificationInfo.yml index 56ca1f21..396f374f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/NotificationInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/NotificationInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: NotificationInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: alert uid: botframework-schema.NotificationInfo.alert package: botframework-schema - summary: '' + summary: true if notification is to be sent to the user, fullName: alert remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alert?: boolean' @@ -25,10 +23,9 @@ properties: - name: alertInMeeting uid: botframework-schema.NotificationInfo.alertInMeeting package: botframework-schema - summary: '' + summary: true if a notification is to be shown to the user while in a meeting, fullName: alertInMeeting remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alertInMeeting?: boolean' @@ -38,10 +35,9 @@ properties: - name: externalResourceUrl uid: botframework-schema.NotificationInfo.externalResourceUrl package: botframework-schema - summary: '' + summary: the value of the notification's external resource url fullName: externalResourceUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'externalResourceUrl?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCard.yml index 6c19f4fd..2f7d44f5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCard.yml @@ -5,43 +5,39 @@ package: botframework-schema summary: '' fullName: O365ConnectorCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: potentialAction uid: botframework-schema.O365ConnectorCard.potentialAction package: botframework-schema - summary: '' + summary: Set of actions fullName: potentialAction remarks: '' - isPreview: false isDeprecated: false syntax: content: 'potentialAction?: O365ConnectorCardActionBase[]' return: description: '' - type: '[]' + type: [] - name: sections uid: botframework-schema.O365ConnectorCard.sections package: botframework-schema - summary: '' + summary: Set of sections for the fullName: sections remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sections?: O365ConnectorCardSection[]' return: description: '' - type: '[]' + type: [] - name: summary uid: botframework-schema.O365ConnectorCard.summary package: botframework-schema - summary: '' + summary: Summary for the card fullName: summary remarks: '' - isPreview: false isDeprecated: false syntax: content: 'summary?: string' @@ -51,10 +47,9 @@ properties: - name: text uid: botframework-schema.O365ConnectorCard.text package: botframework-schema - summary: '' + summary: Text for the card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -64,10 +59,9 @@ properties: - name: themeColor uid: botframework-schema.O365ConnectorCard.themeColor package: botframework-schema - summary: '' + summary: Theme color for the card fullName: themeColor remarks: '' - isPreview: false isDeprecated: false syntax: content: 'themeColor?: string' @@ -77,10 +71,9 @@ properties: - name: title uid: botframework-schema.O365ConnectorCard.title package: botframework-schema - summary: '' + summary: Title of the item fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionBase.yml index 409f0b42..6e4642a6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionBase.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardActionBase remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: '@id' uid: botframework-schema.O365ConnectorCardActionBase.@id package: botframework-schema - summary: '' + summary: Action Id fullName: '@id' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@id?: string' @@ -25,10 +23,9 @@ properties: - name: '@type' uid: botframework-schema.O365ConnectorCardActionBase.@type package: botframework-schema - summary: '' + summary: 'Type of the action. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardActionType' @@ -38,10 +35,9 @@ properties: - name: name uid: botframework-schema.O365ConnectorCardActionBase.name package: botframework-schema - summary: '' + summary: Name of the action that will be used as button fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionCard.yml index a56af528..edb6383a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionCard.yml @@ -5,44 +5,40 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardActionCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: actions uid: botframework-schema.O365ConnectorCardActionCard.actions package: botframework-schema - summary: '' + summary: Set of actions contained fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actions?: O365ConnectorCardActionBase[]' return: description: '' - type: '[]' + type: [] - name: inputs uid: botframework-schema.O365ConnectorCardActionCard.inputs package: botframework-schema - summary: '' + summary: Set of inputs contained in fullName: inputs remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inputs?: O365ConnectorCardInputBase[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: '@id' uid: botframework-schema.O365ConnectorCardActionCard.@id package: botframework-schema - summary: '' + summary: Action Id fullName: '@id' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@id?: string' @@ -51,14 +47,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@id'](xref:O365ConnectorCardActionBase.'@id') + [O365ConnectorCardActionBase.@id](xref:botframework-schema.O365ConnectorCardActionBase.@id) - name: '@type' uid: botframework-schema.O365ConnectorCardActionCard.@type package: botframework-schema - summary: '' + summary: 'Type of the action. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardActionType' @@ -67,14 +62,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@type'](xref:O365ConnectorCardActionBase.'@type') + [O365ConnectorCardActionBase.@type](xref:botframework-schema.O365ConnectorCardActionBase.@type) - name: name uid: botframework-schema.O365ConnectorCardActionCard.name package: botframework-schema - summary: '' + summary: Name of the action that will be used as button fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionQuery.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionQuery.yml index 881f1202..737ed398 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionQuery.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionQuery.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardActionQuery remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: actionId uid: botframework-schema.O365ConnectorCardActionQuery.actionId package: botframework-schema - summary: '' + summary: Action Id associated with the HttpPOST action fullName: actionId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actionId?: string' @@ -25,10 +23,9 @@ properties: - name: body uid: botframework-schema.O365ConnectorCardActionQuery.body package: botframework-schema - summary: '' + summary: The results of body string defined in fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionType.yml index 2a3d37de..ddd93e3b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardActionType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' fullName: O365ConnectorCardActionType remarks: '' -isPreview: false isDeprecated: false syntax: | type O365ConnectorCardActionType = diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardDateInput.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardDateInput.yml index 51664b72..89ad5cf5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardDateInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardDateInput.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardDateInput remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: includeTime uid: botframework-schema.O365ConnectorCardDateInput.includeTime package: botframework-schema - summary: '' + summary: Include time input field. Default value fullName: includeTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'includeTime?: boolean' @@ -26,10 +24,9 @@ inheritedProperties: - name: '@type' uid: botframework-schema.O365ConnectorCardDateInput.@type package: botframework-schema - summary: '' + summary: 'Input type name. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardInputType' @@ -38,14 +35,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardInputBase.'@type'](xref:O365ConnectorCardInputBase.'@type') + [O365ConnectorCardInputBase.@type](xref:botframework-schema.O365ConnectorCardInputBase.@type) - name: id uid: botframework-schema.O365ConnectorCardDateInput.id package: botframework-schema - summary: '' + summary: Input Id. It must be unique per entire O365 fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -58,10 +54,9 @@ inheritedProperties: - name: isRequired uid: botframework-schema.O365ConnectorCardDateInput.isRequired package: botframework-schema - summary: '' + summary: Define if this input is a required field. fullName: isRequired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isRequired?: boolean' @@ -74,10 +69,9 @@ inheritedProperties: - name: title uid: botframework-schema.O365ConnectorCardDateInput.title package: botframework-schema - summary: '' + summary: Input title that will be shown as the placeholder fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' @@ -90,10 +84,9 @@ inheritedProperties: - name: value uid: botframework-schema.O365ConnectorCardDateInput.value package: botframework-schema - summary: '' + summary: Default value for this input field fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardFact.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardFact.yml index b95cfd4b..4c38d3ea 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardFact.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardFact.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardFact remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: name uid: botframework-schema.O365ConnectorCardFact.name package: botframework-schema - summary: '' + summary: Display name of the fact fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -25,10 +23,9 @@ properties: - name: value uid: botframework-schema.O365ConnectorCardFact.value package: botframework-schema - summary: '' + summary: Display value for the fact fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardHttpPOST.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardHttpPOST.yml index 214614b5..1bd6f28d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardHttpPOST.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardHttpPOST.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardHttpPOST remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: body uid: botframework-schema.O365ConnectorCardHttpPOST.body package: botframework-schema - summary: '' + summary: Content to be posted back to bots via invoke fullName: body remarks: '' - isPreview: false isDeprecated: false syntax: content: 'body?: string' @@ -26,10 +24,9 @@ inheritedProperties: - name: '@id' uid: botframework-schema.O365ConnectorCardHttpPOST.@id package: botframework-schema - summary: '' + summary: Action Id fullName: '@id' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@id?: string' @@ -38,14 +35,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@id'](xref:O365ConnectorCardActionBase.'@id') + [O365ConnectorCardActionBase.@id](xref:botframework-schema.O365ConnectorCardActionBase.@id) - name: '@type' uid: botframework-schema.O365ConnectorCardHttpPOST.@type package: botframework-schema - summary: '' + summary: 'Type of the action. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardActionType' @@ -54,14 +50,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@type'](xref:O365ConnectorCardActionBase.'@type') + [O365ConnectorCardActionBase.@type](xref:botframework-schema.O365ConnectorCardActionBase.@type) - name: name uid: botframework-schema.O365ConnectorCardHttpPOST.name package: botframework-schema - summary: '' + summary: Name of the action that will be used as button fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardImage.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardImage.yml index 340a68cd..7e1ef23f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardImage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardImage.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardImage remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: image uid: botframework-schema.O365ConnectorCardImage.image package: botframework-schema - summary: '' + summary: URL for the image fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image?: string' @@ -25,10 +23,9 @@ properties: - name: title uid: botframework-schema.O365ConnectorCardImage.title package: botframework-schema - summary: '' + summary: Alternative text for the image fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBase.yml index 84d64239..bc8efdeb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBase.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardInputBase remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: '@type' uid: botframework-schema.O365ConnectorCardInputBase.@type package: botframework-schema - summary: '' + summary: 'Input type name. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardInputType' @@ -25,10 +23,9 @@ properties: - name: id uid: botframework-schema.O365ConnectorCardInputBase.id package: botframework-schema - summary: '' + summary: Input Id. It must be unique per entire O365 fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -38,10 +35,9 @@ properties: - name: isRequired uid: botframework-schema.O365ConnectorCardInputBase.isRequired package: botframework-schema - summary: '' + summary: Define if this input is a required field. fullName: isRequired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isRequired?: boolean' @@ -51,10 +47,9 @@ properties: - name: title uid: botframework-schema.O365ConnectorCardInputBase.title package: botframework-schema - summary: '' + summary: Input title that will be shown as the placeholder fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' @@ -64,10 +59,9 @@ properties: - name: value uid: botframework-schema.O365ConnectorCardInputBase.value package: botframework-schema - summary: '' + summary: Default value for this input field fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBaseType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBaseType.yml index 1d977481..2d692ebc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBaseType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputBaseType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'textInput', 'dateInput', 'multichoiceInput' fullName: O365ConnectorCardInputBaseType remarks: '' -isPreview: false isDeprecated: false syntax: | type O365ConnectorCardInputBaseType = diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputType.yml index 1787a1ba..30fed232 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardInputType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'textInput', 'dateInput', 'multichoiceInput' fullName: O365ConnectorCardInputType remarks: '' -isPreview: false isDeprecated: false syntax: > type O365ConnectorCardInputType = "textInput" | "dateInput" | diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInput.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInput.yml index 176eb9ea..0d331344 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInput.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardMultichoiceInput remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: choices uid: botframework-schema.O365ConnectorCardMultichoiceInput.choices package: botframework-schema - summary: '' + summary: Set of fullName: choices remarks: '' - isPreview: false isDeprecated: false syntax: content: 'choices?: O365ConnectorCardMultichoiceInputChoice[]' @@ -27,10 +25,9 @@ properties: - name: isMultiSelect uid: botframework-schema.O365ConnectorCardMultichoiceInput.isMultiSelect package: botframework-schema - summary: '' + summary: Define if this input field allows fullName: isMultiSelect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isMultiSelect?: boolean' @@ -40,10 +37,9 @@ properties: - name: style uid: botframework-schema.O365ConnectorCardMultichoiceInput.style package: botframework-schema - summary: '' + summary: Choice item rendering style. Default valud is fullName: style remarks: '' - isPreview: false isDeprecated: false syntax: content: 'style?: Style' @@ -54,10 +50,9 @@ inheritedProperties: - name: '@type' uid: botframework-schema.O365ConnectorCardMultichoiceInput.@type package: botframework-schema - summary: '' + summary: 'Input type name. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardInputType' @@ -66,14 +61,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardInputBase.'@type'](xref:O365ConnectorCardInputBase.'@type') + [O365ConnectorCardInputBase.@type](xref:botframework-schema.O365ConnectorCardInputBase.@type) - name: id uid: botframework-schema.O365ConnectorCardMultichoiceInput.id package: botframework-schema - summary: '' + summary: Input Id. It must be unique per entire O365 fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -86,10 +80,9 @@ inheritedProperties: - name: isRequired uid: botframework-schema.O365ConnectorCardMultichoiceInput.isRequired package: botframework-schema - summary: '' + summary: Define if this input is a required field. fullName: isRequired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isRequired?: boolean' @@ -102,10 +95,9 @@ inheritedProperties: - name: title uid: botframework-schema.O365ConnectorCardMultichoiceInput.title package: botframework-schema - summary: '' + summary: Input title that will be shown as the placeholder fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' @@ -118,10 +110,9 @@ inheritedProperties: - name: value uid: botframework-schema.O365ConnectorCardMultichoiceInput.value package: botframework-schema - summary: '' + summary: Default value for this input field fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInputChoice.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInputChoice.yml index 5e8b7837..d2b721d2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInputChoice.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardMultichoiceInputChoice.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardMultichoiceInputChoice remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: display uid: botframework-schema.O365ConnectorCardMultichoiceInputChoice.display package: botframework-schema - summary: '' + summary: The text rednered on ActionCard. fullName: display remarks: '' - isPreview: false isDeprecated: false syntax: content: 'display?: string' @@ -25,10 +23,9 @@ properties: - name: value uid: botframework-schema.O365ConnectorCardMultichoiceInputChoice.value package: botframework-schema - summary: '' + summary: The value received as results. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUri.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUri.yml index 2a1d8ec2..394a6d90 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUri.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUri.yml @@ -5,31 +5,28 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardOpenUri remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: targets uid: botframework-schema.O365ConnectorCardOpenUri.targets package: botframework-schema - summary: '' + summary: Target os / urls fullName: targets remarks: '' - isPreview: false isDeprecated: false syntax: content: 'targets?: O365ConnectorCardOpenUriTarget[]' return: description: '' - type: '[]' + type: [] inheritedProperties: - name: '@id' uid: botframework-schema.O365ConnectorCardOpenUri.@id package: botframework-schema - summary: '' + summary: Action Id fullName: '@id' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@id?: string' @@ -38,14 +35,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@id'](xref:O365ConnectorCardActionBase.'@id') + [O365ConnectorCardActionBase.@id](xref:botframework-schema.O365ConnectorCardActionBase.@id) - name: '@type' uid: botframework-schema.O365ConnectorCardOpenUri.@type package: botframework-schema - summary: '' + summary: 'Type of the action. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardActionType' @@ -54,14 +50,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@type'](xref:O365ConnectorCardActionBase.'@type') + [O365ConnectorCardActionBase.@type](xref:botframework-schema.O365ConnectorCardActionBase.@type) - name: name uid: botframework-schema.O365ConnectorCardOpenUri.name package: botframework-schema - summary: '' + summary: Name of the action that will be used as button fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUriTarget.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUriTarget.yml index d42c3b96..5536acbb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUriTarget.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardOpenUriTarget.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardOpenUriTarget remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: os uid: botframework-schema.O365ConnectorCardOpenUriTarget.os package: botframework-schema - summary: '' + summary: 'Target operating system. Possible values include:' fullName: os remarks: '' - isPreview: false isDeprecated: false syntax: content: 'os?: Os' @@ -25,10 +23,9 @@ properties: - name: uri uid: botframework-schema.O365ConnectorCardOpenUriTarget.uri package: botframework-schema - summary: '' + summary: Target url fullName: uri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uri?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardSection.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardSection.yml index ac879c7d..b9f5c744 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardSection.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardSection.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardSection remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: activityImage uid: botframework-schema.O365ConnectorCardSection.activityImage package: botframework-schema - summary: '' + summary: Activity image fullName: activityImage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityImage?: string' @@ -25,10 +23,9 @@ properties: - name: activityImageType uid: botframework-schema.O365ConnectorCardSection.activityImageType package: botframework-schema - summary: '' + summary: Describes how Activity fullName: activityImageType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityImageType?: ActivityImageType' @@ -38,10 +35,9 @@ properties: - name: activitySubtitle uid: botframework-schema.O365ConnectorCardSection.activitySubtitle package: botframework-schema - summary: '' + summary: Activity subtitle fullName: activitySubtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activitySubtitle?: string' @@ -51,10 +47,9 @@ properties: - name: activityText uid: botframework-schema.O365ConnectorCardSection.activityText package: botframework-schema - summary: '' + summary: Activity text fullName: activityText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityText?: string' @@ -64,10 +59,9 @@ properties: - name: activityTitle uid: botframework-schema.O365ConnectorCardSection.activityTitle package: botframework-schema - summary: '' + summary: Activity title fullName: activityTitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activityTitle?: string' @@ -77,36 +71,33 @@ properties: - name: facts uid: botframework-schema.O365ConnectorCardSection.facts package: botframework-schema - summary: '' + summary: Set of facts for the current fullName: facts remarks: '' - isPreview: false isDeprecated: false syntax: content: 'facts?: O365ConnectorCardFact[]' return: description: '' - type: '[]' + type: [] - name: images uid: botframework-schema.O365ConnectorCardSection.images package: botframework-schema - summary: '' + summary: Set of images for the current fullName: images remarks: '' - isPreview: false isDeprecated: false syntax: content: 'images?: O365ConnectorCardImage[]' return: description: '' - type: '[]' + type: [] - name: markdown uid: botframework-schema.O365ConnectorCardSection.markdown package: botframework-schema - summary: '' + summary: Use markdown for all text contents. Default fullName: markdown remarks: '' - isPreview: false isDeprecated: false syntax: content: 'markdown?: boolean' @@ -116,23 +107,21 @@ properties: - name: potentialAction uid: botframework-schema.O365ConnectorCardSection.potentialAction package: botframework-schema - summary: '' + summary: Set of actions fullName: potentialAction remarks: '' - isPreview: false isDeprecated: false syntax: content: 'potentialAction?: O365ConnectorCardActionBase[]' return: description: '' - type: '[]' + type: [] - name: text uid: botframework-schema.O365ConnectorCardSection.text package: botframework-schema - summary: '' + summary: Text for the section fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' @@ -142,10 +131,9 @@ properties: - name: title uid: botframework-schema.O365ConnectorCardSection.title package: botframework-schema - summary: '' + summary: Title of the section fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardTextInput.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardTextInput.yml index de7093a3..77cb370b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardTextInput.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardTextInput.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardTextInput remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: isMultiline uid: botframework-schema.O365ConnectorCardTextInput.isMultiline package: botframework-schema - summary: '' + summary: Define if text input is allowed for fullName: isMultiline remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isMultiline?: boolean' @@ -25,10 +23,9 @@ properties: - name: maxLength uid: botframework-schema.O365ConnectorCardTextInput.maxLength package: botframework-schema - summary: '' + summary: Maximum length of text input. Default value fullName: maxLength remarks: '' - isPreview: false isDeprecated: false syntax: content: 'maxLength?: number' @@ -39,10 +36,9 @@ inheritedProperties: - name: '@type' uid: botframework-schema.O365ConnectorCardTextInput.@type package: botframework-schema - summary: '' + summary: 'Input type name. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardInputType' @@ -51,14 +47,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardInputBase.'@type'](xref:O365ConnectorCardInputBase.'@type') + [O365ConnectorCardInputBase.@type](xref:botframework-schema.O365ConnectorCardInputBase.@type) - name: id uid: botframework-schema.O365ConnectorCardTextInput.id package: botframework-schema - summary: '' + summary: Input Id. It must be unique per entire O365 fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -71,10 +66,9 @@ inheritedProperties: - name: isRequired uid: botframework-schema.O365ConnectorCardTextInput.isRequired package: botframework-schema - summary: '' + summary: Define if this input is a required field. fullName: isRequired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isRequired?: boolean' @@ -87,10 +81,9 @@ inheritedProperties: - name: title uid: botframework-schema.O365ConnectorCardTextInput.title package: botframework-schema - summary: '' + summary: Input title that will be shown as the placeholder fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' @@ -103,10 +96,9 @@ inheritedProperties: - name: value uid: botframework-schema.O365ConnectorCardTextInput.value package: botframework-schema - summary: '' + summary: Default value for this input field fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardViewAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardViewAction.yml index 8e6943cf..e883e358 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardViewAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/O365ConnectorCardViewAction.yml @@ -5,31 +5,28 @@ package: botframework-schema summary: '' fullName: O365ConnectorCardViewAction remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: target uid: botframework-schema.O365ConnectorCardViewAction.target package: botframework-schema - summary: '' + summary: Target urls, only the first url effective for fullName: target remarks: '' - isPreview: false isDeprecated: false syntax: content: 'target?: string[]' return: description: '' - type: 'string[]' + type: string[] inheritedProperties: - name: '@id' uid: botframework-schema.O365ConnectorCardViewAction.@id package: botframework-schema - summary: '' + summary: Action Id fullName: '@id' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@id?: string' @@ -38,14 +35,13 @@ inheritedProperties: type: string inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@id'](xref:O365ConnectorCardActionBase.'@id') + [O365ConnectorCardActionBase.@id](xref:botframework-schema.O365ConnectorCardActionBase.@id) - name: '@type' uid: botframework-schema.O365ConnectorCardViewAction.@type package: botframework-schema - summary: '' + summary: 'Type of the action. Possible values include:' fullName: '@type' remarks: '' - isPreview: false isDeprecated: false syntax: content: '@type?: O365ConnectorCardActionType' @@ -54,14 +50,13 @@ inheritedProperties: type: inheritanceDescription: >- Inherited From - [O365ConnectorCardActionBase.'@type'](xref:O365ConnectorCardActionBase.'@type') + [O365ConnectorCardActionBase.@type](xref:botframework-schema.O365ConnectorCardActionBase.@type) - name: name uid: botframework-schema.O365ConnectorCardViewAction.name package: botframework-schema - summary: '' + summary: Name of the action that will be used as button fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/OAuthCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/OAuthCard.yml index 4cba74f9..a52a694c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/OAuthCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/OAuthCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A card representing a request to perform a sign in via OAuth fullName: OAuthCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: Action to use to perform signin fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: connectionName uid: botframework-schema.OAuthCard.connectionName package: botframework-schema summary: The name of the registered connection fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: string' @@ -41,7 +38,6 @@ properties: summary: Text for signin request fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -54,10 +50,21 @@ properties: summary: The token exchange resource for single sign on fullName: tokenExchangeResource remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenExchangeResource: TokenExchangeResource' return: description: '' type: + - name: tokenPostResource + uid: botframework-schema.OAuthCard.tokenPostResource + package: botframework-schema + summary: The token for directly post a token to token service + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource: TokenPostResource' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/OnBehalfOf.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/OnBehalfOf.yml new file mode 100644 index 00000000..5a065984 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/OnBehalfOf.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: OnBehalfOf +uid: botframework-schema.OnBehalfOf +package: botframework-schema +summary: '' +fullName: OnBehalfOf +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayName + uid: botframework-schema.OnBehalfOf.displayName + package: botframework-schema + summary: The of the person. + fullName: displayName + remarks: '' + isDeprecated: false + syntax: + content: 'displayName?: string' + return: + description: '' + type: string + - name: itemid + uid: botframework-schema.OnBehalfOf.itemid + package: botframework-schema + summary: The id of the item. + fullName: itemid + remarks: '' + isDeprecated: false + syntax: + content: 'itemid: number' + return: + description: '' + type: number + - name: mentionType + uid: botframework-schema.OnBehalfOf.mentionType + package: botframework-schema + summary: The mention type of a "person". + fullName: mentionType + remarks: '' + isDeprecated: false + syntax: + content: 'mentionType: string' + return: + description: '' + type: string + - name: mri + uid: botframework-schema.OnBehalfOf.mri + package: botframework-schema + summary: Ther user MRI of the sender. + fullName: mri + remarks: '' + isDeprecated: false + syntax: + content: 'mri: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/OnCardSelectionAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/OnCardSelectionAction.yml new file mode 100644 index 00000000..a5c095dc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/OnCardSelectionAction.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: OnCardSelectionAction +uid: botframework-schema.OnCardSelectionAction +package: botframework-schema +summary: Type of handler for when a card is selected. +fullName: OnCardSelectionAction +remarks: '' +isDeprecated: false +syntax: | + type OnCardSelectionAction = + | QuickViewCardAction + | ExternalLinkCardAction + | SelectMediaCardAction + | GetLocationCardAction + | ShowLocationCardAction + | ExecuteCardAction + | undefined diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Os.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Os.yml index b3c23928..3faf989f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Os.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Os.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'default', 'iOS', 'android', 'windows' fullName: Os remarks: '' -isPreview: false isDeprecated: false syntax: | type Os = "default" | "iOS" | "android" | "windows" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PagedMembersResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PagedMembersResult.yml index 92904433..16dc2f09 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PagedMembersResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PagedMembersResult.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Page of members. fullName: PagedMembersResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Paging token fullName: continuationToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'continuationToken: string' @@ -28,10 +26,9 @@ properties: summary: The Channel Accounts. fullName: members remarks: '' - isPreview: false isDeprecated: false syntax: content: 'members: ChannelAccount[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentAddress.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentAddress.yml index 5e2d79ed..d2e12655 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentAddress.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentAddress.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Address within a Payment Request fullName: PaymentAddress remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -23,20 +22,18 @@ properties: office box number. fullName: addressLine remarks: '' - isPreview: false isDeprecated: false syntax: content: 'addressLine: string[]' return: description: '' - type: 'string[]' + type: string[] - name: city uid: botframework-schema.PaymentAddress.city package: botframework-schema summary: This is the city/town portion of the address. fullName: city remarks: '' - isPreview: false isDeprecated: false syntax: content: 'city: string' @@ -51,7 +48,6 @@ properties: US, GB, CN, or JP fullName: country remarks: '' - isPreview: false isDeprecated: false syntax: content: 'country: string' @@ -68,7 +64,6 @@ properties: neighborhoods, boroughs, districts, or UK dependent localities. fullName: dependentLocality remarks: '' - isPreview: false isDeprecated: false syntax: content: 'dependentLocality: string' @@ -85,7 +80,6 @@ properties: and the order of fields when formatting the address for display. fullName: languageCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'languageCode: string' @@ -95,10 +89,9 @@ properties: - name: organization uid: botframework-schema.PaymentAddress.organization package: botframework-schema - summary: 'This is the organization, firm, company, or institution at this address.' + summary: This is the organization, firm, company, or institution at this address. fullName: organization remarks: '' - isPreview: false isDeprecated: false syntax: content: 'organization: string' @@ -111,7 +104,6 @@ properties: summary: This is the phone number of the recipient or contact person. fullName: phone remarks: '' - isPreview: false isDeprecated: false syntax: content: 'phone: string' @@ -121,10 +113,9 @@ properties: - name: postalCode uid: botframework-schema.PaymentAddress.postalCode package: botframework-schema - summary: 'This is the postal code or ZIP code, also known as PIN code in India.' + summary: This is the postal code or ZIP code, also known as PIN code in India. fullName: postalCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'postalCode: string' @@ -137,7 +128,6 @@ properties: summary: This is the name of the recipient or contact person. fullName: recipient remarks: '' - isPreview: false isDeprecated: false syntax: content: 'recipient: string' @@ -154,7 +144,6 @@ properties: state, a province, an oblast, or a prefecture. fullName: region remarks: '' - isPreview: false isDeprecated: false syntax: content: 'region: string' @@ -164,10 +153,9 @@ properties: - name: sortingCode uid: botframework-schema.PaymentAddress.sortingCode package: botframework-schema - summary: 'This is the sorting code as used in, for example, France.' + summary: This is the sorting code as used in, for example, France. fullName: sortingCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sortingCode: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentCurrencyAmount.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentCurrencyAmount.yml index 54a0bc84..dca6253a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentCurrencyAmount.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentCurrencyAmount.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Supplies monetary amounts fullName: PaymentCurrencyAmount remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: A currency identifier fullName: currency remarks: '' - isPreview: false isDeprecated: false syntax: content: 'currency: string' @@ -29,7 +27,6 @@ properties: summary: Currency system fullName: currencySystem remarks: '' - isPreview: false isDeprecated: false syntax: content: 'currencySystem: string' @@ -42,7 +39,6 @@ properties: summary: Decimal monetary value fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetails.yml index 5b4084a0..88e4fc5b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetails.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetails.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Provides information about the requested transaction fullName: PaymentDetails remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -18,20 +17,18 @@ properties: display fullName: displayItems remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayItems: PaymentItem[]' return: description: '' - type: '[]' + type: [] - name: error uid: botframework-schema.PaymentDetails.error package: botframework-schema summary: Error description fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'error: string' @@ -44,13 +41,12 @@ properties: summary: Contains modifiers for particular payment method identifiers fullName: modifiers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'modifiers: PaymentDetailsModifier[]' return: description: '' - type: '[]' + type: [] - name: shippingOptions uid: botframework-schema.PaymentDetails.shippingOptions package: botframework-schema @@ -59,20 +55,18 @@ properties: choose from fullName: shippingOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shippingOptions: PaymentShippingOption[]' return: description: '' - type: '[]' + type: [] - name: total uid: botframework-schema.PaymentDetails.total package: botframework-schema summary: Contains the total amount of the payment request fullName: total remarks: '' - isPreview: false isDeprecated: false syntax: content: 'total: PaymentItem' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetailsModifier.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetailsModifier.yml index fca592be..1784127e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetailsModifier.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentDetailsModifier.yml @@ -7,7 +7,6 @@ summary: >- identifier fullName: PaymentDetailsModifier remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -23,13 +22,12 @@ properties: supportedMethods field fullName: additionalDisplayItems remarks: '' - isPreview: false isDeprecated: false syntax: content: 'additionalDisplayItems: PaymentItem[]' return: description: '' - type: '[]' + type: [] - name: data uid: botframework-schema.PaymentDetailsModifier.data package: botframework-schema @@ -40,7 +38,6 @@ properties: supported payment methods fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data: any' @@ -53,13 +50,12 @@ properties: summary: Contains a sequence of payment method identifiers fullName: supportedMethods remarks: '' - isPreview: false isDeprecated: false syntax: content: 'supportedMethods: string[]' return: description: '' - type: 'string[]' + type: string[] - name: total uid: botframework-schema.PaymentDetailsModifier.total package: botframework-schema @@ -70,7 +66,6 @@ properties: identifiers in the supportedMethods field fullName: total remarks: '' - isPreview: false isDeprecated: false syntax: content: 'total: PaymentItem' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentItem.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentItem.yml index 9a2d68fd..d54c675b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentItem.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentItem.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Indicates what the payment request is for and the value asked for fullName: PaymentItem remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Monetary amount for the item fullName: amount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'amount: PaymentCurrencyAmount' @@ -29,7 +27,6 @@ properties: summary: Human-readable description of the item fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label: string' @@ -42,7 +39,6 @@ properties: summary: When set to true this flag means that the amount field is not final. fullName: pending remarks: '' - isPreview: false isDeprecated: false syntax: content: 'pending: boolean' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentMethodData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentMethodData.yml index c2a661a1..5404385f 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentMethodData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentMethodData.yml @@ -9,7 +9,6 @@ summary: >- those methods fullName: PaymentMethodData remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -24,7 +23,6 @@ properties: supported payment methods fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data: any' @@ -41,10 +39,9 @@ properties: the merchant web site accepts fullName: supportedMethods remarks: '' - isPreview: false isDeprecated: false syntax: content: 'supportedMethods: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentOptions.yml index 024aaa46..d45701d9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentOptions.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Provides information about the options desired for the payment request fullName: PaymentOptions remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -20,7 +19,6 @@ properties: of the payment request fullName: requestPayerEmail remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestPayerEmail: boolean' @@ -37,7 +35,6 @@ properties: payment request fullName: requestPayerName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestPayerName: boolean' @@ -54,7 +51,6 @@ properties: the payment request fullName: requestPayerPhone remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestPayerPhone: boolean' @@ -71,7 +67,6 @@ properties: payment request fullName: requestShipping remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestShipping: boolean' @@ -89,7 +84,6 @@ properties: address fullName: shippingType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shippingType: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequest.yml index 89c4bc2c..da4ad06b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequest.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A request to make a payment fullName: PaymentRequest remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Details for this request fullName: details remarks: '' - isPreview: false isDeprecated: false syntax: content: 'details: PaymentDetails' @@ -26,10 +24,9 @@ properties: - name: expires uid: botframework-schema.PaymentRequest.expires package: botframework-schema - summary: 'Expiration for this request, in ISO 8601 duration format (e.g., ''P1D'')' + summary: Expiration for this request, in ISO 8601 duration format (e.g., 'P1D') fullName: expires remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expires: string' @@ -42,7 +39,6 @@ properties: summary: ID of this payment request fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -55,20 +51,18 @@ properties: summary: Allowed payment methods for this request fullName: methodData remarks: '' - isPreview: false isDeprecated: false syntax: content: 'methodData: PaymentMethodData[]' return: description: '' - type: '[]' + type: [] - name: options uid: botframework-schema.PaymentRequest.options package: botframework-schema summary: Provides information about the options desired for the payment request fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: 'options: PaymentOptions' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestComplete.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestComplete.yml index 983da25c..9653f4e4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestComplete.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestComplete.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Payload delivered when completing a payment request fullName: PaymentRequestComplete remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Payment request ID fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -29,7 +27,6 @@ properties: summary: Initial payment request fullName: paymentRequest remarks: '' - isPreview: false isDeprecated: false syntax: content: 'paymentRequest: PaymentRequest' @@ -42,7 +39,6 @@ properties: summary: Corresponding payment response fullName: paymentResponse remarks: '' - isPreview: false isDeprecated: false syntax: content: 'paymentResponse: PaymentResponse' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestCompleteResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestCompleteResult.yml index d0c5da78..c3083a22 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestCompleteResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestCompleteResult.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Result from a completed payment request fullName: PaymentRequestCompleteResult remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Result of the payment request completion fullName: result remarks: '' - isPreview: false isDeprecated: false syntax: content: 'result: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdate.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdate.yml index b0f40ead..4d684b6b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdate.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdate.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: An update to a payment request fullName: PaymentRequestUpdate remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Update payment details fullName: details remarks: '' - isPreview: false isDeprecated: false syntax: content: 'details: PaymentDetails' @@ -29,7 +27,6 @@ properties: summary: ID for the payment request to update fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -42,7 +39,6 @@ properties: summary: Updated shipping address fullName: shippingAddress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shippingAddress: PaymentAddress' @@ -55,7 +51,6 @@ properties: summary: Updated shipping options fullName: shippingOption remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shippingOption: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdateResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdateResult.yml index eae6b8bb..dfc6e135 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdateResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentRequestUpdateResult.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A result object from a Payment Request Update invoke operation fullName: PaymentRequestUpdateResult remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Update payment details fullName: details remarks: '' - isPreview: false isDeprecated: false syntax: content: 'details: PaymentDetails' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentResponse.yml index 014b76c2..02167d5a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentResponse.yml @@ -9,7 +9,6 @@ summary: >- request fullName: PaymentResponse remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -24,7 +23,6 @@ properties: merchant to process the transaction and determine successful fund transfer fullName: details remarks: '' - isPreview: false isDeprecated: false syntax: content: 'details: any' @@ -41,7 +39,6 @@ properties: transaction fullName: methodName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'methodName: string' @@ -59,7 +56,6 @@ properties: chosen by the user fullName: payerEmail remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payerEmail: string' @@ -77,7 +73,6 @@ properties: chosen by the user fullName: payerPhone remarks: '' - isPreview: false isDeprecated: false syntax: content: 'payerPhone: string' @@ -97,7 +92,6 @@ properties: user fullName: shippingAddress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shippingAddress: PaymentAddress' @@ -115,7 +109,6 @@ properties: shipping option fullName: shippingOption remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shippingOption: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentShippingOption.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentShippingOption.yml index f49ecee1..4ecca6b2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentShippingOption.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PaymentShippingOption.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Describes a shipping option fullName: PaymentShippingOption remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Bot Framework no longer supports payments type: interface @@ -16,7 +15,6 @@ properties: summary: Contains the monetary amount for the item fullName: amount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'amount: PaymentCurrencyAmount' @@ -29,7 +27,6 @@ properties: summary: String identifier used to reference this PaymentShippingOption fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -42,7 +39,6 @@ properties: summary: Human-readable description of the item fullName: label remarks: '' - isPreview: false isDeprecated: false syntax: content: 'label: string' @@ -55,7 +51,6 @@ properties: summary: Indicates whether this is the default selected PaymentShippingOption fullName: selected remarks: '' - isPreview: false isDeprecated: false syntax: content: 'selected: boolean' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Place.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Place.yml index ec47c04c..1892eeae 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Place.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Place.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: 'Place (entity type: "https://schema.org/Place")' fullName: Place remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: `PostalAddress`) fullName: address remarks: '' - isPreview: false isDeprecated: false syntax: content: 'address: any' @@ -32,7 +30,6 @@ properties: `GeoCoordinates` or `GeoShape`) fullName: geo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'geo: any' @@ -45,7 +42,6 @@ properties: summary: Map to the place (may be `string` (URL) or complex object of type `Map`) fullName: hasMap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hasMap: any' @@ -58,7 +54,6 @@ properties: summary: The name of the thing fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -71,7 +66,6 @@ properties: summary: The type of the thing fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PopupWindowPosition.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PopupWindowPosition.yml new file mode 100644 index 00000000..6f87e4f7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PopupWindowPosition.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: PopupWindowPosition +uid: botframework-schema.PopupWindowPosition +package: botframework-schema +summary: SharePoint property pane link popup window position. +fullName: PopupWindowPosition +remarks: '' +isDeprecated: false +fields: + - name: Center + uid: botframework-schema.PopupWindowPosition.Center + package: botframework-schema + summary: Center. + numericValue: 0 + - name: RightTop + uid: botframework-schema.PopupWindowPosition.RightTop + package: botframework-schema + summary: Right top. + numericValue: 1 + - name: LeftTop + uid: botframework-schema.PopupWindowPosition.LeftTop + package: botframework-schema + summary: Left top. + numericValue: 2 + - name: RightBottom + uid: botframework-schema.PopupWindowPosition.RightBottom + package: botframework-schema + summary: Right bottom. + numericValue: 3 + - name: LeftBottom + uid: botframework-schema.PopupWindowPosition.LeftBottom + package: botframework-schema + summary: Left bottom. + numericValue: 4 diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneCheckboxProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneCheckboxProperties.yml new file mode 100644 index 00000000..76818833 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneCheckboxProperties.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: PropertyPaneCheckboxProperties +uid: botframework-schema.PropertyPaneCheckboxProperties +package: botframework-schema +summary: SharePoint property pane checkbox field properties. +fullName: PropertyPaneCheckboxProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: checked + uid: botframework-schema.PropertyPaneCheckboxProperties.checked + package: botframework-schema + summary: Indicates whether the checkbox is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botframework-schema.PropertyPaneCheckboxProperties.disabled + package: botframework-schema + summary: Indicates whether the checkbox is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: text + uid: botframework-schema.PropertyPaneCheckboxProperties.text + package: botframework-schema + summary: The label text to display next to the checkbox. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupIconProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupIconProperties.yml new file mode 100644 index 00000000..070e8575 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupIconProperties.yml @@ -0,0 +1,23 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupIconProperties +uid: botframework-schema.PropertyPaneChoiceGroupIconProperties +package: botframework-schema +summary: SharePoint property pane choice group icon properties. +fullName: PropertyPaneChoiceGroupIconProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: officeFabricIconFontName + uid: >- + botframework-schema.PropertyPaneChoiceGroupIconProperties.officeFabricIconFontName + package: botframework-schema + summary: The name of the icon to use from Office Fabric icon set. + fullName: officeFabricIconFontName + remarks: '' + isDeprecated: false + syntax: + content: 'officeFabricIconFontName?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupImageSize.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupImageSize.yml new file mode 100644 index 00000000..6033279e --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupImageSize.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupImageSize +uid: botframework-schema.PropertyPaneChoiceGroupImageSize +package: botframework-schema +summary: SharePoint property pane choice group image size. +fullName: PropertyPaneChoiceGroupImageSize +remarks: '' +isDeprecated: false +type: interface +properties: + - name: height + uid: botframework-schema.PropertyPaneChoiceGroupImageSize.height + package: botframework-schema + summary: The height of the image. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height: number' + return: + description: '' + type: number + - name: width + uid: botframework-schema.PropertyPaneChoiceGroupImageSize.width + package: botframework-schema + summary: The width of the image. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupOption.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupOption.yml new file mode 100644 index 00000000..f089c952 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupOption.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupOption +uid: botframework-schema.PropertyPaneChoiceGroupOption +package: botframework-schema +summary: SharePoint property pane choice group option. +fullName: PropertyPaneChoiceGroupOption +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.PropertyPaneChoiceGroupOption.ariaLabel + package: botframework-schema + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: checked + uid: botframework-schema.PropertyPaneChoiceGroupOption.checked + package: botframework-schema + summary: Indicates whether the choice group option is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botframework-schema.PropertyPaneChoiceGroupOption.disabled + package: botframework-schema + summary: Indicates whether the choice group option is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: iconProps + uid: botframework-schema.PropertyPaneChoiceGroupOption.iconProps + package: botframework-schema + summary: The icon properties to use for the choice group option. + fullName: iconProps + remarks: '' + isDeprecated: false + syntax: + content: 'iconProps?: PropertyPaneChoiceGroupIconProperties' + return: + description: '' + type: >- + + - name: imageSize + uid: botframework-schema.PropertyPaneChoiceGroupOption.imageSize + package: botframework-schema + summary: The image size to use for the choice group option. + fullName: imageSize + remarks: '' + isDeprecated: false + syntax: + content: 'imageSize?: PropertyPaneChoiceGroupImageSize' + return: + description: '' + type: + - name: imageSrc + uid: botframework-schema.PropertyPaneChoiceGroupOption.imageSrc + package: botframework-schema + summary: The image source to use for the choice group option. + fullName: imageSrc + remarks: '' + isDeprecated: false + syntax: + content: 'imageSrc?: string' + return: + description: '' + type: string + - name: key + uid: botframework-schema.PropertyPaneChoiceGroupOption.key + package: botframework-schema + summary: The key to uniquely identify the choice group option. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: text + uid: botframework-schema.PropertyPaneChoiceGroupOption.text + package: botframework-schema + summary: The text to display next for this choice group option. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupProperties.yml new file mode 100644 index 00000000..d4e45957 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneChoiceGroupProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: PropertyPaneChoiceGroupProperties +uid: botframework-schema.PropertyPaneChoiceGroupProperties +package: botframework-schema +summary: SharePoint property pane choice group field properties. +fullName: PropertyPaneChoiceGroupProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: label + uid: botframework-schema.PropertyPaneChoiceGroupProperties.label + package: botframework-schema + summary: The label text to display next to the choice group. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: options + uid: botframework-schema.PropertyPaneChoiceGroupProperties.options + package: botframework-schema + summary: The options for the choice group. + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options: PropertyPaneChoiceGroupOption[]' + return: + description: '' + type: [] +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownOption.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownOption.yml new file mode 100644 index 00000000..30100b3c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownOption.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneDropDownOption +uid: botframework-schema.PropertyPaneDropDownOption +package: botframework-schema +summary: SharePoint property pane drop down option. +fullName: PropertyPaneDropDownOption +remarks: '' +isDeprecated: false +type: interface +properties: + - name: index + uid: botframework-schema.PropertyPaneDropDownOption.index + package: botframework-schema + summary: The index of the option. + fullName: index + remarks: '' + isDeprecated: false + syntax: + content: 'index?: number' + return: + description: '' + type: number + - name: key + uid: botframework-schema.PropertyPaneDropDownOption.key + package: botframework-schema + summary: The key to uniquely identify the option. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key: string' + return: + description: '' + type: string + - name: text + uid: botframework-schema.PropertyPaneDropDownOption.text + package: botframework-schema + summary: The text to render for this option. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string + - name: type + uid: botframework-schema.PropertyPaneDropDownOption.type + package: botframework-schema + summary: The type of option to render. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type?: DropDownOptionType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownProperties.yml new file mode 100644 index 00000000..5fc69d16 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneDropDownProperties.yml @@ -0,0 +1,113 @@ +### YamlMime:TSType +name: PropertyPaneDropDownProperties +uid: botframework-schema.PropertyPaneDropDownProperties +package: botframework-schema +summary: SharePoint property pane dropdown field properties. +fullName: PropertyPaneDropDownProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.PropertyPaneDropDownProperties.ariaLabel + package: botframework-schema + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: ariaPositionInSet + uid: botframework-schema.PropertyPaneDropDownProperties.ariaPositionInSet + package: botframework-schema + summary: >- + The elemement's number or position in the current set of controls. Maps to + native aria-positionset attribute. It starts from 1. + fullName: ariaPositionInSet + remarks: '' + isDeprecated: false + syntax: + content: 'ariaPositionInSet?: number' + return: + description: '' + type: number + - name: ariaSetSize + uid: botframework-schema.PropertyPaneDropDownProperties.ariaSetSize + package: botframework-schema + summary: >- + The total number of elements in the current set of controls. Maps to + native aria-setsize attribute. + fullName: ariaSetSize + remarks: '' + isDeprecated: false + syntax: + content: 'ariaSetSize?: number' + return: + description: '' + type: number + - name: disabled + uid: botframework-schema.PropertyPaneDropDownProperties.disabled + package: botframework-schema + summary: Indicates whether the dropdown is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: errorMessage + uid: botframework-schema.PropertyPaneDropDownProperties.errorMessage + package: botframework-schema + summary: The error message to display when the dropdown value is invalid. + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage?: string' + return: + description: '' + type: string + - name: label + uid: botframework-schema.PropertyPaneDropDownProperties.label + package: botframework-schema + summary: The label text to display next to the dropdown. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label: string' + return: + description: '' + type: string + - name: options + uid: botframework-schema.PropertyPaneDropDownProperties.options + package: botframework-schema + summary: The options for the dropdown. + fullName: options + remarks: '' + isDeprecated: false + syntax: + content: 'options?: PropertyPaneDropDownOption[]' + return: + description: '' + type: [] + - name: selectedKey + uid: botframework-schema.PropertyPaneDropDownProperties.selectedKey + package: botframework-schema + summary: The key of the selected dropdown option. + fullName: selectedKey + remarks: '' + isDeprecated: false + syntax: + content: 'selectedKey?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneFieldProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneFieldProperties.yml new file mode 100644 index 00000000..7f0addfb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneFieldProperties.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: PropertyPaneFieldProperties +uid: botframework-schema.PropertyPaneFieldProperties +package: botframework-schema +summary: SharePoint base property pane field properties +fullName: PropertyPaneFieldProperties +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroup.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroup.yml new file mode 100644 index 00000000..f1bea88f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroup.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PropertyPaneGroup +uid: botframework-schema.PropertyPaneGroup +package: botframework-schema +summary: SharePoint property pane group. +fullName: PropertyPaneGroup +remarks: '' +isDeprecated: false +type: interface +properties: + - name: groupFields + uid: botframework-schema.PropertyPaneGroup.groupFields + package: botframework-schema + summary: The fields to be rendered inside this group. + fullName: groupFields + remarks: '' + isDeprecated: false + syntax: + content: 'groupFields: PropertyPaneGroupField[]' + return: + description: '' + type: [] + - name: groupName + uid: botframework-schema.PropertyPaneGroup.groupName + package: botframework-schema + summary: The name of the group. + fullName: groupName + remarks: '' + isDeprecated: false + syntax: + content: 'groupName?: string' + return: + description: '' + type: string + - name: isCollapsed + uid: botframework-schema.PropertyPaneGroup.isCollapsed + package: botframework-schema + summary: Whether the group is collapsed or not. + fullName: isCollapsed + remarks: '' + isDeprecated: false + syntax: + content: 'isCollapsed?: boolean' + return: + description: '' + type: boolean + - name: isGroupNameHidden + uid: botframework-schema.PropertyPaneGroup.isGroupNameHidden + package: botframework-schema + summary: Whether the group name is hidden or not. + fullName: isGroupNameHidden + remarks: '' + isDeprecated: false + syntax: + content: 'isGroupNameHidden?: boolean' + return: + description: '' + type: boolean +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupField.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupField.yml new file mode 100644 index 00000000..b63eb20a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupField.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: PropertyPaneGroupField +uid: botframework-schema.PropertyPaneGroupField +package: botframework-schema +summary: SharePoint property pane group field. +fullName: PropertyPaneGroupField +remarks: '' +isDeprecated: false +type: interface +properties: + - name: properties + uid: botframework-schema.PropertyPaneGroupField.properties + package: botframework-schema + summary: The properties for the field. + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties: PropertyPaneFieldProperties' + return: + description: '' + type: + - name: shouldFocus + uid: botframework-schema.PropertyPaneGroupField.shouldFocus + package: botframework-schema + summary: Indicates whether the field should be focused or not. + fullName: shouldFocus + remarks: '' + isDeprecated: false + syntax: + content: 'shouldFocus?: boolean' + return: + description: '' + type: boolean + - name: targetProperty + uid: botframework-schema.PropertyPaneGroupField.targetProperty + package: botframework-schema + summary: The target property for the field. + fullName: targetProperty + remarks: '' + isDeprecated: false + syntax: + content: 'targetProperty: string' + return: + description: '' + type: string + - name: type + uid: botframework-schema.PropertyPaneGroupField.type + package: botframework-schema + summary: The type of the field. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: FieldType' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupOrConditionalGroup.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupOrConditionalGroup.yml new file mode 100644 index 00000000..8d3292bb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneGroupOrConditionalGroup.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: PropertyPaneGroupOrConditionalGroup +uid: botframework-schema.PropertyPaneGroupOrConditionalGroup +package: botframework-schema +summary: SharePoint property pane group or conditional group +fullName: PropertyPaneGroupOrConditionalGroup +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLabelProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLabelProperties.yml new file mode 100644 index 00000000..959edeef --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLabelProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: PropertyPaneLabelProperties +uid: botframework-schema.PropertyPaneLabelProperties +package: botframework-schema +summary: SharePoint property pane label properties. +fullName: PropertyPaneLabelProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: required + uid: botframework-schema.PropertyPaneLabelProperties.required + package: botframework-schema + summary: Whether the label is required or not. + fullName: required + remarks: '' + isDeprecated: false + syntax: + content: 'required?: boolean' + return: + description: '' + type: boolean + - name: text + uid: botframework-schema.PropertyPaneLabelProperties.text + package: botframework-schema + summary: The text to display in the label. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkPopupWindowProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkPopupWindowProperties.yml new file mode 100644 index 00000000..85a492ba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkPopupWindowProperties.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: PropertyPaneLinkPopupWindowProperties +uid: botframework-schema.PropertyPaneLinkPopupWindowProperties +package: botframework-schema +summary: SharePoint property pane link popup window properties. +fullName: PropertyPaneLinkPopupWindowProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: height + uid: botframework-schema.PropertyPaneLinkPopupWindowProperties.height + package: botframework-schema + summary: The height of the popup window. + fullName: height + remarks: '' + isDeprecated: false + syntax: + content: 'height: number' + return: + description: '' + type: number + - name: positionWindowPosition + uid: >- + botframework-schema.PropertyPaneLinkPopupWindowProperties.positionWindowPosition + package: botframework-schema + summary: The position of the popup window. + fullName: positionWindowPosition + remarks: '' + isDeprecated: false + syntax: + content: 'positionWindowPosition: PopupWindowPosition' + return: + description: '' + type: + - name: title + uid: botframework-schema.PropertyPaneLinkPopupWindowProperties.title + package: botframework-schema + summary: The title of the popup window. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: width + uid: botframework-schema.PropertyPaneLinkPopupWindowProperties.width + package: botframework-schema + summary: The width of the popup window. + fullName: width + remarks: '' + isDeprecated: false + syntax: + content: 'width: number' + return: + description: '' + type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkProperties.yml new file mode 100644 index 00000000..ae1da1c0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneLinkProperties.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: PropertyPaneLinkProperties +uid: botframework-schema.PropertyPaneLinkProperties +package: botframework-schema +summary: SharePoint property pane link field properties. +fullName: PropertyPaneLinkProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.PropertyPaneLinkProperties.ariaLabel + package: botframework-schema + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: disabled + uid: botframework-schema.PropertyPaneLinkProperties.disabled + package: botframework-schema + summary: Whether the link is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: href + uid: botframework-schema.PropertyPaneLinkProperties.href + package: botframework-schema + summary: The URL of the link. + fullName: href + remarks: '' + isDeprecated: false + syntax: + content: 'href: string' + return: + description: '' + type: string + - name: popupWindowProps + uid: botframework-schema.PropertyPaneLinkProperties.popupWindowProps + package: botframework-schema + summary: The properties of the popup window. + fullName: popupWindowProps + remarks: '' + isDeprecated: false + syntax: + content: 'popupWindowProps?: PropertyPaneLinkPopupWindowProperties' + return: + description: '' + type: >- + + - name: target + uid: botframework-schema.PropertyPaneLinkProperties.target + package: botframework-schema + summary: The target of the link. + fullName: target + remarks: '' + isDeprecated: false + syntax: + content: 'target?: string' + return: + description: '' + type: string + - name: text + uid: botframework-schema.PropertyPaneLinkProperties.text + package: botframework-schema + summary: The text to display in the link. + fullName: text + remarks: '' + isDeprecated: false + syntax: + content: 'text: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePage.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePage.yml new file mode 100644 index 00000000..97ff61f2 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePage.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: PropertyPanePage +uid: botframework-schema.PropertyPanePage +package: botframework-schema +summary: SharePoint property pane page. +fullName: PropertyPanePage +remarks: '' +isDeprecated: false +type: interface +properties: + - name: displayGroupsAsAccordion + uid: botframework-schema.PropertyPanePage.displayGroupsAsAccordion + package: botframework-schema + summary: Whether the groups should be displayed as an accordion or not. + fullName: displayGroupsAsAccordion + remarks: '' + isDeprecated: false + syntax: + content: 'displayGroupsAsAccordion?: boolean' + return: + description: '' + type: boolean + - name: groups + uid: botframework-schema.PropertyPanePage.groups + package: botframework-schema + summary: The groups to be rendered inside this page. + fullName: groups + remarks: '' + isDeprecated: false + syntax: + content: 'groups: PropertyPaneGroupOrConditionalGroup[]' + return: + description: '' + type: >- + [] + - name: header + uid: botframework-schema.PropertyPanePage.header + package: botframework-schema + summary: The header to be rendered inside this page. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header?: PropertyPanePageHeader' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePageHeader.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePageHeader.yml new file mode 100644 index 00000000..3b141d85 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPanePageHeader.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: PropertyPanePageHeader +uid: botframework-schema.PropertyPanePageHeader +package: botframework-schema +summary: SharePoint property pane page header. +fullName: PropertyPanePageHeader +remarks: '' +isDeprecated: false +type: interface +properties: + - name: description + uid: botframework-schema.PropertyPanePageHeader.description + package: botframework-schema + summary: The description of the page. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneSliderProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneSliderProperties.yml new file mode 100644 index 00000000..3cc00020 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneSliderProperties.yml @@ -0,0 +1,109 @@ +### YamlMime:TSType +name: PropertyPaneSliderProperties +uid: botframework-schema.PropertyPaneSliderProperties +package: botframework-schema +summary: SharePoint property pane slider field properties. +fullName: PropertyPaneSliderProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.PropertyPaneSliderProperties.ariaLabel + package: botframework-schema + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: disabled + uid: botframework-schema.PropertyPaneSliderProperties.disabled + package: botframework-schema + summary: Whether the slider is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: label + uid: botframework-schema.PropertyPaneSliderProperties.label + package: botframework-schema + summary: The label of the slider. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: max + uid: botframework-schema.PropertyPaneSliderProperties.max + package: botframework-schema + summary: The maximum value of the slider. + fullName: max + remarks: '' + isDeprecated: false + syntax: + content: 'max: number' + return: + description: '' + type: number + - name: min + uid: botframework-schema.PropertyPaneSliderProperties.min + package: botframework-schema + summary: The minimum value of the slider. + fullName: min + remarks: '' + isDeprecated: false + syntax: + content: 'min: number' + return: + description: '' + type: number + - name: showValue + uid: botframework-schema.PropertyPaneSliderProperties.showValue + package: botframework-schema + summary: Whether to show the value on the right of the slider or no. + fullName: showValue + remarks: '' + isDeprecated: false + syntax: + content: 'showValue?: boolean' + return: + description: '' + type: boolean + - name: step + uid: botframework-schema.PropertyPaneSliderProperties.step + package: botframework-schema + summary: The step value of the slider. + fullName: step + remarks: '' + isDeprecated: false + syntax: + content: 'step?: number' + return: + description: '' + type: number + - name: value + uid: botframework-schema.PropertyPaneSliderProperties.value + package: botframework-schema + summary: The value of the slider. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneTextFieldProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneTextFieldProperties.yml new file mode 100644 index 00000000..43a1ce6a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneTextFieldProperties.yml @@ -0,0 +1,175 @@ +### YamlMime:TSType +name: PropertyPaneTextFieldProperties +uid: botframework-schema.PropertyPaneTextFieldProperties +package: botframework-schema +summary: SharePoint property pane text field properties. +fullName: PropertyPaneTextFieldProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.PropertyPaneTextFieldProperties.ariaLabel + package: botframework-schema + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: description + uid: botframework-schema.PropertyPaneTextFieldProperties.description + package: botframework-schema + summary: The description to display under the text field. + fullName: description + remarks: '' + isDeprecated: false + syntax: + content: 'description?: string' + return: + description: '' + type: string + - name: disabled + uid: botframework-schema.PropertyPaneTextFieldProperties.disabled + package: botframework-schema + summary: Whether the text field is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: errorMessage + uid: botframework-schema.PropertyPaneTextFieldProperties.errorMessage + package: botframework-schema + summary: >- + If set, this will be displayed as an error message underneath the text + field.. + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage?: string' + return: + description: '' + type: string + - name: label + uid: botframework-schema.PropertyPaneTextFieldProperties.label + package: botframework-schema + summary: The label of the text field. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: logName + uid: botframework-schema.PropertyPaneTextFieldProperties.logName + package: botframework-schema + summary: >- + Name used to log PropertyPaneTextField value changes for engagement + tracking. + fullName: logName + remarks: '' + isDeprecated: false + syntax: + content: 'logName?: string' + return: + description: '' + type: string + - name: maxLength + uid: botframework-schema.PropertyPaneTextFieldProperties.maxLength + package: botframework-schema + summary: The maximum length of the text field. + fullName: maxLength + remarks: '' + isDeprecated: false + syntax: + content: 'maxLength?: number' + return: + description: '' + type: number + - name: multiline + uid: botframework-schema.PropertyPaneTextFieldProperties.multiline + package: botframework-schema + summary: Whether or not the text field is multiline. + fullName: multiline + remarks: '' + isDeprecated: false + syntax: + content: 'multiline?: boolean' + return: + description: '' + type: boolean + - name: placeholder + uid: botframework-schema.PropertyPaneTextFieldProperties.placeholder + package: botframework-schema + summary: The placeholder text to display in the text field. + fullName: placeholder + remarks: '' + isDeprecated: false + syntax: + content: 'placeholder?: string' + return: + description: '' + type: string + - name: resizable + uid: botframework-schema.PropertyPaneTextFieldProperties.resizable + package: botframework-schema + summary: Whether or not the multiline text field is resizable. + fullName: resizable + remarks: '' + isDeprecated: false + syntax: + content: 'resizable?: boolean' + return: + description: '' + type: boolean + - name: rows + uid: botframework-schema.PropertyPaneTextFieldProperties.rows + package: botframework-schema + summary: >- + Specifies the visible height of a text area(multiline text TextField), in + lines. + fullName: rows + remarks: '' + isDeprecated: false + syntax: + content: 'rows?: number' + return: + description: '' + type: number + - name: underlined + uid: botframework-schema.PropertyPaneTextFieldProperties.underlined + package: botframework-schema + summary: Whether or not the text field is underlined. + fullName: underlined + remarks: '' + isDeprecated: false + syntax: + content: 'underlined?: boolean' + return: + description: '' + type: boolean + - name: value + uid: botframework-schema.PropertyPaneTextFieldProperties.value + package: botframework-schema + summary: The value of the text field. + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneToggleProperties.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneToggleProperties.yml new file mode 100644 index 00000000..e4c254b0 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/PropertyPaneToggleProperties.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: PropertyPaneToggleProperties +uid: botframework-schema.PropertyPaneToggleProperties +package: botframework-schema +summary: SharePoint property pane toggle field properties. +fullName: PropertyPaneToggleProperties +remarks: '' +isDeprecated: false +type: interface +properties: + - name: ariaLabel + uid: botframework-schema.PropertyPaneToggleProperties.ariaLabel + package: botframework-schema + summary: >- + Optional ariaLabel flag. Text for screen-reader to announce regardless of + toggle state. + fullName: ariaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'ariaLabel?: string' + return: + description: '' + type: string + - name: checked + uid: botframework-schema.PropertyPaneToggleProperties.checked + package: botframework-schema + summary: Indicates whether the toggle is checked or not. + fullName: checked + remarks: '' + isDeprecated: false + syntax: + content: 'checked?: boolean' + return: + description: '' + type: boolean + - name: disabled + uid: botframework-schema.PropertyPaneToggleProperties.disabled + package: botframework-schema + summary: Indicates whether the toggle is disabled or not. + fullName: disabled + remarks: '' + isDeprecated: false + syntax: + content: 'disabled?: boolean' + return: + description: '' + type: boolean + - name: key + uid: botframework-schema.PropertyPaneToggleProperties.key + package: botframework-schema + summary: A key to uniquely identify the toggle. + fullName: key + remarks: '' + isDeprecated: false + syntax: + content: 'key?: string' + return: + description: '' + type: string + - name: label + uid: botframework-schema.PropertyPaneToggleProperties.label + package: botframework-schema + summary: A label for the toggle. + fullName: label + remarks: '' + isDeprecated: false + syntax: + content: 'label?: string' + return: + description: '' + type: string + - name: offAriaLabel + uid: botframework-schema.PropertyPaneToggleProperties.offAriaLabel + package: botframework-schema + summary: >- + Optional offAriaLabel flag. Text for screen-reader to announce when toggle + is OFF. + fullName: offAriaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'offAriaLabel?: string' + return: + description: '' + type: string + - name: offText + uid: botframework-schema.PropertyPaneToggleProperties.offText + package: botframework-schema + summary: Text to display when toggle is OFF. + fullName: offText + remarks: '' + isDeprecated: false + syntax: + content: 'offText?: string' + return: + description: '' + type: string + - name: onAriaLabel + uid: botframework-schema.PropertyPaneToggleProperties.onAriaLabel + package: botframework-schema + summary: >- + Optional onAriaLabel flag. Text for screen-reader to announce when toggle + is ON. + fullName: onAriaLabel + remarks: '' + isDeprecated: false + syntax: + content: 'onAriaLabel?: string' + return: + description: '' + type: string + - name: onText + uid: botframework-schema.PropertyPaneToggleProperties.onText + package: botframework-schema + summary: Text to display when toggle is ON. + fullName: onText + remarks: '' + isDeprecated: false + syntax: + content: 'onText?: string' + return: + description: '' + type: string +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewCardAction.yml new file mode 100644 index 00000000..ba1ed4ba --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: QuickViewCardAction +uid: botframework-schema.QuickViewCardAction +package: botframework-schema +summary: SharePoint QuickView action. +fullName: QuickViewCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botframework-schema.QuickViewCardAction.parameters + package: botframework-schema + summary: Parameters for the quick view opened by this action + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: QuickViewParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.QuickViewCardAction.type + package: botframework-schema + summary: Indicates this action opens the quick view. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "QuickView"' + return: + description: '' + type: '"QuickView"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewData.yml new file mode 100644 index 00000000..a37556c7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewData.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: QuickViewData +uid: botframework-schema.QuickViewData +package: botframework-schema +summary: '' +fullName: QuickViewData +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewHandleActionResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewHandleActionResponse.yml new file mode 100644 index 00000000..7cfb2160 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewHandleActionResponse.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: QuickViewHandleActionResponse +uid: botframework-schema.QuickViewHandleActionResponse +package: botframework-schema +summary: The handle action response for quick view. +fullName: QuickViewHandleActionResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: renderArguments + uid: botframework-schema.QuickViewHandleActionResponse.renderArguments + package: botframework-schema + summary: Quick view render arguments. + fullName: renderArguments + remarks: '' + isDeprecated: false + syntax: + content: 'renderArguments: QuickViewResponse' + return: + description: '' + type: + - name: responseType + uid: botframework-schema.QuickViewHandleActionResponse.responseType + package: botframework-schema + summary: Quick view. + fullName: responseType + remarks: '' + isDeprecated: false + syntax: + content: 'responseType: "QuickView"' + return: + description: '' + type: '"QuickView"' +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewParameters.yml new file mode 100644 index 00000000..255c8799 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: QuickViewParameters +uid: botframework-schema.QuickViewParameters +package: botframework-schema +summary: Parameters for opening a Quick view. +fullName: QuickViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: view + uid: botframework-schema.QuickViewParameters.view + package: botframework-schema + summary: The view of the Quick view to open. + fullName: view + remarks: '' + isDeprecated: false + syntax: + content: 'view: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewResponse.yml new file mode 100644 index 00000000..4efc90fb --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/QuickViewResponse.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: QuickViewResponse +uid: botframework-schema.QuickViewResponse +package: botframework-schema +summary: SharePoint ACE Quick view response payload. +fullName: QuickViewResponse +remarks: '' +isDeprecated: false +type: interface +properties: + - name: data + uid: botframework-schema.QuickViewResponse.data + package: botframework-schema + summary: The quick view data. + fullName: data + remarks: '' + isDeprecated: false + syntax: + content: 'data: QuickViewData' + return: + description: '' + type: + - name: externalLink + uid: botframework-schema.QuickViewResponse.externalLink + package: botframework-schema + summary: >- + An optional external link to be displayed in the navigation bar above the + Adaptive Card. + fullName: externalLink + remarks: '' + isDeprecated: false + syntax: + content: 'externalLink: ExternalLinkActionParameters' + return: + description: '' + type: + - name: focusParameters + uid: botframework-schema.QuickViewResponse.focusParameters + package: botframework-schema + summary: >- + An optional focus element to set focus when the view is rendered for + accessibility purposes. + fullName: focusParameters + remarks: '' + isDeprecated: false + syntax: + content: 'focusParameters: FocusParameters' + return: + description: '' + type: + - name: template + uid: botframework-schema.QuickViewResponse.template + package: botframework-schema + summary: The adaptive card template for the quick view. + fullName: template + remarks: '' + isDeprecated: false + syntax: + content: 'template: AdaptiveCard' + return: + description: '' + type: AdaptiveCard + - name: title + uid: botframework-schema.QuickViewResponse.title + package: botframework-schema + summary: The title of the quick view. + fullName: title + remarks: '' + isDeprecated: false + syntax: + content: 'title: string' + return: + description: '' + type: string + - name: viewId + uid: botframework-schema.QuickViewResponse.viewId + package: botframework-schema + summary: The view id. + fullName: viewId + remarks: '' + isDeprecated: false + syntax: + content: 'viewId: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReactionType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReactionType.yml index 96a2f684..4c603cf9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReactionType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReactionType.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' fullName: ReactionType remarks: '' -isPreview: false isDeprecated: false syntax: | type ReactionType = "like" | "heart" | "laugh" | "surprised" | "sad" | "angry" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptCard.yml index 62dd8285..546fe5bd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A receipt card fullName: ReceiptCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,46 +14,42 @@ properties: summary: Set of actions applicable to the current card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: facts uid: botframework-schema.ReceiptCard.facts package: botframework-schema summary: Array of Fact objects fullName: facts remarks: '' - isPreview: false isDeprecated: false syntax: content: 'facts: Fact[]' return: description: '' - type: '[]' + type: [] - name: items uid: botframework-schema.ReceiptCard.items package: botframework-schema summary: Array of Receipt Items fullName: items remarks: '' - isPreview: false isDeprecated: false syntax: content: 'items: ReceiptItem[]' return: description: '' - type: '[]' + type: [] - name: tap uid: botframework-schema.ReceiptCard.tap package: botframework-schema summary: This action will be activated when user taps on the card fullName: tap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tap: CardAction' @@ -67,7 +62,6 @@ properties: summary: Total amount of tax paid (or to be paid) fullName: tax remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tax: string' @@ -80,7 +74,6 @@ properties: summary: Title of the card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -93,7 +86,6 @@ properties: summary: Total amount of money paid (or to be paid) fullName: total remarks: '' - isPreview: false isDeprecated: false syntax: content: 'total: string' @@ -106,7 +98,6 @@ properties: summary: Total amount of VAT paid (or to be paid) fullName: vat remarks: '' - isPreview: false isDeprecated: false syntax: content: 'vat: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptItem.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptItem.yml index 0d4dd592..a2fe37d4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptItem.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ReceiptItem.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: An item on a receipt card fullName: ReceiptItem remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Image fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image: CardImage' @@ -28,7 +26,6 @@ properties: summary: Amount with currency fullName: price remarks: '' - isPreview: false isDeprecated: false syntax: content: 'price: string' @@ -41,7 +38,6 @@ properties: summary: Number of items of given kind fullName: quantity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'quantity: string' @@ -56,7 +52,6 @@ properties: styling only fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -69,7 +64,6 @@ properties: summary: This action will be activated when user taps on the Item bubble. fullName: tap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tap: CardAction' @@ -84,7 +78,6 @@ properties: styling only fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -97,7 +90,6 @@ properties: summary: Title of the Card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ResourceResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ResourceResponse.yml index ac395665..72587d98 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ResourceResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ResourceResponse.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A response containing a resource ID fullName: ResourceResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Id of the resource fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/RoleTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/RoleTypes.yml index c528e95e..1092d37a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/RoleTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/RoleTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'user', 'bot', 'skill' fullName: RoleTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Bot diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchCardViewParameters.yml new file mode 100644 index 00000000..d3c352c7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchCardViewParameters.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: SearchCardViewParameters +uid: botframework-schema.SearchCardViewParameters +package: botframework-schema +summary: The parameters for the search card view. +fullName: SearchCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botframework-schema.SearchCardViewParameters.body + package: botframework-schema + summary: Body area components. Contains a single search box. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: [CardSearchBoxComponent]' + return: + description: '' + type: '[CardSearchBoxComponent]' + - name: cardViewType + uid: botframework-schema.SearchCardViewParameters.cardViewType + package: botframework-schema + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "search"' + return: + description: '' + type: '"search"' + - name: footer + uid: botframework-schema.SearchCardViewParameters.footer + package: botframework-schema + summary: Footer area components. Contains a single search footer. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: [CardSearchFooterComponent]' + return: + description: '' + type: '[CardSearchFooterComponent]' + - name: header + uid: botframework-schema.SearchCardViewParameters.header + package: botframework-schema + summary: Header area components. Contains a single text field. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' +inheritedProperties: + - name: cardBar + uid: botframework-schema.SearchCardViewParameters.cardBar + package: botframework-schema + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botframework-schema.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeOptions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeOptions.yml index 501347a5..4db6193a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeOptions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeOptions.yml @@ -7,7 +7,6 @@ summary: >- [SearchInvokeValue](xref:botframework-schema.SearchInvokeValue) fullName: SearchInvokeOptions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: should be returned. fullName: skip remarks: '' - isPreview: false isDeprecated: false syntax: content: 'skip: number' @@ -32,7 +30,6 @@ properties: summary: Indicates the number of search results that should be returned. fullName: top remarks: '' - isPreview: false isDeprecated: false syntax: content: 'top: number' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeResponse.yml index 495fa96a..a5117146 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeResponse.yml @@ -9,7 +9,6 @@ summary: >- Name of 'application/search'. fullName: SearchInvokeResponse remarks: '' -isPreview: false isDeprecated: false type: interface inheritedProperties: @@ -19,7 +18,6 @@ inheritedProperties: summary: The Card Action response status code. fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode: number' @@ -35,7 +33,6 @@ inheritedProperties: summary: The type of this response. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' @@ -51,13 +48,12 @@ inheritedProperties: summary: The json response object. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: Record' return: description: '' - type: 'Record<string, unknown>' + type: Record<string, unknown> inheritanceDescription: >- Inherited From [AdaptiveCardInvokeResponse.value](xref:botframework-schema.AdaptiveCardInvokeResponse.value) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeValue.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeValue.yml index 1974375e..bd8a8c0b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeValue.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SearchInvokeValue.yml @@ -9,7 +9,6 @@ summary: >- Name of 'application/search'. fullName: SearchInvokeValue remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -26,7 +25,6 @@ properties: For search and searchAnswers, there is no defined context value. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context: any' @@ -41,7 +39,6 @@ properties: Must be either search, searchAnswer or typeAhead. fullName: kind remarks: '' - isPreview: false isDeprecated: false syntax: content: 'kind: string' @@ -56,7 +53,6 @@ properties: for this search invoke value. fullName: queryOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'queryOptions: SearchInvokeOptions' @@ -69,7 +65,6 @@ properties: summary: The query text for the search invoke value. fullName: queryText remarks: '' - isPreview: false isDeprecated: false syntax: content: 'queryText: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaActionParameters.yml new file mode 100644 index 00000000..935a73ee --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaActionParameters.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: SelectMediaActionParameters +uid: botframework-schema.SelectMediaActionParameters +package: botframework-schema +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.SelectMendia + action. +fullName: SelectMediaActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: allowMultipleCapture + uid: botframework-schema.SelectMediaActionParameters.allowMultipleCapture + package: botframework-schema + summary: Allow multiple images to be selected. + fullName: allowMultipleCapture + remarks: '' + isDeprecated: false + syntax: + content: 'allowMultipleCapture?: boolean' + return: + description: '' + type: boolean + - name: maxSizePerFile + uid: botframework-schema.SelectMediaActionParameters.maxSizePerFile + package: botframework-schema + summary: Max file size that can be uploaded. + fullName: maxSizePerFile + remarks: '' + isDeprecated: false + syntax: + content: 'maxSizePerFile?: number' + return: + description: '' + type: number + - name: mediaType + uid: botframework-schema.SelectMediaActionParameters.mediaType + package: botframework-schema + summary: Specifies the specific media type that should be selected + fullName: mediaType + remarks: '' + isDeprecated: false + syntax: + content: 'mediaType: MediaType' + return: + description: '' + type: + - name: supportedFileFormats + uid: botframework-schema.SelectMediaActionParameters.supportedFileFormats + package: botframework-schema + summary: File formats supported for upload. + fullName: supportedFileFormats + remarks: '' + isDeprecated: false + syntax: + content: 'supportedFileFormats?: string[]' + return: + description: '' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaCardAction.yml new file mode 100644 index 00000000..8f0dd24c --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SelectMediaCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: SelectMediaCardAction +uid: botframework-schema.SelectMediaCardAction +package: botframework-schema +summary: SharePoint `VivaAction.SelectMedia` event. +fullName: SelectMediaCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botframework-schema.SelectMediaCardAction.parameters + package: botframework-schema + summary: Parameters for the Select Media Action + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: SelectMediaActionParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.SelectMediaCardAction.type + package: botframework-schema + summary: Indicates this is a Viva Select Media button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.SelectMedia"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticAction.yml index 7949bde3..91e13c07 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticAction.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticAction.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Represents a reference to a programmatic action fullName: SemanticAction remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: Entities associated with this action fullName: entities remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'entities: [key: string]: Entity' + content: 'entities: {[propertyName: string]: Entity}' return: description: '' - type: '[key: string]\: ' + type: '{[propertyName: string]: }' - name: id uid: botframework-schema.SemanticAction.id package: botframework-schema summary: ID of this action fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -41,10 +38,9 @@ properties: summary: 'State of this action. Allowed values: ''start'', ''continue'', ''done''' fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'state: SemanticActionStateTypes | string' + content: 'state: string' return: description: '' - type: | string + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticActionStateTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticActionStateTypes.yml index b296bd6f..5ec704e9 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticActionStateTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SemanticActionStateTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'start', 'continue', 'done' fullName: SemanticActionStateTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Continue diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SetPropertyPaneConfigurationResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SetPropertyPaneConfigurationResponse.yml new file mode 100644 index 00000000..1ce12767 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SetPropertyPaneConfigurationResponse.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: SetPropertyPaneConfigurationResponse +uid: botframework-schema.SetPropertyPaneConfigurationResponse +package: botframework-schema +summary: '' +fullName: SetPropertyPaneConfigurationResponse +remarks: '' +isDeprecated: false +syntax: | + type SetPropertyPaneConfigurationResponse = + | CardViewHandleActionResponse + | NoOpHandleActionResponse diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationActionParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationActionParameters.yml new file mode 100644 index 00000000..b9fb5f84 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationActionParameters.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: ShowLocationActionParameters +uid: botframework-schema.ShowLocationActionParameters +package: botframework-schema +summary: >- + Parameters that can be supplied with the SharePoint VivaAction.ShowLocation + action. +fullName: ShowLocationActionParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: locationCoordinates + uid: botframework-schema.ShowLocationActionParameters.locationCoordinates + package: botframework-schema + summary: |- + If set, show the coordinates that were passed. + Otherwise, show the current location. + fullName: locationCoordinates + remarks: '' + isDeprecated: false + syntax: + content: 'locationCoordinates?: Location' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationCardAction.yml new file mode 100644 index 00000000..1c8d8622 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ShowLocationCardAction.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ShowLocationCardAction +uid: botframework-schema.ShowLocationCardAction +package: botframework-schema +summary: SharePoint `VivaAction.ShowLocation` event. +fullName: ShowLocationCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: parameters + uid: botframework-schema.ShowLocationCardAction.parameters + package: botframework-schema + summary: Parameters that can be supplied with the Viva Show Location action. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters?: ShowLocationActionParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.ShowLocationCardAction.type + package: botframework-schema + summary: Indicates this is a Viva show Location button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "VivaAction.ShowLocation"' + return: + description: '' + type: '""' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInCardViewParameters.yml new file mode 100644 index 00000000..377fdc77 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInCardViewParameters.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: SignInCardViewParameters +uid: botframework-schema.SignInCardViewParameters +package: botframework-schema +summary: The parameters for the sign in card view. +fullName: SignInCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botframework-schema.SignInCardViewParameters.body + package: botframework-schema + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: undefined | [CardTextComponent]' + return: + description: '' + type: undefined | [CardTextComponent] + - name: cardViewType + uid: botframework-schema.SignInCardViewParameters.cardViewType + package: botframework-schema + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "signIn"' + return: + description: '' + type: '"signIn"' + - name: footer + uid: botframework-schema.SignInCardViewParameters.footer + package: botframework-schema + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: [CardButtonComponent]' + return: + description: '' + type: '[CardButtonComponent]' + - name: header + uid: botframework-schema.SignInCardViewParameters.header + package: botframework-schema + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' +inheritedProperties: + - name: cardBar + uid: botframework-schema.SignInCardViewParameters.cardBar + package: botframework-schema + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botframework-schema.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInUrlResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInUrlResponse.yml index 28657284..ddcaebfd 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInUrlResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SignInUrlResponse.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: SignInUrlResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: signInLink remarks: '' - isPreview: false isDeprecated: false syntax: content: 'signInLink?: string' @@ -28,10 +26,21 @@ properties: summary: '' fullName: tokenExchangeResource remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenExchangeResource?: TokenExchangeResource' return: description: '' type: + - name: tokenPostResource + uid: botframework-schema.SignInUrlResponse.tokenPostResource + package: botframework-schema + summary: '' + fullName: tokenPostResource + remarks: '' + isDeprecated: false + syntax: + content: 'tokenPostResource?: TokenPostResource' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninCard.yml index 02014887..4a4dc46a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A card representing a request to sign in fullName: SigninCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,20 +14,18 @@ properties: summary: Action to use to perform signin fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: text uid: botframework-schema.SigninCard.text package: botframework-schema summary: Text for signin request fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninStateVerificationQuery.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninStateVerificationQuery.yml index 8063a1c5..8c038c16 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninStateVerificationQuery.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SigninStateVerificationQuery.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: SigninStateVerificationQuery remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: state uid: botframework-schema.SigninStateVerificationQuery.state package: botframework-schema - summary: '' + summary: The state string originally received when the fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SpeechConstants.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SpeechConstants.yml index 60f3da54..cb19a3f4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SpeechConstants.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SpeechConstants.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Defines constants that can be used in the processing of speech interactions. fullName: SpeechConstants remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -18,7 +17,6 @@ properties: that speech should not be generated. fullName: EmptySpeakTag remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static EmptySpeakTag: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/StatusCodes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/StatusCodes.yml index 15b81d89..e2d73cfc 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/StatusCodes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/StatusCodes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 fullName: StatusCodes remarks: '' -isPreview: false isDeprecated: false fields: - name: OK diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Style.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Style.yml index 1241b0b6..74b8b5b4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Style.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Style.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'compact', 'expanded' fullName: Style remarks: '' -isPreview: false isDeprecated: false syntax: | type Style = "compact" | "expanded" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardAction.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardAction.yml new file mode 100644 index 00000000..9af2c040 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardAction.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: SubmitCardAction +uid: botframework-schema.SubmitCardAction +package: botframework-schema +summary: SharePoint `Action.Submit` event. +fullName: SubmitCardAction +remarks: '' +isDeprecated: false +type: interface +properties: + - name: confirmationDialog + uid: botframework-schema.SubmitCardAction.confirmationDialog + package: botframework-schema + summary: Confirmation dialog option passed to the submit handler. + fullName: confirmationDialog + remarks: '' + isDeprecated: false + syntax: + content: 'confirmationDialog?: ConfirmationDialog' + return: + description: '' + type: + - name: parameters + uid: botframework-schema.SubmitCardAction.parameters + package: botframework-schema + summary: Parameters passed to the Submit event handler. + fullName: parameters + remarks: '' + isDeprecated: false + syntax: + content: 'parameters: SubmitCardParameters' + return: + description: '' + type: + - name: type + uid: botframework-schema.SubmitCardAction.type + package: botframework-schema + summary: Indicates this is a Submit button. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "Submit"' + return: + description: '' + type: '"Submit"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardParameters.yml new file mode 100644 index 00000000..2bcc907f --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SubmitCardParameters.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: SubmitCardParameters +uid: botframework-schema.SubmitCardParameters +package: botframework-schema +summary: Parameters for SharePoint Action.Submit card action. +fullName: SubmitCardParameters +remarks: '' +isDeprecated: false +type: interface diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SuggestedActions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SuggestedActions.yml index b271fc26..0675592e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/SuggestedActions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/SuggestedActions.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: SuggestedActions that can be performed fullName: SuggestedActions remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,13 +14,12 @@ properties: summary: Actions that can be shown to the user fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actions: CardAction[]' return: description: '' - type: '[]' + type: [] - name: to uid: botframework-schema.SuggestedActions.to package: botframework-schema @@ -32,10 +30,9 @@ properties: channelId and a subset of all recipients of the activity fullName: to remarks: '' - isPreview: false isDeprecated: false syntax: content: 'to: string[]' return: description: '' - type: 'string[]' + type: string[] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabContext.yml index 3e0460a8..08dbe20a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabContext.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: theme uid: botframework-schema.TabContext.theme package: botframework-schema - summary: '' + summary: The current user's theme. fullName: theme remarks: '' - isPreview: false isDeprecated: false syntax: content: 'theme?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabEntityContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabEntityContext.yml index b95b32de..c9e0dc62 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabEntityContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabEntityContext.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabEntityContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: tabEntityId uid: botframework-schema.TabEntityContext.tabEntityId package: botframework-schema - summary: '' + summary: The entity id of the tab. fullName: tabEntityId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tabEntityId?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabRequest.yml index 609b1644..174cb503 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabRequest.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: context uid: botframework-schema.TabRequest.context package: botframework-schema - summary: '' + summary: The current user context, i.e., the current theme. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: TabContext' @@ -25,10 +23,9 @@ properties: - name: state uid: botframework-schema.TabRequest.state package: botframework-schema - summary: '' + summary: The magic code for OAuth flow. fullName: state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'state?: string' @@ -38,10 +35,9 @@ properties: - name: tabContext uid: botframework-schema.TabRequest.tabContext package: botframework-schema - summary: '' + summary: The current tab entity request context. fullName: tabContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tabContext?: TabEntityContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponse.yml index 798f1c92..cfbb74a4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: tab uid: botframework-schema.TabResponse.tab package: botframework-schema - summary: '' + summary: The response to the tab/fetch message. fullName: tab remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tab: TabResponsePayload' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCard.yml index 8e76f3f7..f913c857 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCard.yml @@ -5,20 +5,18 @@ package: botframework-schema summary: '' fullName: TabResponseCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: card uid: botframework-schema.TabResponseCard.card package: botframework-schema - summary: '' + summary: The adaptive card for this card tab response. fullName: card remarks: '' - isPreview: false isDeprecated: false syntax: content: 'card: Record' return: description: '' - type: 'Record<string, unknown>' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCards.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCards.yml index a030903d..ee9fde6e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCards.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponseCards.yml @@ -5,20 +5,18 @@ package: botframework-schema summary: '' fullName: TabResponseCards remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: cards uid: botframework-schema.TabResponseCards.cards package: botframework-schema - summary: '' + summary: Adaptive cards for this card tab response. fullName: cards remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cards: TabResponseCard[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponsePayload.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponsePayload.yml index a07c4c32..0d2290d6 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponsePayload.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabResponsePayload.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabResponsePayload remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: suggestedActions uid: botframework-schema.TabResponsePayload.suggestedActions package: botframework-schema - summary: '' + summary: The Suggested Actions for this card tab. fullName: suggestedActions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'suggestedActions?: TabSuggestedActions' @@ -25,23 +23,21 @@ properties: - name: type uid: botframework-schema.TabResponsePayload.type package: botframework-schema - summary: '' + summary: Choice of action options when responding to the tab/fetch message. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'type?: "continue" | "auth" | "silentAuth"' + content: 'type?: "auth" | "continue" | "silentAuth"' return: description: '' - type: '"continue" | "auth" | "silentAuth"' + type: '"auth" | "continue" | "silentAuth"' - name: value uid: botframework-schema.TabResponsePayload.value package: botframework-schema - summary: '' + summary: The TabResponseCards to send when responding to fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: TabResponseCards' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmit.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmit.yml index e09cfac6..d230ff9a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmit.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmit.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabSubmit remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: context uid: botframework-schema.TabSubmit.context package: botframework-schema - summary: '' + summary: The current user context, i.e., the current theme. fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: TabContext' @@ -25,10 +23,9 @@ properties: - name: data uid: botframework-schema.TabSubmit.data package: botframework-schema - summary: '' + summary: User input. Free payload containing properties of key-value pairs. fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data?: TabSubmitData' @@ -38,10 +35,9 @@ properties: - name: tabContext uid: botframework-schema.TabSubmit.tabContext package: botframework-schema - summary: '' + summary: The current tab's entity request context. fullName: tabContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tabContext?: TabEntityContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmitData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmitData.yml index 139fea9c..edbf3850 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmitData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSubmitData.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TabSubmitData remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: type uid: botframework-schema.TabSubmitData.type package: botframework-schema - summary: '' + summary: Should currently be 'tab/submit'. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSuggestedActions.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSuggestedActions.yml index 587f7d93..e58ef4f1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSuggestedActions.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TabSuggestedActions.yml @@ -5,20 +5,18 @@ package: botframework-schema summary: '' fullName: TabSuggestedActions remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: actions uid: botframework-schema.TabSuggestedActions.actions package: botframework-schema - summary: '' + summary: Actions to show in the card response. fullName: actions remarks: '' - isPreview: false isDeprecated: false syntax: content: 'actions: CardAction[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotification.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotification.yml new file mode 100644 index 00000000..43f94890 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotification.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: TargetedMeetingNotification +uid: botframework-schema.TargetedMeetingNotification +package: botframework-schema +summary: '' +fullName: TargetedMeetingNotification +remarks: '' +isDeprecated: false +type: interface +properties: + - name: channelData + uid: botframework-schema.TargetedMeetingNotification.channelData + package: botframework-schema + summary: The channel data of the meeting notification. + fullName: channelData + remarks: '' + isDeprecated: false + syntax: + content: 'channelData?: MeetingNotificationChannelData' + return: + description: '' + type: + - name: type + uid: botframework-schema.TargetedMeetingNotification.type + package: botframework-schema + summary: The type of meeting notification. + fullName: type + remarks: '' + isDeprecated: false + syntax: + content: 'type: "targetedMeetingNotification"' + return: + description: '' + type: '"targetedMeetingNotification"' +inheritedProperties: + - name: value + uid: botframework-schema.TargetedMeetingNotification.value + package: botframework-schema + summary: '' + fullName: value + remarks: '' + isDeprecated: false + syntax: + content: 'value: TargetedMeetingNotificationValue' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [MeetingNotificationBase.value](xref:botframework-schema.MeetingNotificationBase.value) +extends: >- + <> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotificationValue.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotificationValue.yml new file mode 100644 index 00000000..817fa03d --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TargetedMeetingNotificationValue.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TargetedMeetingNotificationValue +uid: botframework-schema.TargetedMeetingNotificationValue +package: botframework-schema +summary: '' +fullName: TargetedMeetingNotificationValue +remarks: '' +isDeprecated: false +type: interface +properties: + - name: recipients + uid: botframework-schema.TargetedMeetingNotificationValue.recipients + package: botframework-schema + summary: The list of recipient meeting MRIs. + fullName: recipients + remarks: '' + isDeprecated: false + syntax: + content: 'recipients: string[]' + return: + description: '' + type: string[] + - name: surfaces + uid: botframework-schema.TargetedMeetingNotificationValue.surfaces + package: botframework-schema + summary: The List of notification surface configuration. + fullName: surfaces + remarks: '' + isDeprecated: false + syntax: + content: 'surfaces: MeetingSurface[]' + return: + description: '' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleCardResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleCardResponse.yml index 684f14ca..205e3d49 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleCardResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleCardResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleCardResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: value uid: botframework-schema.TaskModuleCardResponse.value package: botframework-schema - summary: '' + summary: JSON for Adaptive cards to appear in the tab. fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' @@ -26,10 +24,9 @@ inheritedProperties: - name: type uid: botframework-schema.TaskModuleCardResponse.type package: botframework-schema - summary: '' + summary: Choice of action options when responding to the fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: BotMessagePreviewType' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleContinueResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleContinueResponse.yml index d10316de..e3a5d12c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleContinueResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleContinueResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleContinueResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: value uid: botframework-schema.TaskModuleContinueResponse.value package: botframework-schema - summary: '' + summary: The JSON for the Adaptive card to fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: TaskModuleTaskInfo' @@ -26,10 +24,9 @@ inheritedProperties: - name: type uid: botframework-schema.TaskModuleContinueResponse.type package: botframework-schema - summary: '' + summary: Choice of action options when responding to the fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: BotMessagePreviewType' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleMessageResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleMessageResponse.yml index c67bb27e..66eab000 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleMessageResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleMessageResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleMessageResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: value uid: botframework-schema.TaskModuleMessageResponse.value package: botframework-schema - summary: '' + summary: Teams will display the value of value in a popup fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value?: string' @@ -26,10 +24,9 @@ inheritedProperties: - name: type uid: botframework-schema.TaskModuleMessageResponse.type package: botframework-schema - summary: '' + summary: Choice of action options when responding to the fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: BotMessagePreviewType' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequest.yml index 6a12eb3e..44f21828 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequest.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: context uid: botframework-schema.TaskModuleRequest.context package: botframework-schema - summary: '' + summary: Current user context, i.e., fullName: context remarks: '' - isPreview: false isDeprecated: false syntax: content: 'context?: TaskModuleRequestContext' @@ -25,10 +23,9 @@ properties: - name: data uid: botframework-schema.TaskModuleRequest.data package: botframework-schema - summary: '' + summary: User input data. Free payload with key-value pairs. fullName: data remarks: '' - isPreview: false isDeprecated: false syntax: content: 'data?: any' @@ -38,10 +35,9 @@ properties: - name: tabContext uid: botframework-schema.TaskModuleRequest.tabContext package: botframework-schema - summary: '' + summary: Tab request context. fullName: tabContext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tabContext?: TabEntityContext' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequestContext.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequestContext.yml index 033acfd4..bc5ee99a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequestContext.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleRequestContext.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: TaskModuleRequestContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: theme remarks: '' - isPreview: false isDeprecated: false syntax: content: 'theme?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponse.yml index d08bb4f7..f833fb2e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponse.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: cacheInfo uid: botframework-schema.TaskModuleResponse.cacheInfo package: botframework-schema - summary: '' + summary: The cache info for this response fullName: cacheInfo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cacheInfo?: CacheInfo' @@ -25,10 +23,9 @@ properties: - name: task uid: botframework-schema.TaskModuleResponse.task package: botframework-schema - summary: '' + summary: The JSON for the response to fullName: task remarks: '' - isPreview: false isDeprecated: false syntax: content: 'task?: TaskModuleContinueResponse | TaskModuleMessageResponse' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponseBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponseBase.yml index be0788fe..ba775c76 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponseBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleResponseBase.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleResponseBase remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: type uid: botframework-schema.TaskModuleResponseBase.type package: botframework-schema - summary: '' + summary: Choice of action options when responding to the fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: BotMessagePreviewType' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleTaskInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleTaskInfo.yml index 271889e0..ecd07615 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleTaskInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TaskModuleTaskInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TaskModuleTaskInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: card uid: botframework-schema.TaskModuleTaskInfo.card package: botframework-schema - summary: '' + summary: The JSON for the Adaptive card to appear in fullName: card remarks: '' - isPreview: false isDeprecated: false syntax: content: 'card?: Attachment' @@ -25,10 +23,9 @@ properties: - name: completionBotId uid: botframework-schema.TaskModuleTaskInfo.completionBotId package: botframework-schema - summary: '' + summary: If a client does not support the task fullName: completionBotId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'completionBotId?: string' @@ -38,10 +35,9 @@ properties: - name: fallbackUrl uid: botframework-schema.TaskModuleTaskInfo.fallbackUrl package: botframework-schema - summary: '' + summary: If a client does not support the task fullName: fallbackUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'fallbackUrl?: string' @@ -51,10 +47,9 @@ properties: - name: height uid: botframework-schema.TaskModuleTaskInfo.height package: botframework-schema - summary: '' + summary: This can be a number, representing the task fullName: height remarks: '' - isPreview: false isDeprecated: false syntax: content: 'height?: number | "small" | "medium" | "large"' @@ -64,10 +59,9 @@ properties: - name: title uid: botframework-schema.TaskModuleTaskInfo.title package: botframework-schema - summary: '' + summary: Appears below the app name and to the right of fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title?: string' @@ -77,10 +71,9 @@ properties: - name: url uid: botframework-schema.TaskModuleTaskInfo.url package: botframework-schema - summary: '' + summary: The URL of what is loaded as an iframe inside the fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url?: string' @@ -90,10 +83,9 @@ properties: - name: width uid: botframework-schema.TaskModuleTaskInfo.width package: botframework-schema - summary: '' + summary: This can be a number, representing the task module's fullName: width remarks: '' - isPreview: false isDeprecated: false syntax: content: 'width?: number | "small" | "medium" | "large"' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamDetails.yml index 7721bdca..b75784ec 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamDetails.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamDetails.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamDetails remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: aadGroupId uid: botframework-schema.TeamDetails.aadGroupId package: botframework-schema - summary: '' + summary: Azure Active Directory (AAD) Group Id for fullName: aadGroupId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aadGroupId?: string' @@ -25,10 +23,9 @@ properties: - name: channelCount uid: botframework-schema.TeamDetails.channelCount package: botframework-schema - summary: '' + summary: Count of channels in the team. fullName: channelCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelCount?: number' @@ -38,10 +35,9 @@ properties: - name: id uid: botframework-schema.TeamDetails.id package: botframework-schema - summary: '' + summary: Unique identifier representing a team fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -51,10 +47,9 @@ properties: - name: memberCount uid: botframework-schema.TeamDetails.memberCount package: botframework-schema - summary: '' + summary: Count of members in the team. fullName: memberCount remarks: '' - isPreview: false isDeprecated: false syntax: content: 'memberCount?: number' @@ -64,10 +59,9 @@ properties: - name: name uid: botframework-schema.TeamDetails.name package: botframework-schema - summary: '' + summary: Name of team. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -77,10 +71,11 @@ properties: - name: type uid: botframework-schema.TeamDetails.type package: botframework-schema - summary: '' + summary: >- + The type of the team. Valid values are standard, sharedChannel and + privateChannel. fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamInfo.yml index 198f743b..758d35c5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: aadGroupId uid: botframework-schema.TeamInfo.aadGroupId package: botframework-schema - summary: '' + summary: The Azure AD Teams group ID. fullName: aadGroupId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aadGroupId?: string' @@ -25,10 +23,9 @@ properties: - name: id uid: botframework-schema.TeamInfo.id package: botframework-schema - summary: '' + summary: Unique identifier representing a team fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -38,10 +35,9 @@ properties: - name: name uid: botframework-schema.TeamInfo.name package: botframework-schema - summary: '' + summary: Name of team. fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsAttachment.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsAttachment.yml index 9116afbd..5c5d3f32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsAttachment.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsAttachment.yml @@ -2,20 +2,18 @@ name: TeamsAttachment uid: botframework-schema.TeamsAttachment package: botframework-schema -summary: '' +summary: An attachment within an activity fullName: TeamsAttachment remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: content uid: botframework-schema.TeamsAttachment.content package: botframework-schema - summary: '' + summary: Embedded content fullName: content remarks: '' - isPreview: false isDeprecated: false syntax: content: 'content: ContentType' @@ -29,7 +27,6 @@ inheritedProperties: summary: mimetype/Contenttype for the file fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentType: string' @@ -45,7 +42,6 @@ inheritedProperties: summary: Content Url fullName: contentUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'contentUrl?: string' @@ -61,7 +57,6 @@ inheritedProperties: summary: (OPTIONAL) The name of the attachment fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -77,7 +72,6 @@ inheritedProperties: summary: (OPTIONAL) Thumbnail associated with attachment fullName: thumbnailUrl remarks: '' - isPreview: false isDeprecated: false syntax: content: 'thumbnailUrl?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelAccount.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelAccount.yml index f500fc69..014991b3 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelAccount.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelAccount.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamsChannelAccount remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: email uid: botframework-schema.TeamsChannelAccount.email package: botframework-schema - summary: '' + summary: Email Id of the user. fullName: email remarks: '' - isPreview: false isDeprecated: false syntax: content: 'email?: string' @@ -25,10 +23,9 @@ properties: - name: givenName uid: botframework-schema.TeamsChannelAccount.givenName package: botframework-schema - summary: '' + summary: Given name part of the user name. fullName: givenName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'givenName?: string' @@ -38,10 +35,9 @@ properties: - name: surname uid: botframework-schema.TeamsChannelAccount.surname package: botframework-schema - summary: '' + summary: Surname part of the user name. fullName: surname remarks: '' - isPreview: false isDeprecated: false syntax: content: 'surname?: string' @@ -51,10 +47,9 @@ properties: - name: tenantId uid: botframework-schema.TeamsChannelAccount.tenantId package: botframework-schema - summary: '' + summary: Tenant Id of the user. fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId?: string' @@ -64,10 +59,9 @@ properties: - name: userPrincipalName uid: botframework-schema.TeamsChannelAccount.userPrincipalName package: botframework-schema - summary: '' + summary: Unique user principal name. fullName: userPrincipalName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userPrincipalName?: string' @@ -77,10 +71,9 @@ properties: - name: userRole uid: botframework-schema.TeamsChannelAccount.userRole package: botframework-schema - summary: '' + summary: User Role of the user. fullName: userRole remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userRole?: string' @@ -94,7 +87,6 @@ inheritedProperties: summary: This account's object ID within Azure Active Directory (AAD) fullName: aadObjectId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aadObjectId?: string' @@ -107,14 +99,9 @@ inheritedProperties: - name: id uid: botframework-schema.TeamsChannelAccount.id package: botframework-schema - summary: >- - Channel id for the user or bot on this channel (Example: joe@smith.com, or - @joesmith or - - 123456) + summary: 'Channel id for the user or bot on this channel (Example: joe@smith.com, or' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -130,7 +117,6 @@ inheritedProperties: summary: Display friendly name fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -140,6 +126,21 @@ inheritedProperties: inheritanceDescription: >- Inherited From [ChannelAccount.name](xref:botframework-schema.ChannelAccount.name) + - name: properties + uid: botframework-schema.TeamsChannelAccount.properties + package: botframework-schema + summary: Custom properties object (optional) + fullName: properties + remarks: '' + isDeprecated: false + syntax: + content: 'properties?: any' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [ChannelAccount.properties](xref:botframework-schema.ChannelAccount.properties) - name: role uid: botframework-schema.TeamsChannelAccount.role package: botframework-schema @@ -150,13 +151,12 @@ inheritedProperties: 'user', 'bot', 'skill' fullName: role remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'role?: RoleTypes | string' + content: 'role?: string' return: description: '' - type: | string + type: string inheritanceDescription: >- Inherited From [ChannelAccount.role](xref:botframework-schema.ChannelAccount.role) diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelData.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelData.yml index e52ffbb0..84b5fe5d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelData.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelData.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamsChannelData remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: channel uid: botframework-schema.TeamsChannelData.channel package: botframework-schema - summary: '' + summary: Information about the channel in which the fullName: channel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channel?: ChannelInfo' @@ -25,10 +23,9 @@ properties: - name: eventType uid: botframework-schema.TeamsChannelData.eventType package: botframework-schema - summary: '' + summary: Type of event. fullName: eventType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventType?: string' @@ -38,10 +35,9 @@ properties: - name: meeting uid: botframework-schema.TeamsChannelData.meeting package: botframework-schema - summary: '' + summary: Information about the tenant in which the fullName: meeting remarks: '' - isPreview: false isDeprecated: false syntax: content: 'meeting?: TeamsMeetingInfo' @@ -51,23 +47,33 @@ properties: - name: notification uid: botframework-schema.TeamsChannelData.notification package: botframework-schema - summary: '' + summary: Notification settings for the fullName: notification remarks: '' - isPreview: false isDeprecated: false syntax: content: 'notification?: NotificationInfo' return: description: '' type: + - name: onBehalfOf + uid: botframework-schema.TeamsChannelData.onBehalfOf + package: botframework-schema + summary: The OnBehalfOf information of the message. + fullName: onBehalfOf + remarks: '' + isDeprecated: false + syntax: + content: 'onBehalfOf?: OnBehalfOf[]' + return: + description: '' + type: [] - name: settings uid: botframework-schema.TeamsChannelData.settings package: botframework-schema - summary: '' + summary: Information about the settings in which the fullName: settings remarks: '' - isPreview: false isDeprecated: false syntax: content: 'settings?: TeamsChannelDataSettings' @@ -77,10 +83,9 @@ properties: - name: team uid: botframework-schema.TeamsChannelData.team package: botframework-schema - summary: '' + summary: Information about the team in which the message fullName: team remarks: '' - isPreview: false isDeprecated: false syntax: content: 'team?: TeamInfo' @@ -90,10 +95,9 @@ properties: - name: tenant uid: botframework-schema.TeamsChannelData.tenant package: botframework-schema - summary: '' + summary: Information about the tenant in which the fullName: tenant remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenant?: TenantInfo' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelDataSettings.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelDataSettings.yml index 58ddc8de..75be907a 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelDataSettings.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsChannelDataSettings.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamsChannelDataSettings remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: selectedChannel uid: botframework-schema.TeamsChannelDataSettings.selectedChannel package: botframework-schema - summary: '' + summary: Information about the selected Teams channel. fullName: selectedChannel remarks: '' - isPreview: false isDeprecated: false syntax: content: 'selectedChannel?: ChannelInfo' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingInfo.yml index 4f0fb035..5e18027c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamsMeetingInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: id uid: botframework-schema.TeamsMeetingInfo.id package: botframework-schema - summary: '' + summary: Unique identifier representing a meeting fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingMember.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingMember.yml new file mode 100644 index 00000000..a87451b7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingMember.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: TeamsMeetingMember +uid: botframework-schema.TeamsMeetingMember +package: botframework-schema +summary: '' +fullName: TeamsMeetingMember +remarks: '' +isDeprecated: false +type: interface +properties: + - name: meeting + uid: botframework-schema.TeamsMeetingMember.meeting + package: botframework-schema + summary: The participants info. + fullName: meeting + remarks: '' + isDeprecated: false + syntax: + content: 'meeting: UserMeetingDetails' + return: + description: '' + type: + - name: user + uid: botframework-schema.TeamsMeetingMember.user + package: botframework-schema + summary: The participant account. + fullName: user + remarks: '' + isDeprecated: false + syntax: + content: 'user: TeamsChannelAccount' + return: + description: '' + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingParticipant.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingParticipant.yml index 610ca084..1da5600d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingParticipant.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMeetingParticipant.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TeamsMeetingParticipant remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: conversation uid: botframework-schema.TeamsMeetingParticipant.conversation package: botframework-schema - summary: '' + summary: The conversation account for the meeting. fullName: conversation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'conversation?: ConversationAccount' @@ -25,10 +23,9 @@ properties: - name: meeting uid: botframework-schema.TeamsMeetingParticipant.meeting package: botframework-schema - summary: '' + summary: The meeting details. fullName: meeting remarks: '' - isPreview: false isDeprecated: false syntax: content: 'meeting?: Meeting' @@ -38,10 +35,9 @@ properties: - name: user uid: botframework-schema.TeamsMeetingParticipant.user package: botframework-schema - summary: '' + summary: The user details fullName: user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'user?: TeamsChannelAccount' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMember.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMember.yml new file mode 100644 index 00000000..4725443b --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsMember.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: TeamsMember +uid: botframework-schema.TeamsMember +package: botframework-schema +summary: '' +fullName: TeamsMember +remarks: '' +isDeprecated: false +syntax: | + type TeamsMember = { id: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsPagedMembersResult.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsPagedMembersResult.yml index 928de4c5..d499c09b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsPagedMembersResult.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TeamsPagedMembersResult.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: TeamsPagedMembersResult remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Paging token fullName: continuationToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'continuationToken: string' @@ -28,10 +26,9 @@ properties: summary: The Channel Accounts. fullName: members remarks: '' - isPreview: false isDeprecated: false syntax: content: 'members: TeamsChannelAccount[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TenantInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TenantInfo.yml index f974b595..42670424 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TenantInfo.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TenantInfo.yml @@ -5,17 +5,15 @@ package: botframework-schema summary: '' fullName: TenantInfo remarks: '' -isPreview: false isDeprecated: false type: interface properties: - name: id uid: botframework-schema.TenantInfo.id package: botframework-schema - summary: '' + summary: Unique identifier representing a tenant fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextCardViewParameters.yml new file mode 100644 index 00000000..9e4671dc --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextCardViewParameters.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: TextCardViewParameters +uid: botframework-schema.TextCardViewParameters +package: botframework-schema +summary: The parameters for the card view with text or empty body. +fullName: TextCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botframework-schema.TextCardViewParameters.body + package: botframework-schema + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: undefined | [CardTextComponent]' + return: + description: '' + type: undefined | [CardTextComponent] + - name: cardViewType + uid: botframework-schema.TextCardViewParameters.cardViewType + package: botframework-schema + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "text"' + return: + description: '' + type: '"text"' + - name: footer + uid: botframework-schema.TextCardViewParameters.footer + package: botframework-schema + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: CardViewFooterParameters' + return: + description: '' + type: + - name: header + uid: botframework-schema.TextCardViewParameters.header + package: botframework-schema + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' + - name: image + uid: botframework-schema.TextCardViewParameters.image + package: botframework-schema + summary: Image displayed on the card. + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: cardBar + uid: botframework-schema.TextCardViewParameters.cardBar + package: botframework-schema + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botframework-schema.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextFormatTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextFormatTypes.yml index 9bb944a7..127d6616 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextFormatTypes.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextFormatTypes.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'markdown', 'plain', 'xml' fullName: TextFormatTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Markdown diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextHighlight.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextHighlight.yml index 84471220..7f32e479 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextHighlight.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextHighlight.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Refers to a substring of content within another field fullName: TextHighlight remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: exist. fullName: occurrence remarks: '' - isPreview: false isDeprecated: false syntax: content: 'occurrence: number' @@ -30,7 +28,6 @@ properties: summary: Defines the snippet of text to highlight fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextInputCardViewParameters.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextInputCardViewParameters.yml new file mode 100644 index 00000000..d350c9f8 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TextInputCardViewParameters.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: TextInputCardViewParameters +uid: botframework-schema.TextInputCardViewParameters +package: botframework-schema +summary: The parameters for the card view with text input in the body. +fullName: TextInputCardViewParameters +remarks: '' +isDeprecated: false +type: interface +properties: + - name: body + uid: botframework-schema.TextInputCardViewParameters.body + package: botframework-schema + summary: Body area components. + fullName: body + remarks: '' + isDeprecated: false + syntax: + content: 'body: [CardTextInputComponent]' + return: + description: '' + type: '[CardTextInputComponent]' + - name: cardViewType + uid: botframework-schema.TextInputCardViewParameters.cardViewType + package: botframework-schema + summary: Card View type + fullName: cardViewType + remarks: '' + isDeprecated: false + syntax: + content: 'cardViewType: "textInput"' + return: + description: '' + type: '"textInput"' + - name: footer + uid: botframework-schema.TextInputCardViewParameters.footer + package: botframework-schema + summary: Footer area components. + fullName: footer + remarks: '' + isDeprecated: false + syntax: + content: 'footer?: CardViewActionsFooterParameters' + return: + description: '' + type: + - name: header + uid: botframework-schema.TextInputCardViewParameters.header + package: botframework-schema + summary: Header area components. + fullName: header + remarks: '' + isDeprecated: false + syntax: + content: 'header: [CardTextComponent]' + return: + description: '' + type: '[CardTextComponent]' + - name: image + uid: botframework-schema.TextInputCardViewParameters.image + package: botframework-schema + summary: Image displayed on the card. + fullName: image + remarks: '' + isDeprecated: false + syntax: + content: 'image?: CardImage' + return: + description: '' + type: CardImage +inheritedProperties: + - name: cardBar + uid: botframework-schema.TextInputCardViewParameters.cardBar + package: botframework-schema + summary: Card view title area (card bar) components. + fullName: cardBar + remarks: '' + isDeprecated: false + syntax: + content: 'cardBar: [CardBarComponent]' + return: + description: '' + type: '[CardBarComponent]' + inheritanceDescription: >- + Inherited From + [BaseCardViewParameters.cardBar](xref:botframework-schema.BaseCardViewParameters.cardBar) +extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Thing.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Thing.yml index b60a238f..8eb46a64 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Thing.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Thing.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: 'Thing (entity type: "https://schema.org/Thing")' fullName: Thing remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The name of the thing fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -28,7 +26,6 @@ properties: summary: The type of the thing fullName: type remarks: '' - isPreview: false isDeprecated: false syntax: content: 'type: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailCard.yml index 297cd5f7..f927b5e8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailCard.yml @@ -2,10 +2,9 @@ name: ThumbnailCard uid: botframework-schema.ThumbnailCard package: botframework-schema -summary: 'A thumbnail card (card with a single, small thumbnail image)' +summary: A thumbnail card (card with a single, small thumbnail image) fullName: ThumbnailCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,33 +14,30 @@ properties: summary: Set of actions applicable to the current card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: images uid: botframework-schema.ThumbnailCard.images package: botframework-schema summary: Array of images for the card fullName: images remarks: '' - isPreview: false isDeprecated: false syntax: content: 'images: CardImage[]' return: description: '' - type: '[]' + type: [] - name: subtitle uid: botframework-schema.ThumbnailCard.subtitle package: botframework-schema summary: Subtitle of the card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -54,7 +50,6 @@ properties: summary: This action will be activated when user taps on the card itself fullName: tap remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tap: CardAction' @@ -67,7 +62,6 @@ properties: summary: Text for the card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -80,7 +74,6 @@ properties: summary: Title of the card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailUrl.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailUrl.yml index d67749fd..da8c5cf2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailUrl.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ThumbnailUrl.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Thumbnail URL fullName: ThumbnailUrl remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: HTML alt text to include on this thumbnail image fullName: alt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alt: string' @@ -28,7 +26,6 @@ properties: summary: URL pointing to the thumbnail to use for media content fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeRequest.yml index f1014649..e555defb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeRequest.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A request to exchange a token. fullName: TokenExchangeInvokeRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The connection name. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: string' @@ -28,7 +26,6 @@ properties: summary: The id from the OAuthCard. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -41,7 +38,6 @@ properties: summary: The user token that can be exchanged. fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: content: 'token: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeResponse.yml index 923ca629..ab556e32 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeInvokeResponse.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: The response object of a token exchange invoke. fullName: TokenExchangeInvokeResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The connection name. fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: string' @@ -28,7 +26,6 @@ properties: summary: The details of why the token exchange failed. fullName: failureDetail remarks: '' - isPreview: false isDeprecated: false syntax: content: 'failureDetail: string' @@ -41,7 +38,6 @@ properties: summary: The id from the OAuthCard. fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -54,10 +50,9 @@ properties: summary: Extension data for overflow of properties. fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'properties?: Record' return: description: '' - type: 'Record<string, unknown>' + type: Record<string, unknown> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeRequest.yml index 93bf6168..15f1b345 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeRequest.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: TokenExchangeRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: content: 'token?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: uri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uri?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeResource.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeResource.yml index 0ad3e425..cc3470fa 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeResource.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeResource.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: TokenExchangeResource remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: providerId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'providerId?: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: uri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'uri?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeState.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeState.yml index 3a9bc726..b831c1c5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeState.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenExchangeState.yml @@ -5,12 +5,11 @@ package: botframework-schema summary: State object passed to the bot token service. fullName: TokenExchangeState remarks: '' -isPreview: false isDeprecated: false syntax: | type TokenExchangeState = { - connectionName: string, - conversation: ConversationReference, - msAppId: string, - relatesTo: ConversationReference, + connectionName: string + conversation: ConversationReference + msAppId: string + relatesTo: ConversationReference } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenPostResource.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenPostResource.yml new file mode 100644 index 00000000..4fd3377a --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenPostResource.yml @@ -0,0 +1,22 @@ +### YamlMime:TSType +name: TokenPostResource +uid: botframework-schema.TokenPostResource +package: botframework-schema +summary: '' +fullName: TokenPostResource +remarks: '' +isDeprecated: false +type: interface +properties: + - name: sasUrl + uid: botframework-schema.TokenPostResource.sasUrl + package: botframework-schema + summary: '' + fullName: sasUrl + remarks: '' + isDeprecated: false + syntax: + content: 'sasUrl?: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenRequest.yml index 0bab45ea..c77a8f10 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenRequest.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A request to receive a user token fullName: TokenRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: The provider to request a user token from fullName: provider remarks: '' - isPreview: false isDeprecated: false syntax: content: 'provider: string' @@ -28,10 +26,9 @@ properties: summary: A collection of settings for the specific provider for this request fullName: settings remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'settings: [key: string]: any' + content: 'settings: {[propertyName: string]: any}' return: description: '' - type: '[key: string]\: any' + type: '{[propertyName: string]: any}' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenResponse.yml index 9c9c4717..8ab6ae45 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenResponse.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: A response that includes a user token fullName: TokenResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: channelId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'channelId?: string' @@ -28,7 +26,6 @@ properties: summary: The connection name fullName: connectionName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionName: string' @@ -38,10 +35,9 @@ properties: - name: expiration uid: botframework-schema.TokenResponse.expiration package: botframework-schema - summary: 'Expiration for the token, in ISO 8601 format (e.g. "2007-04-05T14:30Z")' + summary: Expiration for the token, in ISO 8601 format (e.g. "2007-04-05T14:30Z") fullName: expiration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiration: string' @@ -56,20 +52,18 @@ properties: parameters fullName: properties remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'properties?: [key: string]: any' + content: 'properties?: {[propertyName: string]: any}' return: description: '' - type: '[key: string]\: any' + type: '{[propertyName: string]: any}' - name: token uid: botframework-schema.TokenResponse.token package: botframework-schema summary: The user token fullName: token remarks: '' - isPreview: false isDeprecated: false syntax: content: 'token: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenStatus.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenStatus.yml index 54458a04..f4dce9c8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenStatus.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/TokenStatus.yml @@ -5,12 +5,11 @@ package: botframework-schema summary: The status of a particular token. fullName: TokenStatus remarks: '' -isPreview: false isDeprecated: false syntax: | type TokenStatus = { - channelId: string, - connectionName: string, - hasToken: boolean, - serviceProviderDisplayName: string, + channelId: string + connectionName: string + hasToken: boolean + serviceProviderDisplayName: string } diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Transcript.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Transcript.yml index 76767ea0..f0f67d47 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Transcript.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Transcript.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Transcript fullName: Transcript remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,10 +14,9 @@ properties: summary: A collection of Activities that conforms to the Transcript schema. fullName: activities remarks: '' - isPreview: false isDeprecated: false syntax: content: 'activities: Activity[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type.yml index 980b4104..c6b4bb92 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type.yml @@ -7,7 +7,6 @@ summary: |- Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' fullName: Type remarks: '' -isPreview: false isDeprecated: false syntax: | type Type = "ViewAction" | "OpenUri" | "HttpPOST" | "ActionCard" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type1.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type1.yml index fd0c97a2..070fd252 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type1.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type1.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: Type1 remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Use O365ConnectorCardInputBaseType instead. syntax: | diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type2.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type2.yml index c63206ed..f9f3130b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type2.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type2.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: Type2 remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Use BotMessagePreviewType syntax: | diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type3.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type3.yml index 14f4287c..d6b69e30 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type3.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/Type3.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: '' fullName: Type3 remarks: '' -isPreview: false isDeprecated: true customDeprecatedMessage: Use MessagingExtensionResultType instead syntax: | diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserIdentityType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserIdentityType.yml index a81dd37f..c704f4e7 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserIdentityType.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserIdentityType.yml @@ -9,7 +9,6 @@ summary: >- 'federatedUser' fullName: UserIdentityType remarks: '' -isPreview: false isDeprecated: false syntax: | type UserIdentityType = diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserMeetingDetails.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserMeetingDetails.yml new file mode 100644 index 00000000..d4138015 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/UserMeetingDetails.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: UserMeetingDetails +uid: botframework-schema.UserMeetingDetails +package: botframework-schema +summary: '' +fullName: UserMeetingDetails +remarks: '' +isDeprecated: false +type: interface +properties: + - name: inMeeting + uid: botframework-schema.UserMeetingDetails.inMeeting + package: botframework-schema + summary: The user in meeting indicator. + fullName: inMeeting + remarks: '' + isDeprecated: false + syntax: + content: 'inMeeting: boolean' + return: + description: '' + type: boolean + - name: role + uid: botframework-schema.UserMeetingDetails.role + package: botframework-schema + summary: The user's role. + fullName: role + remarks: '' + isDeprecated: false + syntax: + content: 'role: string' + return: + description: '' + type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/VideoCard.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/VideoCard.yml index b0466062..63cc33b8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/VideoCard.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/VideoCard.yml @@ -5,7 +5,6 @@ package: botframework-schema summary: Video card fullName: VideoCard remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -17,7 +16,6 @@ properties: "4:3" fullName: aspect remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aspect: string' @@ -27,10 +25,9 @@ properties: - name: autoloop uid: botframework-schema.VideoCard.autoloop package: botframework-schema - summary: 'Should the client loop playback at end of content (default:true)' + summary: Should the client loop playback at end of content (default:true) fullName: autoloop remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autoloop: boolean' @@ -45,7 +42,6 @@ properties: (default:true) fullName: autostart remarks: '' - isPreview: false isDeprecated: false syntax: content: 'autostart: boolean' @@ -58,13 +54,12 @@ properties: summary: Actions on this card fullName: buttons remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buttons: CardAction[]' return: description: '' - type: '[]' + type: [] - name: duration uid: botframework-schema.VideoCard.duration package: botframework-schema @@ -75,7 +70,6 @@ properties: Formatted as an ISO 8601 Duration field. fullName: duration remarks: '' - isPreview: false isDeprecated: false syntax: content: 'duration: string' @@ -88,7 +82,6 @@ properties: summary: Thumbnail placeholder fullName: image remarks: '' - isPreview: false isDeprecated: false syntax: content: 'image: ThumbnailUrl' @@ -105,20 +98,18 @@ properties: alternative format of the same content. fullName: media remarks: '' - isPreview: false isDeprecated: false syntax: content: 'media: MediaUrl[]' return: description: '' - type: '[]' + type: [] - name: shareable uid: botframework-schema.VideoCard.shareable package: botframework-schema - summary: 'This content may be shared with others (default:true)' + summary: This content may be shared with others (default:true) fullName: shareable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'shareable: boolean' @@ -131,7 +122,6 @@ properties: summary: Subtitle of this card fullName: subtitle remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subtitle: string' @@ -144,7 +134,6 @@ properties: summary: Text of this card fullName: text remarks: '' - isPreview: false isDeprecated: false syntax: content: 'text: string' @@ -157,7 +146,6 @@ properties: summary: Title of this card fullName: title remarks: '' - isPreview: false isDeprecated: false syntax: content: 'title: string' @@ -170,7 +158,6 @@ properties: summary: Supplementary parameter for this card fullName: value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'value: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/ViewResponseType.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ViewResponseType.yml new file mode 100644 index 00000000..e17e40a7 --- /dev/null +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/ViewResponseType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ViewResponseType +uid: botframework-schema.ViewResponseType +package: botframework-schema +summary: The type of the view in the handle action response. +fullName: ViewResponseType +remarks: '' +isDeprecated: false +syntax: | + type ViewResponseType = "Card" | "QuickView" | "NoOp" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-schema/index.yml b/botbuilder-typescript/docs-ref-autogen/botframework-schema/index.yml index b38fc578..54e4ade0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-schema/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-schema/index.yml @@ -3,23 +3,33 @@ uid: botframework-schema name: botframework-schema summary: '' type: package +enums: + - botframework-schema.ActionTypes + - botframework-schema.ActivityEventNames + - botframework-schema.ActivityImportance + - botframework-schema.ActivityTypes + - botframework-schema.AttachmentLayoutTypes + - botframework-schema.Channels + - botframework-schema.ContactRelationUpdateActionTypes + - botframework-schema.DeliveryModes + - botframework-schema.DropDownOptionType + - botframework-schema.EndOfConversationCodes + - botframework-schema.FieldType + - botframework-schema.InputHints + - botframework-schema.InstallationUpdateActionTypes + - botframework-schema.MediaType + - botframework-schema.MessageReactionTypes + - botframework-schema.PopupWindowPosition + - botframework-schema.RoleTypes + - botframework-schema.SemanticActionStateTypes + - botframework-schema.StatusCodes + - botframework-schema.TextFormatTypes +classes: + - botframework-schema.CallerIdConstants + - botframework-schema.SpeechConstants interfaces: - - botframework-schema.CommandResultValue - - botframework-schema.CommandValue - - botframework-schema.IActivity - - botframework-schema.ICommandActivity - - botframework-schema.ICommandResultActivity - - botframework-schema.IContactRelationUpdateActivity - - botframework-schema.IConversationUpdateActivity - - botframework-schema.IEndOfConversationActivity - - botframework-schema.IEventActivity - - botframework-schema.IInstallationUpdateActivity - - botframework-schema.IInvokeActivity - - botframework-schema.IMessageActivity - - botframework-schema.IMessageReactionActivity - - botframework-schema.IMessageUpdateActivity - - botframework-schema.ISuggestionActivity - - botframework-schema.ITraceActivity + - botframework-schema.AceData + - botframework-schema.AceRequest - botframework-schema.Activity - botframework-schema.ActivityTimestamps - botframework-schema.AdaptiveCardAuthentication @@ -27,16 +37,42 @@ interfaces: - botframework-schema.AdaptiveCardInvokeResponse - botframework-schema.AdaptiveCardInvokeValue - botframework-schema.AnimationCard + - botframework-schema.AppBasedLinkQuery - botframework-schema.Attachment - botframework-schema.AttachmentData - botframework-schema.AttachmentInfo - botframework-schema.AttachmentView - botframework-schema.AudioCard + - botframework-schema.BaseCardComponent + - botframework-schema.BaseCardViewParameters + - botframework-schema.BaseHandleActionResponse - botframework-schema.BasicCard + - botframework-schema.BatchFailedEntriesResponse + - botframework-schema.BatchFailedEntry + - botframework-schema.BatchOperationRequest + - botframework-schema.BatchOperationResponse + - botframework-schema.BatchOperationStateResponse + - botframework-schema.BotConfigAuth + - botframework-schema.CacheInfo - botframework-schema.CardAction + - botframework-schema.CardBarComponent + - botframework-schema.CardButtonBase + - botframework-schema.CardButtonComponent - botframework-schema.CardImage + - botframework-schema.CardSearchBoxComponent + - botframework-schema.CardSearchFooterComponent + - botframework-schema.CardTextComponent + - botframework-schema.CardTextInputComponent + - botframework-schema.CardViewHandleActionResponse + - botframework-schema.CardViewResponse - botframework-schema.ChannelAccount + - botframework-schema.ChannelInfo + - botframework-schema.CommandResultValue + - botframework-schema.CommandValue + - botframework-schema.ConfigResponse + - botframework-schema.ConfirmationDialog - botframework-schema.ConversationAccount + - botframework-schema.ConversationList - botframework-schema.ConversationMembers - botframework-schema.ConversationParameters - botframework-schema.ConversationReference @@ -45,84 +81,71 @@ interfaces: - botframework-schema.Entity - botframework-schema.ErrorModel - botframework-schema.ErrorResponse + - botframework-schema.ExecuteCardAction + - botframework-schema.ExecuteCardParameters - botframework-schema.ExpectedReplies + - botframework-schema.ExternalLinkActionParameters + - botframework-schema.ExternalLinkCardAction - botframework-schema.Fact + - botframework-schema.FileConsentCard + - botframework-schema.FileConsentCardResponse + - botframework-schema.FileDownloadInfo + - botframework-schema.FileInfoCard + - botframework-schema.FileUploadInfo + - botframework-schema.FocusParameters - botframework-schema.GeoCoordinates + - botframework-schema.GetLocationActionParameters + - botframework-schema.GetLocationCardAction + - botframework-schema.GetPropertyPaneConfigurationResponse - botframework-schema.HeroCard + - botframework-schema.IActivity + - botframework-schema.ICardSearchBoxButton + - botframework-schema.ICardTextInputIconButton + - botframework-schema.ICardTextInputTitleButton + - botframework-schema.ICommandActivity + - botframework-schema.ICommandResultActivity + - botframework-schema.IContactRelationUpdateActivity + - botframework-schema.IConversationUpdateActivity + - botframework-schema.IEndOfConversationActivity + - botframework-schema.IEventActivity + - botframework-schema.IInstallationUpdateActivity + - botframework-schema.IInvokeActivity + - botframework-schema.IMessageActivity + - botframework-schema.IMessageReactionActivity + - botframework-schema.IMessageUpdateActivity - botframework-schema.IStatusCodeError + - botframework-schema.ISuggestionActivity + - botframework-schema.ITraceActivity - botframework-schema.InnerHttpError - botframework-schema.InvokeResponse + - botframework-schema.Location - botframework-schema.MediaCard - botframework-schema.MediaEventValue - botframework-schema.MediaUrl - - botframework-schema.Mention - - botframework-schema.MessageReaction - - botframework-schema.MicrosoftPayMethodData - - botframework-schema.OAuthCard - - botframework-schema.PagedMembersResult - - botframework-schema.PaymentAddress - - botframework-schema.PaymentCurrencyAmount - - botframework-schema.PaymentDetails - - botframework-schema.PaymentDetailsModifier - - botframework-schema.PaymentItem - - botframework-schema.PaymentMethodData - - botframework-schema.PaymentOptions - - botframework-schema.PaymentRequest - - botframework-schema.PaymentRequestComplete - - botframework-schema.PaymentRequestCompleteResult - - botframework-schema.PaymentRequestUpdate - - botframework-schema.PaymentRequestUpdateResult - - botframework-schema.PaymentResponse - - botframework-schema.PaymentShippingOption - - botframework-schema.Place - - botframework-schema.ReceiptCard - - botframework-schema.ReceiptItem - - botframework-schema.ResourceResponse - - botframework-schema.SearchInvokeOptions - - botframework-schema.SearchInvokeResponse - - botframework-schema.SearchInvokeValue - - botframework-schema.SemanticAction - - botframework-schema.SignInUrlResponse - - botframework-schema.SigninCard - - botframework-schema.SuggestedActions - - botframework-schema.TextHighlight - - botframework-schema.Thing - - botframework-schema.ThumbnailCard - - botframework-schema.ThumbnailUrl - - botframework-schema.TokenExchangeRequest - - botframework-schema.TokenExchangeResource - - botframework-schema.TokenRequest - - botframework-schema.TokenResponse - - botframework-schema.Transcript - - botframework-schema.VideoCard - - botframework-schema.MessageActionsPayloadBody - - botframework-schema.O365ConnectorCardActionBase - - botframework-schema.O365ConnectorCardInputBase - - botframework-schema.TeamsAttachment - - botframework-schema.AppBasedLinkQuery - - botframework-schema.CacheInfo - - botframework-schema.ChannelInfo - - botframework-schema.ConversationList - - botframework-schema.FileConsentCard - - botframework-schema.FileConsentCardResponse - - botframework-schema.FileDownloadInfo - - botframework-schema.FileInfoCard - - botframework-schema.FileUploadInfo - botframework-schema.Meeting - botframework-schema.MeetingDetails - - botframework-schema.MeetingDetailsBase - botframework-schema.MeetingEndEventDetails - botframework-schema.MeetingEventDetails - botframework-schema.MeetingInfo + - botframework-schema.MeetingNotificationBase + - botframework-schema.MeetingNotificationChannelData + - botframework-schema.MeetingNotificationRecipientFailureInfo + - botframework-schema.MeetingNotificationResponse + - botframework-schema.MeetingParticipantsEventDetails + - botframework-schema.MeetingStageSurface - botframework-schema.MeetingStartEventDetails + - botframework-schema.MeetingTabIconSurface + - botframework-schema.Mention - botframework-schema.MessageActionsPayload - botframework-schema.MessageActionsPayloadApp - botframework-schema.MessageActionsPayloadAttachment + - botframework-schema.MessageActionsPayloadBody - botframework-schema.MessageActionsPayloadConversation - botframework-schema.MessageActionsPayloadFrom - botframework-schema.MessageActionsPayloadMention - botframework-schema.MessageActionsPayloadReaction - botframework-schema.MessageActionsPayloadUser + - botframework-schema.MessageReaction - botframework-schema.MessagingExtensionAction - botframework-schema.MessagingExtensionActionResponse - botframework-schema.MessagingExtensionAttachment @@ -132,14 +155,18 @@ interfaces: - botframework-schema.MessagingExtensionResponse - botframework-schema.MessagingExtensionResult - botframework-schema.MessagingExtensionSuggestedAction + - botframework-schema.MicrosoftPayMethodData + - botframework-schema.NoOpHandleActionResponse - botframework-schema.NotificationInfo - botframework-schema.O365ConnectorCard + - botframework-schema.O365ConnectorCardActionBase - botframework-schema.O365ConnectorCardActionCard - botframework-schema.O365ConnectorCardActionQuery - botframework-schema.O365ConnectorCardDateInput - botframework-schema.O365ConnectorCardFact - botframework-schema.O365ConnectorCardHttpPOST - botframework-schema.O365ConnectorCardImage + - botframework-schema.O365ConnectorCardInputBase - botframework-schema.O365ConnectorCardMultichoiceInput - botframework-schema.O365ConnectorCardMultichoiceInputChoice - botframework-schema.O365ConnectorCardOpenUri @@ -147,7 +174,67 @@ interfaces: - botframework-schema.O365ConnectorCardSection - botframework-schema.O365ConnectorCardTextInput - botframework-schema.O365ConnectorCardViewAction + - botframework-schema.OAuthCard + - botframework-schema.OnBehalfOf + - botframework-schema.PagedMembersResult + - botframework-schema.PaymentAddress + - botframework-schema.PaymentCurrencyAmount + - botframework-schema.PaymentDetails + - botframework-schema.PaymentDetailsModifier + - botframework-schema.PaymentItem + - botframework-schema.PaymentMethodData + - botframework-schema.PaymentOptions + - botframework-schema.PaymentRequest + - botframework-schema.PaymentRequestComplete + - botframework-schema.PaymentRequestCompleteResult + - botframework-schema.PaymentRequestUpdate + - botframework-schema.PaymentRequestUpdateResult + - botframework-schema.PaymentResponse + - botframework-schema.PaymentShippingOption + - botframework-schema.Place + - botframework-schema.PropertyPaneCheckboxProperties + - botframework-schema.PropertyPaneChoiceGroupIconProperties + - botframework-schema.PropertyPaneChoiceGroupImageSize + - botframework-schema.PropertyPaneChoiceGroupOption + - botframework-schema.PropertyPaneChoiceGroupProperties + - botframework-schema.PropertyPaneDropDownOption + - botframework-schema.PropertyPaneDropDownProperties + - botframework-schema.PropertyPaneFieldProperties + - botframework-schema.PropertyPaneGroup + - botframework-schema.PropertyPaneGroupField + - botframework-schema.PropertyPaneGroupOrConditionalGroup + - botframework-schema.PropertyPaneLabelProperties + - botframework-schema.PropertyPaneLinkPopupWindowProperties + - botframework-schema.PropertyPaneLinkProperties + - botframework-schema.PropertyPanePage + - botframework-schema.PropertyPanePageHeader + - botframework-schema.PropertyPaneSliderProperties + - botframework-schema.PropertyPaneTextFieldProperties + - botframework-schema.PropertyPaneToggleProperties + - botframework-schema.QuickViewCardAction + - botframework-schema.QuickViewData + - botframework-schema.QuickViewHandleActionResponse + - botframework-schema.QuickViewParameters + - botframework-schema.QuickViewResponse + - botframework-schema.ReceiptCard + - botframework-schema.ReceiptItem + - botframework-schema.ResourceResponse + - botframework-schema.SearchCardViewParameters + - botframework-schema.SearchInvokeOptions + - botframework-schema.SearchInvokeResponse + - botframework-schema.SearchInvokeValue + - botframework-schema.SelectMediaActionParameters + - botframework-schema.SelectMediaCardAction + - botframework-schema.SemanticAction + - botframework-schema.ShowLocationActionParameters + - botframework-schema.ShowLocationCardAction + - botframework-schema.SignInCardViewParameters + - botframework-schema.SignInUrlResponse + - botframework-schema.SigninCard - botframework-schema.SigninStateVerificationQuery + - botframework-schema.SubmitCardAction + - botframework-schema.SubmitCardParameters + - botframework-schema.SuggestedActions - botframework-schema.TabContext - botframework-schema.TabEntityContext - botframework-schema.TabRequest @@ -158,6 +245,8 @@ interfaces: - botframework-schema.TabSubmit - botframework-schema.TabSubmitData - botframework-schema.TabSuggestedActions + - botframework-schema.TargetedMeetingNotification + - botframework-schema.TargetedMeetingNotificationValue - botframework-schema.TaskModuleCardResponse - botframework-schema.TaskModuleContinueResponse - botframework-schema.TaskModuleMessageResponse @@ -168,487 +257,310 @@ interfaces: - botframework-schema.TaskModuleTaskInfo - botframework-schema.TeamDetails - botframework-schema.TeamInfo + - botframework-schema.TeamsAttachment - botframework-schema.TeamsChannelAccount - botframework-schema.TeamsChannelData - botframework-schema.TeamsChannelDataSettings - botframework-schema.TeamsMeetingInfo + - botframework-schema.TeamsMeetingMember - botframework-schema.TeamsMeetingParticipant - botframework-schema.TeamsPagedMembersResult - botframework-schema.TenantInfo + - botframework-schema.TextCardViewParameters + - botframework-schema.TextHighlight + - botframework-schema.TextInputCardViewParameters + - botframework-schema.Thing + - botframework-schema.ThumbnailCard + - botframework-schema.ThumbnailUrl - botframework-schema.TokenExchangeInvokeRequest - botframework-schema.TokenExchangeInvokeResponse + - botframework-schema.TokenExchangeRequest + - botframework-schema.TokenExchangeResource + - botframework-schema.TokenPostResource + - botframework-schema.TokenRequest + - botframework-schema.TokenResponse + - botframework-schema.Transcript + - botframework-schema.UserMeetingDetails + - botframework-schema.VideoCard typeAliases: - - botframework-schema.IHandoffActivity - - botframework-schema.IMessageDeleteActivity - - botframework-schema.ITypingActivity - - botframework-schema.TokenExchangeState - - botframework-schema.TokenStatus - - botframework-schema.FileDownloadInfoAttachment - - botframework-schema.O365ConnectorCardActionType - - botframework-schema.O365ConnectorCardInputType + - botframework-schema.AceCardSize - botframework-schema.Action - botframework-schema.ActivityImageType - botframework-schema.ApplicationIdentityType - botframework-schema.AttachmentLayout + - botframework-schema.BotConfigAuthType - botframework-schema.BotMessagePreviewActionType - botframework-schema.BotMessagePreviewType + - botframework-schema.CardComponentName + - botframework-schema.CardViewActionsFooterParameters + - botframework-schema.CardViewFooterParameters + - botframework-schema.CardViewParameters - botframework-schema.CommandContext + - botframework-schema.ConfigResponseConfig - botframework-schema.ContentType - botframework-schema.ConversationIdentityType + - botframework-schema.FileDownloadInfoAttachment + - botframework-schema.HandleActionResponse + - botframework-schema.IHandoffActivity + - botframework-schema.IMessageDeleteActivity + - botframework-schema.ITypingActivity - botframework-schema.Importance + - botframework-schema.MeetingNotification + - botframework-schema.MeetingSurface - botframework-schema.MessageType - botframework-schema.MessagingExtensionResultType + - botframework-schema.O365ConnectorCardActionType - botframework-schema.O365ConnectorCardInputBaseType + - botframework-schema.O365ConnectorCardInputType + - botframework-schema.OnCardSelectionAction - botframework-schema.Os - botframework-schema.ReactionType + - botframework-schema.SetPropertyPaneConfigurationResponse - botframework-schema.Style + - botframework-schema.TeamsMember + - botframework-schema.TokenExchangeState + - botframework-schema.TokenStatus - botframework-schema.Type - botframework-schema.Type1 - botframework-schema.Type2 - botframework-schema.Type3 - botframework-schema.UserIdentityType -classes: - - botframework-schema.CallerIdConstants - - botframework-schema.SpeechConstants -enums: - - botframework-schema.ActionTypes - - botframework-schema.ActivityEventNames - - botframework-schema.ActivityImportance - - botframework-schema.ActivityTypes - - botframework-schema.AttachmentLayoutTypes - - botframework-schema.Channels - - botframework-schema.ContactRelationUpdateActionTypes - - botframework-schema.DeliveryModes - - botframework-schema.EndOfConversationCodes - - botframework-schema.InputHints - - botframework-schema.InstallationUpdateActionTypes - - botframework-schema.MessageReactionTypes - - botframework-schema.RoleTypes - - botframework-schema.SemanticActionStateTypes - - botframework-schema.StatusCodes - - botframework-schema.TextFormatTypes + - botframework-schema.ViewResponseType functions: - - name: 'assertActivity(unknown, unknown[])' - uid: botframework-schema.assertActivity - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertActivity(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertAttachment(unknown, unknown[])' - uid: botframework-schema.assertAttachment - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertAttachment(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertAttachmentInfo(unknown, unknown[])' - uid: botframework-schema.assertAttachmentInfo - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertAttachmentInfo(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertAttachmentView(unknown, unknown[])' - uid: botframework-schema.assertAttachmentView + - name: >- + BasicCardView(CardBarComponent, CardTextComponent, + CardViewFooterParameters) + uid: botframework-schema.BasicCardView package: botframework-schema - summary: '' + summary: >- + Helper method to create a Basic Card View. + + The Basic Text card view displays the following: + + - Card bar + + - One primary text field + + - Zero or one button in the Medium card size, up to two buttons in Large + card size; or text input. remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertAttachmentView(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertCardAction(unknown, unknown[])' - uid: botframework-schema.assertCardAction - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertCardAction(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertChannelAccount(unknown, unknown[])' - uid: botframework-schema.assertChannelAccount - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertChannelAccount(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertConversationAccount(unknown, unknown[])' - uid: botframework-schema.assertConversationAccount - package: botframework-schema - summary: '' - remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function assertConversationAccount(val: unknown, _args: unknown[]): - asserts + function BasicCardView(cardBar: CardBarComponent, header: + CardTextComponent, footer?: CardViewFooterParameters): + TextCardViewParameters parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: footer + type: + description: up to two buttons or text input to display as footer return: - description: '' - type: asserts - - name: 'assertConversationReference(unknown, unknown[])' - uid: botframework-schema.assertConversationReference + description: basic card view parameters. + type: + - name: >- + ImageCardView(CardBarComponent, CardTextComponent, CardImage, + CardViewFooterParameters) + uid: botframework-schema.ImageCardView package: botframework-schema - summary: '' + summary: >- + Helper method to create an Image Card View. + + The Image Card view displays the following: + + - Card bar + + - One primary text field + + - One image + + - Zero buttons in the Medium card size, up to two buttons in Large card + size; or text input. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function assertConversationReference(val: unknown, _args: unknown[]): - asserts + function ImageCardView(cardBar: CardBarComponent, header: + CardTextComponent, image: CardImage, footer?: CardViewFooterParameters): + TextCardViewParameters parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: image + type: CardImage + description: image to display + - id: footer + type: + description: up to two buttons or text input to display as footer return: - description: '' - type: asserts - - name: 'assertEntity(unknown, unknown[])' - uid: botframework-schema.assertEntity + description: image card view parameters + type: + - name: >- + PrimaryTextCardView(CardBarComponent, CardTextComponent, + CardTextComponent, CardViewFooterParameters) + uid: botframework-schema.PrimaryTextCardView package: botframework-schema - summary: '' + summary: >- + Helper method to create a Primary Text Card View. + + The Primary Text card view displays the following: + + - Card bar + + - One primary text field + + - One description text field + + - Zero or one button in the Medium card size, up to two buttons in Large + card size; or text input. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function assertEntity(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertMessageReaction(unknown, unknown[])' - uid: botframework-schema.assertMessageReaction - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertMessageReaction(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertSemanticAction(unknown, unknown[])' - uid: botframework-schema.assertSemanticAction - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertSemanticAction(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: 'assertSuggestedActions(unknown, unknown[])' - uid: botframework-schema.assertSuggestedActions - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function assertSuggestedActions(val: unknown, _args: unknown[]): asserts' - parameters: - - id: val - type: unknown - description: '' - - id: _args - type: 'unknown[]' - description: '' - return: - description: '' - type: asserts - - name: isActivity(unknown) - uid: botframework-schema.isActivity - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isActivity(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isAttachment(unknown) - uid: botframework-schema.isAttachment - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isAttachment(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isAttachmentInfo(unknown) - uid: botframework-schema.isAttachmentInfo - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isAttachmentInfo(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isAttachmentView(unknown) - uid: botframework-schema.isAttachmentView - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isAttachmentView(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isCardAction(unknown) - uid: botframework-schema.isCardAction - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isCardAction(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isChannelAccount(unknown) - uid: botframework-schema.isChannelAccount - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isChannelAccount(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isConversationAccount(unknown) - uid: botframework-schema.isConversationAccount - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isConversationAccount(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isConversationReference(unknown) - uid: botframework-schema.isConversationReference - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isConversationReference(val: unknown): boolean' - parameters: - - id: val - type: unknown - description: '' - return: - description: '' - type: boolean - - name: isEntity(unknown) - uid: botframework-schema.isEntity - package: botframework-schema - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isEntity(val: unknown): boolean' + content: >- + function PrimaryTextCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextComponent, footer?: + CardViewFooterParameters): TextCardViewParameters parameters: - - id: val - type: unknown - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text component to display as body + - id: footer + type: + description: up to two buttons or text input to display as footer return: - description: '' - type: boolean - - name: isMessageReaction(unknown) - uid: botframework-schema.isMessageReaction + description: primary text card view parameters. + type: + - name: >- + SearchCardView(CardBarComponent, CardTextComponent, + CardSearchBoxComponent, CardSearchFooterComponent) + uid: botframework-schema.SearchCardView package: botframework-schema - summary: '' + summary: |- + Helper method to create a Search Card View. + The Search Card view displays the following: + - Card bar + - One primary text field + - One search box + - One search footer remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function isMessageReaction(val: unknown): boolean' + content: >- + function SearchCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardSearchBoxComponent, footer: + CardSearchFooterComponent): SearchCardViewParameters parameters: - - id: val - type: unknown - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: search box component to display as body + - id: footer + type: + description: search footer component to display as footer return: - description: '' - type: boolean - - name: isSemanticAction(unknown) - uid: botframework-schema.isSemanticAction + description: search card view parameters + type: + - name: >- + SignInCardView(CardBarComponent, CardTextComponent, CardTextComponent, + CardButtonComponent) + uid: botframework-schema.SignInCardView package: botframework-schema - summary: '' - remarks: '' - isPreview: false + summary: |- + Helper method to create a Sign In Card View. + The Sign In Card view displays the following: + - Card bar + - One primary text field + - One description text field + - Two buttons. + remarks: >- + The first button (sign in button) is always displayed based on the + signInText property of the Adaptive Card Extension. Here you should + specify the second button (sign in complete button) to display. isDeprecated: false syntax: - content: 'function isSemanticAction(val: unknown): boolean' + content: >- + function SignInCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextComponent, footer: + CardButtonComponent): SignInCardViewParameters parameters: - - id: val - type: unknown - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text component to display as body + - id: footer + type: + description: sign in complete button to display as footer return: - description: '' - type: boolean - - name: isSuggestedActions(unknown) - uid: botframework-schema.isSuggestedActions + description: sign in card view parameters + type: + - name: >- + TextInputCardView(CardBarComponent, CardTextComponent, + CardTextInputComponent, CardViewActionsFooterParameters) + uid: botframework-schema.TextInputCardView package: botframework-schema - summary: '' + summary: >- + Helper method to create an Text Input Card View. + + The Text Input Card view displays the following: + + - Card bar + + - One primary text field + + - Zero or one image + + - Zero text input in Medium card size if image is presented, one text + input in Medium card size if no image is presented, one text input in + Large card size + + - Zero buttons in the Medium card size if image is presented, one button + in Medium card size if no image is presented, up to two buttons in Large + card size; or text input. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function isSuggestedActions(val: unknown): boolean' + content: >- + function TextInputCardView(cardBar: CardBarComponent, header: + CardTextComponent, body: CardTextInputComponent, footer?: + CardViewActionsFooterParameters): TextInputCardViewParameters parameters: - - id: val - type: unknown - description: '' + - id: cardBar + type: + description: card bar component + - id: header + type: + description: text component to display as header + - id: body + type: + description: text input component to display as body + - id: footer + type: + description: up to two buttons to display as footer return: - description: '' - type: boolean + description: text input card view parameters + type: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/AddressInfo.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/AddressInfo.yml deleted file mode 100644 index be01e078..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/AddressInfo.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: AddressInfo -uid: botframework-streaming.AddressInfo -package: botframework-streaming -summary: '' -fullName: AddressInfo -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: address - uid: botframework-streaming.AddressInfo.address - package: botframework-streaming - summary: '' - fullName: address - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'address: string' - return: - description: '' - type: string - - name: family - uid: botframework-streaming.AddressInfo.family - package: botframework-streaming - summary: '' - fullName: family - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'family: string' - return: - description: '' - type: string - - name: port - uid: botframework-streaming.AddressInfo.port - package: botframework-streaming - summary: '' - fullName: port - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'port: number' - return: - description: '' - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/BufferEncoding.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/BufferEncoding.yml deleted file mode 100644 index e4e6553f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/BufferEncoding.yml +++ /dev/null @@ -1,21 +0,0 @@ -### YamlMime:TSTypeAlias -name: BufferEncoding -uid: botframework-streaming.BufferEncoding -package: botframework-streaming -summary: '' -fullName: BufferEncoding -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type BufferEncoding = - | "ascii" - | "utf8" - | "utf-8" - | "utf16le" - | "ucs2" - | "ucs-2" - | "base64" - | "latin1" - | "binary" - | "hex" diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/CancelDisassembler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/CancelDisassembler.yml deleted file mode 100644 index 2c87cf75..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/CancelDisassembler.yml +++ /dev/null @@ -1,51 +0,0 @@ -### YamlMime:TSType -name: CancelDisassembler -uid: botframework-streaming.CancelDisassembler -package: botframework-streaming -summary: Streaming cancel disassembler. -fullName: CancelDisassembler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'CancelDisassembler(PayloadSender, string, PayloadTypes)' - uid: botframework-streaming.CancelDisassembler.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [CancelDisassembler](xref:botframework-streaming.CancelDisassembler) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new CancelDisassembler(sender: PayloadSender, id: string, payloadType: - PayloadTypes) - parameters: - - id: sender - type: - description: >- - The [PayloadSender](xref:botframework-streaming.PayloadSender) that - this Cancel request will be sent by. - - id: id - type: string - description: The ID of the Stream to cancel. - - id: payloadType - type: - description: | - The type of the Stream that is being cancelled. -methods: - - name: disassemble() - uid: botframework-streaming.CancelDisassembler.disassemble - package: botframework-streaming - summary: >- - Initiates the process of disassembling the request and signals the - [PayloadSender](xref:botframework-streaming.PayloadSender) to begin - sending. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function disassemble() diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ConnectionListener.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ConnectionListener.yml deleted file mode 100644 index 866feed6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ConnectionListener.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConnectionListener -uid: botframework-streaming.ConnectionListener -package: botframework-streaming -summary: '' -fullName: ConnectionListener -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ConnectionListener = (socket: INodeSocket) => void diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ContentStream.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ContentStream.yml index 01bd1872..d34b2ce5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ContentStream.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ContentStream.yml @@ -5,18 +5,16 @@ package: botframework-streaming summary: A stream of fixed or infinite length containing content to be decoded. fullName: ContentStream remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ContentStream(string, PayloadAssembler)' + - name: ContentStream(string, PayloadAssembler) uid: botframework-streaming.ContentStream.constructor package: botframework-streaming summary: >- Initializes a new instance of the [ContentStream](xref:botframework-streaming.ContentStream) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ContentStream(id: string, assembler: PayloadAssembler)' @@ -25,8 +23,8 @@ constructors: type: string description: The ID assigned to this instance. - id: assembler - type: - description: > + type: PayloadAssembler + description: >- The [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) assigned to this instance. properties: @@ -38,22 +36,20 @@ properties: [ContentStream](xref:botframework-streaming.ContentStream). fullName: contentType remarks: '' - isPreview: false isDeprecated: false syntax: - content: string | PayloadTypes contentType + content: string contentType return: description: >- The [PayloadType](xref:botframework-streaming.PayloadType) of this [ContentStream](xref:botframework-streaming.ContentStream). - type: string | + type: string - name: id uid: botframework-streaming.ContentStream.id package: botframework-streaming summary: '' fullName: id remarks: '' - isPreview: false isDeprecated: false syntax: content: 'id: string' @@ -68,7 +64,6 @@ properties: [ContentStream](xref:botframework-streaming.ContentStream). fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: number length @@ -83,7 +78,6 @@ methods: package: botframework-streaming summary: Closes the assembler. remarks: '' - isPreview: false isDeprecated: false syntax: content: function cancel() @@ -94,7 +88,6 @@ methods: Gets the data contained within this [ContentStream](xref:botframework-streaming.ContentStream). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getStream(): SubscribableStream' @@ -111,7 +104,6 @@ methods: [SubscribableStream](xref:botframework-streaming.SubscribableStream) content as a typed JSON object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readAsJson(): Promise' @@ -126,7 +118,6 @@ methods: [SubscribableStream](xref:botframework-streaming.SubscribableStream) content as a string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readAsString(): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HeaderSerializer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HeaderSerializer.yml deleted file mode 100644 index 92f3895f..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HeaderSerializer.yml +++ /dev/null @@ -1,269 +0,0 @@ -### YamlMime:TSType -name: HeaderSerializer -uid: botframework-streaming.HeaderSerializer -package: botframework-streaming -summary: Streaming header serializer -fullName: HeaderSerializer -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: Delimiter - uid: botframework-streaming.HeaderSerializer.Delimiter - package: botframework-streaming - summary: '' - fullName: Delimiter - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Delimiter: "." = "."' - return: - description: '' - type: '"."' - - name: Encoding - uid: botframework-streaming.HeaderSerializer.Encoding - package: botframework-streaming - summary: '' - fullName: Encoding - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Encoding: "utf8" = "utf8"' - return: - description: '' - type: '"utf8"' - - name: End - uid: botframework-streaming.HeaderSerializer.End - package: botframework-streaming - summary: '' - fullName: End - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static End: "1" = "1"' - return: - description: '' - type: '"1"' - - name: EndOffset - uid: botframework-streaming.HeaderSerializer.EndOffset - package: botframework-streaming - summary: '' - fullName: EndOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static EndOffset: 46 = 46' - return: - description: '' - type: '46' - - name: IdDelimeterOffset - uid: botframework-streaming.HeaderSerializer.IdDelimeterOffset - package: botframework-streaming - summary: '' - fullName: IdDelimeterOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static IdDelimeterOffset: 45 = 45' - return: - description: '' - type: '45' - - name: IdLength - uid: botframework-streaming.HeaderSerializer.IdLength - package: botframework-streaming - summary: '' - fullName: IdLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static IdLength: 36 = 36' - return: - description: '' - type: '36' - - name: IdOffset - uid: botframework-streaming.HeaderSerializer.IdOffset - package: botframework-streaming - summary: '' - fullName: IdOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static IdOffset: 9 = 9' - return: - description: '' - type: '9' - - name: LengthDelimeterOffset - uid: botframework-streaming.HeaderSerializer.LengthDelimeterOffset - package: botframework-streaming - summary: '' - fullName: LengthDelimeterOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static LengthDelimeterOffset: 8 = 8' - return: - description: '' - type: '8' - - name: LengthLength - uid: botframework-streaming.HeaderSerializer.LengthLength - package: botframework-streaming - summary: '' - fullName: LengthLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static LengthLength: 6 = 6' - return: - description: '' - type: '6' - - name: LengthOffset - uid: botframework-streaming.HeaderSerializer.LengthOffset - package: botframework-streaming - summary: '' - fullName: LengthOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static LengthOffset: 2 = 2' - return: - description: '' - type: '2' - - name: NotEnd - uid: botframework-streaming.HeaderSerializer.NotEnd - package: botframework-streaming - summary: '' - fullName: NotEnd - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static NotEnd: "0" = "0"' - return: - description: '' - type: '"0"' - - name: Terminator - uid: botframework-streaming.HeaderSerializer.Terminator - package: botframework-streaming - summary: '' - fullName: Terminator - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: |- - static Terminator: " - " = " - " - return: - description: '' - type: |- - " - " - - name: TerminatorOffset - uid: botframework-streaming.HeaderSerializer.TerminatorOffset - package: botframework-streaming - summary: '' - fullName: TerminatorOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static TerminatorOffset: 47 = 47' - return: - description: '' - type: '47' - - name: TypeDelimiterOffset - uid: botframework-streaming.HeaderSerializer.TypeDelimiterOffset - package: botframework-streaming - summary: '' - fullName: TypeDelimiterOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static TypeDelimiterOffset: 1 = 1' - return: - description: '' - type: '1' - - name: TypeOffset - uid: botframework-streaming.HeaderSerializer.TypeOffset - package: botframework-streaming - summary: '' - fullName: TypeOffset - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static TypeOffset: number' - return: - description: '' - type: number -methods: - - name: deserialize(INodeBuffer) - uid: botframework-streaming.HeaderSerializer.deserialize - package: botframework-streaming - summary: Deserializes a buffer containing header information. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function deserialize(buffer: INodeBuffer): IHeader' - parameters: - - id: buffer - type: - description: The buffer from which to obtain the data to deserialize. - return: - description: The deserialized header from the buffer. - type: - - name: 'headerLengthPadder(number, number, string)' - uid: botframework-streaming.HeaderSerializer.headerLengthPadder - package: botframework-streaming - summary: Creates a padded string based on a length and character to be padded to. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function headerLengthPadder(lengthValue: number, totalLength: - number, padChar: string): string - parameters: - - id: lengthValue - type: number - description: The value to be assingned on the result. - - id: totalLength - type: number - description: The length of the padded string result. - - id: padChar - type: string - description: The character value to use as filling. - return: - description: The padded string. - type: string - - name: 'serialize(IHeader, INodeBuffer)' - uid: botframework-streaming.HeaderSerializer.serialize - package: botframework-streaming - summary: Serializes the header into a buffer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function serialize(header: IHeader, buffer: INodeBuffer)' - parameters: - - id: header - type: - description: The header to serialize. - - id: buffer - type: - description: | - The buffer into which to serialize the header. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContent.yml index 9fb9b650..ce35245d 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContent.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContent.yml @@ -7,18 +7,16 @@ summary: >- [SubscribableStream](xref:botframework-streaming.SubscribableStream). fullName: HttpContent remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'HttpContent(IHttpContentHeaders, SubscribableStream)' + - name: HttpContent(IHttpContentHeaders, SubscribableStream) uid: botframework-streaming.HttpContent.constructor package: botframework-streaming summary: >- Initializes a new instance of the [HttpContent](xref:botframework-streaming.HttpContent) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -26,12 +24,11 @@ constructors: SubscribableStream) parameters: - id: headers - type: + type: IHttpContentHeaders description: The Streaming Http content header definition. - id: stream type: - description: | - The stream of buffered data. + description: The stream of buffered data. properties: - name: headers uid: botframework-streaming.HttpContent.headers @@ -39,13 +36,12 @@ properties: summary: '' fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'headers: IHttpContentHeaders' return: description: '' - type: + type: IHttpContentHeaders methods: - name: getStream() uid: botframework-streaming.HttpContent.getStream @@ -54,7 +50,6 @@ methods: Gets the data contained within this [HttpContent](xref:botframework-streaming.HttpContent). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getStream(): SubscribableStream' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStream.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStream.yml deleted file mode 100644 index 96730bda..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStream.yml +++ /dev/null @@ -1,71 +0,0 @@ -### YamlMime:TSType -name: HttpContentStream -uid: botframework-streaming.HttpContentStream -package: botframework-streaming -summary: >- - An attachment contained within a StreamingRequest's stream collection, which - itself contains any form of media item. -fullName: HttpContentStream -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: HttpContentStream(HttpContent) - uid: botframework-streaming.HttpContentStream.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [HttpContentStream](xref:botframework-streaming.HttpContentStream) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new HttpContentStream(content: HttpContent)' - parameters: - - id: content - type: - description: > - The [HttpContent](xref:botframework-streaming.HttpContent) to assign - to the - [HttpContentStream](xref:botframework-streaming.HttpContentStream). -properties: - - name: content - uid: botframework-streaming.HttpContentStream.content - package: botframework-streaming - summary: '' - fullName: content - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'content: HttpContent' - return: - description: '' - type: - - name: description - uid: botframework-streaming.HttpContentStream.description - package: botframework-streaming - summary: '' - fullName: description - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'description: { id: string, length: number, type: string }' - return: - description: '' - type: '{ id: string, length: number, type: string }' - - name: id - uid: botframework-streaming.HttpContentStream.id - package: botframework-streaming - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStreamDisassembler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStreamDisassembler.yml deleted file mode 100644 index ccc80ae8..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/HttpContentStreamDisassembler.yml +++ /dev/null @@ -1,99 +0,0 @@ -### YamlMime:TSType -name: HttpContentStreamDisassembler -uid: botframework-streaming.HttpContentStreamDisassembler -package: botframework-streaming -summary: Disassembler for Http content stream -fullName: HttpContentStreamDisassembler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'HttpContentStreamDisassembler(PayloadSender, HttpContentStream)' - uid: botframework-streaming.HttpContentStreamDisassembler.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [HttpContentStreamDisassembler](xref:botframework-streaming.HttpContentStreamDisassembler) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new HttpContentStreamDisassembler(sender: PayloadSender, contentStream: - HttpContentStream) - parameters: - - id: sender - type: - description: >- - The [PayloadSender](xref:botframework-streaming.PayloadSender) to - send the disassembled data to. - - id: contentStream - type: - description: > - The - [HttpContentStream](xref:botframework-streaming.HttpContentStream) - to be disassembled. -properties: - - name: contentStream - uid: botframework-streaming.HttpContentStreamDisassembler.contentStream - package: botframework-streaming - summary: '' - fullName: contentStream - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'contentStream: HttpContentStream' - return: - description: '' - type: - - name: payloadType - uid: botframework-streaming.HttpContentStreamDisassembler.payloadType - package: botframework-streaming - summary: '' - fullName: payloadType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadType: PayloadTypes' - return: - description: '' - type: -inheritedMethods: - - name: disassemble() - uid: botframework-streaming.HttpContentStreamDisassembler.disassemble - package: botframework-streaming - summary: >- - Begins the process of disassembling a payload and sending the resulting - chunks to the [PayloadSender](xref:botframework-streaming.PayloadSender) - to dispatch over the transport. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function disassemble(): Promise' - return: - description: A completed Promise after the disassembled payload has been sent. - type: Promise<void> - inheritanceDescription: >- - Inherited From - [PayloadDisassembler.disassemble](xref:botframework-streaming.PayloadDisassembler.disassemble) -methods: - - name: getStream() - uid: botframework-streaming.HttpContentStreamDisassembler.getStream - package: botframework-streaming - summary: Gets the stream this disassembler is operating on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getStream(): Promise' - return: - description: >- - An [IStreamWrapper](xref:botframework-streaming.IStreamWrapper) with a - Subscribable Strea. - type: Promise<> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IAssemblerParams.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IAssemblerParams.yml deleted file mode 100644 index b91be84b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IAssemblerParams.yml +++ /dev/null @@ -1,54 +0,0 @@ -### YamlMime:TSType -name: IAssemblerParams -uid: botframework-streaming.IAssemblerParams -package: botframework-streaming -summary: Parameters for a streaming assembler. -fullName: IAssemblerParams -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: header - uid: botframework-streaming.IAssemblerParams.header - package: botframework-streaming - summary: '' - fullName: header - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'header?: IHeader' - return: - description: '' - type: - - name: id - uid: botframework-streaming.IAssemblerParams.id - package: botframework-streaming - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id?: string' - return: - description: '' - type: string - - name: onCompleted - uid: botframework-streaming.IAssemblerParams.onCompleted - package: botframework-streaming - summary: '' - fullName: onCompleted - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - onCompleted?: (id: string, receiveResponse: IReceiveResponse | - IReceiveRequest) => Promise - return: - description: '' - type: >- - (id: string, receiveResponse: IReceiveResponse | IReceiveRequest) - => Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserFileReader.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserFileReader.yml deleted file mode 100644 index 6dc4d0d6..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserFileReader.yml +++ /dev/null @@ -1,56 +0,0 @@ -### YamlMime:TSType -name: IBrowserFileReader -uid: botframework-streaming.IBrowserFileReader -package: botframework-streaming -summary: > - Partially represents a FileReader from the W3C FileAPI Working Draft. - - For more information, see https://w3c.github.io/FileAPI/#APIASynch. - - This interface supports the framework and is not intended to be called - directly for your code. -fullName: IBrowserFileReader -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: onload - uid: botframework-streaming.IBrowserFileReader.onload - package: botframework-streaming - summary: '' - fullName: onload - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onload: (event: any) => void' - return: - description: '' - type: '(event: any) => void' - - name: readAsArrayBuffer - uid: botframework-streaming.IBrowserFileReader.readAsArrayBuffer - package: botframework-streaming - summary: '' - fullName: readAsArrayBuffer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readAsArrayBuffer: (blobOrFile: any) => void' - return: - description: '' - type: '(blobOrFile: any) => void' - - name: result - uid: botframework-streaming.IBrowserFileReader.result - package: botframework-streaming - summary: '' - fullName: result - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'result: any' - return: - description: '' - type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserWebSocket.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserWebSocket.yml deleted file mode 100644 index bce53d6b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IBrowserWebSocket.yml +++ /dev/null @@ -1,106 +0,0 @@ -### YamlMime:TSType -name: IBrowserWebSocket -uid: botframework-streaming.IBrowserWebSocket -package: botframework-streaming -summary: > - Partially represents a WebSocket from the HTML Living Standard. - - For more information, see - https://html.spec.whatwg.org/multipage/web-sockets.html. - - This interface supports the framework and is not intended to be called - directly for your code. -fullName: IBrowserWebSocket -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: onclose - uid: botframework-streaming.IBrowserWebSocket.onclose - package: botframework-streaming - summary: '' - fullName: onclose - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onclose: (event: any) => void' - return: - description: '' - type: '(event: any) => void' - - name: onerror - uid: botframework-streaming.IBrowserWebSocket.onerror - package: botframework-streaming - summary: '' - fullName: onerror - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onerror: (event: any) => void' - return: - description: '' - type: '(event: any) => void' - - name: onmessage - uid: botframework-streaming.IBrowserWebSocket.onmessage - package: botframework-streaming - summary: '' - fullName: onmessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onmessage: (event: any) => void' - return: - description: '' - type: '(event: any) => void' - - name: onopen - uid: botframework-streaming.IBrowserWebSocket.onopen - package: botframework-streaming - summary: '' - fullName: onopen - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onopen: (event: any) => void' - return: - description: '' - type: '(event: any) => void' - - name: readyState - uid: botframework-streaming.IBrowserWebSocket.readyState - package: botframework-streaming - summary: '' - fullName: readyState - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readyState: number' - return: - description: '' - type: number -methods: - - name: close() - uid: botframework-streaming.IBrowserWebSocket.close - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function close() - - name: send(any) - uid: botframework-streaming.IBrowserWebSocket.send - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function send(buffer: any)' - parameters: - - id: buffer - type: any - description: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IEventEmitter.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IEventEmitter.yml deleted file mode 100644 index 64c5d145..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IEventEmitter.yml +++ /dev/null @@ -1,285 +0,0 @@ -### YamlMime:TSType -name: IEventEmitter -uid: botframework-streaming.IEventEmitter -package: botframework-streaming -summary: > - Represents a EventEmitter from the `net` module in Node.js. - - This interface supports the framework and is not intended to be called - directly for your code. -fullName: IEventEmitter -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'addListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.addListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addListener(event: string | symbol, listener: (args: any[]) => - void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: 'emit(string | symbol, any[])' - uid: botframework-streaming.IEventEmitter.emit - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: string | symbol, args: any[]): boolean' - parameters: - - id: event - type: string | symbol - description: '' - - id: args - type: 'any[]' - description: '' - return: - description: '' - type: boolean - - name: eventNames() - uid: botframework-streaming.IEventEmitter.eventNames - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function eventNames(): Array' - return: - description: '' - type: Array<string | symbol> - - name: getMaxListeners() - uid: botframework-streaming.IEventEmitter.getMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMaxListeners(): number' - return: - description: '' - type: number - - name: listenerCount(string | symbol) - uid: botframework-streaming.IEventEmitter.listenerCount - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listenerCount(type: string | symbol): number' - parameters: - - id: type - type: string | symbol - description: '' - return: - description: '' - type: number - - name: listeners(string | symbol) - uid: botframework-streaming.IEventEmitter.listeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - - name: 'off(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.off - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function off(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: 'on(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.on - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function on(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: 'once(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.once - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function once(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: 'prependListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.prependListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: 'prependOnceListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.prependOnceListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: string | symbol, listener: (args: - any[]) => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: rawListeners(string | symbol) - uid: botframework-streaming.IEventEmitter.rawListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function rawListeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - - name: removeAllListeners(string | symbol) - uid: botframework-streaming.IEventEmitter.removeAllListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllListeners(event?: string | symbol): this' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: this - - name: 'removeListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.IEventEmitter.removeListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - - name: setMaxListeners(number) - uid: botframework-streaming.IEventEmitter.setMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setMaxListeners(n: number): this' - parameters: - - id: 'n' - type: number - description: '' - return: - description: '' - type: this diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHeader.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHeader.yml deleted file mode 100644 index 3bfa6e30..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHeader.yml +++ /dev/null @@ -1,63 +0,0 @@ -### YamlMime:TSType -name: IHeader -uid: botframework-streaming.IHeader -package: botframework-streaming -summary: Streaming payload header definition. -fullName: IHeader -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: end - uid: botframework-streaming.IHeader.end - package: botframework-streaming - summary: '' - fullName: end - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'end: boolean' - return: - description: '' - type: boolean - - name: id - uid: botframework-streaming.IHeader.id - package: botframework-streaming - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - - name: payloadLength - uid: botframework-streaming.IHeader.payloadLength - package: botframework-streaming - summary: '' - fullName: payloadLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadLength: number' - return: - description: '' - type: number - - name: payloadType - uid: botframework-streaming.IHeader.payloadType - package: botframework-streaming - summary: '' - fullName: payloadType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadType: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHttpContentHeaders.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHttpContentHeaders.yml deleted file mode 100644 index 8e4f6c04..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IHttpContentHeaders.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: IHttpContentHeaders -uid: botframework-streaming.IHttpContentHeaders -package: botframework-streaming -summary: Streaming Http content header definition. -fullName: IHttpContentHeaders -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: contentLength - uid: botframework-streaming.IHttpContentHeaders.contentLength - package: botframework-streaming - summary: '' - fullName: contentLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'contentLength?: number' - return: - description: '' - type: number - - name: type - uid: botframework-streaming.IHttpContentHeaders.type - package: botframework-streaming - summary: '' - fullName: type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'type?: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeBuffer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeBuffer.yml index 6d8f7689..bbecbcdb 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeBuffer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeBuffer.yml @@ -2,14 +2,14 @@ name: INodeBuffer uid: botframework-streaming.INodeBuffer package: botframework-streaming -summary: > +summary: >- Represents a Buffer from the `net` module in Node.js. + This interface supports the framework and is not intended to be called directly for your code. fullName: INodeBuffer remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,26 +19,12 @@ properties: summary: '' fullName: constructor remarks: '' - isPreview: false isDeprecated: false syntax: content: 'constructor: any' return: description: '' type: any - - name: Uint8Array - uid: botframework-streaming.INodeBuffer.Uint8Array - package: botframework-streaming - summary: '' - fullName: Uint8Array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'Uint8Array: Uint8ArrayConstructor' - return: - description: '' - type: Uint8ArrayConstructor inheritedProperties: - name: buffer uid: botframework-streaming.INodeBuffer.buffer @@ -46,7 +32,6 @@ inheritedProperties: summary: The ArrayBuffer instance referenced by the array. fullName: buffer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'buffer: ArrayBufferLike' @@ -60,7 +45,6 @@ inheritedProperties: summary: The length in bytes of the array. fullName: byteLength remarks: '' - isPreview: false isDeprecated: false syntax: content: 'byteLength: number' @@ -74,7 +58,6 @@ inheritedProperties: summary: The offset in bytes of the array. fullName: byteOffset remarks: '' - isPreview: false isDeprecated: false syntax: content: 'byteOffset: number' @@ -88,7 +71,6 @@ inheritedProperties: summary: The size in bytes of each element in the array. fullName: BYTES_PER_ELEMENT remarks: '' - isPreview: false isDeprecated: false syntax: content: 'BYTES_PER_ELEMENT: number' @@ -102,7 +84,6 @@ inheritedProperties: summary: The length of the array. fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: 'length: number' @@ -110,8 +91,21 @@ inheritedProperties: description: '' type: number inheritanceDescription: Inherited From Uint8Array.length + - name: '[toStringTag]' + uid: botframework-streaming.INodeBuffer.[toStringTag] + package: botframework-streaming + summary: '' + fullName: '[toStringTag]' + remarks: '' + isDeprecated: false + syntax: + content: '[toStringTag]: "Uint8Array"' + return: + description: '' + type: '"Uint8Array"' + inheritanceDescription: Inherited From Uint8Array.__@toStringTag@115 inheritedMethods: - - name: 'copyWithin(number, number, number)' + - name: copyWithin(number, number, number) uid: botframework-streaming.INodeBuffer.copyWithin package: botframework-streaming summary: >- @@ -120,10 +114,11 @@ inheritedMethods: to the same array starting at position target remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function copyWithin(target: number, start: number, end?: number): this' + content: >- + function copyWithin(target: number, start: number, end?: number): + INodeBuffer parameters: - id: target type: number @@ -141,39 +136,39 @@ inheritedMethods: is treated as length+end. - id: end type: number - description: > + description: >- If not specified, length of the this object is used as its default value. return: description: '' - type: this + type: inheritanceDescription: Inherited From Uint8Array.copyWithin - - name: 'every((value: number, index: number, array: Uint8Array) => boolean, any)' + - name: 'every((value: number, index: number, array: Uint8Array) => unknown, any)' uid: botframework-streaming.INodeBuffer.every package: botframework-streaming summary: Determines whether all the members of an array satisfy the specified test. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function every(callbackfn: (value: number, index: number, array: - Uint8Array) => boolean, thisArg?: any): boolean + function every(predicate: (value: number, index: number, array: + Uint8Array) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn - type: '(value: number, index: number, array: Uint8Array) => boolean' + - id: predicate + type: '(value: number, index: number, array: Uint8Array) => unknown' description: >- A function that accepts up to three arguments. The every method calls - the callbackfn function for each element in array1 until the - callbackfn returns false, + the predicate function for each element in the array until the + predicate returns a value - or until the end of the array. + which is coercible to the Boolean value false, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @@ -188,24 +183,23 @@ inheritedMethods: Returns the elements of an array that meet the condition specified in a callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function filter(callbackfn: (value: number, index: number, array: + function filter(predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any): Uint8Array parameters: - - id: callbackfn + - id: predicate type: '(value: number, index: number, array: Uint8Array) => any' description: >- A function that accepts up to three arguments. The filter method calls - the callbackfn function one time for each element in the array. + the predicate function one time for each element in the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @@ -222,12 +216,11 @@ inheritedMethods: otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function find(predicate: (value: number, index: number, obj: Uint8Array) - => boolean, thisArg?: any): number | undefined + => boolean, thisArg?: any): undefined | number parameters: - id: predicate type: '(value: number, index: number, obj: Uint8Array) => boolean' @@ -242,14 +235,14 @@ inheritedMethods: undefined. - id: thisArg type: any - description: > + description: >- If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. return: description: '' - type: number | undefined + type: undefined | number inheritanceDescription: Inherited From Uint8Array.find - name: 'findIndex((value: number, index: number, obj: Uint8Array) => boolean, any)' uid: botframework-streaming.INodeBuffer.findIndex @@ -260,7 +253,6 @@ inheritedMethods: otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -280,7 +272,7 @@ inheritedMethods: findIndex returns -1. - id: thisArg type: any - description: > + description: >- If provided, it will be used as the this value for each invocation of @@ -294,7 +286,6 @@ inheritedMethods: package: botframework-streaming summary: Performs the specified action for each element in an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -308,7 +299,7 @@ inheritedMethods: callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. @@ -321,14 +312,13 @@ inheritedMethods: Adds all the elements of an array separated by the specified separator string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function join(separator?: string): string' parameters: - id: separator type: string - description: > + description: >- A string used to separate one element of an array from the next in the @@ -347,7 +337,6 @@ inheritedMethods: contains the results. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -363,7 +352,7 @@ inheritedMethods: callbackfn function one time for each element in the array. - id: thisArg type: any - description: > + description: >- An object to which the this keyword can refer in the callbackfn function. @@ -386,7 +375,6 @@ inheritedMethods: call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -413,7 +401,6 @@ inheritedMethods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -447,7 +434,6 @@ inheritedMethods: call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -465,7 +451,7 @@ inheritedMethods: callbackfn function one time for each element in the array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start @@ -491,7 +477,6 @@ inheritedMethods: argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -518,7 +503,6 @@ inheritedMethods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -552,7 +536,6 @@ inheritedMethods: argument in the next call to the callback function. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -571,7 +554,7 @@ inheritedMethods: the callbackfn function one time for each element in the array. - id: initialValue type: U - description: > + description: >- If initialValue is specified, it is used as the initial value to start @@ -588,7 +571,6 @@ inheritedMethods: package: botframework-streaming summary: Reverses the elements in an Array. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function reverse(): Uint8Array' @@ -596,12 +578,11 @@ inheritedMethods: description: '' type: Uint8Array inheritanceDescription: Inherited From Uint8Array.reverse - - name: 'set(ArrayLike, number)' + - name: set(ArrayLike, number) uid: botframework-streaming.INodeBuffer.set package: botframework-streaming summary: Sets a value or an array of values. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function set(array: ArrayLike, offset?: number)' @@ -611,38 +592,37 @@ inheritedMethods: description: A typed or untyped array of values to set. - id: offset type: number - description: > + description: >- The index in the current array at which the values are to be written. inheritanceDescription: Inherited From Uint8Array.set - - name: 'some((value: number, index: number, array: Uint8Array) => boolean, any)' + - name: 'some((value: number, index: number, array: Uint8Array) => unknown, any)' uid: botframework-streaming.INodeBuffer.some package: botframework-streaming summary: >- Determines whether the specified callback function returns true for any element of an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function some(callbackfn: (value: number, index: number, array: - Uint8Array) => boolean, thisArg?: any): boolean + function some(predicate: (value: number, index: number, array: + Uint8Array) => unknown, thisArg?: any): boolean parameters: - - id: callbackfn - type: '(value: number, index: number, array: Uint8Array) => boolean' + - id: predicate + type: '(value: number, index: number, array: Uint8Array) => unknown' description: >- A function that accepts up to three arguments. The some method calls - the - callbackfn function for each element in array1 until the callbackfn - returns true, or until + the predicate function for each element in the array until the + predicate returns a value - the end of the array. + which is coercible to the Boolean value true, or until the end of + the array. - id: thisArg type: any - description: > - An object to which the this keyword can refer in the callbackfn + description: >- + An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @@ -655,24 +635,32 @@ inheritedMethods: package: botframework-streaming summary: Sorts an array. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function sort(compareFn?: (a: number, b: number) => number): this' + content: 'function sort(compareFn?: (a: number, b: number) => number): INodeBuffer' parameters: - id: compareFn type: '(a: number, b: number) => number' - description: > - The name of the function used to determine the order of the - elements. If + description: >- + Function used to determine the order of the elements. It is expected + to return - omitted, the elements are sorted in ascending, ASCII character + a negative value if first argument is less than second argument, + zero if they're equal and a positive + + value otherwise. If omitted, the elements are sorted in ascending order. + + ```ts + + [11,2,22,1].sort((a, b) => a - b) + + ``` return: description: '' - type: this + type: inheritanceDescription: Inherited From Uint8Array.sort - - name: 'subarray(number, number)' + - name: subarray(number, number) uid: botframework-streaming.INodeBuffer.subarray package: botframework-streaming summary: >- @@ -681,18 +669,16 @@ inheritedMethods: at begin, inclusive, up to end, exclusive. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function subarray(begin: number, end?: number): Uint8Array' + content: 'function subarray(begin?: number, end?: number): Uint8Array' parameters: - id: begin type: number description: The index of the beginning of the array. - id: end type: number - description: | - The index of the end of the array. + description: The index of the end of the array. return: description: '' type: Uint8Array @@ -702,7 +688,6 @@ inheritedMethods: package: botframework-streaming summary: Converts a number to a string by using the current locale. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toLocaleString(): string' @@ -710,13 +695,36 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From Uint8Array.toLocaleString + - name: valueOf() + uid: botframework-streaming.INodeBuffer.valueOf + package: botframework-streaming + summary: Returns the primitive value of the specified object. + remarks: '' + isDeprecated: false + syntax: + content: 'function valueOf(): Uint8Array' + return: + description: '' + type: Uint8Array + inheritanceDescription: Inherited From Uint8Array.valueOf + - name: '[iterator]()' + uid: botframework-streaming.INodeBuffer.[iterator] + package: botframework-streaming + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function [iterator](): IterableIterator' + return: + description: '' + type: IterableIterator<number> + inheritanceDescription: Inherited From Uint8Array.__@iterator@113 methods: - - name: 'compare(Uint8Array, number, number, number, number)' + - name: compare(Uint8Array, number, number, number, number) uid: botframework-streaming.INodeBuffer.compare package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -741,12 +749,11 @@ methods: return: description: '' type: number - - name: 'copy(Uint8Array, number, number, number)' + - name: copy(Uint8Array, number, number, number) uid: botframework-streaming.INodeBuffer.copy package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -773,19 +780,17 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function entries(): IterableIterator<[number, number]>' return: description: '' - type: 'IterableIterator<[number, number]>' + type: IterableIterator<[number, number]> - name: equals(Uint8Array) uid: botframework-streaming.INodeBuffer.equals package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function equals(otherBuffer: Uint8Array): boolean' @@ -796,15 +801,14 @@ methods: return: description: '' type: boolean - - name: 'fill(any, number, number)' + - name: fill(any, number, number) uid: botframework-streaming.INodeBuffer.fill package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function fill(value: any, offset?: number, end?: number): this' + content: 'function fill(value: any, offset?: number, end?: number): INodeBuffer' parameters: - id: value type: any @@ -817,21 +821,20 @@ methods: description: '' return: description: '' - type: this - - name: 'includes(string | number | this, number, string)' + type: + - name: includes(string | number | INodeBuffer, number, string) uid: botframework-streaming.INodeBuffer.includes package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function includes(value: string | number | this, byteOffset?: number, - encoding?: string): boolean + function includes(value: string | number | INodeBuffer, byteOffset?: + number, encoding?: string): boolean parameters: - id: value - type: string | number | this + type: string | number | description: '' - id: byteOffset type: number @@ -842,12 +845,11 @@ methods: return: description: '' type: boolean - - name: 'indexOf(string | number | Uint8Array, number, string)' + - name: indexOf(string | number | Uint8Array, number, string) uid: botframework-streaming.INodeBuffer.indexOf package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -871,19 +873,17 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function keys(): IterableIterator' return: description: '' type: IterableIterator<number> - - name: 'lastIndexOf(string | number | Uint8Array, number, string)' + - name: lastIndexOf(string | number | Uint8Array, number, string) uid: botframework-streaming.INodeBuffer.lastIndexOf package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -902,12 +902,11 @@ methods: return: description: '' type: number - - name: 'readDoubleBE(number, boolean)' + - name: readDoubleBE(number, boolean) uid: botframework-streaming.INodeBuffer.readDoubleBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readDoubleBE(offset: number, noAssert?: boolean): number' @@ -921,12 +920,11 @@ methods: return: description: '' type: number - - name: 'readDoubleLE(number, boolean)' + - name: readDoubleLE(number, boolean) uid: botframework-streaming.INodeBuffer.readDoubleLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readDoubleLE(offset: number, noAssert?: boolean): number' @@ -940,12 +938,11 @@ methods: return: description: '' type: number - - name: 'readFloatBE(number, boolean)' + - name: readFloatBE(number, boolean) uid: botframework-streaming.INodeBuffer.readFloatBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readFloatBE(offset: number, noAssert?: boolean): number' @@ -959,12 +956,11 @@ methods: return: description: '' type: number - - name: 'readFloatLE(number, boolean)' + - name: readFloatLE(number, boolean) uid: botframework-streaming.INodeBuffer.readFloatLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readFloatLE(offset: number, noAssert?: boolean): number' @@ -978,12 +974,11 @@ methods: return: description: '' type: number - - name: 'readInt16BE(number, boolean)' + - name: readInt16BE(number, boolean) uid: botframework-streaming.INodeBuffer.readInt16BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readInt16BE(offset: number, noAssert?: boolean): number' @@ -997,12 +992,11 @@ methods: return: description: '' type: number - - name: 'readInt16LE(number, boolean)' + - name: readInt16LE(number, boolean) uid: botframework-streaming.INodeBuffer.readInt16LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readInt16LE(offset: number, noAssert?: boolean): number' @@ -1016,12 +1010,11 @@ methods: return: description: '' type: number - - name: 'readInt32BE(number, boolean)' + - name: readInt32BE(number, boolean) uid: botframework-streaming.INodeBuffer.readInt32BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readInt32BE(offset: number, noAssert?: boolean): number' @@ -1035,12 +1028,11 @@ methods: return: description: '' type: number - - name: 'readInt32LE(number, boolean)' + - name: readInt32LE(number, boolean) uid: botframework-streaming.INodeBuffer.readInt32LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readInt32LE(offset: number, noAssert?: boolean): number' @@ -1054,12 +1046,11 @@ methods: return: description: '' type: number - - name: 'readInt8(number, boolean)' + - name: readInt8(number, boolean) uid: botframework-streaming.INodeBuffer.readInt8 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readInt8(offset: number, noAssert?: boolean): number' @@ -1073,12 +1064,11 @@ methods: return: description: '' type: number - - name: 'readIntBE(number, number, boolean)' + - name: readIntBE(number, number, boolean) uid: botframework-streaming.INodeBuffer.readIntBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1097,12 +1087,11 @@ methods: return: description: '' type: number - - name: 'readIntLE(number, number, boolean)' + - name: readIntLE(number, number, boolean) uid: botframework-streaming.INodeBuffer.readIntLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1121,12 +1110,11 @@ methods: return: description: '' type: number - - name: 'readUInt16BE(number, boolean)' + - name: readUInt16BE(number, boolean) uid: botframework-streaming.INodeBuffer.readUInt16BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readUInt16BE(offset: number, noAssert?: boolean): number' @@ -1140,12 +1128,11 @@ methods: return: description: '' type: number - - name: 'readUInt16LE(number, boolean)' + - name: readUInt16LE(number, boolean) uid: botframework-streaming.INodeBuffer.readUInt16LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readUInt16LE(offset: number, noAssert?: boolean): number' @@ -1159,12 +1146,11 @@ methods: return: description: '' type: number - - name: 'readUInt32BE(number, boolean)' + - name: readUInt32BE(number, boolean) uid: botframework-streaming.INodeBuffer.readUInt32BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readUInt32BE(offset: number, noAssert?: boolean): number' @@ -1178,12 +1164,11 @@ methods: return: description: '' type: number - - name: 'readUInt32LE(number, boolean)' + - name: readUInt32LE(number, boolean) uid: botframework-streaming.INodeBuffer.readUInt32LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readUInt32LE(offset: number, noAssert?: boolean): number' @@ -1197,12 +1182,11 @@ methods: return: description: '' type: number - - name: 'readUInt8(number, boolean)' + - name: readUInt8(number, boolean) uid: botframework-streaming.INodeBuffer.readUInt8 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function readUInt8(offset: number, noAssert?: boolean): number' @@ -1216,12 +1200,11 @@ methods: return: description: '' type: number - - name: 'readUIntBE(number, number, boolean)' + - name: readUIntBE(number, number, boolean) uid: botframework-streaming.INodeBuffer.readUIntBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1240,12 +1223,11 @@ methods: return: description: '' type: number - - name: 'readUIntLE(number, number, boolean)' + - name: readUIntLE(number, number, boolean) uid: botframework-streaming.INodeBuffer.readUIntLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1264,15 +1246,14 @@ methods: return: description: '' type: number - - name: 'slice(number, number)' + - name: slice(number, number) uid: botframework-streaming.INodeBuffer.slice package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function slice(start?: number, end?: number): this' + content: 'function slice(start?: number, end?: number): INodeBuffer' parameters: - id: start type: number @@ -1282,61 +1263,56 @@ methods: description: '' return: description: '' - type: this + type: - name: swap16() uid: botframework-streaming.INodeBuffer.swap16 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function swap16(): this' + content: 'function swap16(): INodeBuffer' return: description: '' - type: this + type: - name: swap32() uid: botframework-streaming.INodeBuffer.swap32 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function swap32(): this' + content: 'function swap32(): INodeBuffer' return: description: '' - type: this + type: - name: swap64() uid: botframework-streaming.INodeBuffer.swap64 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function swap64(): this' + content: 'function swap64(): INodeBuffer' return: description: '' - type: this + type: - name: toJSON() uid: botframework-streaming.INodeBuffer.toJSON package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function toJSON(): { data: any[], type: "Buffer" }' return: description: '' type: '{ data: any[], type: "Buffer" }' - - name: 'toString(string, number, number)' + - name: toString(string, number, number) uid: botframework-streaming.INodeBuffer.toString package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1360,19 +1336,17 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function values(): IterableIterator' return: description: '' type: IterableIterator<number> - - name: 'write(string, number, number, string)' + - name: write(string, number, number, string) uid: botframework-streaming.INodeBuffer.write package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1394,12 +1368,11 @@ methods: return: description: '' type: number - - name: 'writeDoubleBE(number, number, boolean)' + - name: writeDoubleBE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeDoubleBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1418,12 +1391,11 @@ methods: return: description: '' type: number - - name: 'writeDoubleLE(number, number, boolean)' + - name: writeDoubleLE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeDoubleLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1442,12 +1414,11 @@ methods: return: description: '' type: number - - name: 'writeFloatBE(number, number, boolean)' + - name: writeFloatBE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeFloatBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1466,12 +1437,11 @@ methods: return: description: '' type: number - - name: 'writeFloatLE(number, number, boolean)' + - name: writeFloatLE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeFloatLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1490,12 +1460,11 @@ methods: return: description: '' type: number - - name: 'writeInt16BE(number, number, boolean)' + - name: writeInt16BE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeInt16BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1514,12 +1483,11 @@ methods: return: description: '' type: number - - name: 'writeInt16LE(number, number, boolean)' + - name: writeInt16LE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeInt16LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1538,12 +1506,11 @@ methods: return: description: '' type: number - - name: 'writeInt32BE(number, number, boolean)' + - name: writeInt32BE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeInt32BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1562,12 +1529,11 @@ methods: return: description: '' type: number - - name: 'writeInt32LE(number, number, boolean)' + - name: writeInt32LE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeInt32LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1586,12 +1552,11 @@ methods: return: description: '' type: number - - name: 'writeInt8(number, number, boolean)' + - name: writeInt8(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeInt8 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1610,12 +1575,11 @@ methods: return: description: '' type: number - - name: 'writeIntBE(number, number, number, boolean)' + - name: writeIntBE(number, number, number, boolean) uid: botframework-streaming.INodeBuffer.writeIntBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1637,12 +1601,11 @@ methods: return: description: '' type: number - - name: 'writeIntLE(number, number, number, boolean)' + - name: writeIntLE(number, number, number, boolean) uid: botframework-streaming.INodeBuffer.writeIntLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1664,12 +1627,11 @@ methods: return: description: '' type: number - - name: 'writeUInt16BE(number, number, boolean)' + - name: writeUInt16BE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUInt16BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1688,12 +1650,11 @@ methods: return: description: '' type: number - - name: 'writeUInt16LE(number, number, boolean)' + - name: writeUInt16LE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUInt16LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1712,12 +1673,11 @@ methods: return: description: '' type: number - - name: 'writeUInt32BE(number, number, boolean)' + - name: writeUInt32BE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUInt32BE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1736,12 +1696,11 @@ methods: return: description: '' type: number - - name: 'writeUInt32LE(number, number, boolean)' + - name: writeUInt32LE(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUInt32LE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1760,12 +1719,11 @@ methods: return: description: '' type: number - - name: 'writeUInt8(number, number, boolean)' + - name: writeUInt8(number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUInt8 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1784,12 +1742,11 @@ methods: return: description: '' type: number - - name: 'writeUIntBE(number, number, number, boolean)' + - name: writeUIntBE(number, number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUIntBE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1811,12 +1768,11 @@ methods: return: description: '' type: number - - name: 'writeUIntLE(number, number, number, boolean)' + - name: writeUIntLE(number, number, number, boolean) uid: botframework-streaming.INodeBuffer.writeUIntLE package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeIncomingMessage.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeIncomingMessage.yml index 82660ec1..5701b3b2 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeIncomingMessage.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeIncomingMessage.yml @@ -2,14 +2,14 @@ name: INodeIncomingMessage uid: botframework-streaming.INodeIncomingMessage package: botframework-streaming -summary: > +summary: >- Represents a IncomingMessage from the `http` module in Node.js. + This interface supports the framework and is not intended to be called directly for your code. fullName: INodeIncomingMessage remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +19,6 @@ properties: summary: Optional. The request headers. fullName: headers remarks: '' - isPreview: false isDeprecated: false syntax: content: 'headers?: any' @@ -32,7 +31,6 @@ properties: summary: Optional. The request method. fullName: method remarks: '' - isPreview: false isDeprecated: false syntax: content: 'method?: any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeServer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeServer.yml deleted file mode 100644 index 9fe6b753..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeServer.yml +++ /dev/null @@ -1,408 +0,0 @@ -### YamlMime:TSType -name: INodeServer -uid: botframework-streaming.INodeServer -package: botframework-streaming -summary: > - Represents a Server from the `net` module in Node.js. - - This interface supports the framework and is not intended to be called - directly for your code. -fullName: INodeServer -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: constructor - uid: botframework-streaming.INodeServer.constructor - package: botframework-streaming - summary: '' - fullName: constructor - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'constructor: this' - return: - description: '' - type: this -inheritedMethods: - - name: 'addListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.addListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addListener(event: string | symbol, listener: (args: any[]) => - void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.addListener](xref:botframework-streaming.IEventEmitter.addListener) - - name: 'emit(string | symbol, any[])' - uid: botframework-streaming.INodeServer.emit - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: string | symbol, args: any[]): boolean' - parameters: - - id: event - type: string | symbol - description: '' - - id: args - type: 'any[]' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [IEventEmitter.emit](xref:botframework-streaming.IEventEmitter.emit) - - name: eventNames() - uid: botframework-streaming.INodeServer.eventNames - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function eventNames(): Array' - return: - description: '' - type: Array<string | symbol> - inheritanceDescription: >- - Inherited From - [IEventEmitter.eventNames](xref:botframework-streaming.IEventEmitter.eventNames) - - name: getMaxListeners() - uid: botframework-streaming.INodeServer.getMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMaxListeners(): number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [IEventEmitter.getMaxListeners](xref:botframework-streaming.IEventEmitter.getMaxListeners) - - name: listenerCount(string | symbol) - uid: botframework-streaming.INodeServer.listenerCount - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listenerCount(type: string | symbol): number' - parameters: - - id: type - type: string | symbol - description: '' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [IEventEmitter.listenerCount](xref:botframework-streaming.IEventEmitter.listenerCount) - - name: listeners(string | symbol) - uid: botframework-streaming.INodeServer.listeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - inheritanceDescription: >- - Inherited From - [IEventEmitter.listeners](xref:botframework-streaming.IEventEmitter.listeners) - - name: 'off(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.off - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function off(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.off](xref:botframework-streaming.IEventEmitter.off) - - name: 'on(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.on - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function on(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.on](xref:botframework-streaming.IEventEmitter.on) - - name: 'once(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.once - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function once(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.once](xref:botframework-streaming.IEventEmitter.once) - - name: 'prependListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.prependListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.prependListener](xref:botframework-streaming.IEventEmitter.prependListener) - - name: 'prependOnceListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.prependOnceListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: string | symbol, listener: (args: - any[]) => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.prependOnceListener](xref:botframework-streaming.IEventEmitter.prependOnceListener) - - name: rawListeners(string | symbol) - uid: botframework-streaming.INodeServer.rawListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function rawListeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - inheritanceDescription: >- - Inherited From - [IEventEmitter.rawListeners](xref:botframework-streaming.IEventEmitter.rawListeners) - - name: removeAllListeners(string | symbol) - uid: botframework-streaming.INodeServer.removeAllListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllListeners(event?: string | symbol): this' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.removeAllListeners](xref:botframework-streaming.IEventEmitter.removeAllListeners) - - name: 'removeListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.INodeServer.removeListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.removeListener](xref:botframework-streaming.IEventEmitter.removeListener) - - name: setMaxListeners(number) - uid: botframework-streaming.INodeServer.setMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setMaxListeners(n: number): this' - parameters: - - id: 'n' - type: number - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.setMaxListeners](xref:botframework-streaming.IEventEmitter.setMaxListeners) -methods: - - name: 'close((err?: Error) => void)' - uid: botframework-streaming.INodeServer.close - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function close(callback?: (err?: Error) => void): this' - parameters: - - id: callback - type: '(err?: Error) => void' - description: '' - return: - description: '' - type: this - - name: 'listen(number, string, number, () => void)' - uid: botframework-streaming.INodeServer.listen - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function listen(port?: number, hostname?: string, backlog?: number, - listeningListener?: () => void): this - parameters: - - id: port - type: number - description: '' - - id: hostname - type: string - description: '' - - id: backlog - type: number - description: '' - - id: listeningListener - type: () => void - description: '' - return: - description: '' - type: this - - name: 'listen(string, () => void)' - uid: botframework-streaming.INodeServer.listen_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listen(path: string, listeningListener?: () => void): this' - parameters: - - id: path - type: string - description: '' - - id: listeningListener - type: () => void - description: '' - return: - description: '' - type: this -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeSocket.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeSocket.yml index c0348e32..dee56ed4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeSocket.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/INodeSocket.yml @@ -2,14 +2,14 @@ name: INodeSocket uid: botframework-streaming.INodeSocket package: botframework-streaming -summary: > +summary: >- Represents a Socket from the `net` module in Node.js. + This interface supports the framework and is not intended to be called directly for your code. fullName: INodeSocket remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +19,6 @@ properties: summary: '' fullName: bufferSize remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bufferSize: number' @@ -32,7 +31,6 @@ properties: summary: '' fullName: bytesRead remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bytesRead: number' @@ -45,7 +43,6 @@ properties: summary: '' fullName: bytesWritten remarks: '' - isPreview: false isDeprecated: false syntax: content: 'bytesWritten: number' @@ -58,7 +55,6 @@ properties: summary: '' fullName: connecting remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connecting: boolean' @@ -71,7 +67,6 @@ properties: summary: '' fullName: destroyed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'destroyed: boolean' @@ -84,7 +79,6 @@ properties: summary: '' fullName: localAddress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localAddress: string' @@ -97,7 +91,6 @@ properties: summary: '' fullName: localPort remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localPort: number' @@ -110,7 +103,6 @@ properties: summary: '' fullName: readable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'readable: boolean' @@ -123,20 +115,18 @@ properties: summary: '' fullName: readableFlowing remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'readableFlowing: boolean | null' + content: 'readableFlowing: null | boolean' return: description: '' - type: boolean | null + type: null | boolean - name: readableHighWaterMark uid: botframework-streaming.INodeSocket.readableHighWaterMark package: botframework-streaming summary: '' fullName: readableHighWaterMark remarks: '' - isPreview: false isDeprecated: false syntax: content: 'readableHighWaterMark: number' @@ -149,7 +139,6 @@ properties: summary: '' fullName: readableLength remarks: '' - isPreview: false isDeprecated: false syntax: content: 'readableLength: number' @@ -162,7 +151,6 @@ properties: summary: '' fullName: writable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'writable: boolean' @@ -175,7 +163,6 @@ properties: summary: '' fullName: writableHighWaterMark remarks: '' - isPreview: false isDeprecated: false syntax: content: 'writableHighWaterMark: number' @@ -188,7 +175,6 @@ properties: summary: '' fullName: writableLength remarks: '' - isPreview: false isDeprecated: false syntax: content: 'writableLength: number' @@ -196,15 +182,14 @@ properties: description: '' type: number methods: - - name: 'addListener("close", () => void)' + - name: addListener("close", () => void) uid: botframework-streaming.INodeSocket.addListener package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function addListener(event: "close", listener: () => void): this' + content: 'function addListener(event: "close", listener: () => void): INodeSocket' parameters: - id: event type: '"close"' @@ -214,18 +199,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'addListener("data", (chunk: any) => void)' uid: botframework-streaming.INodeSocket.addListener_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function addListener(event: "data", listener: (chunk: any) => void): - this + INodeSocket parameters: - id: event type: '"data"' @@ -235,16 +219,15 @@ methods: description: '' return: description: '' - type: this - - name: 'addListener("end", () => void)' + type: + - name: addListener("end", () => void) uid: botframework-streaming.INodeSocket.addListener_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function addListener(event: "end", listener: () => void): this' + content: 'function addListener(event: "end", listener: () => void): INodeSocket' parameters: - id: event type: '"end"' @@ -254,18 +237,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'addListener("error", (err: Error) => void)' uid: botframework-streaming.INodeSocket.addListener_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function addListener(event: "error", listener: (err: Error) => void): - this + INodeSocket parameters: - id: event type: '"error"' @@ -275,16 +257,17 @@ methods: description: '' return: description: '' - type: this - - name: 'addListener("readable", () => void)' + type: + - name: addListener("readable", () => void) uid: botframework-streaming.INodeSocket.addListener_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function addListener(event: "readable", listener: () => void): this' + content: >- + function addListener(event: "readable", listener: () => void): + INodeSocket parameters: - id: event type: '"readable"' @@ -294,18 +277,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'addListener(string | symbol, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.addListener_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function addListener(event: string | symbol, listener: (args: any[]) => - void): this + void): INodeSocket parameters: - id: event type: string | symbol @@ -315,25 +297,23 @@ methods: description: '' return: description: '' - type: this + type: - name: address() uid: botframework-streaming.INodeSocket.address package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function address(): AddressInfo | string' + content: 'function address(): string | AddressInfo' return: description: '' - type: | string - - name: 'connect(any, () => void)' + type: string | AddressInfo + - name: connect(any, () => void) uid: botframework-streaming.INodeSocket.connect package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(options: any, connectionListener?: () => void): any' @@ -347,12 +327,11 @@ methods: return: description: '' type: any - - name: 'connect(number, () => void)' + - name: connect(number, () => void) uid: botframework-streaming.INodeSocket.connect_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(port: number, connectionListener?: () => void): any' @@ -366,12 +345,11 @@ methods: return: description: '' type: any - - name: 'connect(number, string, () => void)' + - name: connect(number, string, () => void) uid: botframework-streaming.INodeSocket.connect_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -390,12 +368,11 @@ methods: return: description: '' type: any - - name: 'connect(string, () => void)' + - name: connect(string, () => void) uid: botframework-streaming.INodeSocket.connect_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(path: string, connectionListener?: () => void): any' @@ -414,7 +391,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function cork() @@ -423,7 +399,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function destroy(error?: Error)' @@ -436,7 +411,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(event: "close"): boolean' @@ -447,12 +421,11 @@ methods: return: description: '' type: boolean - - name: 'emit("data", any)' + - name: emit("data", any) uid: botframework-streaming.INodeSocket.emit_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(event: "data", chunk: any): boolean' @@ -471,7 +444,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(event: "end"): boolean' @@ -482,12 +454,11 @@ methods: return: description: '' type: boolean - - name: 'emit("error", Error)' + - name: emit("error", Error) uid: botframework-streaming.INodeSocket.emit_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(event: "error", err: Error): boolean' @@ -506,7 +477,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(event: "readable"): boolean' @@ -517,12 +487,11 @@ methods: return: description: '' type: boolean - - name: 'emit(string | symbol, any[])' + - name: emit(string | symbol, any[]) uid: botframework-streaming.INodeSocket.emit_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emit(event: string | symbol, args: any[]): boolean' @@ -531,7 +500,7 @@ methods: type: string | symbol description: '' - id: args - type: 'any[]' + type: any[] description: '' return: description: '' @@ -541,7 +510,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function end(cb?: () => void)' @@ -549,12 +517,11 @@ methods: - id: cb type: () => void description: '' - - name: 'end(any, () => void)' + - name: end(any, () => void) uid: botframework-streaming.INodeSocket.end_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function end(chunk: any, cb?: () => void)' @@ -565,12 +532,11 @@ methods: - id: cb type: () => void description: '' - - name: 'end(any, string, () => void)' + - name: end(any, string, () => void) uid: botframework-streaming.INodeSocket.end_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function end(chunk: any, encoding?: string, cb?: () => void)' @@ -589,19 +555,17 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function eventNames(): Array' + content: 'function eventNames(): (string | symbol)[]' return: description: '' - type: Array<string | symbol> + type: (string | symbol)[] - name: getMaxListeners() uid: botframework-streaming.INodeSocket.getMaxListeners package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getMaxListeners(): number' @@ -613,7 +577,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isPaused(): boolean' @@ -625,7 +588,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function listenerCount(type: string | symbol): number' @@ -641,7 +603,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function listeners(event: string | symbol): Function[]' @@ -651,18 +612,17 @@ methods: description: '' return: description: '' - type: 'Function[]' + type: Function[] - name: 'off(string | symbol, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.off package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function off(event: string | symbol, listener: (args: any[]) => void): - this + INodeSocket parameters: - id: event type: string | symbol @@ -672,18 +632,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'on("close", (had_error: boolean) => void)' uid: botframework-streaming.INodeSocket.on_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function on(event: "close", listener: (had_error: boolean) => void): - this + INodeSocket parameters: - id: event type: '"close"' @@ -693,16 +652,15 @@ methods: description: '' return: description: '' - type: this - - name: 'on("connect", () => void)' + type: + - name: on("connect", () => void) uid: botframework-streaming.INodeSocket.on_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function on(event: "connect", listener: () => void): this' + content: 'function on(event: "connect", listener: () => void): INodeSocket' parameters: - id: event type: '"connect"' @@ -712,16 +670,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'on("data", (data: INodeBuffer) => void)' uid: botframework-streaming.INodeSocket.on_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function on(event: "data", listener: (data: INodeBuffer) => void): this' + content: >- + function on(event: "data", listener: (data: INodeBuffer) => void): + INodeSocket parameters: - id: event type: '"data"' @@ -731,16 +690,15 @@ methods: description: '' return: description: '' - type: this - - name: 'on("end", () => void)' + type: + - name: on("end", () => void) uid: botframework-streaming.INodeSocket.on_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function on(event: "end", listener: () => void): this' + content: 'function on(event: "end", listener: () => void): INodeSocket' parameters: - id: event type: '"end"' @@ -750,16 +708,15 @@ methods: description: '' return: description: '' - type: this + type: - name: 'on("error", (err: Error) => void)' uid: botframework-streaming.INodeSocket.on_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function on(event: "error", listener: (err: Error) => void): this' + content: 'function on(event: "error", listener: (err: Error) => void): INodeSocket' parameters: - id: event type: '"error"' @@ -769,16 +726,15 @@ methods: description: '' return: description: '' - type: this + type: - name: 'on(string, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.on package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function on(event: string, listener: (args: any[]) => void): this' + content: 'function on(event: string, listener: (args: any[]) => void): INodeSocket' parameters: - id: event type: string @@ -788,16 +744,15 @@ methods: description: '' return: description: '' - type: this - - name: 'once("close", () => void)' + type: + - name: once("close", () => void) uid: botframework-streaming.INodeSocket.once package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function once(event: "close", listener: () => void): this' + content: 'function once(event: "close", listener: () => void): INodeSocket' parameters: - id: event type: '"close"' @@ -807,16 +762,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'once("data", (chunk: any) => void)' uid: botframework-streaming.INodeSocket.once_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function once(event: "data", listener: (chunk: any) => void): this' + content: >- + function once(event: "data", listener: (chunk: any) => void): + INodeSocket parameters: - id: event type: '"data"' @@ -826,16 +782,15 @@ methods: description: '' return: description: '' - type: this - - name: 'once("end", () => void)' + type: + - name: once("end", () => void) uid: botframework-streaming.INodeSocket.once_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function once(event: "end", listener: () => void): this' + content: 'function once(event: "end", listener: () => void): INodeSocket' parameters: - id: event type: '"end"' @@ -845,16 +800,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'once("error", (err: Error) => void)' uid: botframework-streaming.INodeSocket.once_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function once(event: "error", listener: (err: Error) => void): this' + content: >- + function once(event: "error", listener: (err: Error) => void): + INodeSocket parameters: - id: event type: '"error"' @@ -864,16 +820,15 @@ methods: description: '' return: description: '' - type: this - - name: 'once("readable", () => void)' + type: + - name: once("readable", () => void) uid: botframework-streaming.INodeSocket.once_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function once(event: "readable", listener: () => void): this' + content: 'function once(event: "readable", listener: () => void): INodeSocket' parameters: - id: event type: '"readable"' @@ -883,18 +838,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'once(string | symbol, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.once_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function once(event: string | symbol, listener: (args: any[]) => void): - this + INodeSocket parameters: - id: event type: string | symbol @@ -904,25 +858,23 @@ methods: description: '' return: description: '' - type: this + type: - name: pause() uid: botframework-streaming.INodeSocket.pause package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function pause(): this' + content: 'function pause(): INodeSocket' return: description: '' - type: this + type: - name: 'pipe(T, { end?: boolean })' uid: botframework-streaming.INodeSocket.pipe package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function pipe(destination: T, options?: { end?: boolean }): T' @@ -936,15 +888,16 @@ methods: return: description: '' type: T - - name: 'prependListener("close", () => void)' + - name: prependListener("close", () => void) uid: botframework-streaming.INodeSocket.prependListener package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function prependListener(event: "close", listener: () => void): this' + content: >- + function prependListener(event: "close", listener: () => void): + INodeSocket parameters: - id: event type: '"close"' @@ -954,18 +907,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'prependListener("data", (chunk: any) => void)' uid: botframework-streaming.INodeSocket.prependListener_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependListener(event: "data", listener: (chunk: any) => void): - this + INodeSocket parameters: - id: event type: '"data"' @@ -975,16 +927,17 @@ methods: description: '' return: description: '' - type: this - - name: 'prependListener("end", () => void)' + type: + - name: prependListener("end", () => void) uid: botframework-streaming.INodeSocket.prependListener_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function prependListener(event: "end", listener: () => void): this' + content: >- + function prependListener(event: "end", listener: () => void): + INodeSocket parameters: - id: event type: '"end"' @@ -994,18 +947,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'prependListener("error", (err: Error) => void)' uid: botframework-streaming.INodeSocket.prependListener_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependListener(event: "error", listener: (err: Error) => - void): this + void): INodeSocket parameters: - id: event type: '"error"' @@ -1015,16 +967,17 @@ methods: description: '' return: description: '' - type: this - - name: 'prependListener("readable", () => void)' + type: + - name: prependListener("readable", () => void) uid: botframework-streaming.INodeSocket.prependListener_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function prependListener(event: "readable", listener: () => void): this' + content: >- + function prependListener(event: "readable", listener: () => void): + INodeSocket parameters: - id: event type: '"readable"' @@ -1034,18 +987,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'prependListener(string | symbol, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.prependListener_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependListener(event: string | symbol, listener: (args: any[]) - => void): this + => void): INodeSocket parameters: - id: event type: string | symbol @@ -1055,16 +1007,17 @@ methods: description: '' return: description: '' - type: this - - name: 'prependOnceListener("close", () => void)' + type: + - name: prependOnceListener("close", () => void) uid: botframework-streaming.INodeSocket.prependOnceListener package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function prependOnceListener(event: "close", listener: () => void): this' + content: >- + function prependOnceListener(event: "close", listener: () => void): + INodeSocket parameters: - id: event type: '"close"' @@ -1074,18 +1027,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'prependOnceListener("data", (chunk: any) => void)' uid: botframework-streaming.INodeSocket.prependOnceListener_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependOnceListener(event: "data", listener: (chunk: any) => - void): this + void): INodeSocket parameters: - id: event type: '"data"' @@ -1095,16 +1047,17 @@ methods: description: '' return: description: '' - type: this - - name: 'prependOnceListener("end", () => void)' + type: + - name: prependOnceListener("end", () => void) uid: botframework-streaming.INodeSocket.prependOnceListener_2 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function prependOnceListener(event: "end", listener: () => void): this' + content: >- + function prependOnceListener(event: "end", listener: () => void): + INodeSocket parameters: - id: event type: '"end"' @@ -1114,18 +1067,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'prependOnceListener("error", (err: Error) => void)' uid: botframework-streaming.INodeSocket.prependOnceListener_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependOnceListener(event: "error", listener: (err: Error) => - void): this + void): INodeSocket parameters: - id: event type: '"error"' @@ -1135,18 +1087,17 @@ methods: description: '' return: description: '' - type: this - - name: 'prependOnceListener("readable", () => void)' + type: + - name: prependOnceListener("readable", () => void) uid: botframework-streaming.INodeSocket.prependOnceListener_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependOnceListener(event: "readable", listener: () => void): - this + INodeSocket parameters: - id: event type: '"readable"' @@ -1156,18 +1107,17 @@ methods: description: '' return: description: '' - type: this + type: - name: 'prependOnceListener(string | symbol, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.prependOnceListener_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function prependOnceListener(event: string | symbol, listener: (args: - any[]) => void): this + any[]) => void): INodeSocket parameters: - id: event type: string | symbol @@ -1177,13 +1127,12 @@ methods: description: '' return: description: '' - type: this - - name: 'push(any, string)' + type: + - name: push(any, string) uid: botframework-streaming.INodeSocket.push package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function push(chunk: any, encoding?: string): boolean' @@ -1202,7 +1151,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function rawListeners(event: string | symbol): Function[]' @@ -1212,13 +1160,12 @@ methods: description: '' return: description: '' - type: 'Function[]' + type: Function[] - name: read(number) uid: botframework-streaming.INodeSocket.read package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function read(size?: number): any' @@ -1234,7 +1181,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function ref(): any' @@ -1246,28 +1192,26 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function removeAllListeners(event?: string | symbol): this' + content: 'function removeAllListeners(event?: string | symbol): INodeSocket' parameters: - id: event type: string | symbol description: '' return: description: '' - type: this + type: - name: 'removeListener(string | symbol, (args: any[]) => void)' uid: botframework-streaming.INodeSocket.removeListener package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function removeListener(event: string | symbol, listener: (args: any[]) - => void): this + => void): INodeSocket parameters: - id: event type: string | symbol @@ -1277,60 +1221,58 @@ methods: description: '' return: description: '' - type: this + type: - name: resume() uid: botframework-streaming.INodeSocket.resume package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function resume(): this' + content: 'function resume(): INodeSocket' return: description: '' - type: this + type: - name: setDefaultEncoding(string) uid: botframework-streaming.INodeSocket.setDefaultEncoding package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setDefaultEncoding(encoding: string): this' + content: 'function setDefaultEncoding(encoding: string): INodeSocket' parameters: - id: encoding type: string description: '' return: description: '' - type: this + type: - name: setEncoding(string) uid: botframework-streaming.INodeSocket.setEncoding package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setEncoding(encoding: string): this' + content: 'function setEncoding(encoding: string): INodeSocket' parameters: - id: encoding type: string description: '' return: description: '' - type: this - - name: 'setKeepAlive(boolean, number)' + type: + - name: setKeepAlive(boolean, number) uid: botframework-streaming.INodeSocket.setKeepAlive package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setKeepAlive(enable?: boolean, initialDelay?: number): this' + content: >- + function setKeepAlive(enable?: boolean, initialDelay?: number): + INodeSocket parameters: - id: enable type: boolean @@ -1340,48 +1282,45 @@ methods: description: '' return: description: '' - type: this + type: - name: setMaxListeners(number) uid: botframework-streaming.INodeSocket.setMaxListeners package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setMaxListeners(n: number): this' + content: 'function setMaxListeners(n: number): INodeSocket' parameters: - id: 'n' type: number description: '' return: description: '' - type: this + type: - name: setNoDelay(boolean) uid: botframework-streaming.INodeSocket.setNoDelay package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setNoDelay(noDelay?: boolean): this' + content: 'function setNoDelay(noDelay?: boolean): INodeSocket' parameters: - id: noDelay type: boolean description: '' return: description: '' - type: this - - name: 'setTimeout(number, () => void)' + type: + - name: setTimeout(number, () => void) uid: botframework-streaming.INodeSocket.setTimeout package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setTimeout(timeout: number, callback?: () => void): this' + content: 'function setTimeout(timeout: number, callback?: () => void): INodeSocket' parameters: - id: timeout type: number @@ -1391,13 +1330,12 @@ methods: description: '' return: description: '' - type: this + type: - name: uncork() uid: botframework-streaming.INodeSocket.uncork package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function uncork() @@ -1406,23 +1344,21 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function unpipe(destination?: any): this' + content: 'function unpipe(destination?: any): INodeSocket' parameters: - id: destination type: any description: '' return: description: '' - type: this + type: - name: unref() uid: botframework-streaming.INodeSocket.unref package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unref(): any' @@ -1434,7 +1370,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unshift(chunk: any)' @@ -1447,49 +1382,46 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function wrap(oldStream: any): this' + content: 'function wrap(oldStream: any): INodeSocket' parameters: - id: oldStream type: any description: '' return: description: '' - type: this - - name: 'write(any, (error: Error | null | undefined) => void)' + type: + - name: 'write(any, (error: undefined | null | Error) => void)' uid: botframework-streaming.INodeSocket.write_6 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function write(chunk: any, cb?: (error: Error | null | undefined) => + function write(chunk: any, cb?: (error: undefined | null | Error) => void): boolean parameters: - id: chunk type: any description: '' - id: cb - type: '(error: Error | null | undefined) => void' + type: '(error: undefined | null | Error) => void' description: '' return: description: '' type: boolean - - name: 'write(any, string, (error: Error | null | undefined) => void)' + - name: 'write(any, string, (error: undefined | null | Error) => void)' uid: botframework-streaming.INodeSocket.write_7 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function write(chunk: any, encoding?: string, cb?: (error: Error | null - | undefined) => void): boolean + function write(chunk: any, encoding?: string, cb?: (error: undefined | + null | Error) => void): boolean parameters: - id: chunk type: any @@ -1498,17 +1430,16 @@ methods: type: string description: '' - id: cb - type: '(error: Error | null | undefined) => void' + type: '(error: undefined | null | Error) => void' description: '' return: description: '' type: boolean - - name: 'write(any, string, Function)' + - name: write(any, string, Function) uid: botframework-streaming.INodeSocket.write_5 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(data: any, encoding?: string, callback?: Function)' @@ -1522,12 +1453,11 @@ methods: - id: callback type: Function description: '' - - name: 'write(string, Function)' + - name: write(string, Function) uid: botframework-streaming.INodeSocket.write_3 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(str: string, cb?: Function): boolean' @@ -1541,12 +1471,11 @@ methods: return: description: '' type: boolean - - name: 'write(string, string, Function)' + - name: write(string, string, Function) uid: botframework-streaming.INodeSocket.write_1 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(str: string, encoding?: string, cb?: Function): boolean' @@ -1563,12 +1492,11 @@ methods: return: description: '' type: boolean - - name: 'write(string, string, string)' + - name: write(string, string, string) uid: botframework-streaming.INodeSocket.write_4 package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(str: string, encoding?: string, fd?: string): boolean' @@ -1590,13 +1518,12 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(buffer: ValidBuffer): boolean' parameters: - id: buffer - type: + type: ValidBuffer description: '' return: description: '' @@ -1606,13 +1533,12 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(buffer: ValidBuffer, cb?: (err?: Error) => void): boolean' parameters: - id: buffer - type: + type: ValidBuffer description: '' - id: cb type: '(err?: Error) => void' @@ -1620,3 +1546,14 @@ methods: return: description: '' type: boolean + - name: '[asyncIterator]()' + uid: botframework-streaming.INodeSocket.[asyncIterator] + package: botframework-streaming + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function [asyncIterator](): AsyncIterableIterator' + return: + description: '' + type: AsyncIterableIterator<any> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveRequest.yml index 5458283b..a6b77f29 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveRequest.yml @@ -5,7 +5,6 @@ package: botframework-streaming summary: Streaming receive request definition. fullName: IReceiveRequest remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: Request path; null on responses. fullName: path remarks: '' - isPreview: false isDeprecated: false syntax: content: 'path?: string' @@ -30,20 +28,18 @@ properties: request. fullName: streams remarks: '' - isPreview: false isDeprecated: false syntax: content: 'streams: ContentStream[]' return: description: '' - type: '[]' + type: [] - name: verb uid: botframework-streaming.IReceiveRequest.verb package: botframework-streaming summary: Request verb; null on responses. fullName: verb remarks: '' - isPreview: false isDeprecated: false syntax: content: 'verb?: string' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveResponse.yml index dea5c710..7f1d8dc1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IReceiveResponse.yml @@ -5,7 +5,6 @@ package: botframework-streaming summary: Streaming response from a receive request. fullName: IReceiveResponse remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode?: number' @@ -28,10 +26,9 @@ properties: summary: '' fullName: streams remarks: '' - isPreview: false isDeprecated: false syntax: content: 'streams: ContentStream[]' return: description: '' - type: '[]' + type: [] diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IRequestPayload.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IRequestPayload.yml deleted file mode 100644 index d1575c01..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IRequestPayload.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: IRequestPayload -uid: botframework-streaming.IRequestPayload -package: botframework-streaming -summary: Definition for a streaming request payload. -fullName: IRequestPayload -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: path - uid: botframework-streaming.IRequestPayload.path - package: botframework-streaming - summary: '' - fullName: path - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'path: string' - return: - description: '' - type: string - - name: streams - uid: botframework-streaming.IRequestPayload.streams - package: botframework-streaming - summary: '' - fullName: streams - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'streams?: IStreamDescription[]' - return: - description: '' - type: '[]' - - name: verb - uid: botframework-streaming.IRequestPayload.verb - package: botframework-streaming - summary: '' - fullName: verb - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'verb: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IResponsePayload.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IResponsePayload.yml deleted file mode 100644 index ade6b7bb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IResponsePayload.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: IResponsePayload -uid: botframework-streaming.IResponsePayload -package: botframework-streaming -summary: Base class for all dialogs. -fullName: IResponsePayload -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: statusCode - uid: botframework-streaming.IResponsePayload.statusCode - package: botframework-streaming - summary: '' - fullName: statusCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'statusCode: number' - return: - description: '' - type: number - - name: streams - uid: botframework-streaming.IResponsePayload.streams - package: botframework-streaming - summary: '' - fullName: streams - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'streams?: IStreamDescription[]' - return: - description: '' - type: '[]' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISendPacket.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISendPacket.yml deleted file mode 100644 index 7ae1b0b3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISendPacket.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: ISendPacket -uid: botframework-streaming.ISendPacket -package: botframework-streaming -summary: Streaming send packet definition. -fullName: ISendPacket -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: header - uid: botframework-streaming.ISendPacket.header - package: botframework-streaming - summary: '' - fullName: header - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'header: IHeader' - return: - description: '' - type: - - name: payload - uid: botframework-streaming.ISendPacket.payload - package: botframework-streaming - summary: '' - fullName: payload - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payload: SubscribableStream' - return: - description: '' - type: - - name: sentCallback - uid: botframework-streaming.ISendPacket.sentCallback - package: botframework-streaming - summary: '' - fullName: sentCallback - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sentCallback: () => Promise' - return: - description: '' - type: () => Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISocket.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISocket.yml index dfdeccf0..1bab07e5 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISocket.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ISocket.yml @@ -5,7 +5,6 @@ package: botframework-streaming summary: '' fullName: ISocket remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: isConnected remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isConnected: boolean' @@ -28,7 +26,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function close(): any' @@ -40,7 +37,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(serverAddress: string): Promise' @@ -56,7 +52,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setOnCloseHandler(handler: (x: any) => void): any' @@ -72,7 +67,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setOnErrorHandler(handler: (x: any) => void): any' @@ -88,7 +82,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setOnMessageHandler(handler: (x: any) => void): any' @@ -104,7 +97,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(buffer: INodeBuffer): any' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamDescription.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamDescription.yml deleted file mode 100644 index d48092a0..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamDescription.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: IStreamDescription -uid: botframework-streaming.IStreamDescription -package: botframework-streaming -summary: Definition of a stream description. -fullName: IStreamDescription -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: contentType - uid: botframework-streaming.IStreamDescription.contentType - package: botframework-streaming - summary: '' - fullName: contentType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'contentType?: string' - return: - description: '' - type: string - - name: id - uid: botframework-streaming.IStreamDescription.id - package: botframework-streaming - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - - name: length - uid: botframework-streaming.IStreamDescription.length - package: botframework-streaming - summary: '' - fullName: length - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'length?: number' - return: - description: '' - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamWrapper.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamWrapper.yml deleted file mode 100644 index 7e52fc67..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamWrapper.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: IStreamWrapper -uid: botframework-streaming.IStreamWrapper -package: botframework-streaming -summary: Stream with length. -fullName: IStreamWrapper -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: stream - uid: botframework-streaming.IStreamWrapper.stream - package: botframework-streaming - summary: '' - fullName: stream - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stream: SubscribableStream' - return: - description: '' - type: - - name: streamLength - uid: botframework-streaming.IStreamWrapper.streamLength - package: botframework-streaming - summary: '' - fullName: streamLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'streamLength?: number' - return: - description: '' - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportClient.yml index a9a76b55..2dfc404c 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportClient.yml @@ -9,7 +9,6 @@ summary: >- NamedPipe transport client. fullName: IStreamingTransportClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -18,7 +17,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(): Promise' @@ -30,7 +28,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function disconnect() @@ -39,7 +36,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(request: StreamingRequest): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportServer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportServer.yml index 45393115..c99e7fc1 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportServer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/IStreamingTransportServer.yml @@ -9,7 +9,6 @@ summary: >- NamedPipe transport server. fullName: IStreamingTransportServer remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -19,7 +18,6 @@ properties: summary: '' fullName: isConnected remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isConnected?: boolean' @@ -32,7 +30,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function disconnect() @@ -41,7 +38,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(request: StreamingRequest): Promise' @@ -57,7 +53,6 @@ methods: package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function start(onListen?: () => void): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransport.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransport.yml deleted file mode 100644 index 68ed4810..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransport.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: ITransport -uid: botframework-streaming.ITransport -package: botframework-streaming -summary: Abstraction for a generic transport definition. -fullName: ITransport -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: isConnected - uid: botframework-streaming.ITransport.isConnected - package: botframework-streaming - summary: '' - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isConnected: boolean' - return: - description: '' - type: boolean -methods: - - name: close() - uid: botframework-streaming.ITransport.close - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function close(): any' - return: - description: '' - type: any diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportReceiver.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportReceiver.yml deleted file mode 100644 index 139fc606..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportReceiver.yml +++ /dev/null @@ -1,61 +0,0 @@ -### YamlMime:TSType -name: ITransportReceiver -uid: botframework-streaming.ITransportReceiver -package: botframework-streaming -summary: Definition of a streaming transport that can receive requests. -fullName: ITransportReceiver -remarks: '' -isPreview: false -isDeprecated: false -type: interface -inheritedProperties: - - name: isConnected - uid: botframework-streaming.ITransportReceiver.isConnected - package: botframework-streaming - summary: '' - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isConnected: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [ITransport.isConnected](xref:botframework-streaming.ITransport.isConnected) -inheritedMethods: - - name: close() - uid: botframework-streaming.ITransportReceiver.close - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function close(): any' - return: - description: '' - type: any - inheritanceDescription: >- - Inherited From - [ITransport.close](xref:botframework-streaming.ITransport.close) -methods: - - name: receive(number) - uid: botframework-streaming.ITransportReceiver.receive - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function receive(count: number): Promise' - parameters: - - id: count - type: number - description: '' - return: - description: '' - type: Promise<> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportSender.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportSender.yml deleted file mode 100644 index 5474af82..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ITransportSender.yml +++ /dev/null @@ -1,61 +0,0 @@ -### YamlMime:TSType -name: ITransportSender -uid: botframework-streaming.ITransportSender -package: botframework-streaming -summary: Definition of a streaming transport that can send requests. -fullName: ITransportSender -remarks: '' -isPreview: false -isDeprecated: false -type: interface -inheritedProperties: - - name: isConnected - uid: botframework-streaming.ITransportSender.isConnected - package: botframework-streaming - summary: '' - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isConnected: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [ITransport.isConnected](xref:botframework-streaming.ITransport.isConnected) -inheritedMethods: - - name: close() - uid: botframework-streaming.ITransportSender.close - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function close(): any' - return: - description: '' - type: any - inheritanceDescription: >- - Inherited From - [ITransport.close](xref:botframework-streaming.ITransport.close) -methods: - - name: send(INodeBuffer) - uid: botframework-streaming.ITransportSender.send - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function send(buffer: INodeBuffer): number' - parameters: - - id: buffer - type: - description: '' - return: - description: '' - type: number -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeClient.yml index 290817e8..7463fb5b 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeClient.yml @@ -7,18 +7,16 @@ summary: >- inter-process communication. fullName: NamedPipeClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NamedPipeClient(string, RequestHandler, boolean)' + - name: NamedPipeClient(string, RequestHandler, boolean) uid: botframework-streaming.NamedPipeClient.constructor package: botframework-streaming summary: >- Creates a new instance of the [NamedPipeClient](xref:botframework-streaming.NamedPipeClient) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,7 @@ constructors: process incoming messages received by this client. - id: autoReconnect type: boolean - description: > + description: >- Optional setting to determine if the client sould attempt to reconnect automatically on disconnection events. Defaults to true. methods: @@ -45,7 +43,6 @@ methods: package: botframework-streaming summary: Establish a connection with no custom headers. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(): Promise' @@ -57,7 +54,6 @@ methods: package: botframework-streaming summary: Disconnect the client. remarks: '' - isPreview: false isDeprecated: false syntax: content: function disconnect() @@ -66,7 +62,6 @@ methods: package: botframework-streaming summary: Task used to send data over this client connection. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(request: StreamingRequest): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeServer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeServer.yml index 0a017e3c..76afdd14 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeServer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeServer.yml @@ -7,18 +7,16 @@ summary: >- inter-process communication. fullName: NamedPipeServer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NamedPipeServer(string, RequestHandler, boolean)' + - name: NamedPipeServer(string, RequestHandler, boolean) uid: botframework-streaming.NamedPipeServer.constructor package: botframework-streaming summary: >- Creates a new instance of the [NamedPipeServer](xref:botframework-streaming.NamedPipeServer) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,8 +34,7 @@ constructors: process incoming messages received by this client. - id: autoReconnect type: boolean - description: | - Deprecated: Automatic reconnection is the default behavior. + description: 'Deprecated: Automatic reconnection is the default behavior.' properties: - name: isConnected uid: botframework-streaming.NamedPipeServer.isConnected @@ -45,7 +42,6 @@ properties: summary: Get connected status fullName: isConnected remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean isConnected @@ -58,7 +54,6 @@ methods: package: botframework-streaming summary: Allows for manually disconnecting the server. remarks: '' - isPreview: false isDeprecated: false syntax: content: function disconnect() @@ -67,7 +62,6 @@ methods: package: botframework-streaming summary: Task used to send data over this client connection. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(request: StreamingRequest): Promise' @@ -90,7 +84,6 @@ methods: Used to establish the connection used by this server and begin listening for incoming messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function start(onListen?: () => void): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeTransport.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeTransport.yml deleted file mode 100644 index fe4130ae..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NamedPipeTransport.yml +++ /dev/null @@ -1,127 +0,0 @@ -### YamlMime:TSType -name: NamedPipeTransport -uid: botframework-streaming.NamedPipeTransport -package: botframework-streaming -summary: Named pipes based transport sender and receiver abstraction -fullName: NamedPipeTransport -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: NamedPipeTransport(INodeSocket) - uid: botframework-streaming.NamedPipeTransport.constructor - package: botframework-streaming - summary: >- - Creates a new instance of the - [NamedPipeTransport](xref:botframework-streaming.NamedPipeTransport) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new NamedPipeTransport(socket: INodeSocket)' - parameters: - - id: socket - type: - description: | - The socket object to build this connection on. -properties: - - name: isConnected - uid: botframework-streaming.NamedPipeTransport.isConnected - package: botframework-streaming - summary: Returns `true` if currently connected. - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: boolean isConnected - return: - description: >- - `true` if the the transport is connected and ready to send data, - `false` otherwise. - type: boolean - - name: PipePath - uid: botframework-streaming.NamedPipeTransport.PipePath - package: botframework-streaming - summary: '' - fullName: PipePath - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static PipePath: string' - return: - description: '' - type: string - - name: ServerIncomingPath - uid: botframework-streaming.NamedPipeTransport.ServerIncomingPath - package: botframework-streaming - summary: '' - fullName: ServerIncomingPath - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ServerIncomingPath: string' - return: - description: '' - type: string - - name: ServerOutgoingPath - uid: botframework-streaming.NamedPipeTransport.ServerOutgoingPath - package: botframework-streaming - summary: '' - fullName: ServerOutgoingPath - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static ServerOutgoingPath: string' - return: - description: '' - type: string -methods: - - name: close() - uid: botframework-streaming.NamedPipeTransport.close - package: botframework-streaming - summary: Closes the transport. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function close() - - name: receive(number) - uid: botframework-streaming.NamedPipeTransport.receive - package: botframework-streaming - summary: Receive from the transport into the buffer. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function receive(count: number): Promise' - parameters: - - id: count - type: number - description: The maximum amount of bytes to write to the buffer. - return: - description: The buffer containing the data from the transport. - type: Promise<> - - name: send(INodeBuffer) - uid: botframework-streaming.NamedPipeTransport.send - package: botframework-streaming - summary: Writes to the pipe and sends. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function send(buffer: INodeBuffer): number' - parameters: - - id: buffer - type: - description: The buffer full of data to send out across the socket. - return: - description: >- - A number indicating the length of the sent data if the data was - successfully sent, otherwise 0. - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocket.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocket.yml index b7bd182c..bdb1cfd8 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocket.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocket.yml @@ -9,7 +9,6 @@ summary: >- create a WebSocket server. fullName: NodeWebSocket remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -20,15 +19,13 @@ constructors: Creates a new [NodeWebSocket](xref:botframework-streaming.NodeWebSocket) instance. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new NodeWebSocket(wsSocket?: WebSocket)' parameters: - id: wsSocket type: WebSocket - description: | - The `ws` WebSocket instance to build this connection on. + description: The `ws` WebSocket instance to build this connection on. properties: - name: isConnected uid: botframework-streaming.NodeWebSocket.isConnected @@ -38,7 +35,6 @@ properties: messages. fullName: isConnected remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean isConnected @@ -48,14 +44,13 @@ properties: messages, otherwise `false`. type: boolean methods: - - name: 'close(number, string)' + - name: close(number, string) uid: botframework-streaming.NodeWebSocket.close package: botframework-streaming summary: Close the socket. remarks: >- Optionally pass in a status code and string explaining why the connection is closing. - isPreview: false isDeprecated: false syntax: content: 'function close(code?: number, data?: string)' @@ -65,35 +60,36 @@ methods: description: Optional status code to explain why the connection has closed. - id: data type: string - description: | - Optional additional data to explain why the connection has closed. - - name: 'connect(string, number)' + description: Optional additional data to explain why the connection has closed. + - name: connect(string, number) uid: botframework-streaming.NodeWebSocket.connect package: botframework-streaming summary: Connects to the supporting socket using WebSocket protocol. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function connect(serverAddress: string, port?: number): Promise' + content: >- + function connect(serverAddressOrHostName: string, port?: number): + Promise parameters: - - id: serverAddress + - id: serverAddressOrHostName type: string - description: The address the server is listening on. + description: The host name or URL the server is listening on. - id: port type: number - description: 'The port the server is listening on, defaults to 8082.' + description: >- + If `serverAddressOrHostName` is a host name, the port the server is + listening on, defaults to 8082. Otherwise, this argument is ignored. return: description: >- A Promise that resolves when the websocket connection is closed, or rejects on an error. type: Promise<void> - - name: 'create(INodeIncomingMessage, INodeSocket, INodeBuffer)' + - name: create(INodeIncomingMessage, INodeSocket, INodeBuffer) uid: botframework-streaming.NodeWebSocket.create package: botframework-streaming - summary: 'Create and set a `ws` WebSocket with an HTTP Request, Socket and Buffer.' + summary: Create and set a `ws` WebSocket with an HTTP Request, Socket and Buffer. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -126,56 +122,46 @@ methods: package: botframework-streaming summary: Set the callback to call when encountering socket closures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setOnCloseHandler(handler: (x: any) => void)' parameters: - id: handler type: '(x: any) => void' - description: | - The callback to handle the "close" event. + description: The callback to handle the "close" event. - name: 'setOnErrorHandler((x: any) => void)' uid: botframework-streaming.NodeWebSocket.setOnErrorHandler package: botframework-streaming summary: Set the callback to call when encountering errors. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setOnErrorHandler(handler: (x: any) => void)' parameters: - id: handler type: '(x: any) => void' - description: | - The callback to handle the "error" event. + description: The callback to handle the "error" event. - name: 'setOnMessageHandler((x: any) => void)' uid: botframework-streaming.NodeWebSocket.setOnMessageHandler package: botframework-streaming - summary: >- - Set the handler for `'data'` and `'message'` events received on the - socket. + summary: Set the handler for `'message'` events received on the socket. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setOnMessageHandler(handler: (x: any) => void)' parameters: - id: handler type: '(x: any) => void' - description: | - The callback to handle the "message" event. + description: The callback to handle the "message" event. - name: write(INodeBuffer) uid: botframework-streaming.NodeWebSocket.write package: botframework-streaming summary: Writes a buffer to the socket and sends it. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function write(buffer: INodeBuffer)' parameters: - id: buffer type: - description: | - The buffer of data to send across the connection. + description: The buffer of data to send across the connection. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactory.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactory.yml index ae3f87fb..225c0095 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactory.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactory.yml @@ -5,7 +5,6 @@ package: botframework-streaming summary: Represents a NodeWebSocketFactory to create a WebSocket server. fullName: NodeWebSocketFactory remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,12 +16,11 @@ constructors: [NodeWebSocketFactory](xref:botframework-streaming.NodeWebSocketFactory) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: new NodeWebSocketFactory() methods: - - name: 'createWebSocket(INodeIncomingMessage, INodeSocket, INodeBuffer)' + - name: createWebSocket(INodeIncomingMessage, INodeSocket, INodeBuffer) uid: botframework-streaming.NodeWebSocketFactory.createWebSocket package: botframework-streaming summary: >- @@ -31,7 +29,6 @@ methods: remarks: >- The parameters for this method should be associated with an 'upgrade' event off of a Node.js HTTP Server. - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactoryBase.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactoryBase.yml index 213f5863..1ada3df0 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactoryBase.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/NodeWebSocketFactoryBase.yml @@ -5,16 +5,14 @@ package: botframework-streaming summary: Represents an abstract NodeWebSocketFactoryBase class to create a WebSocket. fullName: NodeWebSocketFactoryBase remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'createWebSocket(INodeIncomingMessage, INodeSocket, INodeBuffer)' + - name: createWebSocket(INodeIncomingMessage, INodeSocket, INodeBuffer) uid: botframework-streaming.NodeWebSocketFactoryBase.createWebSocket package: botframework-streaming summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssembler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssembler.yml deleted file mode 100644 index 0a47ff61..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssembler.yml +++ /dev/null @@ -1,135 +0,0 @@ -### YamlMime:TSType -name: PayloadAssembler -uid: botframework-streaming.PayloadAssembler -package: botframework-streaming -summary: Assembles payloads for streaming library. -fullName: PayloadAssembler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'PayloadAssembler(StreamManager, IAssemblerParams)' - uid: botframework-streaming.PayloadAssembler.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new PayloadAssembler(streamManager: StreamManager, params: - IAssemblerParams) - parameters: - - id: streamManager - type: - description: >- - The [StreamManager](xref:botframework-streaming.StreamManager) - managing the stream being assembled. - - id: params - type: - description: | - Parameters for a streaming assembler. -properties: - - name: contentLength - uid: botframework-streaming.PayloadAssembler.contentLength - package: botframework-streaming - summary: '' - fullName: contentLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'contentLength: number' - return: - description: '' - type: number - - name: end - uid: botframework-streaming.PayloadAssembler.end - package: botframework-streaming - summary: '' - fullName: end - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'end: boolean' - return: - description: '' - type: boolean - - name: id - uid: botframework-streaming.PayloadAssembler.id - package: botframework-streaming - summary: '' - fullName: id - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'id: string' - return: - description: '' - type: string - - name: payloadType - uid: botframework-streaming.PayloadAssembler.payloadType - package: botframework-streaming - summary: '' - fullName: payloadType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadType: string | PayloadTypes' - return: - description: '' - type: string | -methods: - - name: close() - uid: botframework-streaming.PayloadAssembler.close - package: botframework-streaming - summary: Closes the assembler. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function close() - - name: getPayloadStream() - uid: botframework-streaming.PayloadAssembler.getPayloadStream - package: botframework-streaming - summary: Retrieves the assembler's payload as a stream. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPayloadStream(): SubscribableStream' - return: - description: >- - A [SubscribableStream](xref:botframework-streaming.SubscribableStream) - of the assembler's payload. - type: - - name: 'onReceive(IHeader, SubscribableStream, number)' - uid: botframework-streaming.PayloadAssembler.onReceive - package: botframework-streaming - summary: >- - The action the assembler executes when new bytes are received on the - incoming stream. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onReceive(header: IHeader, stream: SubscribableStream, - _contentLength: number) - parameters: - - id: header - type: - description: The stream's Header. - - id: stream - type: - description: The incoming stream being assembled. - - id: _contentLength - type: number - description: | - The length of the stream, if finite. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssemblerManager.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssemblerManager.yml deleted file mode 100644 index e9cc22c3..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadAssemblerManager.yml +++ /dev/null @@ -1,93 +0,0 @@ -### YamlMime:TSType -name: PayloadAssemblerManager -uid: botframework-streaming.PayloadAssemblerManager -package: botframework-streaming -summary: Orchestrates assembly of payloads. -fullName: PayloadAssemblerManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - PayloadAssemblerManager(StreamManager, (id: string, receiveResponse: - IReceiveResponse) => Promise, (id: string, receiveRequest: - IReceiveRequest) => Promise) - uid: botframework-streaming.PayloadAssemblerManager.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [PayloadAssemblerManager](xref:botframework-streaming.PayloadAssemblerManager) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new PayloadAssemblerManager(streamManager: StreamManager, - onReceiveResponse: (id: string, receiveResponse: IReceiveResponse) => - Promise, onReceiveRequest: (id: string, receiveRequest: - IReceiveRequest) => Promise) - parameters: - - id: streamManager - type: - description: >- - The [StreamManager](xref:botframework-streaming.StreamManager) - managing the stream being assembled. - - id: onReceiveResponse - type: >- - (id: string, receiveResponse: IReceiveResponse) => - Promise<void> - description: >- - Function that executes when new bytes are received on a `response` - stream. - - id: onReceiveRequest - type: >- - (id: string, receiveRequest: IReceiveRequest) => - Promise<void> - description: > - Function that executes when new bytes are received on a `request` - stream. -methods: - - name: getPayloadStream(IHeader) - uid: botframework-streaming.PayloadAssemblerManager.getPayloadStream - package: botframework-streaming - summary: Retrieves the assembler's payload as a stream. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPayloadStream(header: IHeader): SubscribableStream' - parameters: - - id: header - type: - description: The Header of the Stream to retrieve. - return: - description: >- - A [SubscribableStream](xref:botframework-streaming.SubscribableStream) - of the assembler's payload. - type: - - name: 'onReceive(IHeader, SubscribableStream, number)' - uid: botframework-streaming.PayloadAssemblerManager.onReceive - package: botframework-streaming - summary: >- - The action the assembler executes when new bytes are received on the - incoming stream. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onReceive(header: IHeader, contentStream: SubscribableStream, - contentLength: number) - parameters: - - id: header - type: - description: The stream's Header. - - id: contentStream - type: - description: The incoming stream being assembled. - - id: contentLength - type: number - description: | - The length of the stream, if finite. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadConstants.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadConstants.yml deleted file mode 100644 index 11ecefa1..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadConstants.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSEnum -name: PayloadConstants -uid: botframework-streaming.PayloadConstants -package: botframework-streaming -summary: Constants for streaming payloads. -fullName: PayloadConstants -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: MinLength - uid: botframework-streaming.PayloadConstants.MinLength - package: botframework-streaming - summary: '' - numericValue: 0 - - name: MaxHeaderLength - uid: botframework-streaming.PayloadConstants.MaxHeaderLength - package: botframework-streaming - summary: '' - numericValue: 48 - - name: MaxPayloadLength - uid: botframework-streaming.PayloadConstants.MaxPayloadLength - package: botframework-streaming - summary: '' - numericValue: 4096 - - name: MaxLength - uid: botframework-streaming.PayloadConstants.MaxLength - package: botframework-streaming - summary: '' - numericValue: 999999 diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadDisassembler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadDisassembler.yml deleted file mode 100644 index 96540579..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadDisassembler.yml +++ /dev/null @@ -1,77 +0,0 @@ -### YamlMime:TSType -name: PayloadDisassembler -uid: botframework-streaming.PayloadDisassembler -package: botframework-streaming -summary: Base class streaming payload disassembling. -fullName: PayloadDisassembler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'PayloadDisassembler(PayloadSender, string)' - uid: botframework-streaming.PayloadDisassembler.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [PayloadDisassembler](xref:botframework-streaming.PayloadDisassembler) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new PayloadDisassembler(sender: PayloadSender, id: string)' - parameters: - - id: sender - type: - description: >- - The [PayloadSender](xref:botframework-streaming.PayloadSender) used - to send the disassembled payload chunks. - - id: id - type: string - description: | - The ID of this disassembler. -properties: - - name: payloadType - uid: botframework-streaming.PayloadDisassembler.payloadType - package: botframework-streaming - summary: '' - fullName: payloadType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadType: PayloadTypes' - return: - description: '' - type: -methods: - - name: disassemble() - uid: botframework-streaming.PayloadDisassembler.disassemble - package: botframework-streaming - summary: >- - Begins the process of disassembling a payload and sending the resulting - chunks to the [PayloadSender](xref:botframework-streaming.PayloadSender) - to dispatch over the transport. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function disassemble(): Promise' - return: - description: A completed Promise after the disassembled payload has been sent. - type: Promise<void> - - name: getStream() - uid: botframework-streaming.PayloadDisassembler.getStream - package: botframework-streaming - summary: Gets the stream this disassembler is operating on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getStream(): Promise' - return: - description: >- - An [IStreamWrapper](xref:botframework-streaming.IStreamWrapper) with a - Subscribable Stream. - type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadReceiver.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadReceiver.yml deleted file mode 100644 index f1e1d432..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadReceiver.yml +++ /dev/null @@ -1,99 +0,0 @@ -### YamlMime:TSType -name: PayloadReceiver -uid: botframework-streaming.PayloadReceiver -package: botframework-streaming -summary: Payload receiver for streaming. -fullName: PayloadReceiver -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: disconnected - uid: botframework-streaming.PayloadReceiver.disconnected - package: botframework-streaming - summary: '' - fullName: disconnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disconnected?: TransportDisconnectedEventHandler' - return: - description: '' - type: >- - - - name: isConnected - uid: botframework-streaming.PayloadReceiver.isConnected - package: botframework-streaming - summary: Get current connected state - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: boolean isConnected - return: - description: true if connected to a transport sender. - type: boolean -methods: - - name: connect(ITransportReceiver) - uid: botframework-streaming.PayloadReceiver.connect - package: botframework-streaming - summary: Connects to a transport receiver - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function connect(receiver: ITransportReceiver): Promise' - parameters: - - id: receiver - type: - description: >- - The - [ITransportReceiver](xref:botframework-streaming.ITransportReceiver) - object to pull incoming data from. - return: - description: a promise that resolves when the receiver is complete - type: Promise<void> - - name: disconnect(TransportDisconnectedEvent) - uid: botframework-streaming.PayloadReceiver.disconnect - package: botframework-streaming - summary: Force this receiver to disconnect. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function disconnect(event?: TransportDisconnectedEvent)' - parameters: - - id: event - type: - description: | - Event arguments to include when broadcasting disconnection event. - - name: >- - subscribe((header: IHeader) => SubscribableStream, (header: IHeader, - stream: SubscribableStream, count: number) => void) - uid: botframework-streaming.PayloadReceiver.subscribe - package: botframework-streaming - summary: >- - Allows subscribing to this receiver in order to be notified when new data - comes in. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function subscribe(getStream: (header: IHeader) => SubscribableStream, - receiveAction: (header: IHeader, stream: SubscribableStream, count: - number) => void) - parameters: - - id: getStream - type: '(header: IHeader) => SubscribableStream' - description: Callback when a new stream has been received. - - id: receiveAction - type: >- - (header: IHeader, stream: SubscribableStream, count: number) => - void - description: | - Callback when a new message has been received. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadSender.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadSender.yml deleted file mode 100644 index 3c17c3c4..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadSender.yml +++ /dev/null @@ -1,91 +0,0 @@ -### YamlMime:TSType -name: PayloadSender -uid: botframework-streaming.PayloadSender -package: botframework-streaming -summary: Streaming payload sender. -fullName: PayloadSender -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: disconnected - uid: botframework-streaming.PayloadSender.disconnected - package: botframework-streaming - summary: '' - fullName: disconnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'disconnected?: TransportDisconnectedEventHandler' - return: - description: '' - type: >- - - - name: isConnected - uid: botframework-streaming.PayloadSender.isConnected - package: botframework-streaming - summary: Get current connected state - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: boolean isConnected - return: - description: true if connected to a transport sender. - type: boolean -methods: - - name: connect(ITransportSender) - uid: botframework-streaming.PayloadSender.connect - package: botframework-streaming - summary: Connects to the given transport sender. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function connect(sender: ITransportSender)' - parameters: - - id: sender - type: - description: | - The transport sender to connect this payload sender to. - - name: disconnect(TransportDisconnectedEvent) - uid: botframework-streaming.PayloadSender.disconnect - package: botframework-streaming - summary: Disconnects this payload sender. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function disconnect(event?: TransportDisconnectedEvent)' - parameters: - - id: event - type: - description: > - The disconnected event arguments to include in the disconnected - event broadcast. - - name: 'sendPayload(IHeader, SubscribableStream, () => Promise)' - uid: botframework-streaming.PayloadSender.sendPayload - package: botframework-streaming - summary: Sends a payload out over the connected transport sender. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendPayload(header: IHeader, payload?: SubscribableStream, - sentCallback?: () => Promise) - parameters: - - id: header - type: - description: The header to attach to the outgoing payload. - - id: payload - type: - description: The stream of buffered data to send. - - id: sentCallback - type: () => Promise<void> - description: | - The function to execute when the send has completed. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadTypes.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadTypes.yml deleted file mode 100644 index 51b52ec9..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/PayloadTypes.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSEnum -name: PayloadTypes -uid: botframework-streaming.PayloadTypes -package: botframework-streaming -summary: Typess of payloads supported in the streaming library. -fullName: PayloadTypes -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: cancelAll - uid: botframework-streaming.PayloadTypes.cancelAll - package: botframework-streaming - summary: '' - - name: cancelStream - uid: botframework-streaming.PayloadTypes.cancelStream - package: botframework-streaming - summary: '' - - name: request - uid: botframework-streaming.PayloadTypes.request - package: botframework-streaming - summary: '' - - name: response - uid: botframework-streaming.PayloadTypes.response - package: botframework-streaming - summary: '' - - name: stream - uid: botframework-streaming.PayloadTypes.stream - package: botframework-streaming - summary: '' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ProtocolAdapter.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ProtocolAdapter.yml deleted file mode 100644 index 20b94dce..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ProtocolAdapter.yml +++ /dev/null @@ -1,123 +0,0 @@ -### YamlMime:TSType -name: ProtocolAdapter -uid: botframework-streaming.ProtocolAdapter -package: botframework-streaming -summary: Creates a protocol adapter for Streaming. -fullName: ProtocolAdapter -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - ProtocolAdapter(RequestHandler, RequestManager, PayloadSender, - PayloadReceiver) - uid: botframework-streaming.ProtocolAdapter.constructor - package: botframework-streaming - summary: Creates a new instance of the protocol adapter class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ProtocolAdapter(requestHandler: RequestHandler, requestManager: - RequestManager, sender: PayloadSender, receiver: PayloadReceiver) - parameters: - - id: requestHandler - type: - description: >- - The [RequestHandler](xref:botframework-streaming.RequestHandler) - that will process incoming requests. - - id: requestManager - type: - description: >- - The [RequestManager](xref:botframework-streaming.RequestManager) - that will process outgoing requests. - - id: sender - type: - description: >- - The [PayloadSender](xref:botframework-streaming.PayloadSender) for - use with outgoing requests. - - id: receiver - type: - description: > - The [PayloadReceiver](xref:botframework-streaming.PayloadReceiver) - for use with incoming requests. -methods: - - name: onCancelStream(PayloadAssembler) - uid: botframework-streaming.ProtocolAdapter.onCancelStream - package: botframework-streaming - summary: Executes the receive pipeline when a cancellation comes in. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function onCancelStream(contentStreamAssembler: PayloadAssembler)' - parameters: - - id: contentStreamAssembler - type: - description: > - The payload assembler processing the incoming data that this - cancellation request targets. - - name: 'onReceiveRequest(string, IReceiveRequest)' - uid: botframework-streaming.ProtocolAdapter.onReceiveRequest - package: botframework-streaming - summary: Executes the receive pipeline when a request comes in. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onReceiveRequest(id: string, request: IReceiveRequest): - Promise - parameters: - - id: id - type: string - description: The id the resources created for the response will be assigned. - - id: request - type: - description: | - The incoming request to process. - return: - description: '' - type: Promise<void> - - name: 'onReceiveResponse(string, IReceiveResponse)' - uid: botframework-streaming.ProtocolAdapter.onReceiveResponse - package: botframework-streaming - summary: Executes the receive pipeline when a response comes in. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onReceiveResponse(id: string, response: IReceiveResponse): - Promise - parameters: - - id: id - type: string - description: The id the resources created for the response will be assigned. - - id: response - type: - description: | - The incoming response to process. - return: - description: '' - type: Promise<void> - - name: sendRequest(StreamingRequest) - uid: botframework-streaming.ProtocolAdapter.sendRequest - package: botframework-streaming - summary: Sends a request over the attached request manager. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendRequest(request: StreamingRequest): - Promise - parameters: - - id: request - type: - description: The outgoing request to send. - return: - description: The response to the specified request. - type: Promise<> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestDisassembler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestDisassembler.yml deleted file mode 100644 index 682bbc9c..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestDisassembler.yml +++ /dev/null @@ -1,100 +0,0 @@ -### YamlMime:TSType -name: RequestDisassembler -uid: botframework-streaming.RequestDisassembler -package: botframework-streaming -summary: Streaming request disassembler. -fullName: RequestDisassembler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'RequestDisassembler(PayloadSender, string, StreamingRequest)' - uid: botframework-streaming.RequestDisassembler.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [RequestDisassembler](xref:botframework-streaming.RequestDisassembler) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new RequestDisassembler(sender: PayloadSender, id: string, request?: - StreamingRequest) - parameters: - - id: sender - type: - description: >- - The [PayloadSender](xref:botframework-streaming.PayloadSender) to - send the disassembled data to. - - id: id - type: string - description: The ID of this disassembler. - - id: request - type: - description: | - The request to be disassembled. -properties: - - name: payloadType - uid: botframework-streaming.RequestDisassembler.payloadType - package: botframework-streaming - summary: '' - fullName: payloadType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadType: PayloadTypes' - return: - description: '' - type: - - name: request - uid: botframework-streaming.RequestDisassembler.request - package: botframework-streaming - summary: '' - fullName: request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'request?: StreamingRequest' - return: - description: '' - type: -inheritedMethods: - - name: disassemble() - uid: botframework-streaming.RequestDisassembler.disassemble - package: botframework-streaming - summary: >- - Begins the process of disassembling a payload and sending the resulting - chunks to the [PayloadSender](xref:botframework-streaming.PayloadSender) - to dispatch over the transport. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function disassemble(): Promise' - return: - description: A completed Promise after the disassembled payload has been sent. - type: Promise<void> - inheritanceDescription: >- - Inherited From - [PayloadDisassembler.disassemble](xref:botframework-streaming.PayloadDisassembler.disassemble) -methods: - - name: getStream() - uid: botframework-streaming.RequestDisassembler.getStream - package: botframework-streaming - summary: Gets the stream this disassembler is operating on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getStream(): Promise' - return: - description: >- - An [IStreamWrapper](xref:botframework-streaming.IStreamWrapper) with a - Subscribable Stream. - type: Promise<> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestHandler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestHandler.yml index 4ea54808..b72bb1c4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestHandler.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestHandler.yml @@ -7,7 +7,6 @@ summary: >- an [IStreamingTransport](xref:botframework-streaming.IStreamingTransport). fullName: RequestHandler remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: package: botframework-streaming summary: The method that must be implemented in order to handle incoming requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestManager.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestManager.yml deleted file mode 100644 index 7751c4ff..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/RequestManager.yml +++ /dev/null @@ -1,64 +0,0 @@ -### YamlMime:TSType -name: RequestManager -uid: botframework-streaming.RequestManager -package: botframework-streaming -summary: Orchestrates and manages pending streaming requests. -fullName: RequestManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: getResponse(string) - uid: botframework-streaming.RequestManager.getResponse - package: botframework-streaming - summary: Constructs and returns a response for this request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getResponse(requestId: string): Promise' - parameters: - - id: requestId - type: string - description: The ID of the StreamingRequest being responded to. - return: - description: The response to the specified request. - type: Promise<> - - name: pendingRequestCount() - uid: botframework-streaming.RequestManager.pendingRequestCount - package: botframework-streaming - summary: Gets the count of the pending requests. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function pendingRequestCount(): number' - return: - description: Number with the pending requests count. - type: number - - name: 'signalResponse(string, IReceiveResponse)' - uid: botframework-streaming.RequestManager.signalResponse - package: botframework-streaming - summary: Signal fired when all response tasks have completed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signalResponse(requestId: string, response: IReceiveResponse): - Promise - parameters: - - id: requestId - type: string - description: The ID of the StreamingRequest. - - id: response - type: - description: >- - The [IReceiveResponse](xref:botframework-streaming.IReceiveResponse) - in response to the request. - return: - description: >- - A Promise that when completed returns `true` if the `requestId`'s - pending response task was completed, otherwise `false`. - type: Promise<boolean> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ResponseDisassembler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ResponseDisassembler.yml deleted file mode 100644 index 9b5c43c4..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ResponseDisassembler.yml +++ /dev/null @@ -1,100 +0,0 @@ -### YamlMime:TSType -name: ResponseDisassembler -uid: botframework-streaming.ResponseDisassembler -package: botframework-streaming -summary: Streaming response disassembler. -fullName: ResponseDisassembler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ResponseDisassembler(PayloadSender, string, StreamingResponse)' - uid: botframework-streaming.ResponseDisassembler.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [ResponseDisassembler](xref:botframework-streaming.ResponseDisassembler) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ResponseDisassembler(sender: PayloadSender, id: string, response: - StreamingResponse) - parameters: - - id: sender - type: - description: >- - The [PayloadSender](xref:botframework-streaming.PayloadSender) to - send the disassembled data to. - - id: id - type: string - description: The ID of this disassembler. - - id: response - type: - description: | - The response to be disassembled. -properties: - - name: payloadType - uid: botframework-streaming.ResponseDisassembler.payloadType - package: botframework-streaming - summary: '' - fullName: payloadType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'payloadType: PayloadTypes' - return: - description: '' - type: - - name: response - uid: botframework-streaming.ResponseDisassembler.response - package: botframework-streaming - summary: '' - fullName: response - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'response: StreamingResponse' - return: - description: '' - type: -inheritedMethods: - - name: disassemble() - uid: botframework-streaming.ResponseDisassembler.disassemble - package: botframework-streaming - summary: >- - Begins the process of disassembling a payload and sending the resulting - chunks to the [PayloadSender](xref:botframework-streaming.PayloadSender) - to dispatch over the transport. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function disassemble(): Promise' - return: - description: A completed Promise after the disassembled payload has been sent. - type: Promise<void> - inheritanceDescription: >- - Inherited From - [PayloadDisassembler.disassemble](xref:botframework-streaming.PayloadDisassembler.disassemble) -methods: - - name: getStream() - uid: botframework-streaming.ResponseDisassembler.getStream - package: botframework-streaming - summary: Gets the stream this disassembler is operating on. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getStream(): Promise' - return: - description: >- - An [IStreamWrapper](xref:botframework-streaming.IStreamWrapper) with a - Subscribable Stream. - type: Promise<> -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SendOperations.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SendOperations.yml deleted file mode 100644 index 15a5884b..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SendOperations.yml +++ /dev/null @@ -1,105 +0,0 @@ -### YamlMime:TSType -name: SendOperations -uid: botframework-streaming.SendOperations -package: botframework-streaming -summary: Send operations for streaming payloads. -fullName: SendOperations -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: SendOperations(PayloadSender) - uid: botframework-streaming.SendOperations.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [SendOperations](xref:botframework-streaming.SendOperations) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new SendOperations(payloadSender: PayloadSender)' - parameters: - - id: payloadSender - type: - description: > - The [PayloadSender](xref:botframework-streaming.PayloadSender) that - will send the disassembled data from all of this instance's send - operations. -methods: - - name: sendCancelStream(string) - uid: botframework-streaming.SendOperations.sendCancelStream - package: botframework-streaming - summary: >- - The send operation used to send a - [PayloadTypes.cancelStream](xref:botframework-streaming.PayloadTypes.cancelStream). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function sendCancelStream(id: string): Promise' - parameters: - - id: id - type: string - description: > - The ID to assign to the - [CancelDisassembler](xref:botframework-streaming.CancelDisassembler) - used by this operation. - return: - description: '' - type: Promise<void> - - name: 'sendRequest(string, StreamingRequest)' - uid: botframework-streaming.SendOperations.sendRequest - package: botframework-streaming - summary: >- - The send operation used to send a - [StreamingRequest](xref:botframework-streaming.StreamingRequest). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendRequest(id: string, request: StreamingRequest): - Promise - parameters: - - id: id - type: string - description: >- - The ID to assign to the - [RequestDisassembler](xref:botframework-streaming.RequestDisassembler) - used by this operation. - - id: request - type: - description: | - The request to send. - return: - description: '' - type: Promise<void> - - name: 'sendResponse(string, StreamingResponse)' - uid: botframework-streaming.SendOperations.sendResponse - package: botframework-streaming - summary: >- - The send operation used to send a - [PayloadTypes.response](xref:botframework-streaming.PayloadTypes.response). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendResponse(id: string, response: StreamingResponse): - Promise - parameters: - - id: id - type: string - description: >- - The ID to assign to the - [ResponseDisassembler](xref:botframework-streaming.ResponseDisassembler) - used by this operation. - - id: response - type: - description: | - The response to send. - return: - description: '' - type: Promise<void> diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamManager.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamManager.yml deleted file mode 100644 index bcd99913..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamManager.yml +++ /dev/null @@ -1,130 +0,0 @@ -### YamlMime:TSType -name: StreamManager -uid: botframework-streaming.StreamManager -package: botframework-streaming -summary: Orchestrates and manages streams. -fullName: StreamManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'StreamManager((contentStreamAssembler: PayloadAssembler) => void)' - uid: botframework-streaming.StreamManager.constructor - package: botframework-streaming - summary: >- - Initializes a new instance of the - [StreamManager](xref:botframework-streaming.StreamManager) class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new StreamManager(onCancelStream: (contentStreamAssembler: - PayloadAssembler) => void) - parameters: - - id: onCancelStream - type: '(contentStreamAssembler: PayloadAssembler) => void' - description: | - Function to trigger if the managed stream is cancelled. -methods: - - name: closeStream(string) - uid: botframework-streaming.StreamManager.closeStream - package: botframework-streaming - summary: >- - Closes the - [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) assigned - to the - [SubscribableStream](xref:botframework-streaming.SubscribableStream) with - the given ID. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function closeStream(id: string)' - parameters: - - id: id - type: string - description: > - The ID of the - [SubscribableStream](xref:botframework-streaming.SubscribableStream) - to close. - - name: getPayloadAssembler(string) - uid: botframework-streaming.StreamManager.getPayloadAssembler - package: botframework-streaming - summary: >- - Retrieves a - [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) with the - given ID if one exists, otherwise a new instance is created and assigned - the given ID. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPayloadAssembler(id: string): PayloadAssembler' - parameters: - - id: id - type: string - description: >- - The ID of the - [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) to - retrieve or create. - return: - description: >- - The [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) - with the given ID. - type: - - name: getPayloadStream(IHeader) - uid: botframework-streaming.StreamManager.getPayloadStream - package: botframework-streaming - summary: >- - Retrieves the - [SubscribableStream](xref:botframework-streaming.SubscribableStream) from - the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) this - manager manages. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPayloadStream(header: IHeader): SubscribableStream' - parameters: - - id: header - type: - description: >- - The Header of the - [SubscribableStream](xref:botframework-streaming.SubscribableStream) - to retrieve. - return: - description: >- - The - [SubscribableStream](xref:botframework-streaming.SubscribableStream) - with the given header. - type: - - name: 'onReceive(IHeader, SubscribableStream, number)' - uid: botframework-streaming.StreamManager.onReceive - package: botframework-streaming - summary: >- - Used to set the behavior of the managed - [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) when data - is received. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function onReceive(header: IHeader, contentStream: SubscribableStream, - contentLength: number) - parameters: - - id: header - type: - description: The Header of the stream. - - id: contentStream - type: - description: >- - The - [SubscribableStream](xref:botframework-streaming.SubscribableStream) - to write incoming data to. - - id: contentLength - type: number - description: | - The amount of data to write to the contentStream. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingRequest.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingRequest.yml index f0d7aaf3..deaef269 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingRequest.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingRequest.yml @@ -7,7 +7,6 @@ summary: >- Extensions transports, equivalent to HTTP request messages. fullName: StreamingRequest remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: Request path; null on responses. fullName: path remarks: '' - isPreview: false isDeprecated: false syntax: content: 'path: string' @@ -30,20 +28,18 @@ properties: summary: List of associated streams. fullName: streams remarks: '' - isPreview: false isDeprecated: false syntax: content: 'streams: HttpContentStream[]' return: description: '' - type: '[]' + type: HttpContentStream[] - name: verb uid: botframework-streaming.StreamingRequest.verb package: botframework-streaming - summary: 'Request verb, null on responses.' + summary: Request verb, null on responses. fullName: verb remarks: '' - isPreview: false isDeprecated: false syntax: content: 'verb: string' @@ -56,21 +52,18 @@ methods: package: botframework-streaming summary: Adds a new stream attachment to this streaming request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addStream(content: HttpContent)' parameters: - id: content type: - description: | - The Http content to include in the new stream attachment. - - name: 'create(string, string, HttpContent)' + description: The Http content to include in the new stream attachment. + - name: create(string, string, HttpContent) uid: botframework-streaming.StreamingRequest.create package: botframework-streaming - summary: 'Creates a streaming request with the passed in method, path, and body.' + summary: Creates a streaming request with the passed in method, path, and body. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -96,12 +89,10 @@ methods: package: botframework-streaming summary: Sets the contents of the body of this streamingRequest. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setBody(body: any)' parameters: - id: body type: any - description: | - The JSON text to write to the body of the streamingRequest. + description: The JSON text to write to the body of the streamingRequest. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingResponse.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingResponse.yml index 6ca72c45..50eaef43 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingResponse.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/StreamingResponse.yml @@ -7,7 +7,6 @@ summary: >- Extensions transports, equivalent to HTTP response messages. fullName: StreamingResponse remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: statusCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'statusCode: number' @@ -30,34 +28,30 @@ properties: summary: '' fullName: streams remarks: '' - isPreview: false isDeprecated: false syntax: content: 'streams: HttpContentStream[]' return: description: '' - type: '[]' + type: HttpContentStream[] methods: - name: addStream(HttpContent) uid: botframework-streaming.StreamingResponse.addStream package: botframework-streaming summary: Adds a new stream attachment to this streaming request. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addStream(content: HttpContent)' parameters: - id: content type: - description: | - The Http content to include in the new stream attachment. - - name: 'create(number, HttpContent)' + description: The Http content to include in the new stream attachment. + - name: create(number, HttpContent) uid: botframework-streaming.StreamingResponse.create package: botframework-streaming - summary: 'Creates a streaming response with the passed in method, path, and body.' + summary: Creates a streaming response with the passed in method, path, and body. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -80,12 +74,10 @@ methods: package: botframework-streaming summary: Sets the contents of the body of this streaming response. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setBody(body: any)' parameters: - id: body type: any - description: | - The JSON text to write to the body of the streaming response. + description: The JSON text to write to the body of the streaming response. diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SubscribableStream.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SubscribableStream.yml index 9cb4af65..3f23e9e4 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SubscribableStream.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/SubscribableStream.yml @@ -7,7 +7,6 @@ summary: >- `PayloadAssembler` to convert raw bytes into a consumable form. fullName: SubscribableStream remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,15 +18,13 @@ constructors: [SubscribableStream](xref:botframework-streaming.SubscribableStream) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new SubscribableStream(options?: DuplexOptions)' parameters: - id: options type: DuplexOptions - description: | - The `DuplexOptions` to use when constructing this stream. + description: The `DuplexOptions` to use when constructing this stream. properties: - name: length uid: botframework-streaming.SubscribableStream.length @@ -35,1496 +32,23 @@ properties: summary: '' fullName: length remarks: '' - isPreview: false isDeprecated: false syntax: content: 'length: number' return: description: '' type: number -inheritedProperties: - - name: defaultMaxListeners - uid: botframework-streaming.SubscribableStream.defaultMaxListeners - package: botframework-streaming - summary: '' - fullName: defaultMaxListeners - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static defaultMaxListeners: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From EventEmitter.defaultMaxListeners - - name: readable - uid: botframework-streaming.SubscribableStream.readable - package: botframework-streaming - summary: '' - fullName: readable - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readable: boolean' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.readable - - name: readableFlowing - uid: botframework-streaming.SubscribableStream.readableFlowing - package: botframework-streaming - summary: '' - fullName: readableFlowing - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readableFlowing: boolean | null' - return: - description: '' - type: boolean | null - inheritanceDescription: Inherited From Readable.readableFlowing - - name: readableHighWaterMark - uid: botframework-streaming.SubscribableStream.readableHighWaterMark - package: botframework-streaming - summary: '' - fullName: readableHighWaterMark - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readableHighWaterMark: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From Readable.readableHighWaterMark - - name: readableLength - uid: botframework-streaming.SubscribableStream.readableLength - package: botframework-streaming - summary: '' - fullName: readableLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'readableLength: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From Readable.readableLength - - name: writable - uid: botframework-streaming.SubscribableStream.writable - package: botframework-streaming - summary: '' - fullName: writable - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'writable: boolean' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Duplex.writable - - name: writableHighWaterMark - uid: botframework-streaming.SubscribableStream.writableHighWaterMark - package: botframework-streaming - summary: '' - fullName: writableHighWaterMark - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'writableHighWaterMark: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From Duplex.writableHighWaterMark - - name: writableLength - uid: botframework-streaming.SubscribableStream.writableLength - package: botframework-streaming - summary: '' - fullName: writableLength - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'writableLength: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From Duplex.writableLength -inheritedMethods: - - name: 'addListener("close", () => void)' - uid: botframework-streaming.SubscribableStream.addListener - package: botframework-streaming - summary: |- - Event emitter - The defined events on documents including: - 1. close - 2. data - 3. end - 4. readable - 5. error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addListener(event: "close", listener: () => void): this' - parameters: - - id: event - type: '"close"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.addListener - - name: 'addListener("data", (chunk: any) => void)' - uid: botframework-streaming.SubscribableStream.addListener_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addListener(event: "data", listener: (chunk: any) => void): - this - parameters: - - id: event - type: '"data"' - description: '' - - id: listener - type: '(chunk: any) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.addListener - - name: 'addListener("end", () => void)' - uid: botframework-streaming.SubscribableStream.addListener_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addListener(event: "end", listener: () => void): this' - parameters: - - id: event - type: '"end"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.addListener - - name: 'addListener("error", (err: Error) => void)' - uid: botframework-streaming.SubscribableStream.addListener_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addListener(event: "error", listener: (err: Error) => void): - this - parameters: - - id: event - type: '"error"' - description: '' - - id: listener - type: '(err: Error) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.addListener - - name: 'addListener("readable", () => void)' - uid: botframework-streaming.SubscribableStream.addListener_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addListener(event: "readable", listener: () => void): this' - parameters: - - id: event - type: '"readable"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.addListener - - name: 'addListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.addListener_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addListener(event: string | symbol, listener: (args: any[]) => - void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.addListener - - name: cork() - uid: botframework-streaming.SubscribableStream.cork - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function cork() - inheritanceDescription: Inherited From Duplex.cork - - name: destroy(Error) - uid: botframework-streaming.SubscribableStream.destroy - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function destroy(error?: Error)' - parameters: - - id: error - type: Error - description: '' - inheritanceDescription: Inherited From Readable.destroy - - name: emit("close") - uid: botframework-streaming.SubscribableStream.emit - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: "close"): boolean' - parameters: - - id: event - type: '"close"' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.emit - - name: 'emit("data", any)' - uid: botframework-streaming.SubscribableStream.emit_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: "data", chunk: any): boolean' - parameters: - - id: event - type: '"data"' - description: '' - - id: chunk - type: any - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.emit - - name: emit("end") - uid: botframework-streaming.SubscribableStream.emit_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: "end"): boolean' - parameters: - - id: event - type: '"end"' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.emit - - name: 'emit("error", Error)' - uid: botframework-streaming.SubscribableStream.emit_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: "error", err: Error): boolean' - parameters: - - id: event - type: '"error"' - description: '' - - id: err - type: Error - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.emit - - name: emit("readable") - uid: botframework-streaming.SubscribableStream.emit_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: "readable"): boolean' - parameters: - - id: event - type: '"readable"' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.emit - - name: 'emit(string | symbol, any[])' - uid: botframework-streaming.SubscribableStream.emit_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: string | symbol, args: any[]): boolean' - parameters: - - id: event - type: string | symbol - description: '' - - id: args - type: 'any[]' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.emit - - name: end(() => void) - uid: botframework-streaming.SubscribableStream.end - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(cb?: () => void)' - parameters: - - id: cb - type: () => void - description: '' - inheritanceDescription: Inherited From Duplex.end - - name: 'end(any, () => void)' - uid: botframework-streaming.SubscribableStream.end_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(chunk: any, cb?: () => void)' - parameters: - - id: chunk - type: any - description: '' - - id: cb - type: () => void - description: '' - inheritanceDescription: Inherited From Duplex.end - - name: 'end(any, string, () => void)' - uid: botframework-streaming.SubscribableStream.end_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(chunk: any, encoding?: string, cb?: () => void)' - parameters: - - id: chunk - type: any - description: '' - - id: encoding - type: string - description: '' - - id: cb - type: () => void - description: '' - inheritanceDescription: Inherited From Duplex.end - - name: eventNames() - uid: botframework-streaming.SubscribableStream.eventNames - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function eventNames(): Array' - return: - description: '' - type: Array<string | symbol> - inheritanceDescription: Inherited From EventEmitter.eventNames - - name: getMaxListeners() - uid: botframework-streaming.SubscribableStream.getMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMaxListeners(): number' - return: - description: '' - type: number - inheritanceDescription: Inherited From EventEmitter.getMaxListeners - - name: isPaused() - uid: botframework-streaming.SubscribableStream.isPaused - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isPaused(): boolean' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.isPaused - - name: 'listenerCount(EventEmitter, string | symbol)' - uid: botframework-streaming.SubscribableStream.listenerCount - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: true - customDeprecatedMessage: since v4.0.0 - syntax: - content: >- - static function listenerCount(emitter: EventEmitter, event: string | - symbol): number - parameters: - - id: emitter - type: EventEmitter - description: '' - - id: event - type: string | symbol - description: '' - return: - description: '' - type: number - inheritanceDescription: Inherited From EventEmitter.listenerCount - - name: listenerCount(string | symbol) - uid: botframework-streaming.SubscribableStream.listenerCount - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listenerCount(type: string | symbol): number' - parameters: - - id: type - type: string | symbol - description: '' - return: - description: '' - type: number - inheritanceDescription: Inherited From EventEmitter.listenerCount - - name: listeners(string | symbol) - uid: botframework-streaming.SubscribableStream.listeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - inheritanceDescription: Inherited From EventEmitter.listeners - - name: 'off(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.off - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function off(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From EventEmitter.off - - name: 'on("close", () => void)' - uid: botframework-streaming.SubscribableStream.on - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function on(event: "close", listener: () => void): this' - parameters: - - id: event - type: '"close"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.on - - name: 'on("data", (chunk: any) => void)' - uid: botframework-streaming.SubscribableStream.on_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function on(event: "data", listener: (chunk: any) => void): this' - parameters: - - id: event - type: '"data"' - description: '' - - id: listener - type: '(chunk: any) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.on - - name: 'on("end", () => void)' - uid: botframework-streaming.SubscribableStream.on_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function on(event: "end", listener: () => void): this' - parameters: - - id: event - type: '"end"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.on - - name: 'on("error", (err: Error) => void)' - uid: botframework-streaming.SubscribableStream.on_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function on(event: "error", listener: (err: Error) => void): this' - parameters: - - id: event - type: '"error"' - description: '' - - id: listener - type: '(err: Error) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.on - - name: 'on("readable", () => void)' - uid: botframework-streaming.SubscribableStream.on_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function on(event: "readable", listener: () => void): this' - parameters: - - id: event - type: '"readable"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.on - - name: 'on(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.on_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function on(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.on - - name: 'once("close", () => void)' - uid: botframework-streaming.SubscribableStream.once - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function once(event: "close", listener: () => void): this' - parameters: - - id: event - type: '"close"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.once - - name: 'once("data", (chunk: any) => void)' - uid: botframework-streaming.SubscribableStream.once_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function once(event: "data", listener: (chunk: any) => void): this' - parameters: - - id: event - type: '"data"' - description: '' - - id: listener - type: '(chunk: any) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.once - - name: 'once("end", () => void)' - uid: botframework-streaming.SubscribableStream.once_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function once(event: "end", listener: () => void): this' - parameters: - - id: event - type: '"end"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.once - - name: 'once("error", (err: Error) => void)' - uid: botframework-streaming.SubscribableStream.once_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function once(event: "error", listener: (err: Error) => void): this' - parameters: - - id: event - type: '"error"' - description: '' - - id: listener - type: '(err: Error) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.once - - name: 'once("readable", () => void)' - uid: botframework-streaming.SubscribableStream.once_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function once(event: "readable", listener: () => void): this' - parameters: - - id: event - type: '"readable"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.once - - name: 'once(NodeEventTarget, string | symbol)' - uid: botframework-streaming.SubscribableStream.once - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function once(emitter: NodeEventTarget, event: string | symbol): - Promise - parameters: - - id: emitter - type: NodeEventTarget - description: '' - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Promise<any[]>' - inheritanceDescription: Inherited From EventEmitter.once - - name: 'once(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.once_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function once(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.once - - name: pause() - uid: botframework-streaming.SubscribableStream.pause - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function pause(): this' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.pause - - name: 'pipe(T, { end?: boolean })' - uid: botframework-streaming.SubscribableStream.pipe - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function pipe(destination: T, options?: { end?: boolean }): T' - parameters: - - id: destination - type: T - description: '' - - id: options - type: '{ end?: boolean }' - description: '' - return: - description: '' - type: T - inheritanceDescription: Inherited From internal.pipe - - name: 'prependListener("close", () => void)' - uid: botframework-streaming.SubscribableStream.prependListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function prependListener(event: "close", listener: () => void): this' - parameters: - - id: event - type: '"close"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependListener - - name: 'prependListener("data", (chunk: any) => void)' - uid: botframework-streaming.SubscribableStream.prependListener_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependListener(event: "data", listener: (chunk: any) => void): - this - parameters: - - id: event - type: '"data"' - description: '' - - id: listener - type: '(chunk: any) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependListener - - name: 'prependListener("end", () => void)' - uid: botframework-streaming.SubscribableStream.prependListener_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function prependListener(event: "end", listener: () => void): this' - parameters: - - id: event - type: '"end"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependListener - - name: 'prependListener("error", (err: Error) => void)' - uid: botframework-streaming.SubscribableStream.prependListener_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependListener(event: "error", listener: (err: Error) => - void): this - parameters: - - id: event - type: '"error"' - description: '' - - id: listener - type: '(err: Error) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependListener - - name: 'prependListener("readable", () => void)' - uid: botframework-streaming.SubscribableStream.prependListener_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function prependListener(event: "readable", listener: () => void): this' - parameters: - - id: event - type: '"readable"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependListener - - name: 'prependListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.prependListener_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependListener - - name: 'prependOnceListener("close", () => void)' - uid: botframework-streaming.SubscribableStream.prependOnceListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function prependOnceListener(event: "close", listener: () => void): this' - parameters: - - id: event - type: '"close"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependOnceListener - - name: 'prependOnceListener("data", (chunk: any) => void)' - uid: botframework-streaming.SubscribableStream.prependOnceListener_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: "data", listener: (chunk: any) => - void): this - parameters: - - id: event - type: '"data"' - description: '' - - id: listener - type: '(chunk: any) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependOnceListener - - name: 'prependOnceListener("end", () => void)' - uid: botframework-streaming.SubscribableStream.prependOnceListener_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function prependOnceListener(event: "end", listener: () => void): this' - parameters: - - id: event - type: '"end"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependOnceListener - - name: 'prependOnceListener("error", (err: Error) => void)' - uid: botframework-streaming.SubscribableStream.prependOnceListener_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: "error", listener: (err: Error) => - void): this - parameters: - - id: event - type: '"error"' - description: '' - - id: listener - type: '(err: Error) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependOnceListener - - name: 'prependOnceListener("readable", () => void)' - uid: botframework-streaming.SubscribableStream.prependOnceListener_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: "readable", listener: () => void): - this - parameters: - - id: event - type: '"readable"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependOnceListener - - name: 'prependOnceListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.prependOnceListener_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: string | symbol, listener: (args: - any[]) => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.prependOnceListener - - name: 'push(any, string)' - uid: botframework-streaming.SubscribableStream.push - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function push(chunk: any, encoding?: string): boolean' - parameters: - - id: chunk - type: any - description: '' - - id: encoding - type: string - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Readable.push - - name: rawListeners(string | symbol) - uid: botframework-streaming.SubscribableStream.rawListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function rawListeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - inheritanceDescription: Inherited From EventEmitter.rawListeners - - name: read(number) - uid: botframework-streaming.SubscribableStream.read - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function read(size?: number): any' - parameters: - - id: size - type: number - description: '' - return: - description: '' - type: any - inheritanceDescription: Inherited From Readable.read - - name: removeAllListeners(string | symbol) - uid: botframework-streaming.SubscribableStream.removeAllListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllListeners(event?: string | symbol): this' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From EventEmitter.removeAllListeners - - name: 'removeListener("close", () => void)' - uid: botframework-streaming.SubscribableStream.removeListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeListener(event: "close", listener: () => void): this' - parameters: - - id: event - type: '"close"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.removeListener - - name: 'removeListener("data", (chunk: any) => void)' - uid: botframework-streaming.SubscribableStream.removeListener_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeListener(event: "data", listener: (chunk: any) => void): - this - parameters: - - id: event - type: '"data"' - description: '' - - id: listener - type: '(chunk: any) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.removeListener - - name: 'removeListener("end", () => void)' - uid: botframework-streaming.SubscribableStream.removeListener_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeListener(event: "end", listener: () => void): this' - parameters: - - id: event - type: '"end"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.removeListener - - name: 'removeListener("error", (err: Error) => void)' - uid: botframework-streaming.SubscribableStream.removeListener_4 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeListener(event: "error", listener: (err: Error) => void): - this - parameters: - - id: event - type: '"error"' - description: '' - - id: listener - type: '(err: Error) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.removeListener - - name: 'removeListener("readable", () => void)' - uid: botframework-streaming.SubscribableStream.removeListener_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeListener(event: "readable", listener: () => void): this' - parameters: - - id: event - type: '"readable"' - description: '' - - id: listener - type: () => void - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.removeListener - - name: 'removeListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.SubscribableStream.removeListener_5 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.removeListener - - name: resume() - uid: botframework-streaming.SubscribableStream.resume - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function resume(): this' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.resume - - name: setDefaultEncoding(string) - uid: botframework-streaming.SubscribableStream.setDefaultEncoding - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setDefaultEncoding(encoding: string): this' - parameters: - - id: encoding - type: string - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Duplex.setDefaultEncoding - - name: setEncoding(string) - uid: botframework-streaming.SubscribableStream.setEncoding - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setEncoding(encoding: string): this' - parameters: - - id: encoding - type: string - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.setEncoding - - name: setMaxListeners(number) - uid: botframework-streaming.SubscribableStream.setMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setMaxListeners(n: number): this' - parameters: - - id: 'n' - type: number - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From EventEmitter.setMaxListeners - - name: uncork() - uid: botframework-streaming.SubscribableStream.uncork - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function uncork() - inheritanceDescription: Inherited From Duplex.uncork - - name: unpipe(WritableStream) - uid: botframework-streaming.SubscribableStream.unpipe - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function unpipe(destination?: WritableStream): this' - parameters: - - id: destination - type: WritableStream - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.unpipe - - name: unshift(any) - uid: botframework-streaming.SubscribableStream.unshift - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function unshift(chunk: any)' - parameters: - - id: chunk - type: any - description: '' - inheritanceDescription: Inherited From Readable.unshift - - name: wrap(ReadableStream) - uid: botframework-streaming.SubscribableStream.wrap - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function wrap(oldStream: ReadableStream): this' - parameters: - - id: oldStream - type: ReadableStream - description: '' - return: - description: '' - type: this - inheritanceDescription: Inherited From Readable.wrap - - name: 'write(any, (error: Error | null | undefined) => void)' - uid: botframework-streaming.SubscribableStream.write - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function write(chunk: any, cb?: (error: Error | null | undefined) => - void): boolean - parameters: - - id: chunk - type: any - description: '' - - id: cb - type: '(error: Error | null | undefined) => void' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Duplex.write - - name: 'write(any, string, (error: Error | null | undefined) => void)' - uid: botframework-streaming.SubscribableStream.write_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function write(chunk: any, encoding?: string, cb?: (error: Error | null - | undefined) => void): boolean - parameters: - - id: chunk - type: any - description: '' - - id: encoding - type: string - description: '' - - id: cb - type: '(error: Error | null | undefined) => void' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Duplex.write methods: - name: 'subscribe((chunk: any) => void)' uid: botframework-streaming.SubscribableStream.subscribe package: botframework-streaming summary: Subscribes to the stream when receives data. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function subscribe(onData: (chunk: any) => void)' parameters: - id: onData type: '(chunk: any) => void' - description: | - Callback to be called when onData is executed. + description: Callback to be called when onData is executed. extends: Duplex diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEvent.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEvent.yml deleted file mode 100644 index 431c7e2e..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEvent.yml +++ /dev/null @@ -1,56 +0,0 @@ -### YamlMime:TSType -name: TransportDisconnectedEvent -uid: botframework-streaming.TransportDisconnectedEvent -package: botframework-streaming -summary: Event to be included when disconnection events are fired. -fullName: TransportDisconnectedEvent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: TransportDisconnectedEvent(string) - uid: botframework-streaming.TransportDisconnectedEvent.constructor - package: botframework-streaming - summary: >- - Indicates a transport disconnected with the reason provided via the - constructor. - remarks: |- - This class is used for communicating disconnection events between the - PayloadReceiver and PayloadSender. - isPreview: false - isDeprecated: false - syntax: - content: 'new TransportDisconnectedEvent(reason?: string)' - parameters: - - id: reason - type: string - description: | - The reason the disconnection event fired, in plain text. -properties: - - name: Empty - uid: botframework-streaming.TransportDisconnectedEvent.Empty - package: botframework-streaming - summary: A new and empty TransportDisconnectedEvent. - fullName: Empty - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Empty: TransportDisconnectedEvent' - return: - description: '' - type: - - name: reason - uid: botframework-streaming.TransportDisconnectedEvent.reason - package: botframework-streaming - summary: 'The reason the disconnection event fired, in plain text.' - fullName: reason - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'reason: string' - return: - description: '' - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEventHandler.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEventHandler.yml deleted file mode 100644 index e77f5518..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/TransportDisconnectedEventHandler.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: TransportDisconnectedEventHandler -uid: botframework-streaming.TransportDisconnectedEventHandler -package: botframework-streaming -summary: '' -fullName: TransportDisconnectedEventHandler -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type TransportDisconnectedEventHandler = ( - sender: any, - e: TransportDisconnectedEvent - ) => void diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ValidBuffer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ValidBuffer.yml deleted file mode 100644 index 6ea2c239..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/ValidBuffer.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: ValidBuffer -uid: botframework-streaming.ValidBuffer -package: botframework-streaming -summary: |- - Copyright (c) Microsoft Corporation. All rights reserved. - Licensed under the MIT License. -fullName: ValidBuffer -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ValidBuffer = string | Uint8Array | INodeBuffer diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketClient.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketClient.yml index a6781dd5..3e9ce52e 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketClient.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketClient.yml @@ -5,7 +5,6 @@ package: botframework-streaming summary: Web socket based client to be used as streaming transport. fullName: WebSocketClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,25 +17,26 @@ constructors: Creates a new instance of the [WebSocketClient](xref:botframework-streaming.WebSocketClient) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new WebSocketClient(__namedParameters: { disconnectionHandler: (message: - string) => void, requestHandler: RequestHandler, url: string }) + new WebSocketClient(config: { disconnectionHandler: (message: string) => + void, requestHandler: RequestHandler, url: string }) parameters: - - id: __namedParameters + - id: config type: >- { disconnectionHandler: (message: string) => void, requestHandler: RequestHandler, url: string } - description: '' + description: >- + For configuring a + [WebSocketClient](xref:botframework-streaming.WebSocketClient) + instance to communicate with a WebSocket server. methods: - name: connect() uid: botframework-streaming.WebSocketClient.connect package: botframework-streaming summary: Establish a connection with no custom headers. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function connect(): Promise' @@ -50,7 +50,6 @@ methods: package: botframework-streaming summary: Stop this client from listening. remarks: '' - isPreview: false isDeprecated: false syntax: content: function disconnect() @@ -59,7 +58,6 @@ methods: package: botframework-streaming summary: Task used to send data over this client connection. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(request: StreamingRequest): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketServer.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketServer.yml index ba54b717..0a944d35 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketServer.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketServer.yml @@ -5,18 +5,16 @@ package: botframework-streaming summary: Web socket based server to be used as streaming transport. fullName: WebSocketServer remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'WebSocketServer(ISocket, RequestHandler)' + - name: WebSocketServer(ISocket, RequestHandler) uid: botframework-streaming.WebSocketServer.constructor package: botframework-streaming summary: >- Creates a new instance of the [WebSocketServer](xref:botframework-streaming.WebSocketServer) class. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new WebSocketServer(socket: ISocket, requestHandler?: RequestHandler)' @@ -26,7 +24,7 @@ constructors: description: The underlying web socket. - id: requestHandler type: - description: > + description: >- Optional [RequestHandler](xref:botframework-streaming.RequestHandler) to process incoming messages received by this server. @@ -39,7 +37,6 @@ properties: returns `true` if the socket connection is open. fullName: isConnected remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean isConnected @@ -54,7 +51,6 @@ methods: package: botframework-streaming summary: Stop this server. remarks: '' - isPreview: false isDeprecated: false syntax: content: function disconnect() @@ -63,7 +59,6 @@ methods: package: botframework-streaming summary: Task used to send data over this server connection. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function send(request: StreamingRequest): Promise' @@ -83,7 +78,6 @@ methods: Used to establish the connection used by this server and begin listening for incoming messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function start(): Promise' diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketTransport.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketTransport.yml deleted file mode 100644 index 14edff02..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WebSocketTransport.yml +++ /dev/null @@ -1,104 +0,0 @@ -### YamlMime:TSType -name: WebSocketTransport -uid: botframework-streaming.WebSocketTransport -package: botframework-streaming -summary: Web socket based transport. -fullName: WebSocketTransport -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: WebSocketTransport(ISocket) - uid: botframework-streaming.WebSocketTransport.constructor - package: botframework-streaming - summary: >- - Creates a new instance of the - [WebSocketTransport](xref:botframework-streaming.WebSocketTransport) - class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new WebSocketTransport(ws: ISocket)' - parameters: - - id: ws - type: - description: | - The ISocket to build this transport on top of. -properties: - - name: isConnected - uid: botframework-streaming.WebSocketTransport.isConnected - package: botframework-streaming - summary: Returns true if the transport is connected to a socket. - fullName: isConnected - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: boolean isConnected - return: - description: >- - `true` if the the transport is connected and ready to send data, - `false` otherwise. - type: boolean -methods: - - name: close() - uid: botframework-streaming.WebSocketTransport.close - package: botframework-streaming - summary: Close the socket this transport is connected to. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function close() - - name: onReceive(INodeBuffer) - uid: botframework-streaming.WebSocketTransport.onReceive - package: botframework-streaming - summary: >- - Sets the transport to attempt to receive incoming data that has not yet - arrived. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function onReceive(data: INodeBuffer)' - parameters: - - id: data - type: - description: | - A buffer to store incoming data in. - - name: receive(number) - uid: botframework-streaming.WebSocketTransport.receive - package: botframework-streaming - summary: Attempt to receive incoming data from the connected socket. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function receive(count: number): Promise' - parameters: - - id: count - type: number - description: The number of bytes to attempt to receive. - return: - description: A buffer populated with the received data. - type: Promise<> - - name: send(INodeBuffer) - uid: botframework-streaming.WebSocketTransport.send - package: botframework-streaming - summary: Sends the given buffer out over the socket's connection. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function send(buffer: INodeBuffer): number' - parameters: - - id: buffer - type: - description: The buffered data to send out over the connection. - return: - description: >- - A number indicating the length of the sent data if the data was - successfully sent, otherwise 0. - type: number diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WritableStream.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WritableStream.yml deleted file mode 100644 index 466b59cb..00000000 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/WritableStream.yml +++ /dev/null @@ -1,447 +0,0 @@ -### YamlMime:TSType -name: WritableStream -uid: botframework-streaming.WritableStream -package: botframework-streaming -summary: '' -fullName: WritableStream -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: writable - uid: botframework-streaming.WritableStream.writable - package: botframework-streaming - summary: '' - fullName: writable - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'writable: boolean' - return: - description: '' - type: boolean -inheritedMethods: - - name: 'addListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.addListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addListener(event: string | symbol, listener: (args: any[]) => - void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.addListener](xref:botframework-streaming.IEventEmitter.addListener) - - name: 'emit(string | symbol, any[])' - uid: botframework-streaming.WritableStream.emit - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function emit(event: string | symbol, args: any[]): boolean' - parameters: - - id: event - type: string | symbol - description: '' - - id: args - type: 'any[]' - description: '' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [IEventEmitter.emit](xref:botframework-streaming.IEventEmitter.emit) - - name: eventNames() - uid: botframework-streaming.WritableStream.eventNames - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function eventNames(): Array' - return: - description: '' - type: Array<string | symbol> - inheritanceDescription: >- - Inherited From - [IEventEmitter.eventNames](xref:botframework-streaming.IEventEmitter.eventNames) - - name: getMaxListeners() - uid: botframework-streaming.WritableStream.getMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getMaxListeners(): number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [IEventEmitter.getMaxListeners](xref:botframework-streaming.IEventEmitter.getMaxListeners) - - name: listenerCount(string | symbol) - uid: botframework-streaming.WritableStream.listenerCount - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listenerCount(type: string | symbol): number' - parameters: - - id: type - type: string | symbol - description: '' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [IEventEmitter.listenerCount](xref:botframework-streaming.IEventEmitter.listenerCount) - - name: listeners(string | symbol) - uid: botframework-streaming.WritableStream.listeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function listeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - inheritanceDescription: >- - Inherited From - [IEventEmitter.listeners](xref:botframework-streaming.IEventEmitter.listeners) - - name: 'off(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.off - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function off(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.off](xref:botframework-streaming.IEventEmitter.off) - - name: 'on(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.on - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function on(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.on](xref:botframework-streaming.IEventEmitter.on) - - name: 'once(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.once - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function once(event: string | symbol, listener: (args: any[]) => void): - this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.once](xref:botframework-streaming.IEventEmitter.once) - - name: 'prependListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.prependListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.prependListener](xref:botframework-streaming.IEventEmitter.prependListener) - - name: 'prependOnceListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.prependOnceListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function prependOnceListener(event: string | symbol, listener: (args: - any[]) => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.prependOnceListener](xref:botframework-streaming.IEventEmitter.prependOnceListener) - - name: rawListeners(string | symbol) - uid: botframework-streaming.WritableStream.rawListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function rawListeners(event: string | symbol): Function[]' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: 'Function[]' - inheritanceDescription: >- - Inherited From - [IEventEmitter.rawListeners](xref:botframework-streaming.IEventEmitter.rawListeners) - - name: removeAllListeners(string | symbol) - uid: botframework-streaming.WritableStream.removeAllListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllListeners(event?: string | symbol): this' - parameters: - - id: event - type: string | symbol - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.removeAllListeners](xref:botframework-streaming.IEventEmitter.removeAllListeners) - - name: 'removeListener(string | symbol, (args: any[]) => void)' - uid: botframework-streaming.WritableStream.removeListener - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeListener(event: string | symbol, listener: (args: any[]) - => void): this - parameters: - - id: event - type: string | symbol - description: '' - - id: listener - type: '(args: any[]) => void' - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.removeListener](xref:botframework-streaming.IEventEmitter.removeListener) - - name: setMaxListeners(number) - uid: botframework-streaming.WritableStream.setMaxListeners - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setMaxListeners(n: number): this' - parameters: - - id: 'n' - type: number - description: '' - return: - description: '' - type: this - inheritanceDescription: >- - Inherited From - [IEventEmitter.setMaxListeners](xref:botframework-streaming.IEventEmitter.setMaxListeners) -methods: - - name: 'end(Buffer, Function)' - uid: botframework-streaming.WritableStream.end_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(buffer: Buffer, cb?: Function)' - parameters: - - id: buffer - type: Buffer - description: '' - - id: cb - type: Function - description: '' - - name: end(Function) - uid: botframework-streaming.WritableStream.end - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(cb?: Function)' - parameters: - - id: cb - type: Function - description: '' - - name: 'end(string, Function)' - uid: botframework-streaming.WritableStream.end_2 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(str: string, cb?: Function)' - parameters: - - id: str - type: string - description: '' - - id: cb - type: Function - description: '' - - name: 'end(string, string, Function)' - uid: botframework-streaming.WritableStream.end_3 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function end(str: string, encoding?: string, cb?: Function)' - parameters: - - id: str - type: string - description: '' - - id: encoding - type: string - description: '' - - id: cb - type: Function - description: '' - - name: 'write(Buffer | string, Function)' - uid: botframework-streaming.WritableStream.write - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function write(buffer: Buffer | string, cb?: Function): boolean' - parameters: - - id: buffer - type: Buffer | string - description: '' - - id: cb - type: Function - description: '' - return: - description: '' - type: boolean - - name: 'write(string, string, Function)' - uid: botframework-streaming.WritableStream.write_1 - package: botframework-streaming - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function write(str: string, encoding?: string, cb?: Function): boolean' - parameters: - - id: str - type: string - description: '' - - id: encoding - type: string - description: '' - - id: cb - type: Function - description: '' - return: - description: '' - type: boolean -extends: diff --git a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/index.yml b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/index.yml index bdaf1cb1..cc9ee653 100644 --- a/botbuilder-typescript/docs-ref-autogen/botframework-streaming/index.yml +++ b/botbuilder-typescript/docs-ref-autogen/botframework-streaming/index.yml @@ -4,111 +4,25 @@ name: botframework-streaming summary: '' type: package classes: - - botframework-streaming.PayloadAssembler - botframework-streaming.ContentStream - - botframework-streaming.CancelDisassembler - - botframework-streaming.HttpContentStreamDisassembler - - botframework-streaming.PayloadDisassembler - - botframework-streaming.RequestDisassembler - - botframework-streaming.ResponseDisassembler - botframework-streaming.HttpContent - - botframework-streaming.HttpContentStream - botframework-streaming.NamedPipeClient - botframework-streaming.NamedPipeServer - - botframework-streaming.NamedPipeTransport - - botframework-streaming.PayloadReceiver - - botframework-streaming.PayloadSender - - botframework-streaming.TransportDisconnectedEvent - - botframework-streaming.HeaderSerializer - - botframework-streaming.PayloadAssemblerManager - - botframework-streaming.RequestManager - - botframework-streaming.SendOperations - - botframework-streaming.StreamManager - - botframework-streaming.ProtocolAdapter + - botframework-streaming.NodeWebSocket + - botframework-streaming.NodeWebSocketFactory + - botframework-streaming.NodeWebSocketFactoryBase - botframework-streaming.RequestHandler - botframework-streaming.StreamingRequest - botframework-streaming.StreamingResponse - botframework-streaming.SubscribableStream - - botframework-streaming.NodeWebSocketFactory - - botframework-streaming.NodeWebSocketFactoryBase - - botframework-streaming.NodeWebSocket - botframework-streaming.WebSocketClient - botframework-streaming.WebSocketServer - - botframework-streaming.WebSocketTransport interfaces: - - botframework-streaming.IAssemblerParams - - botframework-streaming.IBrowserFileReader - - botframework-streaming.IBrowserWebSocket - - botframework-streaming.IEventEmitter - - botframework-streaming.IHeader - - botframework-streaming.IHttpContentHeaders - botframework-streaming.INodeBuffer - botframework-streaming.INodeIncomingMessage - - botframework-streaming.INodeServer - - botframework-streaming.AddressInfo - botframework-streaming.INodeSocket - - botframework-streaming.WritableStream - botframework-streaming.IReceiveRequest - botframework-streaming.IReceiveResponse - - botframework-streaming.IRequestPayload - - botframework-streaming.IResponsePayload - - botframework-streaming.ISendPacket - botframework-streaming.ISocket - - botframework-streaming.IStreamDescription - - botframework-streaming.IStreamWrapper - botframework-streaming.IStreamingTransportClient - botframework-streaming.IStreamingTransportServer - - botframework-streaming.ITransport - - botframework-streaming.ITransportReceiver - - botframework-streaming.ITransportSender -typeAliases: - - botframework-streaming.BufferEncoding - - botframework-streaming.ValidBuffer - - botframework-streaming.TransportDisconnectedEventHandler - - botframework-streaming.ConnectionListener -enums: - - botframework-streaming.PayloadConstants - - botframework-streaming.PayloadTypes -functions: - - name: createNodeServer(ConnectionListener) - uid: botframework-streaming.createNodeServer - package: botframework-streaming - summary: Create a Node 'net' server - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function createNodeServer(callback?: ConnectionListener): INodeServer' - parameters: - - id: callback - type: - description: Optional connection listener - return: - description: a Node 'net' server instance - type: - - name: getServerFactory() - uid: botframework-streaming.getServerFactory - package: botframework-streaming - summary: Get a function that creates a Node 'net' server instance - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getServerFactory(): (callback?: ConnectionListener) => - INodeServer - return: - description: a server factory function - type: '(callback?: ConnectionListener) => INodeServer' - - name: generateGuid() - uid: botframework-streaming.generateGuid - package: botframework-streaming - summary: Generates an uuid v4 string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateGuid(): string' - return: - description: An uuidv4 string. - type: string diff --git a/botbuilder-typescript/docs-ref-autogen/toc.yml b/botbuilder-typescript/docs-ref-autogen/toc.yml index 93efdf83..a27f531f 100644 --- a/botbuilder-typescript/docs-ref-autogen/toc.yml +++ b/botbuilder-typescript/docs-ref-autogen/toc.yml @@ -2,51 +2,12 @@ items: - name: Overview uid: adaptive-expressions - - uid: adaptive-expressions.Abs - name: Abs - items: [] - - uid: adaptive-expressions.Accessor - name: Accessor - items: [] - - uid: adaptive-expressions.Add - name: Add - items: [] - - uid: adaptive-expressions.AddDays - name: AddDays - items: [] - - uid: adaptive-expressions.AddHours - name: AddHours - items: [] - - uid: adaptive-expressions.AddMinutes - name: AddMinutes - items: [] - - uid: adaptive-expressions.AddOrdinal - name: AddOrdinal - items: [] - - uid: adaptive-expressions.AddProperty - name: AddProperty - items: [] - - uid: adaptive-expressions.AddSeconds - name: AddSeconds - items: [] - - uid: adaptive-expressions.AddToTime - name: AddToTime - items: [] - - uid: adaptive-expressions.All - name: All - items: [] - uid: adaptive-expressions.Alpha_numsContext name: Alpha_numsContext items: [] - uid: adaptive-expressions.AlternationContext name: AlternationContext items: [] - - uid: adaptive-expressions.And - name: And - items: [] - - uid: adaptive-expressions.Any - name: Any - items: [] - uid: adaptive-expressions.ArgsListContext name: ArgsListContext items: [] @@ -62,27 +23,9 @@ - uid: adaptive-expressions.AtomContext name: AtomContext items: [] - - uid: adaptive-expressions.Average - name: Average - items: [] - - uid: adaptive-expressions.Base64 - name: Base64 - items: [] - - uid: adaptive-expressions.Base64ToBinary - name: Base64ToBinary - items: [] - - uid: adaptive-expressions.Base64ToString - name: Base64ToString - items: [] - - uid: adaptive-expressions.Binary - name: Binary - items: [] - uid: adaptive-expressions.BinaryOpExpContext name: BinaryOpExpContext items: [] - - uid: adaptive-expressions.Bool - name: Bool - items: [] - uid: adaptive-expressions.BoolExpression name: BoolExpression items: [] @@ -98,18 +41,12 @@ - uid: adaptive-expressions.Cc_literalContext name: Cc_literalContext items: [] - - uid: adaptive-expressions.Ceiling - name: Ceiling - items: [] - uid: adaptive-expressions.Character_classContext name: Character_classContext items: [] - uid: adaptive-expressions.Clause name: Clause items: [] - - uid: adaptive-expressions.Coalesce - name: Coalesce - items: [] - uid: adaptive-expressions.CommonRegex name: CommonRegex items: [] @@ -128,99 +65,30 @@ - uid: adaptive-expressions.ComparisonEvaluator name: ComparisonEvaluator items: [] - - uid: adaptive-expressions.Concat - name: Concat - items: [] - uid: adaptive-expressions.Constant name: Constant items: [] - - uid: adaptive-expressions.Contains - name: Contains - items: [] - - uid: adaptive-expressions.ConvertFromUTC - name: ConvertFromUTC - items: [] - - uid: adaptive-expressions.ConvertToUTC - name: ConvertToUTC - items: [] - - uid: adaptive-expressions.Count - name: Count - items: [] - - uid: adaptive-expressions.CountWord - name: CountWord - items: [] - - uid: adaptive-expressions.CreateArray - name: CreateArray - items: [] - - uid: adaptive-expressions.DataUri - name: DataUri - items: [] - - uid: adaptive-expressions.DataUriToBinary - name: DataUriToBinary - items: [] - - uid: adaptive-expressions.DataUriToString - name: DataUriToString - items: [] - - uid: adaptive-expressions.DateFunc - name: DateFunc - items: [] - - uid: adaptive-expressions.DateReadBack - name: DateReadBack - items: [] - - uid: adaptive-expressions.DateTimeDiff - name: DateTimeDiff - items: [] - - uid: adaptive-expressions.DayOfMonth - name: DayOfMonth - items: [] - - uid: adaptive-expressions.DayOfWeek - name: DayOfWeek - items: [] - - uid: adaptive-expressions.DayOfYear - name: DayOfYear - items: [] - uid: adaptive-expressions.DigitContext name: DigitContext items: [] - uid: adaptive-expressions.DigitsContext name: DigitsContext items: [] - - uid: adaptive-expressions.Divide - name: Divide - items: [] - - uid: adaptive-expressions.Element - name: Element - items: [] - uid: adaptive-expressions.ElementContext name: ElementContext items: [] - - uid: adaptive-expressions.Empty - name: Empty - items: [] - - uid: adaptive-expressions.EndsWith - name: EndsWith - items: [] - uid: adaptive-expressions.EnumExpression name: EnumExpression items: [] - uid: adaptive-expressions.EnumExpressionConverter name: EnumExpressionConverter items: [] - - uid: adaptive-expressions.EOL - name: EOL - items: [] - - uid: adaptive-expressions.Equal - name: Equal - items: [] - uid: adaptive-expressions.EvaluateExpressionDelegate name: EvaluateExpressionDelegate items: [] - uid: adaptive-expressions.EvaluatorLookup name: EvaluatorLookup items: [] - - uid: adaptive-expressions.Exists - name: Exists - items: [] - uid: adaptive-expressions.ExprContext name: ExprContext items: [] @@ -269,33 +137,6 @@ - uid: adaptive-expressions.FileContext name: FileContext items: [] - - uid: adaptive-expressions.First - name: First - items: [] - - uid: adaptive-expressions.Flatten - name: Flatten - items: [] - - uid: adaptive-expressions.Float - name: Float - items: [] - - uid: adaptive-expressions.Floor - name: Floor - items: [] - - uid: adaptive-expressions.Foreach - name: Foreach - items: [] - - uid: adaptive-expressions.FormatDateTime - name: FormatDateTime - items: [] - - uid: adaptive-expressions.FormatEpoch - name: FormatEpoch - items: [] - - uid: adaptive-expressions.FormatNumber - name: FormatNumber - items: [] - - uid: adaptive-expressions.FormatTicks - name: FormatTicks - items: [] - uid: adaptive-expressions.FuncInvokeExpContext name: FuncInvokeExpContext items: [] @@ -305,129 +146,21 @@ - uid: adaptive-expressions.FunctionUtils name: FunctionUtils items: [] - - uid: adaptive-expressions.GetFutureTime - name: GetFutureTime - items: [] - - uid: adaptive-expressions.GetNextViableDate - name: GetNextViableDate - items: [] - - uid: adaptive-expressions.GetNextViableTime - name: GetNextViableTime - items: [] - - uid: adaptive-expressions.GetPastTime - name: GetPastTime - items: [] - - uid: adaptive-expressions.GetPreviousViableDate - name: GetPreviousViableDate - items: [] - - uid: adaptive-expressions.GetPreviousViableTime - name: GetPreviousViableTime - items: [] - - uid: adaptive-expressions.GetProperty - name: GetProperty - items: [] - - uid: adaptive-expressions.GetTimeOfDay - name: GetTimeOfDay - items: [] - - uid: adaptive-expressions.GreaterThan - name: GreaterThan - items: [] - - uid: adaptive-expressions.GreaterThanOrEqual - name: GreaterThanOrEqual - items: [] - uid: adaptive-expressions.IdAtomContext name: IdAtomContext items: [] - - uid: adaptive-expressions.If - name: If - items: [] - - uid: adaptive-expressions.Ignore - name: Ignore - items: [] - uid: adaptive-expressions.IndexAccessExpContext name: IndexAccessExpContext items: [] - - uid: adaptive-expressions.IndexOf - name: IndexOf - items: [] - - uid: adaptive-expressions.IndicesAndValues - name: IndicesAndValues - items: [] - - uid: adaptive-expressions.Int - name: Int - items: [] - - uid: adaptive-expressions.InternalFunctionUtils - name: InternalFunctionUtils - items: [] - - uid: adaptive-expressions.Intersection - name: Intersection - items: [] - uid: adaptive-expressions.IntExpression name: IntExpression items: [] - uid: adaptive-expressions.IntExpressionConverter name: IntExpressionConverter items: [] - - uid: adaptive-expressions.IsArray - name: IsArray - items: [] - - uid: adaptive-expressions.IsBoolean - name: IsBoolean - items: [] - - uid: adaptive-expressions.IsDate - name: IsDate - items: [] - - uid: adaptive-expressions.IsDateRange - name: IsDateRange - items: [] - - uid: adaptive-expressions.IsDateTime - name: IsDateTime - items: [] - - uid: adaptive-expressions.IsDefinite - name: IsDefinite - items: [] - - uid: adaptive-expressions.IsDuration - name: IsDuration - items: [] - - uid: adaptive-expressions.IsFloat - name: IsFloat - items: [] - - uid: adaptive-expressions.IsInteger - name: IsInteger - items: [] - - uid: adaptive-expressions.IsMatch - name: IsMatch - items: [] - - uid: adaptive-expressions.IsObject - name: IsObject - items: [] - - uid: adaptive-expressions.IsPresent - name: IsPresent - items: [] - - uid: adaptive-expressions.IsString - name: IsString - items: [] - - uid: adaptive-expressions.IsTime - name: IsTime - items: [] - - uid: adaptive-expressions.IsTimeRange - name: IsTimeRange - items: [] - - uid: adaptive-expressions.Join - name: Join - items: [] - - uid: adaptive-expressions.JPath - name: JPath - items: [] - - uid: adaptive-expressions.Json - name: Json - items: [] - uid: adaptive-expressions.JsonCreationExpContext name: JsonCreationExpContext items: [] - - uid: adaptive-expressions.JsonStringify - name: JsonStringify - items: [] - uid: adaptive-expressions.KeyContext name: KeyContext items: [] @@ -440,60 +173,24 @@ - uid: adaptive-expressions.LambdaContext name: LambdaContext items: [] - - uid: adaptive-expressions.Last - name: Last - items: [] - - uid: adaptive-expressions.LastIndexOf - name: LastIndexOf - items: [] - - uid: adaptive-expressions.Length - name: Length - items: [] - - uid: adaptive-expressions.LessThan - name: LessThan - items: [] - - uid: adaptive-expressions.LessThanOrEqual - name: LessThanOrEqual - items: [] - uid: adaptive-expressions.LetterContext name: LetterContext items: [] - uid: adaptive-expressions.LiteralContext name: LiteralContext items: [] - - uid: adaptive-expressions.Max - name: Max - items: [] - uid: adaptive-expressions.MemberAccessExpContext name: MemberAccessExpContext items: [] - uid: adaptive-expressions.MemoryInterface name: MemoryInterface items: [] - - uid: adaptive-expressions.Merge - name: Merge - items: [] - - uid: adaptive-expressions.Min - name: Min - items: [] - - uid: adaptive-expressions.Mod - name: Mod - items: [] - - uid: adaptive-expressions.Month - name: Month - items: [] - - uid: adaptive-expressions.Multiply - name: Multiply - items: [] - uid: adaptive-expressions.MultivariateNumericEvaluator name: MultivariateNumericEvaluator items: [] - uid: adaptive-expressions.NameContext name: NameContext items: [] - - uid: adaptive-expressions.NewGuid - name: NewGuid - items: [] - uid: adaptive-expressions.Node name: Node items: [] @@ -506,12 +203,6 @@ - uid: adaptive-expressions.Non_close_parensContext name: Non_close_parensContext items: [] - - uid: adaptive-expressions.Not - name: Not - items: [] - - uid: adaptive-expressions.NotEqual - name: NotEqual - items: [] - uid: adaptive-expressions.NumberContext name: NumberContext items: [] @@ -545,9 +236,6 @@ - uid: adaptive-expressions.Optimizer name: Optimizer items: [] - - uid: adaptive-expressions.Optional - name: Optional - items: [] - uid: adaptive-expressions.OptionContext name: OptionContext items: [] @@ -557,9 +245,6 @@ - uid: adaptive-expressions.Option_flagContext name: Option_flagContext items: [] - - uid: adaptive-expressions.Or - name: Or - items: [] - uid: adaptive-expressions.ParenthesisExpContext name: ParenthesisExpContext items: [] @@ -569,9 +254,6 @@ - uid: adaptive-expressions.ParseErrorListener name: ParseErrorListener items: [] - - uid: adaptive-expressions.Power - name: Power - items: [] - uid: adaptive-expressions.PredicateComparer name: PredicateComparer items: [] @@ -596,48 +278,15 @@ - uid: adaptive-expressions.Quantifier_typeContext name: Quantifier_typeContext items: [] - - uid: adaptive-expressions.Rand - name: Rand - items: [] - - uid: adaptive-expressions.Range - name: Range - items: [] - uid: adaptive-expressions.RegexErrorListener name: RegexErrorListener items: [] - uid: adaptive-expressions.RelationshipType name: RelationshipType items: [] - - uid: adaptive-expressions.RemoveProperty - name: RemoveProperty - items: [] - - uid: adaptive-expressions.Replace - name: Replace - items: [] - - uid: adaptive-expressions.ReplaceIgnoreCase - name: ReplaceIgnoreCase - items: [] - uid: adaptive-expressions.ReturnType name: ReturnType items: [] - - uid: adaptive-expressions.Reverse - name: Reverse - items: [] - - uid: adaptive-expressions.Round - name: Round - items: [] - - uid: adaptive-expressions.Select - name: Select - items: [] - - uid: adaptive-expressions.SentenceCase - name: SentenceCase - items: [] - - uid: adaptive-expressions.SetPathToValue - name: SetPathToValue - items: [] - - uid: adaptive-expressions.SetProperty - name: SetProperty - items: [] - uid: adaptive-expressions.Shared_atomContext name: Shared_atomContext items: [] @@ -647,39 +296,9 @@ - uid: adaptive-expressions.SimpleObjectMemory name: SimpleObjectMemory items: [] - - uid: adaptive-expressions.Skip - name: Skip - items: [] - - uid: adaptive-expressions.SortBy - name: SortBy - items: [] - - uid: adaptive-expressions.SortByDescending - name: SortByDescending - items: [] - - uid: adaptive-expressions.Split - name: Split - items: [] - - uid: adaptive-expressions.Sqrt - name: Sqrt - items: [] - uid: adaptive-expressions.StackedMemory name: StackedMemory items: [] - - uid: adaptive-expressions.StartOfDay - name: StartOfDay - items: [] - - uid: adaptive-expressions.StartOfHour - name: StartOfHour - items: [] - - uid: adaptive-expressions.StartOfMonth - name: StartOfMonth - items: [] - - uid: adaptive-expressions.StartsWith - name: StartsWith - items: [] - - uid: adaptive-expressions.String - name: String - items: [] - uid: adaptive-expressions.StringAtomContext name: StringAtomContext items: [] @@ -695,111 +314,30 @@ - uid: adaptive-expressions.StringInterpolationContext name: StringInterpolationContext items: [] - - uid: adaptive-expressions.StringOrValue - name: StringOrValue - items: [] - uid: adaptive-expressions.StringTransformEvaluator name: StringTransformEvaluator items: [] - - uid: adaptive-expressions.SubArray - name: SubArray - items: [] - - uid: adaptive-expressions.Substring - name: Substring - items: [] - - uid: adaptive-expressions.Subtract - name: Subtract - items: [] - - uid: adaptive-expressions.SubtractFromTime - name: SubtractFromTime - items: [] - - uid: adaptive-expressions.Sum - name: Sum - items: [] - - uid: adaptive-expressions.Take - name: Take - items: [] - uid: adaptive-expressions.TextContentContext name: TextContentContext items: [] - - uid: adaptive-expressions.Ticks - name: Ticks - items: [] - - uid: adaptive-expressions.TicksToDays - name: TicksToDays - items: [] - - uid: adaptive-expressions.TicksToHours - name: TicksToHours - items: [] - - uid: adaptive-expressions.TicksToMinutes - name: TicksToMinutes - items: [] - uid: adaptive-expressions.TimeTransformEvaluator name: TimeTransformEvaluator items: [] - - uid: adaptive-expressions.TimexResolve - name: TimexResolve - items: [] - uid: adaptive-expressions.TimeZoneConverter name: TimeZoneConverter items: [] - - uid: adaptive-expressions.TitleCase - name: TitleCase - items: [] - - uid: adaptive-expressions.ToLower - name: ToLower - items: [] - - uid: adaptive-expressions.ToUpper - name: ToUpper - items: [] - uid: adaptive-expressions.Trigger name: Trigger items: [] - uid: adaptive-expressions.TriggerTree name: TriggerTree items: [] - - uid: adaptive-expressions.Trim - name: Trim - items: [] - uid: adaptive-expressions.TripleOpExpContext name: TripleOpExpContext items: [] - uid: adaptive-expressions.UnaryOpExpContext name: UnaryOpExpContext items: [] - - uid: adaptive-expressions.Union - name: Union - items: [] - - uid: adaptive-expressions.Unique - name: Unique - items: [] - - uid: adaptive-expressions.UriComponent - name: UriComponent - items: [] - - uid: adaptive-expressions.UriComponentToString - name: UriComponentToString - items: [] - - uid: adaptive-expressions.UriHost - name: UriHost - items: [] - - uid: adaptive-expressions.UriPath - name: UriPath - items: [] - - uid: adaptive-expressions.UriPathAndQuery - name: UriPathAndQuery - items: [] - - uid: adaptive-expressions.UriPort - name: UriPort - items: [] - - uid: adaptive-expressions.UriQuery - name: UriQuery - items: [] - - uid: adaptive-expressions.UriScheme - name: UriScheme - items: [] - - uid: adaptive-expressions.UtcNow - name: UtcNow - items: [] - uid: adaptive-expressions.Util name: Util items: [] @@ -818,584 +356,2814 @@ - uid: adaptive-expressions.VerifyExpression name: VerifyExpression items: [] - - uid: adaptive-expressions.Where - name: Where +- name: adaptive-expressions-ie11 + items: + - name: Overview + uid: adaptive-expressions-ie11 + - uid: adaptive-expressions-ie11.Alpha_numsContext + name: Alpha_numsContext items: [] - - uid: adaptive-expressions.XML - name: XML + - uid: adaptive-expressions-ie11.AlternationContext + name: AlternationContext items: [] - - uid: adaptive-expressions.XPath - name: XPath + - uid: adaptive-expressions-ie11.ArgsListContext + name: ArgsListContext items: [] - - uid: adaptive-expressions.Year - name: Year + - uid: adaptive-expressions-ie11.ArrayCreationExpContext + name: ArrayCreationExpContext items: [] -- name: botbuilder - items: - - name: Overview - uid: botbuilder - - uid: botbuilder.BotFrameworkAdapter - name: BotFrameworkAdapter + - uid: adaptive-expressions-ie11.ArrayExpression + name: ArrayExpression items: [] - - uid: botbuilder.BotFrameworkAdapterSettings - name: BotFrameworkAdapterSettings + - uid: adaptive-expressions-ie11.ArrayExpressionConverter + name: ArrayExpressionConverter items: [] - - uid: botbuilder.BotFrameworkHttpAdapter - name: BotFrameworkHttpAdapter + - uid: adaptive-expressions-ie11.AtomContext + name: AtomContext items: [] - - uid: botbuilder.BotFrameworkHttpClient - name: BotFrameworkHttpClient + - uid: adaptive-expressions-ie11.BinaryOpExpContext + name: BinaryOpExpContext items: [] - - uid: botbuilder.ChannelServiceHandler - name: ChannelServiceHandler + - uid: adaptive-expressions-ie11.BoolExpression + name: BoolExpression items: [] - - uid: botbuilder.ChannelServiceHandlerBase - name: ChannelServiceHandlerBase + - uid: adaptive-expressions-ie11.BoolExpressionConverter + name: BoolExpressionConverter items: [] - - uid: botbuilder.ChannelServiceRoutes - name: ChannelServiceRoutes + - uid: adaptive-expressions-ie11.CaptureContext + name: CaptureContext items: [] - - uid: botbuilder.CloudAdapter - name: CloudAdapter + - uid: adaptive-expressions-ie11.Cc_atomContext + name: Cc_atomContext items: [] - - uid: botbuilder.CloudChannelServiceHandler - name: CloudChannelServiceHandler + - uid: adaptive-expressions-ie11.Cc_literalContext + name: Cc_literalContext items: [] - - uid: botbuilder.CloudSkillHandler - name: CloudSkillHandler + - uid: adaptive-expressions-ie11.Character_classContext + name: Character_classContext items: [] - - uid: botbuilder.ConnectorClientBuilder - name: ConnectorClientBuilder + - uid: adaptive-expressions-ie11.Clause + name: Clause items: [] - - uid: botbuilder.EventFactory - name: EventFactory + - uid: adaptive-expressions-ie11.CommonRegex + name: CommonRegex items: [] - - uid: botbuilder.FileTranscriptStore - name: FileTranscriptStore + - uid: adaptive-expressions-ie11.CommonRegexLexer + name: CommonRegexLexer items: [] - - uid: botbuilder.HandoffEventNames - name: HandoffEventNames + - uid: adaptive-expressions-ie11.CommonRegexListener + name: CommonRegexListener items: [] - - uid: botbuilder.InspectionMiddleware - name: InspectionMiddleware + - uid: adaptive-expressions-ie11.CommonRegexParser + name: CommonRegexParser items: [] - - uid: botbuilder.InspectionState - name: InspectionState + - uid: adaptive-expressions-ie11.CommonRegexVisitor + name: CommonRegexVisitor items: [] - - uid: botbuilder.Request - name: Request + - uid: adaptive-expressions-ie11.ComparisonEvaluator + name: ComparisonEvaluator items: [] - - uid: botbuilder.Response - name: Response + - uid: adaptive-expressions-ie11.Constant + name: Constant items: [] - - uid: botbuilder.RouteConstants - name: RouteConstants + - uid: adaptive-expressions-ie11.DigitContext + name: DigitContext items: [] - - uid: botbuilder.RouteHandler - name: RouteHandler + - uid: adaptive-expressions-ie11.DigitsContext + name: DigitsContext items: [] - - uid: botbuilder.SetSpeakMiddleware - name: SetSpeakMiddleware + - uid: adaptive-expressions-ie11.ElementContext + name: ElementContext items: [] - - uid: botbuilder.SkillHandler - name: SkillHandler + - uid: adaptive-expressions-ie11.EnumExpression + name: EnumExpression items: [] - - uid: botbuilder.SkillHandlerImpl - name: SkillHandlerImpl + - uid: adaptive-expressions-ie11.EnumExpressionConverter + name: EnumExpressionConverter items: [] - - uid: botbuilder.SkillHttpClient - name: SkillHttpClient + - uid: adaptive-expressions-ie11.EvaluateExpressionDelegate + name: EvaluateExpressionDelegate items: [] - - uid: botbuilder.StatusCodeError - name: StatusCodeError + - uid: adaptive-expressions-ie11.EvaluatorLookup + name: EvaluatorLookup items: [] - - uid: botbuilder.StreamingHttpClient - name: StreamingHttpClient + - uid: adaptive-expressions-ie11.ExprContext + name: ExprContext items: [] - - uid: botbuilder.TeamsActivityHandler - name: TeamsActivityHandler + - uid: adaptive-expressions-ie11.Expression + name: Expression items: [] - - uid: botbuilder.TeamsInfo - name: TeamsInfo + - uid: adaptive-expressions-ie11.ExpressionAntlrLexer + name: ExpressionAntlrLexer items: [] - - uid: botbuilder.TeamsSSOTokenExchangeMiddleware - name: TeamsSSOTokenExchangeMiddleware + - uid: adaptive-expressions-ie11.ExpressionAntlrParser + name: ExpressionAntlrParser items: [] - - uid: botbuilder.TokenResolver - name: TokenResolver + - uid: adaptive-expressions-ie11.ExpressionAntlrParserListener + name: ExpressionAntlrParserListener items: [] - - uid: botbuilder.WebRequest - name: WebRequest + - uid: adaptive-expressions-ie11.ExpressionAntlrParserVisitor + name: ExpressionAntlrParserVisitor items: [] - - uid: botbuilder.WebResponse - name: WebResponse + - uid: adaptive-expressions-ie11.ExpressionContext + name: ExpressionContext items: [] - - uid: botbuilder.WebServer - name: WebServer + - uid: adaptive-expressions-ie11.ExpressionConverter + name: ExpressionConverter + items: [] + - uid: adaptive-expressions-ie11.ExpressionEvaluator + name: ExpressionEvaluator + items: [] + - uid: adaptive-expressions-ie11.ExpressionFunctions + name: ExpressionFunctions + items: [] + - uid: adaptive-expressions-ie11.ExpressionParser + name: ExpressionParser + items: [] + - uid: adaptive-expressions-ie11.ExpressionParserInterface + name: ExpressionParserInterface + items: [] + - uid: adaptive-expressions-ie11.ExpressionProperty + name: ExpressionProperty + items: [] + - uid: adaptive-expressions-ie11.ExpressionType + name: ExpressionType + items: [] + - uid: adaptive-expressions-ie11.Extensions + name: Extensions + items: [] + - uid: adaptive-expressions-ie11.FileContext + name: FileContext + items: [] + - uid: adaptive-expressions-ie11.FuncInvokeExpContext + name: FuncInvokeExpContext + items: [] + - uid: adaptive-expressions-ie11.FunctionTable + name: FunctionTable + items: [] + - uid: adaptive-expressions-ie11.FunctionUtils + name: FunctionUtils + items: [] + - uid: adaptive-expressions-ie11.IdAtomContext + name: IdAtomContext + items: [] + - uid: adaptive-expressions-ie11.IndexAccessExpContext + name: IndexAccessExpContext + items: [] + - uid: adaptive-expressions-ie11.IntExpression + name: IntExpression + items: [] + - uid: adaptive-expressions-ie11.IntExpressionConverter + name: IntExpressionConverter + items: [] + - uid: adaptive-expressions-ie11.JsonCreationExpContext + name: JsonCreationExpContext + items: [] + - uid: adaptive-expressions-ie11.KeyContext + name: KeyContext + items: [] + - uid: adaptive-expressions-ie11.KeyValuePairContext + name: KeyValuePairContext + items: [] + - uid: adaptive-expressions-ie11.KeyValuePairListContext + name: KeyValuePairListContext + items: [] + - uid: adaptive-expressions-ie11.LambdaContext + name: LambdaContext + items: [] + - uid: adaptive-expressions-ie11.LetterContext + name: LetterContext + items: [] + - uid: adaptive-expressions-ie11.LiteralContext + name: LiteralContext + items: [] + - uid: adaptive-expressions-ie11.MemberAccessExpContext + name: MemberAccessExpContext + items: [] + - uid: adaptive-expressions-ie11.MemoryInterface + name: MemoryInterface + items: [] + - uid: adaptive-expressions-ie11.MultivariateNumericEvaluator + name: MultivariateNumericEvaluator + items: [] + - uid: adaptive-expressions-ie11.NameContext + name: NameContext + items: [] + - uid: adaptive-expressions-ie11.Node + name: Node + items: [] + - uid: adaptive-expressions-ie11.Non_captureContext + name: Non_captureContext + items: [] + - uid: adaptive-expressions-ie11.Non_close_parenContext + name: Non_close_parenContext + items: [] + - uid: adaptive-expressions-ie11.Non_close_parensContext + name: Non_close_parensContext + items: [] + - uid: adaptive-expressions-ie11.NumberContext + name: NumberContext + items: [] + - uid: adaptive-expressions-ie11.NumberExpression + name: NumberExpression + items: [] + - uid: adaptive-expressions-ie11.NumberExpressionConverter + name: NumberExpressionConverter + items: [] + - uid: adaptive-expressions-ie11.NumberTransformEvaluator + name: NumberTransformEvaluator + items: [] + - uid: adaptive-expressions-ie11.NumericAtomContext + name: NumericAtomContext + items: [] + - uid: adaptive-expressions-ie11.NumericEvaluator + name: NumericEvaluator + items: [] + - uid: adaptive-expressions-ie11.ObjectExpression + name: ObjectExpression + items: [] + - uid: adaptive-expressions-ie11.ObjectExpressionConverter + name: ObjectExpressionConverter + items: [] + - uid: adaptive-expressions-ie11.Octal_charContext + name: Octal_charContext + items: [] + - uid: adaptive-expressions-ie11.Octal_digitContext + name: Octal_digitContext + items: [] + - uid: adaptive-expressions-ie11.Optimizer + name: Optimizer + items: [] + - uid: adaptive-expressions-ie11.OptionContext + name: OptionContext + items: [] + - uid: adaptive-expressions-ie11.Options + name: Options + items: [] + - uid: adaptive-expressions-ie11.Option_flagContext + name: Option_flagContext + items: [] + - uid: adaptive-expressions-ie11.ParenthesisExpContext + name: ParenthesisExpContext + items: [] + - uid: adaptive-expressions-ie11.ParseContext + name: ParseContext + items: [] + - uid: adaptive-expressions-ie11.ParseErrorListener + name: ParseErrorListener + items: [] + - uid: adaptive-expressions-ie11.PredicateComparer + name: PredicateComparer + items: [] + - uid: adaptive-expressions-ie11.PredicateComparers + name: PredicateComparers + items: [] + - uid: adaptive-expressions-ie11.PrimaryExpContext + name: PrimaryExpContext + items: [] + - uid: adaptive-expressions-ie11.PrimaryExpressionContext + name: PrimaryExpressionContext + items: [] + - uid: adaptive-expressions-ie11.Quantifier + name: Quantifier + items: [] + - uid: adaptive-expressions-ie11.QuantifierContext + name: QuantifierContext + items: [] + - uid: adaptive-expressions-ie11.QuantifierType + name: QuantifierType + items: [] + - uid: adaptive-expressions-ie11.Quantifier_typeContext + name: Quantifier_typeContext + items: [] + - uid: adaptive-expressions-ie11.RegexErrorListener + name: RegexErrorListener + items: [] + - uid: adaptive-expressions-ie11.RelationshipType + name: RelationshipType + items: [] + - uid: adaptive-expressions-ie11.ReturnType + name: ReturnType + items: [] + - uid: adaptive-expressions-ie11.Shared_atomContext + name: Shared_atomContext + items: [] + - uid: adaptive-expressions-ie11.Shared_literalContext + name: Shared_literalContext + items: [] + - uid: adaptive-expressions-ie11.SimpleObjectMemory + name: SimpleObjectMemory + items: [] + - uid: adaptive-expressions-ie11.StackedMemory + name: StackedMemory + items: [] + - uid: adaptive-expressions-ie11.StringAtomContext + name: StringAtomContext + items: [] + - uid: adaptive-expressions-ie11.StringExpression + name: StringExpression + items: [] + - uid: adaptive-expressions-ie11.StringExpressionConverter + name: StringExpressionConverter + items: [] + - uid: adaptive-expressions-ie11.StringInterpolationAtomContext + name: StringInterpolationAtomContext + items: [] + - uid: adaptive-expressions-ie11.StringInterpolationContext + name: StringInterpolationContext + items: [] + - uid: adaptive-expressions-ie11.StringTransformEvaluator + name: StringTransformEvaluator + items: [] + - uid: adaptive-expressions-ie11.TextContentContext + name: TextContentContext + items: [] + - uid: adaptive-expressions-ie11.TimeTransformEvaluator + name: TimeTransformEvaluator + items: [] + - uid: adaptive-expressions-ie11.TimeZoneConverter + name: TimeZoneConverter + items: [] + - uid: adaptive-expressions-ie11.Trigger + name: Trigger + items: [] + - uid: adaptive-expressions-ie11.TriggerTree + name: TriggerTree + items: [] + - uid: adaptive-expressions-ie11.TripleOpExpContext + name: TripleOpExpContext + items: [] + - uid: adaptive-expressions-ie11.UnaryOpExpContext + name: UnaryOpExpContext + items: [] + - uid: adaptive-expressions-ie11.Util + name: Util + items: [] + - uid: adaptive-expressions-ie11.ValidateExpressionDelegate + name: ValidateExpressionDelegate + items: [] + - uid: adaptive-expressions-ie11.ValueExpression + name: ValueExpression + items: [] + - uid: adaptive-expressions-ie11.ValueExpressionConverter + name: ValueExpressionConverter + items: [] + - uid: adaptive-expressions-ie11.ValueWithError + name: ValueWithError + items: [] + - uid: adaptive-expressions-ie11.VerifyExpression + name: VerifyExpression + items: [] +- name: botbuilder + items: + - name: Overview + uid: botbuilder + - uid: botbuilder.AceCardSize + name: AceCardSize + items: [] + - uid: botbuilder.AceData + name: AceData + items: [] + - uid: botbuilder.AceRequest + name: AceRequest + items: [] + - uid: botbuilder.Action + name: Action + items: [] + - uid: botbuilder.ActionTypes + name: ActionTypes + items: [] + - uid: botbuilder.Activity + name: Activity + items: [] + - uid: botbuilder.ActivityEventNames + name: ActivityEventNames + items: [] + - uid: botbuilder.ActivityEx + name: ActivityEx + items: [] + - uid: botbuilder.ActivityFactory + name: ActivityFactory + items: [] + - uid: botbuilder.ActivityHandler + name: ActivityHandler + items: [] + - uid: botbuilder.ActivityHandlerBase + name: ActivityHandlerBase + items: [] + - uid: botbuilder.ActivityImageType + name: ActivityImageType + items: [] + - uid: botbuilder.ActivityImportance + name: ActivityImportance + items: [] + - uid: botbuilder.ActivityTimestamps + name: ActivityTimestamps + items: [] + - uid: botbuilder.ActivityTypes + name: ActivityTypes + items: [] + - uid: botbuilder.AdaptiveCardAuthentication + name: AdaptiveCardAuthentication + items: [] + - uid: botbuilder.AdaptiveCardInvokeAction + name: AdaptiveCardInvokeAction + items: [] + - uid: botbuilder.AdaptiveCardInvokeResponse + name: AdaptiveCardInvokeResponse + items: [] + - uid: botbuilder.AdaptiveCardInvokeValue + name: AdaptiveCardInvokeValue + items: [] + - uid: botbuilder.AnimationCard + name: AnimationCard + items: [] + - uid: botbuilder.AppBasedLinkQuery + name: AppBasedLinkQuery + items: [] + - uid: botbuilder.ApplicationIdentityType + name: ApplicationIdentityType + items: [] + - uid: botbuilder.Attachment + name: Attachment + items: [] + - uid: botbuilder.AttachmentData + name: AttachmentData + items: [] + - uid: botbuilder.AttachmentInfo + name: AttachmentInfo + items: [] + - uid: botbuilder.AttachmentLayout + name: AttachmentLayout + items: [] + - uid: botbuilder.AttachmentLayoutTypes + name: AttachmentLayoutTypes + items: [] + - uid: botbuilder.AttachmentView + name: AttachmentView + items: [] + - uid: botbuilder.AudioCard + name: AudioCard + items: [] + - uid: botbuilder.AutoSaveStateMiddleware + name: AutoSaveStateMiddleware + items: [] + - uid: botbuilder.BaseCardComponent + name: BaseCardComponent + items: [] + - uid: botbuilder.BaseCardViewParameters + name: BaseCardViewParameters + items: [] + - uid: botbuilder.BaseHandleActionResponse + name: BaseHandleActionResponse + items: [] + - uid: botbuilder.BasicCard + name: BasicCard + items: [] + - uid: botbuilder.BatchFailedEntriesResponse + name: BatchFailedEntriesResponse + items: [] + - uid: botbuilder.BatchFailedEntry + name: BatchFailedEntry + items: [] + - uid: botbuilder.BatchOperationRequest + name: BatchOperationRequest + items: [] + - uid: botbuilder.BatchOperationResponse + name: BatchOperationResponse + items: [] + - uid: botbuilder.BatchOperationStateResponse + name: BatchOperationStateResponse + items: [] + - uid: botbuilder.BotAdapter + name: BotAdapter + items: [] + - uid: botbuilder.BotComponent + name: BotComponent + items: [] + - uid: botbuilder.BotConfigAuth + name: BotConfigAuth + items: [] + - uid: botbuilder.BotConfigAuthType + name: BotConfigAuthType + items: [] + - uid: botbuilder.BotFrameworkAdapter + name: BotFrameworkAdapter + items: [] + - uid: botbuilder.BotFrameworkAdapterSettings + name: BotFrameworkAdapterSettings + items: [] + - uid: botbuilder.BotFrameworkClient + name: BotFrameworkClient + items: [] + - uid: botbuilder.BotFrameworkHttpAdapter + name: BotFrameworkHttpAdapter + items: [] + - uid: botbuilder.BotFrameworkHttpClient + name: BotFrameworkHttpClient + items: [] + - uid: botbuilder.BotFrameworkSkill + name: BotFrameworkSkill + items: [] + - uid: botbuilder.BotHandler + name: BotHandler + items: [] + - uid: botbuilder.BotMessagePreviewActionType + name: BotMessagePreviewActionType + items: [] + - uid: botbuilder.BotMessagePreviewType + name: BotMessagePreviewType + items: [] + - uid: botbuilder.BotPageViewTelemetryClient + name: BotPageViewTelemetryClient + items: [] + - uid: botbuilder.BotState + name: BotState + items: [] + - uid: botbuilder.BotStatePropertyAccessor + name: BotStatePropertyAccessor + items: [] + - uid: botbuilder.BotStateSet + name: BotStateSet + items: [] + - uid: botbuilder.BotTelemetryClient + name: BotTelemetryClient + items: [] + - uid: botbuilder.BrowserLocalStorage + name: BrowserLocalStorage + items: [] + - uid: botbuilder.BrowserSessionStorage + name: BrowserSessionStorage + items: [] + - uid: botbuilder.CachedBotState + name: CachedBotState + items: [] + - uid: botbuilder.CacheInfo + name: CacheInfo + items: [] + - uid: botbuilder.CallerIdConstants + name: CallerIdConstants + items: [] + - uid: botbuilder.CardAction + name: CardAction + items: [] + - uid: botbuilder.CardBarComponent + name: CardBarComponent + items: [] + - uid: botbuilder.CardButtonBase + name: CardButtonBase + items: [] + - uid: botbuilder.CardButtonComponent + name: CardButtonComponent + items: [] + - uid: botbuilder.CardComponentName + name: CardComponentName + items: [] + - uid: botbuilder.CardFactory + name: CardFactory + items: [] + - uid: botbuilder.CardImage + name: CardImage + items: [] + - uid: botbuilder.CardSearchBoxComponent + name: CardSearchBoxComponent + items: [] + - uid: botbuilder.CardSearchFooterComponent + name: CardSearchFooterComponent + items: [] + - uid: botbuilder.CardTextComponent + name: CardTextComponent + items: [] + - uid: botbuilder.CardTextInputComponent + name: CardTextInputComponent + items: [] + - uid: botbuilder.CardViewActionsFooterParameters + name: CardViewActionsFooterParameters + items: [] + - uid: botbuilder.CardViewFooterParameters + name: CardViewFooterParameters + items: [] + - uid: botbuilder.CardViewHandleActionResponse + name: CardViewHandleActionResponse + items: [] + - uid: botbuilder.CardViewParameters + name: CardViewParameters + items: [] + - uid: botbuilder.CardViewResponse + name: CardViewResponse + items: [] + - uid: botbuilder.ChannelAccount + name: ChannelAccount + items: [] + - uid: botbuilder.ChannelInfo + name: ChannelInfo + items: [] + - uid: botbuilder.Channels + name: Channels + items: [] + - uid: botbuilder.ChannelServiceHandler + name: ChannelServiceHandler + items: [] + - uid: botbuilder.ChannelServiceHandlerBase + name: ChannelServiceHandlerBase + items: [] + - uid: botbuilder.ChannelServiceRoutes + name: ChannelServiceRoutes + items: [] + - uid: botbuilder.CloudAdapter + name: CloudAdapter + items: [] + - uid: botbuilder.CloudAdapterBase + name: CloudAdapterBase + items: [] + - uid: botbuilder.CloudSkillHandler + name: CloudSkillHandler + items: [] + - uid: botbuilder.CommandContext + name: CommandContext + items: [] + - uid: botbuilder.CommandResultValue + name: CommandResultValue + items: [] + - uid: botbuilder.CommandValue + name: CommandValue + items: [] + - uid: botbuilder.ComponentRegistration + name: ComponentRegistration + items: [] + - uid: botbuilder.ConfigResponse + name: ConfigResponse + items: [] + - uid: botbuilder.ConfigResponseConfig + name: ConfigResponseConfig + items: [] + - uid: botbuilder.ConfigurationBotFrameworkAuthentication + name: ConfigurationBotFrameworkAuthentication + items: [] + - uid: botbuilder.ConfigurationBotFrameworkAuthenticationOptions + name: ConfigurationBotFrameworkAuthenticationOptions + items: [] + - uid: botbuilder.ConfigurationServiceClientCredentialFactory + name: ConfigurationServiceClientCredentialFactory + items: [] + - uid: botbuilder.ConfigurationServiceClientCredentialFactoryOptions + name: ConfigurationServiceClientCredentialFactoryOptions + items: [] + - uid: botbuilder.ConfirmationDialog + name: ConfirmationDialog + items: [] + - uid: botbuilder.ConsoleTranscriptLogger + name: ConsoleTranscriptLogger + items: [] + - uid: botbuilder.ContactRelationUpdateActionTypes + name: ContactRelationUpdateActionTypes + items: [] + - uid: botbuilder.ContentType + name: ContentType + items: [] + - uid: botbuilder.ConversationAccount + name: ConversationAccount + items: [] + - uid: botbuilder.ConversationIdentityType + name: ConversationIdentityType + items: [] + - uid: botbuilder.ConversationList + name: ConversationList + items: [] + - uid: botbuilder.ConversationMembers + name: ConversationMembers + items: [] + - uid: botbuilder.ConversationParameters + name: ConversationParameters + items: [] + - uid: botbuilder.ConversationReference + name: ConversationReference + items: [] + - uid: botbuilder.ConversationResourceResponse + name: ConversationResourceResponse + items: [] + - uid: botbuilder.ConversationsResult + name: ConversationsResult + items: [] + - uid: botbuilder.ConversationState + name: ConversationState + items: [] + - uid: botbuilder.CoreAppCredentials + name: CoreAppCredentials + items: [] + - uid: botbuilder.DeleteActivityHandler + name: DeleteActivityHandler + items: [] + - uid: botbuilder.DeliveryModes + name: DeliveryModes + items: [] + - uid: botbuilder.DropDownOptionType + name: DropDownOptionType + items: [] + - uid: botbuilder.EndOfConversationCodes + name: EndOfConversationCodes + items: [] + - uid: botbuilder.Entity + name: Entity + items: [] + - uid: botbuilder.ErrorModel + name: ErrorModel + items: [] + - uid: botbuilder.ErrorResponse + name: ErrorResponse + items: [] + - uid: botbuilder.EventFactory + name: EventFactory + items: [] + - uid: botbuilder.ExecuteCardAction + name: ExecuteCardAction + items: [] + - uid: botbuilder.ExecuteCardParameters + name: ExecuteCardParameters + items: [] + - uid: botbuilder.ExpectedReplies + name: ExpectedReplies + items: [] + - uid: botbuilder.ExtendedUserTokenProvider + name: ExtendedUserTokenProvider + items: [] + - uid: botbuilder.ExternalLinkActionParameters + name: ExternalLinkActionParameters + items: [] + - uid: botbuilder.ExternalLinkCardAction + name: ExternalLinkCardAction + items: [] + - uid: botbuilder.Fact + name: Fact + items: [] + - uid: botbuilder.FieldType + name: FieldType + items: [] + - uid: botbuilder.FileConsentCard + name: FileConsentCard + items: [] + - uid: botbuilder.FileConsentCardResponse + name: FileConsentCardResponse + items: [] + - uid: botbuilder.FileDownloadInfo + name: FileDownloadInfo + items: [] + - uid: botbuilder.FileDownloadInfoAttachment + name: FileDownloadInfoAttachment + items: [] + - uid: botbuilder.FileInfoCard + name: FileInfoCard + items: [] + - uid: botbuilder.FileTranscriptStore + name: FileTranscriptStore + items: [] + - uid: botbuilder.FileUploadInfo + name: FileUploadInfo + items: [] + - uid: botbuilder.FocusParameters + name: FocusParameters + items: [] + - uid: botbuilder.GeoCoordinates + name: GeoCoordinates + items: [] + - uid: botbuilder.GetLocationActionParameters + name: GetLocationActionParameters + items: [] + - uid: botbuilder.GetLocationCardAction + name: GetLocationCardAction + items: [] + - uid: botbuilder.GetPropertyPaneConfigurationResponse + name: GetPropertyPaneConfigurationResponse + items: [] + - uid: botbuilder.HandleActionResponse + name: HandleActionResponse + items: [] + - uid: botbuilder.HandoffEventNames + name: HandoffEventNames + items: [] + - uid: botbuilder.HeroCard + name: HeroCard + items: [] + - uid: botbuilder.IActivity + name: IActivity + items: [] + - uid: botbuilder.ICardSearchBoxButton + name: ICardSearchBoxButton + items: [] + - uid: botbuilder.ICardTextInputIconButton + name: ICardTextInputIconButton + items: [] + - uid: botbuilder.ICardTextInputTitleButton + name: ICardTextInputTitleButton + items: [] + - uid: botbuilder.ICommandActivity + name: ICommandActivity + items: [] + - uid: botbuilder.ICommandResultActivity + name: ICommandResultActivity + items: [] + - uid: botbuilder.IContactRelationUpdateActivity + name: IContactRelationUpdateActivity + items: [] + - uid: botbuilder.IConversationUpdateActivity + name: IConversationUpdateActivity + items: [] + - uid: botbuilder.IEndOfConversationActivity + name: IEndOfConversationActivity + items: [] + - uid: botbuilder.IEventActivity + name: IEventActivity + items: [] + - uid: botbuilder.IHandoffActivity + name: IHandoffActivity + items: [] + - uid: botbuilder.IInstallationUpdateActivity + name: IInstallationUpdateActivity + items: [] + - uid: botbuilder.IInvokeActivity + name: IInvokeActivity + items: [] + - uid: botbuilder.IMessageActivity + name: IMessageActivity + items: [] + - uid: botbuilder.IMessageDeleteActivity + name: IMessageDeleteActivity + items: [] + - uid: botbuilder.IMessageReactionActivity + name: IMessageReactionActivity + items: [] + - uid: botbuilder.IMessageUpdateActivity + name: IMessageUpdateActivity + items: [] + - uid: botbuilder.Importance + name: Importance + items: [] + - uid: botbuilder.InnerHttpError + name: InnerHttpError + items: [] + - uid: botbuilder.InputHints + name: InputHints + items: [] + - uid: botbuilder.InspectionMiddleware + name: InspectionMiddleware + items: [] + - uid: botbuilder.InspectionState + name: InspectionState + items: [] + - uid: botbuilder.InstallationUpdateActionTypes + name: InstallationUpdateActionTypes + items: [] + - uid: botbuilder.IntentScore + name: IntentScore + items: [] + - uid: botbuilder.InvokeException + name: InvokeException + items: [] + - uid: botbuilder.InvokeResponse + name: InvokeResponse + items: [] + - uid: botbuilder.IStatusCodeError + name: IStatusCodeError + items: [] + - uid: botbuilder.ISuggestionActivity + name: ISuggestionActivity + items: [] + - uid: botbuilder.ITraceActivity + name: ITraceActivity + items: [] + - uid: botbuilder.ITypingActivity + name: ITypingActivity + items: [] + - uid: botbuilder.IUserTokenProvider + name: IUserTokenProvider + items: [] + - uid: botbuilder.Location + name: Location + items: [] + - uid: botbuilder.MediaCard + name: MediaCard + items: [] + - uid: botbuilder.MediaEventValue + name: MediaEventValue + items: [] + - uid: botbuilder.MediaType + name: MediaType + items: [] + - uid: botbuilder.MediaUrl + name: MediaUrl + items: [] + - uid: botbuilder.Meeting + name: Meeting + items: [] + - uid: botbuilder.MeetingDetails + name: MeetingDetails + items: [] + - uid: botbuilder.MeetingEndEventDetails + name: MeetingEndEventDetails + items: [] + - uid: botbuilder.MeetingEventDetails + name: MeetingEventDetails + items: [] + - uid: botbuilder.MeetingInfo + name: MeetingInfo + items: [] + - uid: botbuilder.MeetingNotification + name: MeetingNotification + items: [] + - uid: botbuilder.MeetingNotificationBase + name: MeetingNotificationBase + items: [] + - uid: botbuilder.MeetingNotificationChannelData + name: MeetingNotificationChannelData + items: [] + - uid: botbuilder.MeetingNotificationRecipientFailureInfo + name: MeetingNotificationRecipientFailureInfo + items: [] + - uid: botbuilder.MeetingNotificationResponse + name: MeetingNotificationResponse + items: [] + - uid: botbuilder.MeetingParticipantsEventDetails + name: MeetingParticipantsEventDetails + items: [] + - uid: botbuilder.MeetingStageSurface + name: MeetingStageSurface + items: [] + - uid: botbuilder.MeetingStartEventDetails + name: MeetingStartEventDetails + items: [] + - uid: botbuilder.MeetingSurface + name: MeetingSurface + items: [] + - uid: botbuilder.MeetingTabIconSurface + name: MeetingTabIconSurface + items: [] + - uid: botbuilder.MemoryStorage + name: MemoryStorage + items: [] + - uid: botbuilder.MemoryTranscriptStore + name: MemoryTranscriptStore + items: [] + - uid: botbuilder.Mention + name: Mention + items: [] + - uid: botbuilder.MessageActionsPayload + name: MessageActionsPayload + items: [] + - uid: botbuilder.MessageActionsPayloadApp + name: MessageActionsPayloadApp + items: [] + - uid: botbuilder.MessageActionsPayloadAttachment + name: MessageActionsPayloadAttachment + items: [] + - uid: botbuilder.MessageActionsPayloadBody + name: MessageActionsPayloadBody + items: [] + - uid: botbuilder.MessageActionsPayloadConversation + name: MessageActionsPayloadConversation + items: [] + - uid: botbuilder.MessageActionsPayloadFrom + name: MessageActionsPayloadFrom + items: [] + - uid: botbuilder.MessageActionsPayloadMention + name: MessageActionsPayloadMention + items: [] + - uid: botbuilder.MessageActionsPayloadReaction + name: MessageActionsPayloadReaction + items: [] + - uid: botbuilder.MessageActionsPayloadUser + name: MessageActionsPayloadUser + items: [] + - uid: botbuilder.MessageFactory + name: MessageFactory + items: [] + - uid: botbuilder.MessageReaction + name: MessageReaction + items: [] + - uid: botbuilder.MessageReactionTypes + name: MessageReactionTypes + items: [] + - uid: botbuilder.MessageType + name: MessageType + items: [] + - uid: botbuilder.MessagingExtensionAction + name: MessagingExtensionAction + items: [] + - uid: botbuilder.MessagingExtensionActionResponse + name: MessagingExtensionActionResponse + items: [] + - uid: botbuilder.MessagingExtensionAttachment + name: MessagingExtensionAttachment + items: [] + - uid: botbuilder.MessagingExtensionParameter + name: MessagingExtensionParameter + items: [] + - uid: botbuilder.MessagingExtensionQuery + name: MessagingExtensionQuery + items: [] + - uid: botbuilder.MessagingExtensionQueryOptions + name: MessagingExtensionQueryOptions + items: [] + - uid: botbuilder.MessagingExtensionResponse + name: MessagingExtensionResponse + items: [] + - uid: botbuilder.MessagingExtensionResult + name: MessagingExtensionResult + items: [] + - uid: botbuilder.MessagingExtensionResultType + name: MessagingExtensionResultType + items: [] + - uid: botbuilder.MessagingExtensionSuggestedAction + name: MessagingExtensionSuggestedAction + items: [] + - uid: botbuilder.MicrosoftPayMethodData + name: MicrosoftPayMethodData + items: [] + - uid: botbuilder.Middleware + name: Middleware + items: [] + - uid: botbuilder.MiddlewareHandler + name: MiddlewareHandler + items: [] + - uid: botbuilder.MiddlewareSet + name: MiddlewareSet + items: [] + - uid: botbuilder.NoOpHandleActionResponse + name: NoOpHandleActionResponse + items: [] + - uid: botbuilder.NotificationInfo + name: NotificationInfo + items: [] + - uid: botbuilder.NullTelemetryClient + name: NullTelemetryClient + items: [] + - uid: botbuilder.O365ConnectorCard + name: O365ConnectorCard + items: [] + - uid: botbuilder.O365ConnectorCardActionBase + name: O365ConnectorCardActionBase + items: [] + - uid: botbuilder.O365ConnectorCardActionCard + name: O365ConnectorCardActionCard + items: [] + - uid: botbuilder.O365ConnectorCardActionQuery + name: O365ConnectorCardActionQuery + items: [] + - uid: botbuilder.O365ConnectorCardActionType + name: O365ConnectorCardActionType + items: [] + - uid: botbuilder.O365ConnectorCardDateInput + name: O365ConnectorCardDateInput + items: [] + - uid: botbuilder.O365ConnectorCardFact + name: O365ConnectorCardFact + items: [] + - uid: botbuilder.O365ConnectorCardHttpPOST + name: O365ConnectorCardHttpPOST + items: [] + - uid: botbuilder.O365ConnectorCardImage + name: O365ConnectorCardImage + items: [] + - uid: botbuilder.O365ConnectorCardInputBase + name: O365ConnectorCardInputBase + items: [] + - uid: botbuilder.O365ConnectorCardInputBaseType + name: O365ConnectorCardInputBaseType + items: [] + - uid: botbuilder.O365ConnectorCardInputType + name: O365ConnectorCardInputType + items: [] + - uid: botbuilder.O365ConnectorCardMultichoiceInput + name: O365ConnectorCardMultichoiceInput + items: [] + - uid: botbuilder.O365ConnectorCardMultichoiceInputChoice + name: O365ConnectorCardMultichoiceInputChoice + items: [] + - uid: botbuilder.O365ConnectorCardOpenUri + name: O365ConnectorCardOpenUri + items: [] + - uid: botbuilder.O365ConnectorCardOpenUriTarget + name: O365ConnectorCardOpenUriTarget + items: [] + - uid: botbuilder.O365ConnectorCardSection + name: O365ConnectorCardSection + items: [] + - uid: botbuilder.O365ConnectorCardTextInput + name: O365ConnectorCardTextInput + items: [] + - uid: botbuilder.O365ConnectorCardViewAction + name: O365ConnectorCardViewAction + items: [] + - uid: botbuilder.OAuthCard + name: OAuthCard + items: [] + - uid: botbuilder.OnBehalfOf + name: OnBehalfOf + items: [] + - uid: botbuilder.OnCardSelectionAction + name: OnCardSelectionAction + items: [] + - uid: botbuilder.Os + name: Os + items: [] + - uid: botbuilder.PagedMembersResult + name: PagedMembersResult + items: [] + - uid: botbuilder.PagedResult + name: PagedResult + items: [] + - uid: botbuilder.PaymentAddress + name: PaymentAddress + items: [] + - uid: botbuilder.PaymentCurrencyAmount + name: PaymentCurrencyAmount + items: [] + - uid: botbuilder.PaymentDetails + name: PaymentDetails + items: [] + - uid: botbuilder.PaymentDetailsModifier + name: PaymentDetailsModifier + items: [] + - uid: botbuilder.PaymentItem + name: PaymentItem + items: [] + - uid: botbuilder.PaymentMethodData + name: PaymentMethodData + items: [] + - uid: botbuilder.PaymentOptions + name: PaymentOptions + items: [] + - uid: botbuilder.PaymentRequest + name: PaymentRequest + items: [] + - uid: botbuilder.PaymentRequestComplete + name: PaymentRequestComplete + items: [] + - uid: botbuilder.PaymentRequestCompleteResult + name: PaymentRequestCompleteResult + items: [] + - uid: botbuilder.PaymentRequestUpdate + name: PaymentRequestUpdate + items: [] + - uid: botbuilder.PaymentRequestUpdateResult + name: PaymentRequestUpdateResult + items: [] + - uid: botbuilder.PaymentResponse + name: PaymentResponse + items: [] + - uid: botbuilder.PaymentShippingOption + name: PaymentShippingOption + items: [] + - uid: botbuilder.Place + name: Place + items: [] + - uid: botbuilder.PopupWindowPosition + name: PopupWindowPosition + items: [] + - uid: botbuilder.PrivateConversationState + name: PrivateConversationState + items: [] + - uid: botbuilder.PropertyManager + name: PropertyManager + items: [] + - uid: botbuilder.PropertyPaneCheckboxProperties + name: PropertyPaneCheckboxProperties + items: [] + - uid: botbuilder.PropertyPaneChoiceGroupIconProperties + name: PropertyPaneChoiceGroupIconProperties + items: [] + - uid: botbuilder.PropertyPaneChoiceGroupImageSize + name: PropertyPaneChoiceGroupImageSize + items: [] + - uid: botbuilder.PropertyPaneChoiceGroupOption + name: PropertyPaneChoiceGroupOption + items: [] + - uid: botbuilder.PropertyPaneChoiceGroupProperties + name: PropertyPaneChoiceGroupProperties + items: [] + - uid: botbuilder.PropertyPaneDropDownOption + name: PropertyPaneDropDownOption + items: [] + - uid: botbuilder.PropertyPaneDropDownProperties + name: PropertyPaneDropDownProperties + items: [] + - uid: botbuilder.PropertyPaneFieldProperties + name: PropertyPaneFieldProperties + items: [] + - uid: botbuilder.PropertyPaneGroup + name: PropertyPaneGroup + items: [] + - uid: botbuilder.PropertyPaneGroupField + name: PropertyPaneGroupField + items: [] + - uid: botbuilder.PropertyPaneGroupOrConditionalGroup + name: PropertyPaneGroupOrConditionalGroup + items: [] + - uid: botbuilder.PropertyPaneLabelProperties + name: PropertyPaneLabelProperties + items: [] + - uid: botbuilder.PropertyPaneLinkPopupWindowProperties + name: PropertyPaneLinkPopupWindowProperties + items: [] + - uid: botbuilder.PropertyPaneLinkProperties + name: PropertyPaneLinkProperties + items: [] + - uid: botbuilder.PropertyPanePage + name: PropertyPanePage + items: [] + - uid: botbuilder.PropertyPanePageHeader + name: PropertyPanePageHeader + items: [] + - uid: botbuilder.PropertyPaneSliderProperties + name: PropertyPaneSliderProperties + items: [] + - uid: botbuilder.PropertyPaneTextFieldProperties + name: PropertyPaneTextFieldProperties + items: [] + - uid: botbuilder.PropertyPaneToggleProperties + name: PropertyPaneToggleProperties + items: [] + - uid: botbuilder.QueueStorage + name: QueueStorage + items: [] + - uid: botbuilder.QuickViewCardAction + name: QuickViewCardAction + items: [] + - uid: botbuilder.QuickViewData + name: QuickViewData + items: [] + - uid: botbuilder.QuickViewHandleActionResponse + name: QuickViewHandleActionResponse + items: [] + - uid: botbuilder.QuickViewParameters + name: QuickViewParameters + items: [] + - uid: botbuilder.QuickViewResponse + name: QuickViewResponse + items: [] + - uid: botbuilder.ReactionType + name: ReactionType + items: [] + - uid: botbuilder.ReceiptCard + name: ReceiptCard + items: [] + - uid: botbuilder.ReceiptItem + name: ReceiptItem + items: [] + - uid: botbuilder.RecognizerResult + name: RecognizerResult + items: [] + - uid: botbuilder.RegisterClassMiddleware + name: RegisterClassMiddleware + items: [] + - uid: botbuilder.Request + name: Request + items: [] + - uid: botbuilder.ResourceResponse + name: ResourceResponse + items: [] + - uid: botbuilder.Response + name: Response + items: [] + - uid: botbuilder.RoleTypes + name: RoleTypes + items: [] + - uid: botbuilder.RouteHandler + name: RouteHandler + items: [] + - uid: botbuilder.SearchCardViewParameters + name: SearchCardViewParameters + items: [] + - uid: botbuilder.SearchInvokeOptions + name: SearchInvokeOptions + items: [] + - uid: botbuilder.SearchInvokeResponse + name: SearchInvokeResponse + items: [] + - uid: botbuilder.SearchInvokeValue + name: SearchInvokeValue + items: [] + - uid: botbuilder.SelectMediaActionParameters + name: SelectMediaActionParameters + items: [] + - uid: botbuilder.SelectMediaCardAction + name: SelectMediaCardAction + items: [] + - uid: botbuilder.SemanticAction + name: SemanticAction + items: [] + - uid: botbuilder.SemanticActionStateTypes + name: SemanticActionStateTypes + items: [] + - uid: botbuilder.SendActivitiesHandler + name: SendActivitiesHandler + items: [] + - uid: botbuilder.SetPropertyPaneConfigurationResponse + name: SetPropertyPaneConfigurationResponse + items: [] + - uid: botbuilder.SetSpeakMiddleware + name: SetSpeakMiddleware + items: [] + - uid: botbuilder.Severity + name: Severity + items: [] + - uid: botbuilder.SharePointActivityHandler + name: SharePointActivityHandler + items: [] + - uid: botbuilder.ShowLocationActionParameters + name: ShowLocationActionParameters + items: [] + - uid: botbuilder.ShowLocationCardAction + name: ShowLocationCardAction + items: [] + - uid: botbuilder.ShowTypingMiddleware + name: ShowTypingMiddleware + items: [] + - uid: botbuilder.SigninCard + name: SigninCard + items: [] + - uid: botbuilder.SignInCardViewParameters + name: SignInCardViewParameters + items: [] + - uid: botbuilder.SigninStateVerificationQuery + name: SigninStateVerificationQuery + items: [] + - uid: botbuilder.SignInUrlResponse + name: SignInUrlResponse + items: [] + - uid: botbuilder.SkillConversationIdFactory + name: SkillConversationIdFactory + items: [] + - uid: botbuilder.SkillConversationIdFactoryBase + name: SkillConversationIdFactoryBase + items: [] + - uid: botbuilder.SkillConversationIdFactoryOptions + name: SkillConversationIdFactoryOptions + items: [] + - uid: botbuilder.SkillConversationReference + name: SkillConversationReference + items: [] + - uid: botbuilder.SkillHandler + name: SkillHandler + items: [] + - uid: botbuilder.SkillHttpClient + name: SkillHttpClient + items: [] + - uid: botbuilder.SkypeMentionNormalizeMiddleware + name: SkypeMentionNormalizeMiddleware + items: [] + - uid: botbuilder.SpeechConstants + name: SpeechConstants + items: [] + - uid: botbuilder.StatePropertyAccessor + name: StatePropertyAccessor + items: [] + - uid: botbuilder.StatusCodeError + name: StatusCodeError + items: [] + - uid: botbuilder.StatusCodes + name: StatusCodes + items: [] + - uid: botbuilder.Storage + name: Storage + items: [] + - uid: botbuilder.StorageKeyFactory + name: StorageKeyFactory + items: [] + - uid: botbuilder.StoreItem + name: StoreItem + items: [] + - uid: botbuilder.StoreItems + name: StoreItems + items: [] + - uid: botbuilder.StreamingHttpClient + name: StreamingHttpClient + items: [] + - uid: botbuilder.StringUtils + name: StringUtils + items: [] + - uid: botbuilder.Style + name: Style + items: [] + - uid: botbuilder.SubmitCardAction + name: SubmitCardAction + items: [] + - uid: botbuilder.SubmitCardParameters + name: SubmitCardParameters + items: [] + - uid: botbuilder.SuggestedActions + name: SuggestedActions + items: [] + - uid: botbuilder.TabContext + name: TabContext + items: [] + - uid: botbuilder.TabEntityContext + name: TabEntityContext + items: [] + - uid: botbuilder.TabRequest + name: TabRequest + items: [] + - uid: botbuilder.TabResponse + name: TabResponse + items: [] + - uid: botbuilder.TabResponseCard + name: TabResponseCard + items: [] + - uid: botbuilder.TabResponseCards + name: TabResponseCards + items: [] + - uid: botbuilder.TabResponsePayload + name: TabResponsePayload + items: [] + - uid: botbuilder.TabSubmit + name: TabSubmit + items: [] + - uid: botbuilder.TabSubmitData + name: TabSubmitData + items: [] + - uid: botbuilder.TabSuggestedActions + name: TabSuggestedActions + items: [] + - uid: botbuilder.TargetedMeetingNotification + name: TargetedMeetingNotification + items: [] + - uid: botbuilder.TargetedMeetingNotificationValue + name: TargetedMeetingNotificationValue + items: [] + - uid: botbuilder.TaskModuleCardResponse + name: TaskModuleCardResponse + items: [] + - uid: botbuilder.TaskModuleContinueResponse + name: TaskModuleContinueResponse + items: [] + - uid: botbuilder.TaskModuleMessageResponse + name: TaskModuleMessageResponse + items: [] + - uid: botbuilder.TaskModuleRequest + name: TaskModuleRequest + items: [] + - uid: botbuilder.TaskModuleRequestContext + name: TaskModuleRequestContext + items: [] + - uid: botbuilder.TaskModuleResponse + name: TaskModuleResponse + items: [] + - uid: botbuilder.TaskModuleResponseBase + name: TaskModuleResponseBase + items: [] + - uid: botbuilder.TaskModuleTaskInfo + name: TaskModuleTaskInfo + items: [] + - uid: botbuilder.TeamDetails + name: TeamDetails + items: [] + - uid: botbuilder.TeamInfo + name: TeamInfo + items: [] + - uid: botbuilder.TeamsActivityHandler + name: TeamsActivityHandler + items: [] + - uid: botbuilder.TeamsAttachment + name: TeamsAttachment + items: [] + - uid: botbuilder.TeamsChannelAccount + name: TeamsChannelAccount + items: [] + - uid: botbuilder.TeamsChannelData + name: TeamsChannelData + items: [] + - uid: botbuilder.TeamsChannelDataSettings + name: TeamsChannelDataSettings + items: [] + - uid: botbuilder.TeamsInfo + name: TeamsInfo + items: [] + - uid: botbuilder.TeamsMeetingInfo + name: TeamsMeetingInfo + items: [] + - uid: botbuilder.TeamsMeetingMember + name: TeamsMeetingMember + items: [] + - uid: botbuilder.TeamsMeetingParticipant + name: TeamsMeetingParticipant + items: [] + - uid: botbuilder.TeamsMember + name: TeamsMember + items: [] + - uid: botbuilder.TeamsPagedMembersResult + name: TeamsPagedMembersResult + items: [] + - uid: botbuilder.TeamsSSOTokenExchangeMiddleware + name: TeamsSSOTokenExchangeMiddleware + items: [] + - uid: botbuilder.TelemetryDependency + name: TelemetryDependency + items: [] + - uid: botbuilder.TelemetryEvent + name: TelemetryEvent + items: [] + - uid: botbuilder.TelemetryException + name: TelemetryException + items: [] + - uid: botbuilder.TelemetryLoggerMiddleware + name: TelemetryLoggerMiddleware + items: [] + - uid: botbuilder.TelemetryPageView + name: TelemetryPageView + items: [] + - uid: botbuilder.TelemetryTrace + name: TelemetryTrace + items: [] + - uid: botbuilder.TenantInfo + name: TenantInfo + items: [] + - uid: botbuilder.TestActivityInspector + name: TestActivityInspector + items: [] + - uid: botbuilder.TestAdapter + name: TestAdapter + items: [] + - uid: botbuilder.TestFlow + name: TestFlow + items: [] + - uid: botbuilder.TextCardViewParameters + name: TextCardViewParameters + items: [] + - uid: botbuilder.TextFormatTypes + name: TextFormatTypes + items: [] + - uid: botbuilder.TextHighlight + name: TextHighlight + items: [] + - uid: botbuilder.TextInputCardViewParameters + name: TextInputCardViewParameters + items: [] + - uid: botbuilder.Thing + name: Thing + items: [] + - uid: botbuilder.ThumbnailCard + name: ThumbnailCard + items: [] + - uid: botbuilder.ThumbnailUrl + name: ThumbnailUrl + items: [] + - uid: botbuilder.TokenExchangeInvokeRequest + name: TokenExchangeInvokeRequest + items: [] + - uid: botbuilder.TokenExchangeInvokeResponse + name: TokenExchangeInvokeResponse + items: [] + - uid: botbuilder.TokenExchangeRequest + name: TokenExchangeRequest + items: [] + - uid: botbuilder.TokenExchangeResource + name: TokenExchangeResource + items: [] + - uid: botbuilder.TokenExchangeState + name: TokenExchangeState + items: [] + - uid: botbuilder.TokenPollingSettings + name: TokenPollingSettings + items: [] + - uid: botbuilder.TokenPostResource + name: TokenPostResource + items: [] + - uid: botbuilder.TokenRequest + name: TokenRequest + items: [] + - uid: botbuilder.TokenResolver + name: TokenResolver + items: [] + - uid: botbuilder.TokenResponse + name: TokenResponse + items: [] + - uid: botbuilder.TokenStatus + name: TokenStatus + items: [] + - uid: botbuilder.Transcript + name: Transcript + items: [] + - uid: botbuilder.TranscriptInfo + name: TranscriptInfo + items: [] + - uid: botbuilder.TranscriptLogger + name: TranscriptLogger + items: [] + - uid: botbuilder.TranscriptLoggerMiddleware + name: TranscriptLoggerMiddleware + items: [] + - uid: botbuilder.TranscriptStore + name: TranscriptStore + items: [] + - uid: botbuilder.TurnContext + name: TurnContext + items: [] + - uid: botbuilder.TurnContextStateCollection + name: TurnContextStateCollection + items: [] + - uid: botbuilder.Type + name: Type + items: [] + - uid: botbuilder.Type1 + name: Type1 + items: [] + - uid: botbuilder.Type2 + name: Type2 + items: [] + - uid: botbuilder.Type3 + name: Type3 + items: [] + - uid: botbuilder.UpdateActivityHandler + name: UpdateActivityHandler + items: [] + - uid: botbuilder.UserIdentityType + name: UserIdentityType + items: [] + - uid: botbuilder.UserMeetingDetails + name: UserMeetingDetails + items: [] + - uid: botbuilder.UserState + name: UserState + items: [] + - uid: botbuilder.VideoCard + name: VideoCard + items: [] + - uid: botbuilder.ViewResponseType + name: ViewResponseType + items: [] + - uid: botbuilder.WebRequest + name: WebRequest + items: [] + - uid: botbuilder.WebResponse + name: WebResponse + items: [] + - uid: botbuilder.WebServer + name: WebServer + items: [] +- name: botbuilder-ai + items: + - name: Overview + uid: botbuilder-ai + - uid: botbuilder-ai.ActiveLearningUtils + name: ActiveLearningUtils + items: [] + - uid: botbuilder-ai.Anchor + name: Anchor + items: [] + - uid: botbuilder-ai.AnswerSpanResponse + name: AnswerSpanResponse + items: [] + - uid: botbuilder-ai.CustomQuestionAnswering + name: CustomQuestionAnswering + items: [] + - uid: botbuilder-ai.DateTimeSpec + name: DateTimeSpec + items: [] + - uid: botbuilder-ai.DynamicList + name: DynamicList + items: [] + - uid: botbuilder-ai.ExternalEntity + name: ExternalEntity + items: [] + - uid: botbuilder-ai.FeedbackRecord + name: FeedbackRecord + items: [] + - uid: botbuilder-ai.FeedbackRecords + name: FeedbackRecords + items: [] + - uid: botbuilder-ai.Filters + name: Filters + items: [] + - uid: botbuilder-ai.GeographyV2 + name: GeographyV2 + items: [] + - uid: botbuilder-ai.GeographyV2Type + name: GeographyV2Type + items: [] + - uid: botbuilder-ai.InstanceData + name: InstanceData + items: [] + - uid: botbuilder-ai.IntentData + name: IntentData + items: [] + - uid: botbuilder-ai.JoinOperator + name: JoinOperator + items: [] + - uid: botbuilder-ai.KnowledgeBaseAnswer + name: KnowledgeBaseAnswer + items: [] + - uid: botbuilder-ai.KnowledgeBaseAnswers + name: KnowledgeBaseAnswers + items: [] + - uid: botbuilder-ai.KnowledgeBaseAnswerSpan + name: KnowledgeBaseAnswerSpan + items: [] + - uid: botbuilder-ai.ListElement + name: ListElement + items: [] + - uid: botbuilder-ai.LuisAdaptiveRecognizer + name: LuisAdaptiveRecognizer + items: [] + - uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration + name: LuisAdaptiveRecognizerConfiguration + items: [] + - uid: botbuilder-ai.LuisApplication + name: LuisApplication + items: [] + - uid: botbuilder-ai.LuisBotComponent + name: LuisBotComponent + items: [] + - uid: botbuilder-ai.LuisComponentRegistration + name: LuisComponentRegistration + items: [] + - uid: botbuilder-ai.LuisPredictionOptions + name: LuisPredictionOptions + items: [] + - uid: botbuilder-ai.LuisRecognizer + name: LuisRecognizer + items: [] + - uid: botbuilder-ai.LuisRecognizerOptions + name: LuisRecognizerOptions + items: [] + - uid: botbuilder-ai.LuisRecognizerOptionsV2 + name: LuisRecognizerOptionsV2 + items: [] + - uid: botbuilder-ai.LuisRecognizerOptionsV3 + name: LuisRecognizerOptionsV3 + items: [] + - uid: botbuilder-ai.LuisRecognizerTelemetryClient + name: LuisRecognizerTelemetryClient + items: [] + - uid: botbuilder-ai.LuisTelemetryConstants + name: LuisTelemetryConstants + items: [] + - uid: botbuilder-ai.MetadataFilter + name: MetadataFilter + items: [] + - uid: botbuilder-ai.NumberWithUnits + name: NumberWithUnits + items: [] + - uid: botbuilder-ai.OrdinalV2 + name: OrdinalV2 + items: [] + - uid: botbuilder-ai.QnACardBuilder + name: QnACardBuilder + items: [] + - uid: botbuilder-ai.QnAMaker + name: QnAMaker + items: [] + - uid: botbuilder-ai.QnAMakerBotComponent + name: QnAMakerBotComponent + items: [] + - uid: botbuilder-ai.QnAMakerClient + name: QnAMakerClient + items: [] + - uid: botbuilder-ai.QnAMakerComponentRegistration + name: QnAMakerComponentRegistration + items: [] + - uid: botbuilder-ai.QnAMakerDialog + name: QnAMakerDialog + items: [] + - uid: botbuilder-ai.QnAMakerDialogOptions + name: QnAMakerDialogOptions + items: [] + - uid: botbuilder-ai.QnAMakerDialogResponseOptions + name: QnAMakerDialogResponseOptions + items: [] + - uid: botbuilder-ai.QnAMakerEndpoint + name: QnAMakerEndpoint + items: [] + - uid: botbuilder-ai.QnAMakerMetadata + name: QnAMakerMetadata + items: [] + - uid: botbuilder-ai.QnAMakerOptions + name: QnAMakerOptions + items: [] + - uid: botbuilder-ai.QnAMakerPrompt + name: QnAMakerPrompt + items: [] + - uid: botbuilder-ai.QnAMakerRecognizer + name: QnAMakerRecognizer + items: [] + - uid: botbuilder-ai.QnAMakerRecognizerConfiguration + name: QnAMakerRecognizerConfiguration + items: [] + - uid: botbuilder-ai.QnAMakerResult + name: QnAMakerResult + items: [] + - uid: botbuilder-ai.QnAMakerResults + name: QnAMakerResults + items: [] + - uid: botbuilder-ai.QnAMakerTelemetryClient + name: QnAMakerTelemetryClient + items: [] + - uid: botbuilder-ai.QnAMakerTraceInfo + name: QnAMakerTraceInfo + items: [] + - uid: botbuilder-ai.QnARequestContext + name: QnARequestContext + items: [] + - uid: botbuilder-ai.QnAResponseContext + name: QnAResponseContext + items: [] + - uid: botbuilder-ai.QnASuggestionsActivityFactory + name: QnASuggestionsActivityFactory + items: [] + - uid: botbuilder-ai.RankerTypes + name: RankerTypes + items: [] + - uid: botbuilder-ai.ServiceType + name: ServiceType + items: [] +- name: botbuilder-ai-orchestrator + items: + - name: Overview + uid: botbuilder-ai-orchestrator + - uid: botbuilder-ai-orchestrator.LabelType + name: LabelType + items: [] + - uid: botbuilder-ai-orchestrator.OrchestratorBotComponent + name: OrchestratorBotComponent + items: [] + - uid: botbuilder-ai-orchestrator.OrchestratorRecognizer + name: OrchestratorRecognizer + items: [] +- name: botbuilder-applicationinsights + items: + - name: Overview + uid: botbuilder-applicationinsights + - uid: botbuilder-applicationinsights.ApplicationInsightsTelemetryClient + name: ApplicationInsightsTelemetryClient + items: [] + - uid: botbuilder-applicationinsights.TelemetryInitializerMiddleware + name: TelemetryInitializerMiddleware + items: [] +- name: botbuilder-azure + items: + - name: Overview + uid: botbuilder-azure + - uid: botbuilder-azure.AzureBlobTranscriptStore + name: AzureBlobTranscriptStore + items: [] + - uid: botbuilder-azure.BlobStorage + name: BlobStorage + items: [] + - uid: botbuilder-azure.BlobStorageSettings + name: BlobStorageSettings + items: [] + - uid: botbuilder-azure.CosmosDbKeyEscape + name: CosmosDbKeyEscape + items: [] + - uid: botbuilder-azure.CosmosDbPartitionedStorage + name: CosmosDbPartitionedStorage + items: [] + - uid: botbuilder-azure.CosmosDbPartitionedStorageOptions + name: CosmosDbPartitionedStorageOptions + items: [] + - uid: botbuilder-azure.Host + name: Host + items: [] +- name: botbuilder-azure-blobs + items: + - name: Overview + uid: botbuilder-azure-blobs + - uid: botbuilder-azure-blobs.BlobsStorage + name: BlobsStorage + items: [] + - uid: botbuilder-azure-blobs.BlobsStorageOptions + name: BlobsStorageOptions + items: [] + - uid: botbuilder-azure-blobs.BlobsTranscriptStore + name: BlobsTranscriptStore + items: [] + - uid: botbuilder-azure-blobs.BlobsTranscriptStoreOptions + name: BlobsTranscriptStoreOptions + items: [] +- name: botbuilder-azure-queues + items: + - name: Overview + uid: botbuilder-azure-queues + - uid: botbuilder-azure-queues.AzureQueueStorage + name: AzureQueueStorage + items: [] +- name: botbuilder-core + items: + - name: Overview + uid: botbuilder-core + - uid: botbuilder-core.AceCardSize + name: AceCardSize + items: [] + - uid: botbuilder-core.AceData + name: AceData + items: [] + - uid: botbuilder-core.AceRequest + name: AceRequest + items: [] + - uid: botbuilder-core.Action + name: Action + items: [] + - uid: botbuilder-core.ActionTypes + name: ActionTypes + items: [] + - uid: botbuilder-core.Activity + name: Activity + items: [] + - uid: botbuilder-core.ActivityEventNames + name: ActivityEventNames + items: [] + - uid: botbuilder-core.ActivityEx + name: ActivityEx + items: [] + - uid: botbuilder-core.ActivityFactory + name: ActivityFactory + items: [] + - uid: botbuilder-core.ActivityHandler + name: ActivityHandler + items: [] + - uid: botbuilder-core.ActivityHandlerBase + name: ActivityHandlerBase + items: [] + - uid: botbuilder-core.ActivityImageType + name: ActivityImageType + items: [] + - uid: botbuilder-core.ActivityImportance + name: ActivityImportance + items: [] + - uid: botbuilder-core.ActivityTimestamps + name: ActivityTimestamps + items: [] + - uid: botbuilder-core.ActivityTypes + name: ActivityTypes + items: [] + - uid: botbuilder-core.AdaptiveCardAuthentication + name: AdaptiveCardAuthentication + items: [] + - uid: botbuilder-core.AdaptiveCardInvokeAction + name: AdaptiveCardInvokeAction + items: [] + - uid: botbuilder-core.AdaptiveCardInvokeResponse + name: AdaptiveCardInvokeResponse + items: [] + - uid: botbuilder-core.AdaptiveCardInvokeValue + name: AdaptiveCardInvokeValue + items: [] + - uid: botbuilder-core.AnimationCard + name: AnimationCard + items: [] + - uid: botbuilder-core.AppBasedLinkQuery + name: AppBasedLinkQuery + items: [] + - uid: botbuilder-core.ApplicationIdentityType + name: ApplicationIdentityType + items: [] + - uid: botbuilder-core.Attachment + name: Attachment + items: [] + - uid: botbuilder-core.AttachmentData + name: AttachmentData + items: [] + - uid: botbuilder-core.AttachmentInfo + name: AttachmentInfo + items: [] + - uid: botbuilder-core.AttachmentLayout + name: AttachmentLayout + items: [] + - uid: botbuilder-core.AttachmentLayoutTypes + name: AttachmentLayoutTypes + items: [] + - uid: botbuilder-core.AttachmentView + name: AttachmentView + items: [] + - uid: botbuilder-core.AudioCard + name: AudioCard + items: [] + - uid: botbuilder-core.AutoSaveStateMiddleware + name: AutoSaveStateMiddleware + items: [] + - uid: botbuilder-core.BaseCardComponent + name: BaseCardComponent + items: [] + - uid: botbuilder-core.BaseCardViewParameters + name: BaseCardViewParameters + items: [] + - uid: botbuilder-core.BaseHandleActionResponse + name: BaseHandleActionResponse + items: [] + - uid: botbuilder-core.BasicCard + name: BasicCard + items: [] + - uid: botbuilder-core.BatchFailedEntriesResponse + name: BatchFailedEntriesResponse + items: [] + - uid: botbuilder-core.BatchFailedEntry + name: BatchFailedEntry + items: [] + - uid: botbuilder-core.BatchOperationRequest + name: BatchOperationRequest + items: [] + - uid: botbuilder-core.BatchOperationResponse + name: BatchOperationResponse + items: [] + - uid: botbuilder-core.BatchOperationStateResponse + name: BatchOperationStateResponse + items: [] + - uid: botbuilder-core.BotAdapter + name: BotAdapter + items: [] + - uid: botbuilder-core.BotComponent + name: BotComponent + items: [] + - uid: botbuilder-core.BotConfigAuth + name: BotConfigAuth + items: [] + - uid: botbuilder-core.BotConfigAuthType + name: BotConfigAuthType + items: [] + - uid: botbuilder-core.BotFrameworkClient + name: BotFrameworkClient + items: [] + - uid: botbuilder-core.BotFrameworkSkill + name: BotFrameworkSkill + items: [] + - uid: botbuilder-core.BotHandler + name: BotHandler + items: [] + - uid: botbuilder-core.BotMessagePreviewActionType + name: BotMessagePreviewActionType + items: [] + - uid: botbuilder-core.BotMessagePreviewType + name: BotMessagePreviewType + items: [] + - uid: botbuilder-core.BotPageViewTelemetryClient + name: BotPageViewTelemetryClient + items: [] + - uid: botbuilder-core.BotState + name: BotState + items: [] + - uid: botbuilder-core.BotStatePropertyAccessor + name: BotStatePropertyAccessor + items: [] + - uid: botbuilder-core.BotStateSet + name: BotStateSet + items: [] + - uid: botbuilder-core.BotTelemetryClient + name: BotTelemetryClient + items: [] + - uid: botbuilder-core.BrowserLocalStorage + name: BrowserLocalStorage + items: [] + - uid: botbuilder-core.BrowserSessionStorage + name: BrowserSessionStorage + items: [] + - uid: botbuilder-core.CachedBotState + name: CachedBotState + items: [] + - uid: botbuilder-core.CacheInfo + name: CacheInfo + items: [] + - uid: botbuilder-core.CallerIdConstants + name: CallerIdConstants + items: [] + - uid: botbuilder-core.CardAction + name: CardAction + items: [] + - uid: botbuilder-core.CardBarComponent + name: CardBarComponent + items: [] + - uid: botbuilder-core.CardButtonBase + name: CardButtonBase + items: [] + - uid: botbuilder-core.CardButtonComponent + name: CardButtonComponent + items: [] + - uid: botbuilder-core.CardComponentName + name: CardComponentName + items: [] + - uid: botbuilder-core.CardFactory + name: CardFactory + items: [] + - uid: botbuilder-core.CardImage + name: CardImage + items: [] + - uid: botbuilder-core.CardSearchBoxComponent + name: CardSearchBoxComponent + items: [] + - uid: botbuilder-core.CardSearchFooterComponent + name: CardSearchFooterComponent + items: [] + - uid: botbuilder-core.CardTextComponent + name: CardTextComponent + items: [] + - uid: botbuilder-core.CardTextInputComponent + name: CardTextInputComponent + items: [] + - uid: botbuilder-core.CardViewActionsFooterParameters + name: CardViewActionsFooterParameters + items: [] + - uid: botbuilder-core.CardViewFooterParameters + name: CardViewFooterParameters + items: [] + - uid: botbuilder-core.CardViewHandleActionResponse + name: CardViewHandleActionResponse + items: [] + - uid: botbuilder-core.CardViewParameters + name: CardViewParameters + items: [] + - uid: botbuilder-core.CardViewResponse + name: CardViewResponse + items: [] + - uid: botbuilder-core.ChannelAccount + name: ChannelAccount + items: [] + - uid: botbuilder-core.ChannelInfo + name: ChannelInfo + items: [] + - uid: botbuilder-core.Channels + name: Channels + items: [] + - uid: botbuilder-core.CloudAdapterBase + name: CloudAdapterBase + items: [] + - uid: botbuilder-core.CommandContext + name: CommandContext + items: [] + - uid: botbuilder-core.CommandResultValue + name: CommandResultValue + items: [] + - uid: botbuilder-core.CommandValue + name: CommandValue + items: [] + - uid: botbuilder-core.ComponentRegistration + name: ComponentRegistration + items: [] + - uid: botbuilder-core.ConfigResponse + name: ConfigResponse + items: [] + - uid: botbuilder-core.ConfigResponseConfig + name: ConfigResponseConfig + items: [] + - uid: botbuilder-core.ConfigurationBotFrameworkAuthentication + name: ConfigurationBotFrameworkAuthentication + items: [] + - uid: botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions + name: ConfigurationBotFrameworkAuthenticationOptions + items: [] + - uid: botbuilder-core.ConfigurationServiceClientCredentialFactory + name: ConfigurationServiceClientCredentialFactory items: [] -- name: botbuilder-ai - items: - - name: Overview - uid: botbuilder-ai - - uid: botbuilder-ai.ActiveLearningUtils - name: ActiveLearningUtils + - uid: botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions + name: ConfigurationServiceClientCredentialFactoryOptions items: [] - - uid: botbuilder-ai.Anchor - name: Anchor + - uid: botbuilder-core.ConfirmationDialog + name: ConfirmationDialog items: [] - - uid: botbuilder-ai.AnswerSpanResponse - name: AnswerSpanResponse + - uid: botbuilder-core.ConsoleTranscriptLogger + name: ConsoleTranscriptLogger items: [] - - uid: botbuilder-ai.BindToActivity - name: BindToActivity + - uid: botbuilder-core.ContactRelationUpdateActionTypes + name: ContactRelationUpdateActionTypes items: [] - - uid: botbuilder-ai.CustomQuestionAnswering - name: CustomQuestionAnswering + - uid: botbuilder-core.ContentType + name: ContentType items: [] - - uid: botbuilder-ai.DateTimeSpec - name: DateTimeSpec + - uid: botbuilder-core.ConversationAccount + name: ConversationAccount items: [] - - uid: botbuilder-ai.DynamicList - name: DynamicList + - uid: botbuilder-core.ConversationIdentityType + name: ConversationIdentityType items: [] - - uid: botbuilder-ai.DynamicList - name: DynamicList + - uid: botbuilder-core.ConversationList + name: ConversationList items: [] - - uid: botbuilder-ai.ExternalEntity - name: ExternalEntity + - uid: botbuilder-core.ConversationMembers + name: ConversationMembers items: [] - - uid: botbuilder-ai.FeedbackRecord - name: FeedbackRecord + - uid: botbuilder-core.ConversationParameters + name: ConversationParameters items: [] - - uid: botbuilder-ai.FeedbackRecords - name: FeedbackRecords + - uid: botbuilder-core.ConversationReference + name: ConversationReference items: [] - - uid: botbuilder-ai.Filters - name: Filters + - uid: botbuilder-core.ConversationResourceResponse + name: ConversationResourceResponse items: [] - - uid: botbuilder-ai.GenerateAnswerUtils - name: GenerateAnswerUtils + - uid: botbuilder-core.ConversationsResult + name: ConversationsResult items: [] - - uid: botbuilder-ai.GeographyV2 - name: GeographyV2 + - uid: botbuilder-core.ConversationState + name: ConversationState items: [] - - uid: botbuilder-ai.GeographyV2Type - name: GeographyV2Type + - uid: botbuilder-core.CoreAppCredentials + name: CoreAppCredentials items: [] - - uid: botbuilder-ai.HttpRequestUtils - name: HttpRequestUtils + - uid: botbuilder-core.DeleteActivityHandler + name: DeleteActivityHandler items: [] - - uid: botbuilder-ai.InstanceData - name: InstanceData + - uid: botbuilder-core.DeliveryModes + name: DeliveryModes items: [] - - uid: botbuilder-ai.IntentData - name: IntentData + - uid: botbuilder-core.DropDownOptionType + name: DropDownOptionType items: [] - - uid: botbuilder-ai.JoinOperator - name: JoinOperator + - uid: botbuilder-core.EndOfConversationCodes + name: EndOfConversationCodes items: [] - - uid: botbuilder-ai.KnowledgeBaseAnswer - name: KnowledgeBaseAnswer + - uid: botbuilder-core.Entity + name: Entity items: [] - - uid: botbuilder-ai.KnowledgeBaseAnswers - name: KnowledgeBaseAnswers + - uid: botbuilder-core.ErrorModel + name: ErrorModel items: [] - - uid: botbuilder-ai.KnowledgeBaseAnswerSpan - name: KnowledgeBaseAnswerSpan + - uid: botbuilder-core.ErrorResponse + name: ErrorResponse items: [] - - uid: botbuilder-ai.LanguageServiceUtils - name: LanguageServiceUtils + - uid: botbuilder-core.ExecuteCardAction + name: ExecuteCardAction items: [] - - uid: botbuilder-ai.ListElement - name: ListElement + - uid: botbuilder-core.ExecuteCardParameters + name: ExecuteCardParameters items: [] - - uid: botbuilder-ai.LuisAdaptivePredictionOptions - name: LuisAdaptivePredictionOptions + - uid: botbuilder-core.ExpectedReplies + name: ExpectedReplies items: [] - - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConfiguration - name: LuisAdaptivePredictionOptionsConfiguration + - uid: botbuilder-core.ExtendedUserTokenProvider + name: ExtendedUserTokenProvider items: [] - - uid: botbuilder-ai.LuisAdaptivePredictionOptionsConverter - name: LuisAdaptivePredictionOptionsConverter + - uid: botbuilder-core.ExternalLinkActionParameters + name: ExternalLinkActionParameters items: [] - - uid: botbuilder-ai.LuisAdaptiveRecognizer - name: LuisAdaptiveRecognizer + - uid: botbuilder-core.ExternalLinkCardAction + name: ExternalLinkCardAction items: [] - - uid: botbuilder-ai.LuisAdaptiveRecognizerConfiguration - name: LuisAdaptiveRecognizerConfiguration + - uid: botbuilder-core.Fact + name: Fact items: [] - - uid: botbuilder-ai.LuisApplication - name: LuisApplication + - uid: botbuilder-core.FieldType + name: FieldType items: [] - - uid: botbuilder-ai.LuisBotComponent - name: LuisBotComponent + - uid: botbuilder-core.FileConsentCard + name: FileConsentCard items: [] - - uid: botbuilder-ai.LuisComponentRegistration - name: LuisComponentRegistration + - uid: botbuilder-core.FileConsentCardResponse + name: FileConsentCardResponse items: [] - - uid: botbuilder-ai.LuisPredictionOptions - name: LuisPredictionOptions + - uid: botbuilder-core.FileDownloadInfo + name: FileDownloadInfo items: [] - - uid: botbuilder-ai.LuisRecognizer - name: LuisRecognizer + - uid: botbuilder-core.FileDownloadInfoAttachment + name: FileDownloadInfoAttachment items: [] - - uid: botbuilder-ai.LuisRecognizerInternal - name: LuisRecognizerInternal + - uid: botbuilder-core.FileInfoCard + name: FileInfoCard items: [] - - uid: botbuilder-ai.LuisRecognizerOptions - name: LuisRecognizerOptions + - uid: botbuilder-core.FileUploadInfo + name: FileUploadInfo items: [] - - uid: botbuilder-ai.LuisRecognizerOptionsV2 - name: LuisRecognizerOptionsV2 + - uid: botbuilder-core.FocusParameters + name: FocusParameters items: [] - - uid: botbuilder-ai.LuisRecognizerOptionsV3 - name: LuisRecognizerOptionsV3 + - uid: botbuilder-core.GeoCoordinates + name: GeoCoordinates items: [] - - uid: botbuilder-ai.LuisRecognizerTelemetryClient - name: LuisRecognizerTelemetryClient + - uid: botbuilder-core.GetLocationActionParameters + name: GetLocationActionParameters items: [] - - uid: botbuilder-ai.LuisRecognizerV2 - name: LuisRecognizerV2 + - uid: botbuilder-core.GetLocationCardAction + name: GetLocationCardAction items: [] - - uid: botbuilder-ai.LuisRecognizerV3 - name: LuisRecognizerV3 + - uid: botbuilder-core.GetPropertyPaneConfigurationResponse + name: GetPropertyPaneConfigurationResponse items: [] - - uid: botbuilder-ai.LuisTelemetryConstants - name: LuisTelemetryConstants + - uid: botbuilder-core.HandleActionResponse + name: HandleActionResponse items: [] - - uid: botbuilder-ai.MetadataFilter - name: MetadataFilter + - uid: botbuilder-core.HeroCard + name: HeroCard items: [] - - uid: botbuilder-ai.NumberWithUnits - name: NumberWithUnits + - uid: botbuilder-core.IActivity + name: IActivity items: [] - - uid: botbuilder-ai.OrdinalV2 - name: OrdinalV2 + - uid: botbuilder-core.ICardSearchBoxButton + name: ICardSearchBoxButton items: [] - - uid: botbuilder-ai.QnACardBuilder - name: QnACardBuilder + - uid: botbuilder-core.ICardTextInputIconButton + name: ICardTextInputIconButton items: [] - - uid: botbuilder-ai.QnAMaker - name: QnAMaker + - uid: botbuilder-core.ICardTextInputTitleButton + name: ICardTextInputTitleButton items: [] - - uid: botbuilder-ai.QnAMakerBotComponent - name: QnAMakerBotComponent + - uid: botbuilder-core.ICommandActivity + name: ICommandActivity items: [] - - uid: botbuilder-ai.QnAMakerClient - name: QnAMakerClient + - uid: botbuilder-core.ICommandResultActivity + name: ICommandResultActivity items: [] - - uid: botbuilder-ai.QnAMakerClient - name: QnAMakerClient + - uid: botbuilder-core.IContactRelationUpdateActivity + name: IContactRelationUpdateActivity items: [] - - uid: botbuilder-ai.QnAMakerComponentRegistration - name: QnAMakerComponentRegistration + - uid: botbuilder-core.IConversationUpdateActivity + name: IConversationUpdateActivity + items: [] + - uid: botbuilder-core.IEndOfConversationActivity + name: IEndOfConversationActivity + items: [] + - uid: botbuilder-core.IEventActivity + name: IEventActivity + items: [] + - uid: botbuilder-core.IHandoffActivity + name: IHandoffActivity + items: [] + - uid: botbuilder-core.IInstallationUpdateActivity + name: IInstallationUpdateActivity + items: [] + - uid: botbuilder-core.IInvokeActivity + name: IInvokeActivity + items: [] + - uid: botbuilder-core.IMessageActivity + name: IMessageActivity + items: [] + - uid: botbuilder-core.IMessageDeleteActivity + name: IMessageDeleteActivity + items: [] + - uid: botbuilder-core.IMessageReactionActivity + name: IMessageReactionActivity + items: [] + - uid: botbuilder-core.IMessageUpdateActivity + name: IMessageUpdateActivity + items: [] + - uid: botbuilder-core.Importance + name: Importance + items: [] + - uid: botbuilder-core.InnerHttpError + name: InnerHttpError + items: [] + - uid: botbuilder-core.InputHints + name: InputHints + items: [] + - uid: botbuilder-core.InstallationUpdateActionTypes + name: InstallationUpdateActionTypes + items: [] + - uid: botbuilder-core.IntentScore + name: IntentScore + items: [] + - uid: botbuilder-core.InvokeException + name: InvokeException + items: [] + - uid: botbuilder-core.InvokeResponse + name: InvokeResponse + items: [] + - uid: botbuilder-core.IStatusCodeError + name: IStatusCodeError + items: [] + - uid: botbuilder-core.ISuggestionActivity + name: ISuggestionActivity + items: [] + - uid: botbuilder-core.ITraceActivity + name: ITraceActivity + items: [] + - uid: botbuilder-core.ITypingActivity + name: ITypingActivity + items: [] + - uid: botbuilder-core.IUserTokenProvider + name: IUserTokenProvider + items: [] + - uid: botbuilder-core.Location + name: Location + items: [] + - uid: botbuilder-core.MediaCard + name: MediaCard + items: [] + - uid: botbuilder-core.MediaEventValue + name: MediaEventValue + items: [] + - uid: botbuilder-core.MediaType + name: MediaType + items: [] + - uid: botbuilder-core.MediaUrl + name: MediaUrl + items: [] + - uid: botbuilder-core.Meeting + name: Meeting + items: [] + - uid: botbuilder-core.MeetingDetails + name: MeetingDetails + items: [] + - uid: botbuilder-core.MeetingEndEventDetails + name: MeetingEndEventDetails + items: [] + - uid: botbuilder-core.MeetingEventDetails + name: MeetingEventDetails + items: [] + - uid: botbuilder-core.MeetingInfo + name: MeetingInfo + items: [] + - uid: botbuilder-core.MeetingNotification + name: MeetingNotification + items: [] + - uid: botbuilder-core.MeetingNotificationBase + name: MeetingNotificationBase + items: [] + - uid: botbuilder-core.MeetingNotificationChannelData + name: MeetingNotificationChannelData + items: [] + - uid: botbuilder-core.MeetingNotificationRecipientFailureInfo + name: MeetingNotificationRecipientFailureInfo + items: [] + - uid: botbuilder-core.MeetingNotificationResponse + name: MeetingNotificationResponse + items: [] + - uid: botbuilder-core.MeetingParticipantsEventDetails + name: MeetingParticipantsEventDetails + items: [] + - uid: botbuilder-core.MeetingStageSurface + name: MeetingStageSurface + items: [] + - uid: botbuilder-core.MeetingStartEventDetails + name: MeetingStartEventDetails + items: [] + - uid: botbuilder-core.MeetingSurface + name: MeetingSurface + items: [] + - uid: botbuilder-core.MeetingTabIconSurface + name: MeetingTabIconSurface + items: [] + - uid: botbuilder-core.MemoryStorage + name: MemoryStorage + items: [] + - uid: botbuilder-core.MemoryTranscriptStore + name: MemoryTranscriptStore + items: [] + - uid: botbuilder-core.Mention + name: Mention + items: [] + - uid: botbuilder-core.MessageActionsPayload + name: MessageActionsPayload + items: [] + - uid: botbuilder-core.MessageActionsPayloadApp + name: MessageActionsPayloadApp + items: [] + - uid: botbuilder-core.MessageActionsPayloadAttachment + name: MessageActionsPayloadAttachment + items: [] + - uid: botbuilder-core.MessageActionsPayloadBody + name: MessageActionsPayloadBody + items: [] + - uid: botbuilder-core.MessageActionsPayloadConversation + name: MessageActionsPayloadConversation + items: [] + - uid: botbuilder-core.MessageActionsPayloadFrom + name: MessageActionsPayloadFrom + items: [] + - uid: botbuilder-core.MessageActionsPayloadMention + name: MessageActionsPayloadMention + items: [] + - uid: botbuilder-core.MessageActionsPayloadReaction + name: MessageActionsPayloadReaction + items: [] + - uid: botbuilder-core.MessageActionsPayloadUser + name: MessageActionsPayloadUser + items: [] + - uid: botbuilder-core.MessageFactory + name: MessageFactory + items: [] + - uid: botbuilder-core.MessageReaction + name: MessageReaction + items: [] + - uid: botbuilder-core.MessageReactionTypes + name: MessageReactionTypes + items: [] + - uid: botbuilder-core.MessageType + name: MessageType + items: [] + - uid: botbuilder-core.MessagingExtensionAction + name: MessagingExtensionAction + items: [] + - uid: botbuilder-core.MessagingExtensionActionResponse + name: MessagingExtensionActionResponse + items: [] + - uid: botbuilder-core.MessagingExtensionAttachment + name: MessagingExtensionAttachment + items: [] + - uid: botbuilder-core.MessagingExtensionParameter + name: MessagingExtensionParameter + items: [] + - uid: botbuilder-core.MessagingExtensionQuery + name: MessagingExtensionQuery + items: [] + - uid: botbuilder-core.MessagingExtensionQueryOptions + name: MessagingExtensionQueryOptions + items: [] + - uid: botbuilder-core.MessagingExtensionResponse + name: MessagingExtensionResponse + items: [] + - uid: botbuilder-core.MessagingExtensionResult + name: MessagingExtensionResult + items: [] + - uid: botbuilder-core.MessagingExtensionResultType + name: MessagingExtensionResultType items: [] - - uid: botbuilder-ai.QnAMakerDialog - name: QnAMakerDialog + - uid: botbuilder-core.MessagingExtensionSuggestedAction + name: MessagingExtensionSuggestedAction items: [] - - uid: botbuilder-ai.QnAMakerDialogConfiguration - name: QnAMakerDialogConfiguration + - uid: botbuilder-core.MicrosoftPayMethodData + name: MicrosoftPayMethodData items: [] - - uid: botbuilder-ai.QnAMakerDialogOptions - name: QnAMakerDialogOptions + - uid: botbuilder-core.Middleware + name: Middleware items: [] - - uid: botbuilder-ai.QnAMakerDialogResponseOptions - name: QnAMakerDialogResponseOptions + - uid: botbuilder-core.MiddlewareHandler + name: MiddlewareHandler items: [] - - uid: botbuilder-ai.QnAMakerEndpoint - name: QnAMakerEndpoint + - uid: botbuilder-core.MiddlewareSet + name: MiddlewareSet items: [] - - uid: botbuilder-ai.QnAMakerMetadata - name: QnAMakerMetadata + - uid: botbuilder-core.NoOpHandleActionResponse + name: NoOpHandleActionResponse items: [] - - uid: botbuilder-ai.QnAMakerOptions - name: QnAMakerOptions + - uid: botbuilder-core.NotificationInfo + name: NotificationInfo items: [] - - uid: botbuilder-ai.QnAMakerPrompt - name: QnAMakerPrompt + - uid: botbuilder-core.NullTelemetryClient + name: NullTelemetryClient items: [] - - uid: botbuilder-ai.QnAMakerRecognizer - name: QnAMakerRecognizer + - uid: botbuilder-core.O365ConnectorCard + name: O365ConnectorCard items: [] - - uid: botbuilder-ai.QnAMakerRecognizerConfiguration - name: QnAMakerRecognizerConfiguration + - uid: botbuilder-core.O365ConnectorCardActionBase + name: O365ConnectorCardActionBase items: [] - - uid: botbuilder-ai.QnAMakerResult - name: QnAMakerResult + - uid: botbuilder-core.O365ConnectorCardActionCard + name: O365ConnectorCardActionCard items: [] - - uid: botbuilder-ai.QnAMakerResults - name: QnAMakerResults + - uid: botbuilder-core.O365ConnectorCardActionQuery + name: O365ConnectorCardActionQuery items: [] - - uid: botbuilder-ai.QnAMakerTelemetryClient - name: QnAMakerTelemetryClient + - uid: botbuilder-core.O365ConnectorCardActionType + name: O365ConnectorCardActionType items: [] - - uid: botbuilder-ai.QnAMakerTelemetryClient - name: QnAMakerTelemetryClient + - uid: botbuilder-core.O365ConnectorCardDateInput + name: O365ConnectorCardDateInput items: [] - - uid: botbuilder-ai.QnAMakerTraceInfo - name: QnAMakerTraceInfo + - uid: botbuilder-core.O365ConnectorCardFact + name: O365ConnectorCardFact items: [] - - uid: botbuilder-ai.QnARequestContext - name: QnARequestContext + - uid: botbuilder-core.O365ConnectorCardHttpPOST + name: O365ConnectorCardHttpPOST items: [] - - uid: botbuilder-ai.QnAResponseContext - name: QnAResponseContext + - uid: botbuilder-core.O365ConnectorCardImage + name: O365ConnectorCardImage items: [] - - uid: botbuilder-ai.QnASuggestionsActivityFactory - name: QnASuggestionsActivityFactory + - uid: botbuilder-core.O365ConnectorCardInputBase + name: O365ConnectorCardInputBase items: [] - - uid: botbuilder-ai.QnATelemetryConstants - name: QnATelemetryConstants + - uid: botbuilder-core.O365ConnectorCardInputBaseType + name: O365ConnectorCardInputBaseType items: [] - - uid: botbuilder-ai.RankerTypes - name: RankerTypes + - uid: botbuilder-core.O365ConnectorCardInputType + name: O365ConnectorCardInputType items: [] - - uid: botbuilder-ai.ServiceType - name: ServiceType + - uid: botbuilder-core.O365ConnectorCardMultichoiceInput + name: O365ConnectorCardMultichoiceInput items: [] - - uid: botbuilder-ai.TrainUtils - name: TrainUtils + - uid: botbuilder-core.O365ConnectorCardMultichoiceInputChoice + name: O365ConnectorCardMultichoiceInputChoice items: [] - - uid: botbuilder-ai.window - name: window + - uid: botbuilder-core.O365ConnectorCardOpenUri + name: O365ConnectorCardOpenUri items: [] -- name: botbuilder-ai-orchestrator - items: - - name: Overview - uid: botbuilder-ai-orchestrator - - uid: botbuilder-ai-orchestrator.Label - name: Label + - uid: botbuilder-core.O365ConnectorCardOpenUriTarget + name: O365ConnectorCardOpenUriTarget items: [] - - uid: botbuilder-ai-orchestrator.LabelResolver - name: LabelResolver + - uid: botbuilder-core.O365ConnectorCardSection + name: O365ConnectorCardSection items: [] - - uid: botbuilder-ai-orchestrator.LabelType - name: LabelType + - uid: botbuilder-core.O365ConnectorCardTextInput + name: O365ConnectorCardTextInput items: [] - - uid: botbuilder-ai-orchestrator.OrchestratorBotComponent - name: OrchestratorBotComponent + - uid: botbuilder-core.O365ConnectorCardViewAction + name: O365ConnectorCardViewAction items: [] - - uid: botbuilder-ai-orchestrator.OrchestratorRecognizer - name: OrchestratorRecognizer + - uid: botbuilder-core.OAuthCard + name: OAuthCard items: [] - - uid: botbuilder-ai-orchestrator.OrchestratorRecognizerConfiguration - name: OrchestratorRecognizerConfiguration + - uid: botbuilder-core.OnBehalfOf + name: OnBehalfOf items: [] - - uid: botbuilder-ai-orchestrator.Result - name: Result + - uid: botbuilder-core.OnCardSelectionAction + name: OnCardSelectionAction items: [] -- name: botbuilder-applicationinsights - items: - - name: Overview - uid: botbuilder-applicationinsights - - uid: botbuilder-applicationinsights.ApplicationInsightsTelemetryClient - name: ApplicationInsightsTelemetryClient + - uid: botbuilder-core.Os + name: Os items: [] - - uid: botbuilder-applicationinsights.TelemetryInitializerMiddleware - name: TelemetryInitializerMiddleware + - uid: botbuilder-core.PagedMembersResult + name: PagedMembersResult items: [] -- name: botbuilder-azure - items: - - name: Overview - uid: botbuilder-azure - - uid: botbuilder-azure.AzureBlobTranscriptStore - name: AzureBlobTranscriptStore + - uid: botbuilder-core.PagedResult + name: PagedResult items: [] - - uid: botbuilder-azure.BlobStorage - name: BlobStorage + - uid: botbuilder-core.PaymentAddress + name: PaymentAddress items: [] - - uid: botbuilder-azure.BlobStorageSettings - name: BlobStorageSettings + - uid: botbuilder-core.PaymentCurrencyAmount + name: PaymentCurrencyAmount items: [] - - uid: botbuilder-azure.CosmosDbKeyEscape - name: CosmosDbKeyEscape + - uid: botbuilder-core.PaymentDetails + name: PaymentDetails items: [] - - uid: botbuilder-azure.CosmosDbPartitionedStorage - name: CosmosDbPartitionedStorage + - uid: botbuilder-core.PaymentDetailsModifier + name: PaymentDetailsModifier items: [] - - uid: botbuilder-azure.CosmosDbPartitionedStorageOptions - name: CosmosDbPartitionedStorageOptions + - uid: botbuilder-core.PaymentItem + name: PaymentItem items: [] - - uid: botbuilder-azure.DoOnce - name: DoOnce + - uid: botbuilder-core.PaymentMethodData + name: PaymentMethodData items: [] - - uid: botbuilder-azure.Host - name: Host + - uid: botbuilder-core.PaymentOptions + name: PaymentOptions items: [] -- name: botbuilder-azure-blobs - items: - - name: Overview - uid: botbuilder-azure-blobs - - uid: botbuilder-azure-blobs.BlobsStorage - name: BlobsStorage + - uid: botbuilder-core.PaymentRequest + name: PaymentRequest items: [] - - uid: botbuilder-azure-blobs.BlobsStorageOptions - name: BlobsStorageOptions + - uid: botbuilder-core.PaymentRequestComplete + name: PaymentRequestComplete items: [] - - uid: botbuilder-azure-blobs.BlobsTranscriptStore - name: BlobsTranscriptStore + - uid: botbuilder-core.PaymentRequestCompleteResult + name: PaymentRequestCompleteResult items: [] - - uid: botbuilder-azure-blobs.BlobsTranscriptStoreOptions - name: BlobsTranscriptStoreOptions + - uid: botbuilder-core.PaymentRequestUpdate + name: PaymentRequestUpdate items: [] - - uid: botbuilder-azure-blobs.IgnoreError - name: IgnoreError + - uid: botbuilder-core.PaymentRequestUpdateResult + name: PaymentRequestUpdateResult items: [] -- name: botbuilder-azure-queues - items: - - name: Overview - uid: botbuilder-azure-queues - - uid: botbuilder-azure-queues.AzureQueueStorage - name: AzureQueueStorage + - uid: botbuilder-core.PaymentResponse + name: PaymentResponse items: [] -- name: botbuilder-core - items: - - name: Overview - uid: botbuilder-core - - uid: botbuilder-core.ActivityFactory - name: ActivityFactory + - uid: botbuilder-core.PaymentShippingOption + name: PaymentShippingOption items: [] - - uid: botbuilder-core.ActivityHandler - name: ActivityHandler + - uid: botbuilder-core.Place + name: Place items: [] - - uid: botbuilder-core.ActivityHandlerBase - name: ActivityHandlerBase + - uid: botbuilder-core.PopupWindowPosition + name: PopupWindowPosition items: [] - - uid: botbuilder-core.AutoSaveStateMiddleware - name: AutoSaveStateMiddleware + - uid: botbuilder-core.PrivateConversationState + name: PrivateConversationState items: [] - - uid: botbuilder-core.BotAdapter - name: BotAdapter + - uid: botbuilder-core.PropertyManager + name: PropertyManager items: [] - - uid: botbuilder-core.BotComponent - name: BotComponent + - uid: botbuilder-core.PropertyPaneCheckboxProperties + name: PropertyPaneCheckboxProperties items: [] - - uid: botbuilder-core.BotFrameworkSkill - name: BotFrameworkSkill + - uid: botbuilder-core.PropertyPaneChoiceGroupIconProperties + name: PropertyPaneChoiceGroupIconProperties items: [] - - uid: botbuilder-core.BotHandler - name: BotHandler + - uid: botbuilder-core.PropertyPaneChoiceGroupImageSize + name: PropertyPaneChoiceGroupImageSize items: [] - - uid: botbuilder-core.BotPageViewTelemetryClient - name: BotPageViewTelemetryClient + - uid: botbuilder-core.PropertyPaneChoiceGroupOption + name: PropertyPaneChoiceGroupOption items: [] - - uid: botbuilder-core.BotState - name: BotState + - uid: botbuilder-core.PropertyPaneChoiceGroupProperties + name: PropertyPaneChoiceGroupProperties items: [] - - uid: botbuilder-core.BotStatePropertyAccessor - name: BotStatePropertyAccessor + - uid: botbuilder-core.PropertyPaneDropDownOption + name: PropertyPaneDropDownOption items: [] - - uid: botbuilder-core.BotStateSet - name: BotStateSet + - uid: botbuilder-core.PropertyPaneDropDownProperties + name: PropertyPaneDropDownProperties items: [] - - uid: botbuilder-core.BotTelemetryClient - name: BotTelemetryClient + - uid: botbuilder-core.PropertyPaneFieldProperties + name: PropertyPaneFieldProperties items: [] - - uid: botbuilder-core.BrowserLocalStorage - name: BrowserLocalStorage + - uid: botbuilder-core.PropertyPaneGroup + name: PropertyPaneGroup items: [] - - uid: botbuilder-core.BrowserSessionStorage - name: BrowserSessionStorage + - uid: botbuilder-core.PropertyPaneGroupField + name: PropertyPaneGroupField items: [] - - uid: botbuilder-core.CachedBotState - name: CachedBotState + - uid: botbuilder-core.PropertyPaneGroupOrConditionalGroup + name: PropertyPaneGroupOrConditionalGroup items: [] - - uid: botbuilder-core.CardFactory - name: CardFactory + - uid: botbuilder-core.PropertyPaneLabelProperties + name: PropertyPaneLabelProperties items: [] - - uid: botbuilder-core.CloudAdapterBase - name: CloudAdapterBase + - uid: botbuilder-core.PropertyPaneLinkPopupWindowProperties + name: PropertyPaneLinkPopupWindowProperties items: [] - - uid: botbuilder-core.ComponentRegistration - name: ComponentRegistration + - uid: botbuilder-core.PropertyPaneLinkProperties + name: PropertyPaneLinkProperties items: [] - - uid: botbuilder-core.ConfigurationBotFrameworkAuthentication - name: ConfigurationBotFrameworkAuthentication + - uid: botbuilder-core.PropertyPanePage + name: PropertyPanePage items: [] - - uid: botbuilder-core.ConfigurationBotFrameworkAuthenticationOptions - name: ConfigurationBotFrameworkAuthenticationOptions + - uid: botbuilder-core.PropertyPanePageHeader + name: PropertyPanePageHeader items: [] - - uid: botbuilder-core.ConfigurationServiceClientCredentialFactory - name: ConfigurationServiceClientCredentialFactory + - uid: botbuilder-core.PropertyPaneSliderProperties + name: PropertyPaneSliderProperties items: [] - - uid: botbuilder-core.ConfigurationServiceClientCredentialFactoryOptions - name: ConfigurationServiceClientCredentialFactoryOptions + - uid: botbuilder-core.PropertyPaneTextFieldProperties + name: PropertyPaneTextFieldProperties items: [] - - uid: botbuilder-core.ConsoleTranscriptLogger - name: ConsoleTranscriptLogger + - uid: botbuilder-core.PropertyPaneToggleProperties + name: PropertyPaneToggleProperties items: [] - - uid: botbuilder-core.ConversationState - name: ConversationState + - uid: botbuilder-core.QueueStorage + name: QueueStorage items: [] - - uid: botbuilder-core.CoreAppCredentials - name: CoreAppCredentials + - uid: botbuilder-core.QuickViewCardAction + name: QuickViewCardAction items: [] - - uid: botbuilder-core.CoreWebResource - name: CoreWebResource + - uid: botbuilder-core.QuickViewData + name: QuickViewData items: [] - - uid: botbuilder-core.DeleteActivityHandler - name: DeleteActivityHandler + - uid: botbuilder-core.QuickViewHandleActionResponse + name: QuickViewHandleActionResponse items: [] - - uid: botbuilder-core.ExtendedUserTokenProvider - name: ExtendedUserTokenProvider + - uid: botbuilder-core.QuickViewParameters + name: QuickViewParameters items: [] - - uid: botbuilder-core.IntentScore - name: IntentScore + - uid: botbuilder-core.QuickViewResponse + name: QuickViewResponse items: [] - - uid: botbuilder-core.InvokeException - name: InvokeException + - uid: botbuilder-core.ReactionType + name: ReactionType items: [] - - uid: botbuilder-core.IUserTokenProvider - name: IUserTokenProvider + - uid: botbuilder-core.ReceiptCard + name: ReceiptCard items: [] - - uid: botbuilder-core.MemoryStorage - name: MemoryStorage + - uid: botbuilder-core.ReceiptItem + name: ReceiptItem items: [] - - uid: botbuilder-core.MemoryTranscriptStore - name: MemoryTranscriptStore + - uid: botbuilder-core.RecognizerResult + name: RecognizerResult items: [] - - uid: botbuilder-core.MessageFactory - name: MessageFactory + - uid: botbuilder-core.RegisterClassMiddleware + name: RegisterClassMiddleware items: [] - - uid: botbuilder-core.Middleware - name: Middleware + - uid: botbuilder-core.ResourceResponse + name: ResourceResponse items: [] - - uid: botbuilder-core.MiddlewareHandler - name: MiddlewareHandler + - uid: botbuilder-core.RoleTypes + name: RoleTypes items: [] - - uid: botbuilder-core.MiddlewareSet - name: MiddlewareSet + - uid: botbuilder-core.SearchCardViewParameters + name: SearchCardViewParameters items: [] - - uid: botbuilder-core.NullTelemetryClient - name: NullTelemetryClient + - uid: botbuilder-core.SearchInvokeOptions + name: SearchInvokeOptions items: [] - - uid: botbuilder-core.PagedResult - name: PagedResult + - uid: botbuilder-core.SearchInvokeResponse + name: SearchInvokeResponse items: [] - - uid: botbuilder-core.PrivateConversationState - name: PrivateConversationState + - uid: botbuilder-core.SearchInvokeValue + name: SearchInvokeValue items: [] - - uid: botbuilder-core.PropertyManager - name: PropertyManager + - uid: botbuilder-core.SelectMediaActionParameters + name: SelectMediaActionParameters items: [] - - uid: botbuilder-core.QueueStorage - name: QueueStorage + - uid: botbuilder-core.SelectMediaCardAction + name: SelectMediaCardAction items: [] - - uid: botbuilder-core.RecognizerResult - name: RecognizerResult + - uid: botbuilder-core.SemanticAction + name: SemanticAction items: [] - - uid: botbuilder-core.RegisterClassMiddleware - name: RegisterClassMiddleware + - uid: botbuilder-core.SemanticActionStateTypes + name: SemanticActionStateTypes items: [] - uid: botbuilder-core.SendActivitiesHandler name: SendActivitiesHandler items: [] + - uid: botbuilder-core.SetPropertyPaneConfigurationResponse + name: SetPropertyPaneConfigurationResponse + items: [] - uid: botbuilder-core.Severity name: Severity items: [] + - uid: botbuilder-core.ShowLocationActionParameters + name: ShowLocationActionParameters + items: [] + - uid: botbuilder-core.ShowLocationCardAction + name: ShowLocationCardAction + items: [] - uid: botbuilder-core.ShowTypingMiddleware name: ShowTypingMiddleware items: [] + - uid: botbuilder-core.SigninCard + name: SigninCard + items: [] + - uid: botbuilder-core.SignInCardViewParameters + name: SignInCardViewParameters + items: [] + - uid: botbuilder-core.SigninStateVerificationQuery + name: SigninStateVerificationQuery + items: [] + - uid: botbuilder-core.SignInUrlResponse + name: SignInUrlResponse + items: [] - uid: botbuilder-core.SkillConversationIdFactory name: SkillConversationIdFactory items: [] @@ -1411,9 +3179,15 @@ - uid: botbuilder-core.SkypeMentionNormalizeMiddleware name: SkypeMentionNormalizeMiddleware items: [] + - uid: botbuilder-core.SpeechConstants + name: SpeechConstants + items: [] - uid: botbuilder-core.StatePropertyAccessor name: StatePropertyAccessor items: [] + - uid: botbuilder-core.StatusCodes + name: StatusCodes + items: [] - uid: botbuilder-core.Storage name: Storage items: [] @@ -1429,8 +3203,110 @@ - uid: botbuilder-core.StringUtils name: StringUtils items: [] - - uid: botbuilder-core.TelemetryConstants - name: TelemetryConstants + - uid: botbuilder-core.Style + name: Style + items: [] + - uid: botbuilder-core.SubmitCardAction + name: SubmitCardAction + items: [] + - uid: botbuilder-core.SubmitCardParameters + name: SubmitCardParameters + items: [] + - uid: botbuilder-core.SuggestedActions + name: SuggestedActions + items: [] + - uid: botbuilder-core.TabContext + name: TabContext + items: [] + - uid: botbuilder-core.TabEntityContext + name: TabEntityContext + items: [] + - uid: botbuilder-core.TabRequest + name: TabRequest + items: [] + - uid: botbuilder-core.TabResponse + name: TabResponse + items: [] + - uid: botbuilder-core.TabResponseCard + name: TabResponseCard + items: [] + - uid: botbuilder-core.TabResponseCards + name: TabResponseCards + items: [] + - uid: botbuilder-core.TabResponsePayload + name: TabResponsePayload + items: [] + - uid: botbuilder-core.TabSubmit + name: TabSubmit + items: [] + - uid: botbuilder-core.TabSubmitData + name: TabSubmitData + items: [] + - uid: botbuilder-core.TabSuggestedActions + name: TabSuggestedActions + items: [] + - uid: botbuilder-core.TargetedMeetingNotification + name: TargetedMeetingNotification + items: [] + - uid: botbuilder-core.TargetedMeetingNotificationValue + name: TargetedMeetingNotificationValue + items: [] + - uid: botbuilder-core.TaskModuleCardResponse + name: TaskModuleCardResponse + items: [] + - uid: botbuilder-core.TaskModuleContinueResponse + name: TaskModuleContinueResponse + items: [] + - uid: botbuilder-core.TaskModuleMessageResponse + name: TaskModuleMessageResponse + items: [] + - uid: botbuilder-core.TaskModuleRequest + name: TaskModuleRequest + items: [] + - uid: botbuilder-core.TaskModuleRequestContext + name: TaskModuleRequestContext + items: [] + - uid: botbuilder-core.TaskModuleResponse + name: TaskModuleResponse + items: [] + - uid: botbuilder-core.TaskModuleResponseBase + name: TaskModuleResponseBase + items: [] + - uid: botbuilder-core.TaskModuleTaskInfo + name: TaskModuleTaskInfo + items: [] + - uid: botbuilder-core.TeamDetails + name: TeamDetails + items: [] + - uid: botbuilder-core.TeamInfo + name: TeamInfo + items: [] + - uid: botbuilder-core.TeamsAttachment + name: TeamsAttachment + items: [] + - uid: botbuilder-core.TeamsChannelAccount + name: TeamsChannelAccount + items: [] + - uid: botbuilder-core.TeamsChannelData + name: TeamsChannelData + items: [] + - uid: botbuilder-core.TeamsChannelDataSettings + name: TeamsChannelDataSettings + items: [] + - uid: botbuilder-core.TeamsMeetingInfo + name: TeamsMeetingInfo + items: [] + - uid: botbuilder-core.TeamsMeetingMember + name: TeamsMeetingMember + items: [] + - uid: botbuilder-core.TeamsMeetingParticipant + name: TeamsMeetingParticipant + items: [] + - uid: botbuilder-core.TeamsMember + name: TeamsMember + items: [] + - uid: botbuilder-core.TeamsPagedMembersResult + name: TeamsPagedMembersResult items: [] - uid: botbuilder-core.TelemetryDependency name: TelemetryDependency @@ -1450,6 +3326,9 @@ - uid: botbuilder-core.TelemetryTrace name: TelemetryTrace items: [] + - uid: botbuilder-core.TenantInfo + name: TenantInfo + items: [] - uid: botbuilder-core.TestActivityInspector name: TestActivityInspector items: [] @@ -1459,9 +3338,60 @@ - uid: botbuilder-core.TestFlow name: TestFlow items: [] + - uid: botbuilder-core.TextCardViewParameters + name: TextCardViewParameters + items: [] + - uid: botbuilder-core.TextFormatTypes + name: TextFormatTypes + items: [] + - uid: botbuilder-core.TextHighlight + name: TextHighlight + items: [] + - uid: botbuilder-core.TextInputCardViewParameters + name: TextInputCardViewParameters + items: [] + - uid: botbuilder-core.Thing + name: Thing + items: [] + - uid: botbuilder-core.ThumbnailCard + name: ThumbnailCard + items: [] + - uid: botbuilder-core.ThumbnailUrl + name: ThumbnailUrl + items: [] + - uid: botbuilder-core.TokenExchangeInvokeRequest + name: TokenExchangeInvokeRequest + items: [] + - uid: botbuilder-core.TokenExchangeInvokeResponse + name: TokenExchangeInvokeResponse + items: [] + - uid: botbuilder-core.TokenExchangeRequest + name: TokenExchangeRequest + items: [] + - uid: botbuilder-core.TokenExchangeResource + name: TokenExchangeResource + items: [] + - uid: botbuilder-core.TokenExchangeState + name: TokenExchangeState + items: [] - uid: botbuilder-core.TokenPollingSettings name: TokenPollingSettings items: [] + - uid: botbuilder-core.TokenPostResource + name: TokenPostResource + items: [] + - uid: botbuilder-core.TokenRequest + name: TokenRequest + items: [] + - uid: botbuilder-core.TokenResponse + name: TokenResponse + items: [] + - uid: botbuilder-core.TokenStatus + name: TokenStatus + items: [] + - uid: botbuilder-core.Transcript + name: Transcript + items: [] - uid: botbuilder-core.TranscriptInfo name: TranscriptInfo items: [] @@ -1480,12 +3410,36 @@ - uid: botbuilder-core.TurnContextStateCollection name: TurnContextStateCollection items: [] + - uid: botbuilder-core.Type + name: Type + items: [] + - uid: botbuilder-core.Type1 + name: Type1 + items: [] + - uid: botbuilder-core.Type2 + name: Type2 + items: [] + - uid: botbuilder-core.Type3 + name: Type3 + items: [] - uid: botbuilder-core.UpdateActivityHandler name: UpdateActivityHandler items: [] + - uid: botbuilder-core.UserIdentityType + name: UserIdentityType + items: [] + - uid: botbuilder-core.UserMeetingDetails + name: UserMeetingDetails + items: [] - uid: botbuilder-core.UserState name: UserState items: [] + - uid: botbuilder-core.VideoCard + name: VideoCard + items: [] + - uid: botbuilder-core.ViewResponseType + name: ViewResponseType + items: [] - name: botbuilder-dialogs items: - name: Overview @@ -1514,12 +3468,6 @@ - uid: botbuilder-dialogs.Choice name: Choice items: [] - - uid: botbuilder-dialogs.ChoiceDefaultsChoicePrompt - name: ChoiceDefaultsChoicePrompt - items: [] - - uid: botbuilder-dialogs.ChoiceDefaultsConfirmPrompt - name: ChoiceDefaultsConfirmPrompt - items: [] - uid: botbuilder-dialogs.ChoiceFactory name: ChoiceFactory items: [] @@ -1616,9 +3564,6 @@ - uid: botbuilder-dialogs.DialogsBotComponent name: DialogsBotComponent items: [] - - uid: botbuilder-dialogs.DialogsComponentRegistration - name: DialogsComponentRegistration - items: [] - uid: botbuilder-dialogs.DialogSet name: DialogSet items: [] @@ -1767,12 +3712,6 @@ items: - name: Overview uid: botbuilder-dialogs-adaptive - - uid: botbuilder-dialogs-adaptive.ActionChangeList - name: ActionChangeList - items: [] - - uid: botbuilder-dialogs-adaptive.ActionChangeType - name: ActionChangeType - items: [] - uid: botbuilder-dialogs-adaptive.ActionContext name: ActionContext items: [] @@ -1788,18 +3727,12 @@ - uid: botbuilder-dialogs-adaptive.ActionScopeResult name: ActionScopeResult items: [] - - uid: botbuilder-dialogs-adaptive.ActionState - name: ActionState - items: [] - uid: botbuilder-dialogs-adaptive.ActivityTemplate name: ActivityTemplate items: [] - uid: botbuilder-dialogs-adaptive.ActivityTemplateConguration name: ActivityTemplateConguration items: [] - - uid: botbuilder-dialogs-adaptive.ActivityTemplateConverter - name: ActivityTemplateConverter - items: [] - uid: botbuilder-dialogs-adaptive.AdaptiveBotComponent name: AdaptiveBotComponent items: [] @@ -1809,9 +3742,6 @@ - uid: botbuilder-dialogs-adaptive.AdaptiveDialogConfiguration name: AdaptiveDialogConfiguration items: [] - - uid: botbuilder-dialogs-adaptive.AdaptiveDialogState - name: AdaptiveDialogState - items: [] - uid: botbuilder-dialogs-adaptive.AdaptiveEvents name: AdaptiveEvents items: [] @@ -1836,9 +3766,6 @@ - uid: botbuilder-dialogs-adaptive.AskConfiguration name: AskConfiguration items: [] - - uid: botbuilder-dialogs-adaptive.AssignmentInput - name: AssignmentInput - items: [] - uid: botbuilder-dialogs-adaptive.AttachmentInput name: AttachmentInput items: [] @@ -1878,9 +3805,6 @@ - uid: botbuilder-dialogs-adaptive.CancelAllDialogs name: CancelAllDialogs items: [] - - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBase - name: CancelAllDialogsBase - items: [] - uid: botbuilder-dialogs-adaptive.CancelAllDialogsBaseConfiguration name: CancelAllDialogsBaseConfiguration items: [] @@ -1890,9 +3814,6 @@ - uid: botbuilder-dialogs-adaptive.Case name: Case items: [] - - uid: botbuilder-dialogs-adaptive.CaseInput - name: CaseInput - items: [] - uid: botbuilder-dialogs-adaptive.ChannelMentionEntityRecognizer name: ChannelMentionEntityRecognizer items: [] @@ -1965,12 +3886,6 @@ - uid: botbuilder-dialogs-adaptive.CurrencyEntityRecognizer name: CurrencyEntityRecognizer items: [] - - uid: botbuilder-dialogs-adaptive.D - name: D - items: [] - - uid: botbuilder-dialogs-adaptive.D - name: D - items: [] - uid: botbuilder-dialogs-adaptive.DateTimeEntityRecognizer name: DateTimeEntityRecognizer items: [] @@ -2004,24 +3919,15 @@ - uid: botbuilder-dialogs-adaptive.DialogExpressionConverter name: DialogExpressionConverter items: [] - - uid: botbuilder-dialogs-adaptive.DialogListConverter - name: DialogListConverter - items: [] - uid: botbuilder-dialogs-adaptive.DialogProperty name: DialogProperty items: [] - - uid: botbuilder-dialogs-adaptive.DialogSetConverter - name: DialogSetConverter - items: [] - uid: botbuilder-dialogs-adaptive.DimensionEntityRecognizer name: DimensionEntityRecognizer items: [] - uid: botbuilder-dialogs-adaptive.DynamicBeginDialog name: DynamicBeginDialog items: [] - - uid: botbuilder-dialogs-adaptive.DynamicBeginDialogDeserializer - name: DynamicBeginDialogDeserializer - items: [] - uid: botbuilder-dialogs-adaptive.EditActions name: EditActions items: [] @@ -2055,24 +3961,6 @@ - uid: botbuilder-dialogs-adaptive.EndTurnConfiguration name: EndTurnConfiguration items: [] - - uid: botbuilder-dialogs-adaptive.EntityAssignment - name: EntityAssignment - items: [] - - uid: botbuilder-dialogs-adaptive.EntityAssignmentComparer - name: EntityAssignmentComparer - items: [] - - uid: botbuilder-dialogs-adaptive.EntityAssignmentConfiguration - name: EntityAssignmentConfiguration - items: [] - - uid: botbuilder-dialogs-adaptive.EntityAssignments - name: EntityAssignments - items: [] - - uid: botbuilder-dialogs-adaptive.EntityAssignmentsConfiguration - name: EntityAssignmentsConfiguration - items: [] - - uid: botbuilder-dialogs-adaptive.EntityInfo - name: EntityInfo - items: [] - uid: botbuilder-dialogs-adaptive.EntityRecognizer name: EntityRecognizer items: [] @@ -2130,12 +4018,6 @@ - uid: botbuilder-dialogs-adaptive.HasPendingActionsFunction name: HasPendingActionsFunction items: [] - - uid: botbuilder-dialogs-adaptive.HeadersInput - name: HeadersInput - items: [] - - uid: botbuilder-dialogs-adaptive.HeadersOutput - name: HeadersOutput - items: [] - uid: botbuilder-dialogs-adaptive.HttpMethod name: HttpMethod items: [] @@ -2151,15 +4033,6 @@ - uid: botbuilder-dialogs-adaptive.IfConditionConfiguration name: IfConditionConfiguration items: [] - - uid: botbuilder-dialogs-adaptive.Input - name: Input - items: [] - - uid: botbuilder-dialogs-adaptive.Input - name: Input - items: [] - - uid: botbuilder-dialogs-adaptive.Input - name: Input - items: [] - uid: botbuilder-dialogs-adaptive.InputDialog name: InputDialog items: [] @@ -2172,9 +4045,6 @@ - uid: botbuilder-dialogs-adaptive.IntentPattern name: IntentPattern items: [] - - uid: botbuilder-dialogs-adaptive.IntentPatternInput - name: IntentPatternInput - items: [] - uid: botbuilder-dialogs-adaptive.IntProperty name: IntProperty items: [] @@ -2190,9 +4060,6 @@ - uid: botbuilder-dialogs-adaptive.LanguageGenerator name: LanguageGenerator items: [] - - uid: botbuilder-dialogs-adaptive.LanguageGeneratorConverter - name: LanguageGeneratorConverter - items: [] - uid: botbuilder-dialogs-adaptive.LanguageGeneratorExtensions name: LanguageGeneratorExtensions items: [] @@ -2238,9 +4105,6 @@ - uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizerConfiguration name: MultiLanguageRecognizerConfiguration items: [] - - uid: botbuilder-dialogs-adaptive.MultiLanguageRecognizerConverter - name: MultiLanguageRecognizerConverter - items: [] - uid: botbuilder-dialogs-adaptive.NumberEntityRecognizer name: NumberEntityRecognizer items: [] @@ -2373,24 +4237,12 @@ - uid: botbuilder-dialogs-adaptive.OrdinalEntityRecognizer name: OrdinalEntityRecognizer items: [] - - uid: botbuilder-dialogs-adaptive.Output - name: Output - items: [] - - uid: botbuilder-dialogs-adaptive.Output - name: Output - items: [] - uid: botbuilder-dialogs-adaptive.PercentageEntityRecognizer name: PercentageEntityRecognizer items: [] - uid: botbuilder-dialogs-adaptive.PhoneNumberEntityRecognizer name: PhoneNumberEntityRecognizer items: [] - - uid: botbuilder-dialogs-adaptive.PropertiesInput - name: PropertiesInput - items: [] - - uid: botbuilder-dialogs-adaptive.PropertiesOutput - name: PropertiesOutput - items: [] - uid: botbuilder-dialogs-adaptive.Property name: Property items: [] @@ -2403,12 +4255,6 @@ - uid: botbuilder-dialogs-adaptive.RandomSelector name: RandomSelector items: [] - - uid: botbuilder-dialogs-adaptive.RecognizerConverter - name: RecognizerConverter - items: [] - - uid: botbuilder-dialogs-adaptive.RecognizerListConverter - name: RecognizerListConverter - items: [] - uid: botbuilder-dialogs-adaptive.RecognizerSet name: RecognizerSet items: [] @@ -2529,9 +4375,6 @@ - uid: botbuilder-dialogs-adaptive.TextEntity name: TextEntity items: [] - - uid: botbuilder-dialogs-adaptive.TextEntityRecognizer - name: TextEntityRecognizer - items: [] - uid: botbuilder-dialogs-adaptive.TextInput name: TextInput items: [] @@ -2544,9 +4387,6 @@ - uid: botbuilder-dialogs-adaptive.TextTemplateConfiguration name: TextTemplateConfiguration items: [] - - uid: botbuilder-dialogs-adaptive.TextTemplateConverter - name: TextTemplateConverter - items: [] - uid: botbuilder-dialogs-adaptive.ThrowException name: ThrowException items: [] @@ -2577,61 +4417,248 @@ - uid: botbuilder-dialogs-adaptive.UrlEntityRecognizer name: UrlEntityRecognizer items: [] - - uid: botbuilder-dialogs-adaptive.ValueRecognizer - name: ValueRecognizer +- name: botbuilder-dialogs-adaptive-runtime + items: null +- name: botbuilder-dialogs-adaptive-runtime-core + items: + - name: Overview + uid: botbuilder-dialogs-adaptive-runtime-core + - uid: botbuilder-dialogs-adaptive-runtime-core.Configuration + name: Configuration + items: [] + - uid: botbuilder-dialogs-adaptive-runtime-core.DependencyFactory + name: DependencyFactory + items: [] + - uid: botbuilder-dialogs-adaptive-runtime-core.Factory + name: Factory + items: [] + - uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection + name: ServiceCollection + items: [] +- name: botbuilder-dialogs-adaptive-runtime-integration-azure-functions + items: + - name: Overview + uid: botbuilder-dialogs-adaptive-runtime-integration-azure-functions + - uid: botbuilder-dialogs-adaptive-runtime-integration-azure-functions.Options + name: Options + items: [] +- name: botbuilder-dialogs-adaptive-runtime-integration-express + items: + - name: Overview + uid: botbuilder-dialogs-adaptive-runtime-integration-express + - uid: botbuilder-dialogs-adaptive-runtime-integration-express.Options + name: Options + items: [] +- name: botbuilder-dialogs-adaptive-runtime-integration-restify + items: + - name: Overview + uid: botbuilder-dialogs-adaptive-runtime-integration-restify + - uid: botbuilder-dialogs-adaptive-runtime-integration-restify.Options + name: Options + items: [] +- name: botbuilder-dialogs-adaptive-teams + items: + - name: Overview + uid: botbuilder-dialogs-adaptive-teams + - uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipant + name: GetMeetingParticipant + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetMeetingParticipantConfiguration + name: GetMeetingParticipantConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetMember + name: GetMember + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetMemberConfiguration + name: GetMemberConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetPagedMembers + name: GetPagedMembers + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetPagedMembersConfiguration + name: GetPagedMembersConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembers + name: GetPagedTeamMembers + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetPagedTeamMembersConfiguration + name: GetPagedTeamMembersConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetTeamChannels + name: GetTeamChannels + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetTeamChannelsConfiguration + name: GetTeamChannelsConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetTeamDetails + name: GetTeamDetails + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetTeamDetailsConfiguration + name: GetTeamDetailsConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetTeamMember + name: GetTeamMember + items: [] + - uid: botbuilder-dialogs-adaptive-teams.GetTeamMemberConfiguration + name: GetTeamMemberConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsAppBasedLinkQuery + name: OnTeamsAppBasedLinkQuery + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsCardAction + name: OnTeamsCardAction + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelCreated + name: OnTeamsChannelCreated + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelDeleted + name: OnTeamsChannelDeleted + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRenamed + name: OnTeamsChannelRenamed + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsChannelRestored + name: OnTeamsChannelRestored + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsFileConsent + name: OnTeamsFileConsent + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewEdit + name: OnTeamsMEBotMessagePreviewEdit + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEBotMessagePreviewSend + name: OnTeamsMEBotMessagePreviewSend + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMECardButtonClicked + name: OnTeamsMECardButtonClicked + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigQuerySettingUrl + name: OnTeamsMEConfigQuerySettingUrl + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEConfigurationSetting + name: OnTeamsMEConfigurationSetting + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEFetchTask + name: OnTeamsMEFetchTask + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMEQuery + name: OnTeamsMEQuery + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESelectItem + name: OnTeamsMESelectItem + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsMESubmitAction + name: OnTeamsMESubmitAction + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsO365ConnectorCardAction + name: OnTeamsO365ConnectorCardAction + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabFetch + name: OnTeamsTabFetch + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTabSubmit + name: OnTeamsTabSubmit + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleFetch + name: OnTeamsTaskModuleFetch + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTaskModuleSubmit + name: OnTeamsTaskModuleSubmit + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamArchived + name: OnTeamsTeamArchived + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamDeleted + name: OnTeamsTeamDeleted + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamHardDeleted + name: OnTeamsTeamHardDeleted + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRenamed + name: OnTeamsTeamRenamed + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamRestored + name: OnTeamsTeamRestored + items: [] + - uid: botbuilder-dialogs-adaptive-teams.OnTeamsTeamUnarchived + name: OnTeamsTeamUnarchived + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponse + name: SendAppBasedLinkQueryResponse + items: [] + - uid: >- + botbuilder-dialogs-adaptive-teams.SendAppBasedLinkQueryResponseConfiguration + name: SendAppBasedLinkQueryResponseConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponse + name: SendMEActionResponse + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEActionResponseConfiguration + name: SendMEActionResponseConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponse + name: SendMEAttachmentsResponse + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEAttachmentsResponseConfiguration + name: SendMEAttachmentsResponseConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEAuthResponse + name: SendMEAuthResponse + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponse + name: SendMEBotMessagePreviewResponse + items: [] + - uid: >- + botbuilder-dialogs-adaptive-teams.SendMEBotMessagePreviewResponseConfiguration + name: SendMEBotMessagePreviewResponseConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponse + name: SendMEConfigQuerySettingUrlResponse + items: [] + - uid: >- + botbuilder-dialogs-adaptive-teams.SendMEConfigQuerySettingUrlResponseConfiguration + name: SendMEConfigQuerySettingUrlResponseConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponse + name: SendMEMessageResponse items: [] -- name: botbuilder-dialogs-adaptive-runtime - items: - - name: Overview - uid: botbuilder-dialogs-adaptive-runtime - - uid: botbuilder-dialogs-adaptive-runtime.Configuration - name: Configuration + - uid: botbuilder-dialogs-adaptive-teams.SendMEMessageResponseConfiguration + name: SendMEMessageResponseConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-runtime.ConfigurationResourceExporer - name: ConfigurationResourceExporer + - uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponse + name: SendMESelectItemResponse items: [] - - uid: botbuilder-dialogs-adaptive-runtime.CoreBot - name: CoreBot + - uid: botbuilder-dialogs-adaptive-teams.SendMESelectItemResponseConfiguration + name: SendMESelectItemResponseConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-runtime.CoreBotAdapter - name: CoreBotAdapter + - uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannel + name: SendMessageToTeamsChannel items: [] -- name: botbuilder-dialogs-adaptive-runtime-core - items: - - name: Overview - uid: botbuilder-dialogs-adaptive-runtime-core - - uid: botbuilder-dialogs-adaptive-runtime-core.Configuration - name: Configuration + - uid: botbuilder-dialogs-adaptive-teams.SendMessageToTeamsChannelConfiguration + name: SendMessageToTeamsChannelConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-runtime-core.DependencyFactory - name: DependencyFactory + - uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponse + name: SendTaskModuleCardResponse items: [] - - uid: botbuilder-dialogs-adaptive-runtime-core.Factory - name: Factory + - uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleCardResponseConfiguration + name: SendTaskModuleCardResponseConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-runtime-core.ServiceCollection - name: ServiceCollection + - uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponse + name: SendTaskModuleMessageResponse items: [] -- name: botbuilder-dialogs-adaptive-runtime-integration-azure-functions - items: - - name: Overview - uid: botbuilder-dialogs-adaptive-runtime-integration-azure-functions - - uid: botbuilder-dialogs-adaptive-runtime-integration-azure-functions.Options - name: Options + - uid: >- + botbuilder-dialogs-adaptive-teams.SendTaskModuleMessageResponseConfiguration + name: SendTaskModuleMessageResponseConfiguration items: [] -- name: botbuilder-dialogs-adaptive-runtime-integration-express - items: - - name: Overview - uid: botbuilder-dialogs-adaptive-runtime-integration-express - - uid: botbuilder-dialogs-adaptive-runtime-integration-express.Options - name: Options + - uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponse + name: SendTaskModuleUrlResponse items: [] -- name: botbuilder-dialogs-adaptive-runtime-integration-restify - items: - - name: Overview - uid: botbuilder-dialogs-adaptive-runtime-integration-restify - - uid: botbuilder-dialogs-adaptive-runtime-integration-restify.Options - name: Options + - uid: botbuilder-dialogs-adaptive-teams.SendTaskModuleUrlResponseConfiguration + name: SendTaskModuleUrlResponseConfiguration + items: [] + - uid: botbuilder-dialogs-adaptive-teams.TeamsComponentRegistration + name: TeamsComponentRegistration items: [] - name: botbuilder-dialogs-adaptive-testing items: @@ -2676,54 +4703,18 @@ - uid: botbuilder-dialogs-adaptive-testing.AssertTelemetryContainsConfiguration name: AssertTelemetryContainsConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-testing.AssignmentInput - name: AssignmentInput - items: [] - - uid: botbuilder-dialogs-adaptive-testing.BodyMatchType - name: BodyMatchType - items: [] - uid: botbuilder-dialogs-adaptive-testing.CustomEvent name: CustomEvent items: [] - uid: botbuilder-dialogs-adaptive-testing.CustomEventConfiguration name: CustomEventConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-testing.DialogContextInspector - name: DialogContextInspector - items: [] - - uid: botbuilder-dialogs-adaptive-testing.DialogInspector - name: DialogInspector - items: [] - uid: botbuilder-dialogs-adaptive-testing.FallbackFunc name: FallbackFunc items: [] - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMessage name: HttpRequestMessage items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMock - name: HttpRequestMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpRequestMocksConverter - name: HttpRequestMocksConverter - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMock - name: HttpRequestSequenceMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpRequestSequenceMockConfiguration - name: HttpRequestSequenceMockConfiguration - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMessage - name: HttpResponseMessage - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMock - name: HttpResponseMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockContent - name: HttpResponseMockContent - items: [] - - uid: botbuilder-dialogs-adaptive-testing.HttpResponseMockMessage - name: HttpResponseMockMessage - items: [] - uid: botbuilder-dialogs-adaptive-testing.Inspector name: Inspector items: [] @@ -2745,42 +4736,12 @@ - uid: botbuilder-dialogs-adaptive-testing.MockSettingsMiddleware name: MockSettingsMiddleware items: [] - - uid: botbuilder-dialogs-adaptive-testing.ResponseContent - name: ResponseContent - items: [] - - uid: botbuilder-dialogs-adaptive-testing.ResponseContentType - name: ResponseContentType - items: [] - - uid: botbuilder-dialogs-adaptive-testing.ResponseStatusCode - name: ResponseStatusCode - items: [] - - uid: botbuilder-dialogs-adaptive-testing.SequenceResponseManager - name: SequenceResponseManager - items: [] - uid: botbuilder-dialogs-adaptive-testing.SetProperties name: SetProperties items: [] - uid: botbuilder-dialogs-adaptive-testing.SetPropertiesConfiguration name: SetPropertiesConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-testing.SetTestOptionsMiddleware - name: SetTestOptionsMiddleware - items: [] - - uid: botbuilder-dialogs-adaptive-testing.SettingMock - name: SettingMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.SettingMocksConverter - name: SettingMocksConverter - items: [] - - uid: botbuilder-dialogs-adaptive-testing.SettingStringAssignment - name: SettingStringAssignment - items: [] - - uid: botbuilder-dialogs-adaptive-testing.SettingStringMock - name: SettingStringMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.SettingStringMockConfiguration - name: SettingStringMockConfiguration - items: [] - uid: botbuilder-dialogs-adaptive-testing.TestAction name: TestAction items: [] @@ -2790,9 +4751,6 @@ - uid: botbuilder-dialogs-adaptive-testing.TestScriptConfiguration name: TestScriptConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-testing.TestTelemetryClient - name: TestTelemetryClient - items: [] - uid: botbuilder-dialogs-adaptive-testing.TestUtils name: TestUtils items: [] @@ -2820,18 +4778,6 @@ - uid: botbuilder-dialogs-adaptive-testing.UserSaysConfiguration name: UserSaysConfiguration items: [] - - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMock - name: UserTokenBasicMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.UserTokenBasicMockConfiguration - name: UserTokenBasicMockConfiguration - items: [] - - uid: botbuilder-dialogs-adaptive-testing.UserTokenMock - name: UserTokenMock - items: [] - - uid: botbuilder-dialogs-adaptive-testing.UserTokenMocksConverter - name: UserTokenMocksConverter - items: [] - uid: botbuilder-dialogs-adaptive-testing.UserTyping name: UserTyping items: [] @@ -2860,9 +4806,6 @@ - uid: botbuilder-dialogs-declarative.FolderResourceProvider name: FolderResourceProvider items: [] - - uid: botbuilder-dialogs-declarative.PathUtil - name: PathUtil - items: [] - uid: botbuilder-dialogs-declarative.Resource name: Resource items: [] @@ -3029,9 +4972,6 @@ - uid: botbuilder-lg.Range name: Range items: [] - - uid: botbuilder-lg.SourceRange - name: SourceRange - items: [] - uid: botbuilder-lg.StaticChecker name: StaticChecker items: [] @@ -3104,6 +5044,25 @@ - uid: botbuilder-lg.TemplateStringContext name: TemplateStringContext items: [] +- name: botbuilder-stdlib + items: + - name: Overview + uid: botbuilder-stdlib + - uid: botbuilder-stdlib.Extends + name: Extends + items: [] + - uid: botbuilder-stdlib.Maybe + name: Maybe + items: [] + - uid: botbuilder-stdlib.Newable + name: Newable + items: [] + - uid: botbuilder-stdlib.Nil + name: Nil + items: [] + - uid: botbuilder-stdlib.stringExt + name: stringExt + items: [] - name: botbuilder-testing items: - name: Overview @@ -3124,9 +5083,6 @@ - uid: botframework-config.AppInsightsService name: AppInsightsService items: [] - - uid: botframework-config.AzureService - name: AzureService - items: [] - uid: botframework-config.BlobStorageService name: BlobStorageService items: [] @@ -3215,14 +5171,8 @@ - uid: botframework-connector.AppCredentials name: AppCredentials items: [] - - uid: botframework-connector.Attachments - name: Attachments - items: [] - - uid: botframework-connector.AttachmentsGetAttachmentInfoResponse - name: AttachmentsGetAttachmentInfoResponse - items: [] - - uid: botframework-connector.AttachmentsGetAttachmentResponse - name: AttachmentsGetAttachmentResponse + - uid: botframework-connector.AseChannelValidation + name: AseChannelValidation items: [] - uid: botframework-connector.AuthenticateRequestResult name: AuthenticateRequestResult @@ -3236,6 +5186,15 @@ - uid: botframework-connector.AuthenticationError name: AuthenticationError items: [] + - uid: botframework-connector.AuthenticatorResult + name: AuthenticatorResult + items: [] + - uid: botframework-connector.BatchBatchFailedEntriesResponse + name: BatchBatchFailedEntriesResponse + items: [] + - uid: botframework-connector.BatchBatchOperationStateResponse + name: BatchBatchOperationStateResponse + items: [] - uid: botframework-connector.BotFrameworkAuthentication name: BotFrameworkAuthentication items: [] @@ -3245,12 +5204,6 @@ - uid: botframework-connector.BotFrameworkClient name: BotFrameworkClient items: [] - - uid: botframework-connector.BotFrameworkClientImpl - name: BotFrameworkClientImpl - items: [] - - uid: botframework-connector.BotSignIn - name: BotSignIn - items: [] - uid: botframework-connector.BotSignInGetSignInResourceOptionalParams name: BotSignInGetSignInResourceOptionalParams items: [] @@ -3263,9 +5216,15 @@ - uid: botframework-connector.BotSignInGetSignInUrlResponse name: BotSignInGetSignInUrlResponse items: [] + - uid: botframework-connector.CancelOperationResponse + name: CancelOperationResponse + items: [] - uid: botframework-connector.CertificateAppCredentials name: CertificateAppCredentials items: [] + - uid: botframework-connector.CertificateServiceClientCredentialsFactory + name: CertificateServiceClientCredentialsFactory + items: [] - uid: botframework-connector.ChannelValidation name: ChannelValidation items: [] @@ -3278,65 +5237,19 @@ - uid: botframework-connector.ConnectorClient name: ConnectorClient items: [] - - uid: botframework-connector.ConnectorClientContext - name: ConnectorClientContext - items: [] - uid: botframework-connector.ConnectorClientOptions name: ConnectorClientOptions items: [] - uid: botframework-connector.ConnectorFactory name: ConnectorFactory items: [] - - uid: botframework-connector.ConnectorFactoryImpl - name: ConnectorFactoryImpl - items: [] - - uid: botframework-connector.Conversations - name: Conversations - items: [] - - uid: botframework-connector.ConversationsCreateConversationResponse - name: ConversationsCreateConversationResponse - items: [] - - uid: botframework-connector.ConversationsGetActivityMembersResponse - name: ConversationsGetActivityMembersResponse - items: [] - - uid: botframework-connector.ConversationsGetConversationMemberResponse - name: ConversationsGetConversationMemberResponse - items: [] - - uid: botframework-connector.ConversationsGetConversationMembersResponse - name: ConversationsGetConversationMembersResponse - items: [] - - uid: >- - botframework-connector.ConversationsGetConversationPagedMembersOptionalParams - name: ConversationsGetConversationPagedMembersOptionalParams + - uid: botframework-connector.ConversationConstants + name: ConversationConstants items: [] - uid: >- botframework-connector.ConversationsGetConversationPagedMembersOptionalParams name: ConversationsGetConversationPagedMembersOptionalParams items: [] - - uid: botframework-connector.ConversationsGetConversationPagedMembersResponse - name: ConversationsGetConversationPagedMembersResponse - items: [] - - uid: botframework-connector.ConversationsGetConversationsOptionalParams - name: ConversationsGetConversationsOptionalParams - items: [] - - uid: botframework-connector.ConversationsGetConversationsResponse - name: ConversationsGetConversationsResponse - items: [] - - uid: botframework-connector.ConversationsReplyToActivityResponse - name: ConversationsReplyToActivityResponse - items: [] - - uid: botframework-connector.ConversationsSendConversationHistoryResponse - name: ConversationsSendConversationHistoryResponse - items: [] - - uid: botframework-connector.ConversationsSendToConversationResponse - name: ConversationsSendToConversationResponse - items: [] - - uid: botframework-connector.ConversationsUpdateActivityResponse - name: ConversationsUpdateActivityResponse - items: [] - - uid: botframework-connector.ConversationsUploadAttachmentResponse - name: ConversationsUploadAttachmentResponse - items: [] - uid: botframework-connector.EmulatorApiClient name: EmulatorApiClient items: [] @@ -3370,12 +5283,6 @@ - uid: botframework-connector.InnerHttpError name: InnerHttpError items: [] - - uid: botframework-connector.IOpenIdMetadataKey - name: IOpenIdMetadataKey - items: [] - - uid: botframework-connector.JwtTokenExtractor - name: JwtTokenExtractor - items: [] - uid: botframework-connector.JwtTokenProviderFactory name: JwtTokenProviderFactory items: [] @@ -3394,11 +5301,14 @@ - uid: botframework-connector.MicrosoftAppCredentials name: MicrosoftAppCredentials items: [] - - uid: botframework-connector.OpenIdMetadata - name: OpenIdMetadata + - uid: botframework-connector.MicrosoftGovernmentAppCredentials + name: MicrosoftGovernmentAppCredentials + items: [] + - uid: botframework-connector.MsalAppCredentials + name: MsalAppCredentials items: [] - - uid: botframework-connector.ParameterizedBotFrameworkAuthentication - name: ParameterizedBotFrameworkAuthentication + - uid: botframework-connector.MsalServiceClientCredentialsFactory + name: MsalServiceClientCredentialsFactory items: [] - uid: botframework-connector.PasswordServiceClientCredentialFactory name: PasswordServiceClientCredentialFactory @@ -3406,9 +5316,15 @@ - uid: botframework-connector.ReadReceiptInfo name: ReadReceiptInfo items: [] + - uid: botframework-connector.ServiceClientCredentials + name: ServiceClientCredentials + items: [] - uid: botframework-connector.ServiceClientCredentialsFactory name: ServiceClientCredentialsFactory items: [] + - uid: botframework-connector.SignInUrlResponse + name: SignInUrlResponse + items: [] - uid: botframework-connector.SimpleCredentialProvider name: SimpleCredentialProvider items: [] @@ -3421,6 +5337,9 @@ - uid: botframework-connector.Teams name: Teams items: [] + - uid: botframework-connector.TeamsBatchOperationResponse + name: TeamsBatchOperationResponse + items: [] - uid: botframework-connector.TeamsConnectorClient name: TeamsConnectorClient items: [] @@ -3430,6 +5349,59 @@ - uid: botframework-connector.TeamsConnectorClientOptions name: TeamsConnectorClientOptions items: [] + - uid: botframework-connector.TeamsConnectorMappers + name: TeamsConnectorMappers + items: [] + - name: TeamsConnectorModels + items: + - name: Overview + uid: botframework-connector.TeamsConnectorModels + - uid: >- + botframework-connector.TeamsConnectorModels.BatchBatchFailedEntriesResponse + name: BatchBatchFailedEntriesResponse + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.BatchBatchOperationStateResponse + name: BatchBatchOperationStateResponse + items: [] + - uid: botframework-connector.TeamsConnectorModels.CancelOperationResponse + name: CancelOperationResponse + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.ConversationsGetConversationPagedMembersOptionalParams + name: ConversationsGetConversationPagedMembersOptionalParams + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsBatchOperationResponse + name: TeamsBatchOperationResponse + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsConnectorClientOptions + name: TeamsConnectorClientOptions + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchChannelListResponse + name: TeamsFetchChannelListResponse + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantOptionalParams + name: TeamsFetchMeetingParticipantOptionalParams + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchMeetingParticipantResponse + name: TeamsFetchMeetingParticipantResponse + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsFetchTeamDetailsResponse + name: TeamsFetchTeamDetailsResponse + items: [] + - uid: botframework-connector.TeamsConnectorModels.TeamsMeetingInfoResponse + name: TeamsMeetingInfoResponse + items: [] + - uid: >- + botframework-connector.TeamsConnectorModels.TeamsMeetingNotificationResponse + name: TeamsMeetingNotificationResponse + items: [] - uid: botframework-connector.TeamsFetchChannelListResponse name: TeamsFetchChannelListResponse items: [] @@ -3445,24 +5417,92 @@ - uid: botframework-connector.TeamsMeetingInfoResponse name: TeamsMeetingInfoResponse items: [] + - uid: botframework-connector.TeamsMeetingNotificationResponse + name: TeamsMeetingNotificationResponse + items: [] - uid: botframework-connector.TokenApiClient name: TokenApiClient items: [] - - uid: botframework-connector.TokenApiClientContext - name: TokenApiClientContext - items: [] - uid: botframework-connector.TokenApiClientOptions name: TokenApiClientOptions items: [] - - uid: botframework-connector.UserToken - name: UserToken + - name: TokenApiModels + items: + - name: Overview + uid: botframework-connector.TokenApiModels + - uid: botframework-connector.TokenApiModels.AadResourceUrls + name: AadResourceUrls + items: [] + - uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceOptionalParams + name: BotSignInGetSignInResourceOptionalParams + items: [] + - uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInResourceResponse + name: BotSignInGetSignInResourceResponse + items: [] + - uid: >- + botframework-connector.TokenApiModels.BotSignInGetSignInUrlOptionalParams + name: BotSignInGetSignInUrlOptionalParams + items: [] + - uid: botframework-connector.TokenApiModels.BotSignInGetSignInUrlResponse + name: BotSignInGetSignInUrlResponse + items: [] + - uid: botframework-connector.TokenApiModels.ErrorModel + name: ErrorModel + items: [] + - uid: botframework-connector.TokenApiModels.ErrorResponse + name: ErrorResponse + items: [] + - uid: botframework-connector.TokenApiModels.InnerHttpError + name: InnerHttpError + items: [] + - uid: botframework-connector.TokenApiModels.TokenApiClientOptions + name: TokenApiClientOptions + items: [] + - uid: botframework-connector.TokenApiModels.UserTokenExchangeAsyncResponse + name: UserTokenExchangeAsyncResponse + items: [] + - uid: >- + botframework-connector.TokenApiModels.UserTokenGetAadTokensOptionalParams + name: UserTokenGetAadTokensOptionalParams + items: [] + - uid: botframework-connector.TokenApiModels.UserTokenGetAadTokensResponse + name: UserTokenGetAadTokensResponse + items: [] + - uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenOptionalParams + name: UserTokenGetTokenOptionalParams + items: [] + - uid: botframework-connector.TokenApiModels.UserTokenGetTokenResponse + name: UserTokenGetTokenResponse + items: [] + - uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusOptionalParams + name: UserTokenGetTokenStatusOptionalParams + items: [] + - uid: >- + botframework-connector.TokenApiModels.UserTokenGetTokenStatusResponse + name: UserTokenGetTokenStatusResponse + items: [] + - uid: botframework-connector.TokenApiModels.UserTokenSignOutOptionalParams + name: UserTokenSignOutOptionalParams + items: [] + - uid: botframework-connector.TokenApiModels.UserTokenSignOutResponse + name: UserTokenSignOutResponse + items: [] + - uid: botframework-connector.TokenCredentials + name: TokenCredentials + items: [] + - uid: botframework-connector.TokenExchangeRequest + name: TokenExchangeRequest + items: [] + - uid: botframework-connector.TokenStatus + name: TokenStatus items: [] - uid: botframework-connector.UserTokenClient name: UserTokenClient items: [] - - uid: botframework-connector.UserTokenClientImpl - name: UserTokenClientImpl - items: [] - uid: botframework-connector.UserTokenExchangeAsyncResponse name: UserTokenExchangeAsyncResponse items: [] @@ -3497,6 +5537,15 @@ items: - name: Overview uid: botframework-schema + - uid: botframework-schema.AceCardSize + name: AceCardSize + items: [] + - uid: botframework-schema.AceData + name: AceData + items: [] + - uid: botframework-schema.AceRequest + name: AceRequest + items: [] - uid: botframework-schema.Action name: Action items: [] @@ -3566,9 +5615,39 @@ - uid: botframework-schema.AudioCard name: AudioCard items: [] + - uid: botframework-schema.BaseCardComponent + name: BaseCardComponent + items: [] + - uid: botframework-schema.BaseCardViewParameters + name: BaseCardViewParameters + items: [] + - uid: botframework-schema.BaseHandleActionResponse + name: BaseHandleActionResponse + items: [] - uid: botframework-schema.BasicCard name: BasicCard items: [] + - uid: botframework-schema.BatchFailedEntriesResponse + name: BatchFailedEntriesResponse + items: [] + - uid: botframework-schema.BatchFailedEntry + name: BatchFailedEntry + items: [] + - uid: botframework-schema.BatchOperationRequest + name: BatchOperationRequest + items: [] + - uid: botframework-schema.BatchOperationResponse + name: BatchOperationResponse + items: [] + - uid: botframework-schema.BatchOperationStateResponse + name: BatchOperationStateResponse + items: [] + - uid: botframework-schema.BotConfigAuth + name: BotConfigAuth + items: [] + - uid: botframework-schema.BotConfigAuthType + name: BotConfigAuthType + items: [] - uid: botframework-schema.BotMessagePreviewActionType name: BotMessagePreviewActionType items: [] @@ -3584,9 +5663,48 @@ - uid: botframework-schema.CardAction name: CardAction items: [] + - uid: botframework-schema.CardBarComponent + name: CardBarComponent + items: [] + - uid: botframework-schema.CardButtonBase + name: CardButtonBase + items: [] + - uid: botframework-schema.CardButtonComponent + name: CardButtonComponent + items: [] + - uid: botframework-schema.CardComponentName + name: CardComponentName + items: [] - uid: botframework-schema.CardImage name: CardImage items: [] + - uid: botframework-schema.CardSearchBoxComponent + name: CardSearchBoxComponent + items: [] + - uid: botframework-schema.CardSearchFooterComponent + name: CardSearchFooterComponent + items: [] + - uid: botframework-schema.CardTextComponent + name: CardTextComponent + items: [] + - uid: botframework-schema.CardTextInputComponent + name: CardTextInputComponent + items: [] + - uid: botframework-schema.CardViewActionsFooterParameters + name: CardViewActionsFooterParameters + items: [] + - uid: botframework-schema.CardViewFooterParameters + name: CardViewFooterParameters + items: [] + - uid: botframework-schema.CardViewHandleActionResponse + name: CardViewHandleActionResponse + items: [] + - uid: botframework-schema.CardViewParameters + name: CardViewParameters + items: [] + - uid: botframework-schema.CardViewResponse + name: CardViewResponse + items: [] - uid: botframework-schema.ChannelAccount name: ChannelAccount items: [] @@ -3605,6 +5723,15 @@ - uid: botframework-schema.CommandValue name: CommandValue items: [] + - uid: botframework-schema.ConfigResponse + name: ConfigResponse + items: [] + - uid: botframework-schema.ConfigResponseConfig + name: ConfigResponseConfig + items: [] + - uid: botframework-schema.ConfirmationDialog + name: ConfirmationDialog + items: [] - uid: botframework-schema.ContactRelationUpdateActionTypes name: ContactRelationUpdateActionTypes items: [] @@ -3638,6 +5765,9 @@ - uid: botframework-schema.DeliveryModes name: DeliveryModes items: [] + - uid: botframework-schema.DropDownOptionType + name: DropDownOptionType + items: [] - uid: botframework-schema.EndOfConversationCodes name: EndOfConversationCodes items: [] @@ -3650,12 +5780,27 @@ - uid: botframework-schema.ErrorResponse name: ErrorResponse items: [] + - uid: botframework-schema.ExecuteCardAction + name: ExecuteCardAction + items: [] + - uid: botframework-schema.ExecuteCardParameters + name: ExecuteCardParameters + items: [] - uid: botframework-schema.ExpectedReplies name: ExpectedReplies items: [] + - uid: botframework-schema.ExternalLinkActionParameters + name: ExternalLinkActionParameters + items: [] + - uid: botframework-schema.ExternalLinkCardAction + name: ExternalLinkCardAction + items: [] - uid: botframework-schema.Fact name: Fact items: [] + - uid: botframework-schema.FieldType + name: FieldType + items: [] - uid: botframework-schema.FileConsentCard name: FileConsentCard items: [] @@ -3674,15 +5819,39 @@ - uid: botframework-schema.FileUploadInfo name: FileUploadInfo items: [] + - uid: botframework-schema.FocusParameters + name: FocusParameters + items: [] - uid: botframework-schema.GeoCoordinates name: GeoCoordinates items: [] + - uid: botframework-schema.GetLocationActionParameters + name: GetLocationActionParameters + items: [] + - uid: botframework-schema.GetLocationCardAction + name: GetLocationCardAction + items: [] + - uid: botframework-schema.GetPropertyPaneConfigurationResponse + name: GetPropertyPaneConfigurationResponse + items: [] + - uid: botframework-schema.HandleActionResponse + name: HandleActionResponse + items: [] - uid: botframework-schema.HeroCard name: HeroCard items: [] - uid: botframework-schema.IActivity name: IActivity items: [] + - uid: botframework-schema.ICardSearchBoxButton + name: ICardSearchBoxButton + items: [] + - uid: botframework-schema.ICardTextInputIconButton + name: ICardTextInputIconButton + items: [] + - uid: botframework-schema.ICardTextInputTitleButton + name: ICardTextInputTitleButton + items: [] - uid: botframework-schema.ICommandActivity name: ICommandActivity items: [] @@ -3749,12 +5918,18 @@ - uid: botframework-schema.ITypingActivity name: ITypingActivity items: [] + - uid: botframework-schema.Location + name: Location + items: [] - uid: botframework-schema.MediaCard name: MediaCard items: [] - uid: botframework-schema.MediaEventValue name: MediaEventValue items: [] + - uid: botframework-schema.MediaType + name: MediaType + items: [] - uid: botframework-schema.MediaUrl name: MediaUrl items: [] @@ -3764,9 +5939,6 @@ - uid: botframework-schema.MeetingDetails name: MeetingDetails items: [] - - uid: botframework-schema.MeetingDetailsBase - name: MeetingDetailsBase - items: [] - uid: botframework-schema.MeetingEndEventDetails name: MeetingEndEventDetails items: [] @@ -3776,9 +5948,36 @@ - uid: botframework-schema.MeetingInfo name: MeetingInfo items: [] + - uid: botframework-schema.MeetingNotification + name: MeetingNotification + items: [] + - uid: botframework-schema.MeetingNotificationBase + name: MeetingNotificationBase + items: [] + - uid: botframework-schema.MeetingNotificationChannelData + name: MeetingNotificationChannelData + items: [] + - uid: botframework-schema.MeetingNotificationRecipientFailureInfo + name: MeetingNotificationRecipientFailureInfo + items: [] + - uid: botframework-schema.MeetingNotificationResponse + name: MeetingNotificationResponse + items: [] + - uid: botframework-schema.MeetingParticipantsEventDetails + name: MeetingParticipantsEventDetails + items: [] + - uid: botframework-schema.MeetingStageSurface + name: MeetingStageSurface + items: [] - uid: botframework-schema.MeetingStartEventDetails name: MeetingStartEventDetails items: [] + - uid: botframework-schema.MeetingSurface + name: MeetingSurface + items: [] + - uid: botframework-schema.MeetingTabIconSurface + name: MeetingTabIconSurface + items: [] - uid: botframework-schema.Mention name: Mention items: [] @@ -3851,6 +6050,9 @@ - uid: botframework-schema.MicrosoftPayMethodData name: MicrosoftPayMethodData items: [] + - uid: botframework-schema.NoOpHandleActionResponse + name: NoOpHandleActionResponse + items: [] - uid: botframework-schema.NotificationInfo name: NotificationInfo items: [] @@ -3914,6 +6116,12 @@ - uid: botframework-schema.OAuthCard name: OAuthCard items: [] + - uid: botframework-schema.OnBehalfOf + name: OnBehalfOf + items: [] + - uid: botframework-schema.OnCardSelectionAction + name: OnCardSelectionAction + items: [] - uid: botframework-schema.Os name: Os items: [] @@ -3965,6 +6173,81 @@ - uid: botframework-schema.Place name: Place items: [] + - uid: botframework-schema.PopupWindowPosition + name: PopupWindowPosition + items: [] + - uid: botframework-schema.PropertyPaneCheckboxProperties + name: PropertyPaneCheckboxProperties + items: [] + - uid: botframework-schema.PropertyPaneChoiceGroupIconProperties + name: PropertyPaneChoiceGroupIconProperties + items: [] + - uid: botframework-schema.PropertyPaneChoiceGroupImageSize + name: PropertyPaneChoiceGroupImageSize + items: [] + - uid: botframework-schema.PropertyPaneChoiceGroupOption + name: PropertyPaneChoiceGroupOption + items: [] + - uid: botframework-schema.PropertyPaneChoiceGroupProperties + name: PropertyPaneChoiceGroupProperties + items: [] + - uid: botframework-schema.PropertyPaneDropDownOption + name: PropertyPaneDropDownOption + items: [] + - uid: botframework-schema.PropertyPaneDropDownProperties + name: PropertyPaneDropDownProperties + items: [] + - uid: botframework-schema.PropertyPaneFieldProperties + name: PropertyPaneFieldProperties + items: [] + - uid: botframework-schema.PropertyPaneGroup + name: PropertyPaneGroup + items: [] + - uid: botframework-schema.PropertyPaneGroupField + name: PropertyPaneGroupField + items: [] + - uid: botframework-schema.PropertyPaneGroupOrConditionalGroup + name: PropertyPaneGroupOrConditionalGroup + items: [] + - uid: botframework-schema.PropertyPaneLabelProperties + name: PropertyPaneLabelProperties + items: [] + - uid: botframework-schema.PropertyPaneLinkPopupWindowProperties + name: PropertyPaneLinkPopupWindowProperties + items: [] + - uid: botframework-schema.PropertyPaneLinkProperties + name: PropertyPaneLinkProperties + items: [] + - uid: botframework-schema.PropertyPanePage + name: PropertyPanePage + items: [] + - uid: botframework-schema.PropertyPanePageHeader + name: PropertyPanePageHeader + items: [] + - uid: botframework-schema.PropertyPaneSliderProperties + name: PropertyPaneSliderProperties + items: [] + - uid: botframework-schema.PropertyPaneTextFieldProperties + name: PropertyPaneTextFieldProperties + items: [] + - uid: botframework-schema.PropertyPaneToggleProperties + name: PropertyPaneToggleProperties + items: [] + - uid: botframework-schema.QuickViewCardAction + name: QuickViewCardAction + items: [] + - uid: botframework-schema.QuickViewData + name: QuickViewData + items: [] + - uid: botframework-schema.QuickViewHandleActionResponse + name: QuickViewHandleActionResponse + items: [] + - uid: botframework-schema.QuickViewParameters + name: QuickViewParameters + items: [] + - uid: botframework-schema.QuickViewResponse + name: QuickViewResponse + items: [] - uid: botframework-schema.ReactionType name: ReactionType items: [] @@ -3980,6 +6263,9 @@ - uid: botframework-schema.RoleTypes name: RoleTypes items: [] + - uid: botframework-schema.SearchCardViewParameters + name: SearchCardViewParameters + items: [] - uid: botframework-schema.SearchInvokeOptions name: SearchInvokeOptions items: [] @@ -3989,15 +6275,33 @@ - uid: botframework-schema.SearchInvokeValue name: SearchInvokeValue items: [] + - uid: botframework-schema.SelectMediaActionParameters + name: SelectMediaActionParameters + items: [] + - uid: botframework-schema.SelectMediaCardAction + name: SelectMediaCardAction + items: [] - uid: botframework-schema.SemanticAction name: SemanticAction items: [] - uid: botframework-schema.SemanticActionStateTypes name: SemanticActionStateTypes items: [] + - uid: botframework-schema.SetPropertyPaneConfigurationResponse + name: SetPropertyPaneConfigurationResponse + items: [] + - uid: botframework-schema.ShowLocationActionParameters + name: ShowLocationActionParameters + items: [] + - uid: botframework-schema.ShowLocationCardAction + name: ShowLocationCardAction + items: [] - uid: botframework-schema.SigninCard name: SigninCard items: [] + - uid: botframework-schema.SignInCardViewParameters + name: SignInCardViewParameters + items: [] - uid: botframework-schema.SigninStateVerificationQuery name: SigninStateVerificationQuery items: [] @@ -4013,6 +6317,12 @@ - uid: botframework-schema.Style name: Style items: [] + - uid: botframework-schema.SubmitCardAction + name: SubmitCardAction + items: [] + - uid: botframework-schema.SubmitCardParameters + name: SubmitCardParameters + items: [] - uid: botframework-schema.SuggestedActions name: SuggestedActions items: [] @@ -4046,6 +6356,12 @@ - uid: botframework-schema.TabSuggestedActions name: TabSuggestedActions items: [] + - uid: botframework-schema.TargetedMeetingNotification + name: TargetedMeetingNotification + items: [] + - uid: botframework-schema.TargetedMeetingNotificationValue + name: TargetedMeetingNotificationValue + items: [] - uid: botframework-schema.TaskModuleCardResponse name: TaskModuleCardResponse items: [] @@ -4091,21 +6407,33 @@ - uid: botframework-schema.TeamsMeetingInfo name: TeamsMeetingInfo items: [] + - uid: botframework-schema.TeamsMeetingMember + name: TeamsMeetingMember + items: [] - uid: botframework-schema.TeamsMeetingParticipant name: TeamsMeetingParticipant items: [] + - uid: botframework-schema.TeamsMember + name: TeamsMember + items: [] - uid: botframework-schema.TeamsPagedMembersResult name: TeamsPagedMembersResult items: [] - uid: botframework-schema.TenantInfo name: TenantInfo items: [] + - uid: botframework-schema.TextCardViewParameters + name: TextCardViewParameters + items: [] - uid: botframework-schema.TextFormatTypes name: TextFormatTypes items: [] - uid: botframework-schema.TextHighlight name: TextHighlight items: [] + - uid: botframework-schema.TextInputCardViewParameters + name: TextInputCardViewParameters + items: [] - uid: botframework-schema.Thing name: Thing items: [] @@ -4130,6 +6458,9 @@ - uid: botframework-schema.TokenExchangeState name: TokenExchangeState items: [] + - uid: botframework-schema.TokenPostResource + name: TokenPostResource + items: [] - uid: botframework-schema.TokenRequest name: TokenRequest items: [] @@ -4157,67 +6488,31 @@ - uid: botframework-schema.UserIdentityType name: UserIdentityType items: [] + - uid: botframework-schema.UserMeetingDetails + name: UserMeetingDetails + items: [] - uid: botframework-schema.VideoCard name: VideoCard items: [] + - uid: botframework-schema.ViewResponseType + name: ViewResponseType + items: [] - name: botframework-streaming items: - name: Overview uid: botframework-streaming - - uid: botframework-streaming.AddressInfo - name: AddressInfo - items: [] - - uid: botframework-streaming.BufferEncoding - name: BufferEncoding - items: [] - - uid: botframework-streaming.CancelDisassembler - name: CancelDisassembler - items: [] - - uid: botframework-streaming.ConnectionListener - name: ConnectionListener - items: [] - uid: botframework-streaming.ContentStream name: ContentStream items: [] - - uid: botframework-streaming.HeaderSerializer - name: HeaderSerializer - items: [] - uid: botframework-streaming.HttpContent name: HttpContent items: [] - - uid: botframework-streaming.HttpContentStream - name: HttpContentStream - items: [] - - uid: botframework-streaming.HttpContentStreamDisassembler - name: HttpContentStreamDisassembler - items: [] - - uid: botframework-streaming.IAssemblerParams - name: IAssemblerParams - items: [] - - uid: botframework-streaming.IBrowserFileReader - name: IBrowserFileReader - items: [] - - uid: botframework-streaming.IBrowserWebSocket - name: IBrowserWebSocket - items: [] - - uid: botframework-streaming.IEventEmitter - name: IEventEmitter - items: [] - - uid: botframework-streaming.IHeader - name: IHeader - items: [] - - uid: botframework-streaming.IHttpContentHeaders - name: IHttpContentHeaders - items: [] - uid: botframework-streaming.INodeBuffer name: INodeBuffer items: [] - uid: botframework-streaming.INodeIncomingMessage name: INodeIncomingMessage items: [] - - uid: botframework-streaming.INodeServer - name: INodeServer - items: [] - uid: botframework-streaming.INodeSocket name: INodeSocket items: [] @@ -4227,48 +6522,21 @@ - uid: botframework-streaming.IReceiveResponse name: IReceiveResponse items: [] - - uid: botframework-streaming.IRequestPayload - name: IRequestPayload - items: [] - - uid: botframework-streaming.IResponsePayload - name: IResponsePayload - items: [] - - uid: botframework-streaming.ISendPacket - name: ISendPacket - items: [] - uid: botframework-streaming.ISocket name: ISocket items: [] - - uid: botframework-streaming.IStreamDescription - name: IStreamDescription - items: [] - uid: botframework-streaming.IStreamingTransportClient name: IStreamingTransportClient items: [] - uid: botframework-streaming.IStreamingTransportServer name: IStreamingTransportServer items: [] - - uid: botframework-streaming.IStreamWrapper - name: IStreamWrapper - items: [] - - uid: botframework-streaming.ITransport - name: ITransport - items: [] - - uid: botframework-streaming.ITransportReceiver - name: ITransportReceiver - items: [] - - uid: botframework-streaming.ITransportSender - name: ITransportSender - items: [] - uid: botframework-streaming.NamedPipeClient name: NamedPipeClient items: [] - uid: botframework-streaming.NamedPipeServer name: NamedPipeServer items: [] - - uid: botframework-streaming.NamedPipeTransport - name: NamedPipeTransport - items: [] - uid: botframework-streaming.NodeWebSocket name: NodeWebSocket items: [] @@ -4278,75 +6546,21 @@ - uid: botframework-streaming.NodeWebSocketFactoryBase name: NodeWebSocketFactoryBase items: [] - - uid: botframework-streaming.PayloadAssembler - name: PayloadAssembler - items: [] - - uid: botframework-streaming.PayloadAssemblerManager - name: PayloadAssemblerManager - items: [] - - uid: botframework-streaming.PayloadConstants - name: PayloadConstants - items: [] - - uid: botframework-streaming.PayloadDisassembler - name: PayloadDisassembler - items: [] - - uid: botframework-streaming.PayloadReceiver - name: PayloadReceiver - items: [] - - uid: botframework-streaming.PayloadSender - name: PayloadSender - items: [] - - uid: botframework-streaming.PayloadTypes - name: PayloadTypes - items: [] - - uid: botframework-streaming.ProtocolAdapter - name: ProtocolAdapter - items: [] - - uid: botframework-streaming.RequestDisassembler - name: RequestDisassembler - items: [] - uid: botframework-streaming.RequestHandler name: RequestHandler items: [] - - uid: botframework-streaming.RequestManager - name: RequestManager - items: [] - - uid: botframework-streaming.ResponseDisassembler - name: ResponseDisassembler - items: [] - - uid: botframework-streaming.SendOperations - name: SendOperations - items: [] - uid: botframework-streaming.StreamingRequest name: StreamingRequest items: [] - uid: botframework-streaming.StreamingResponse name: StreamingResponse items: [] - - uid: botframework-streaming.StreamManager - name: StreamManager - items: [] - uid: botframework-streaming.SubscribableStream name: SubscribableStream items: [] - - uid: botframework-streaming.TransportDisconnectedEvent - name: TransportDisconnectedEvent - items: [] - - uid: botframework-streaming.TransportDisconnectedEventHandler - name: TransportDisconnectedEventHandler - items: [] - - uid: botframework-streaming.ValidBuffer - name: ValidBuffer - items: [] - uid: botframework-streaming.WebSocketClient name: WebSocketClient items: [] - uid: botframework-streaming.WebSocketServer name: WebSocketServer items: [] - - uid: botframework-streaming.WebSocketTransport - name: WebSocketTransport - items: [] - - uid: botframework-streaming.WritableStream - name: WritableStream - items: []